マイクロサービスはシンプルな分散ログ追跡を実装します

最近、プロジェクトに簡単な分散リクエスト追跡機能を追加したいと考えています。フロントエンドからゲートウェイへのリクエストを開始し、ゲートウェイから Spring Cloud マイクロサービスを呼び出します。これらのプロセス中に、ログから分散 ID リンクが表示されることを期待します。問題のトラブルシューティングを容易にするために、リクエスト ID を通じてリンク全体を追跡できます。

[[378163]]

既存のソリューションとしては、当然ながら SkyWalking、Spring Cloud Sleuth、Zipkin などのコンポーネントを使用することになります。ただし、ログクエリを容易にするために、さまざまなサービスで常に実行できる ID を記録することが主な目的であるため、複雑なコンポーネントをあまり導入したくありません。最終的に、MDC を介してログに追跡 ID を出力し、Feign と RestTemplate のマイクロサービスにリクエスト ID を渡すことにしました。

主にいくつかのステップが含まれます:

フロントエンドからリクエストIDを生成し、それをリクエストヘッダーに追加してゲートウェイに持ち込む
ゲートウェイは WebFilter を通じてメッセージを傍受し、MDC に参加してログに出力します。
FeignとRequestTemplateでは、リクエストIDをHTTPヘッダー内のマイクロサービスに渡します。
各マイクロサービスもWebFilterによってインターセプトされ、MDCに追加され、ログに出力されます。

MDCC

MDC (Mapped Diagnostic Context) は、マルチスレッド条件下でのログ記録を容易にするために Log4j と Logback によって提供される機能です。 MDC は、キーと値のペアを追加できる、現在のスレッドにバインドされたハッシュテーブルとして考えることができます。

MDCの主な業務:

値を MDC に設定します: MDC.put(key, value);
MDC から値を取得します: MDC.get(key);
MDC の内容をログに出力します: %X{key}

TraceIdツールクラスを追加しました

まず、TRACE_ID の定数値と TRACE_ID の設定および生成方法を定義する TraceIdUtils ツールクラスを追加します。以降のコードはこの推定クラスを通じて操作されます。

 org.apache.commons.lang.RandomStringUtils をインポートします。
 org.apache.commons.lang.StringUtils をインポートします。
 org.slf4j.MDC をインポートします。 
 
パブリッククラスTraceIdUtils {
公共 静的最終文字列 TRACE_ID = "traceId" ;
    プライベート静的最終int MAX_ID_LENGTH = 10; 
 
    /**
     * トレースIDを生成する
     */
    プライベート静的文字列genTraceId() {
 RandomStringUtils.randomAlphanumeric(MAX_ID_LENGTH)を返します。
    } 
 
    /**
     * トレースIDを設定する
     */
公共 静的void setTraceId(文字列traceId) {
        // パラメータが空の場合は新しいIDを生成する
        トレース ID = StringUtils.isBlank(traceId) ? genTraceId(): トレースID;
        //MDCにtraceIdを入れる
        MDC.put(TRACE_ID、 StringUtils.substring (traceId、-MAX_ID_LENGTH));
    } 
 
    /**
     * トレースIDを取得
     */
公共 静的文字列 getTraceId() {
        // 得る
        文字列traceId = MDC.get(TRACE_ID);
        // traceIdが空の場合は新しいIDを生成する
StringUtils.isBlank(traceId)を返しますか? genTraceId(): トレースID;
    }
 }

WebFilter経由でTraceIdフィルターを追加する

リクエストヘッダーから TraceIdUtils.TRACE_ID に対応する値を取得するために、GenericFilterBean を追加します。この値は、フロントエンドがリクエストを開始するとき、またはマイクロサービス間で渡されるときに伝達されます。値がない場合、TraceIdUtils.setTraceId によって値が生成されます。

 org.springframework.core.annotation.Orderをインポートします。
 org.springframework.web.filter.GenericFilterBean をインポートします。 
 
 @WebFilter(urlPatterns = "/*" , filterName = "traceIdFilter" )
 @注文(1)
パブリッククラスTraceIdFilterはGenericFilterBeanを拡張します{
    @オーバーライド
public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) は IOException、ServletException をスローします {
        //traceIdの初期化
        HttpServletRequest 要求 = (HttpServletRequest) リクエスト;
        文字列 traceId = req.getHeader(TraceIdUtils.TRACE_ID);
        TraceIdUtils.setTraceId(traceId);
        // 後続のフィルターを実行する
        フィルターチェーン.doFilter(リクエスト、レスポンス);
    }
 }

SpringBoot スタートアップクラスに @ServletComponentScan アノテーションを追加することを忘れないでください。そうしないと、カスタムフィルターは有効になりません。「com.yourtion.trace.filter」は、TraceIdFilter が配置されているパッケージ名です。

 @ServletComponentScan(basePackages = "com.yourtion.trace.filter" )
 @SpringBootアプリケーション
パブリッククラスMyApplication { 
 
公共 静的void main(String[] args) {
        SpringApplication.run(MyApplication.class、引数);
    }
 }

FeignにTraceIdを追加する

@FeignClient プロキシクラスは実行時に Spring コンテキストの RequestInterceptor を使用するため、独自のインターセプターをカスタマイズして Spring コンテキストに挿入し、リクエストコンテキストにカスタムリクエストヘッダーを追加できるようにします。

 feign.RequestInterceptor をインポートします。
 feign.RequestTemplate をインポートします。
 org.springframework.stereotype.Service をインポートします。 
 
 @サービス
パブリッククラスFeignInterceptorはRequestInterceptorを実装します{
    @オーバーライド
パブリックvoid 適用(リクエストテンプレート テンプレート) {
        template.header(TraceIdUtils.TRACE_ID, TraceIdUtils.getTraceId());
    }
 }

RestTemplate に TraceId を追加する

一部のリクエストは RestTemplate を通じて開始されます。以前は、RestTemplateConfig 構成クラスを独自に実装していました。今回は、関連する構成に以下を追加しました。

 RestTemplate restTemplate = builder.additionalInterceptors((リクエスト、本文、実行) -> {
    リクエスト.getHeaders()。 add (TraceIdUtils.TRACE_ID, TraceIdUtils.getTraceId());
実行を返します。execute (リクエスト、本文) ;
 }）。建てる（）;

この時点で、リンクへの TraceId の追加は完了しており、残っているのはそれをログに印刷することだけです。

Log4j2のレイアウト形式を変更する

MDC に traceId を出力するために、ログのレイアウト形式を変更します。

 <! -- 元の形式 -->  
 <PatternLayout パターン = "%5p %c:%L - %m %throwable{セパレーター( --> )}%n" /> 
 
 <! -- traceId フォーマットを追加 -->  
 <PatternLayout パターン = "%5p traceId:%X{traceId} %c:%L - %m %throwable{separator( --> )}%n" />