ウクライナの旗私たちはウクライナの友人や同僚と共にいます。困っているウクライナを支援するには、このページをご覧ください。

フロントエンド/UI設定

バージョン  1.62最新

設定

UIのいくつかの側面を設定できます。

  • 「依存関係」セクションを有効/設定できます。
  • 「モニター」タブ（別名：サービスパフォーマンス監視）を有効/設定できます。
  • アプリの分析トラッキングを有効/設定できます（Google Analyticsまたはカスタムプラグインを使用）。
  • 追加のメニューオプションをグローバルナビゲーションに追加できます。
  • 検索入力の制限を設定できます。

これらのオプションは、JSON設定ファイルで設定できます。クエリサービスの--query.ui-configコマンドラインパラメータは、クエリサービスの起動時にJSONファイルへのパスに設定する必要があります。

設定ファイルの例（完全なスキーマはこちら 外部リンク を参照）

{
  "dependencies": {
    "dagMaxNumServices": 200,
    "menuEnabled": true
  },
  "monitor": {
    "menuEnabled": true
  },
  "archiveEnabled": true,
  "tracking": {
    "gaID": "UA-000000-2",
    "trackErrors": true
  },
  "menu": [
    {
      "label": "About Jaeger",
      "items": [
        {
          "label": "GitHub",
          "url": "https://github.com/jaegertracing/jaeger"
        },
        {
          "label": "Docs",
          "url": "http://jaeger.readthedocs.io/en/latest/"
        }
      ]
    }
  ],
  "search": {
    "maxLookback": {
      "label": "2 Days",
      "value": "2d"
    },
    "maxLimit": 1500
  },
  "linkPatterns": [{
    "type": "process",
    "key": "jaeger.version",
    "url": "https://github.com/jaegertracing/jaeger-client-java/releases/tag/#{jaeger.version}",
    "text": "Information about Jaeger release #{jaeger.version}"
  },
  {
    "type": "tags",
    "key": "uniqueId",
    "url": "https://mykibana.com/uniqueId=#{uniqueId}&traceId=#{trace.traceID}",
    "text": "Redirect to kibana to view log"
  }]
}

依存関係

dependencies.dagMaxNumServicesは、DAG依存関係ビューが無効になるまでに許可されるサービスの最大数を定義します。デフォルト：200。

dependencies.menuEnabledは、依存関係メニューボタンを有効（true）または無効（false）にします。デフォルト：true。

モニター

monitor.menuEnabledは、モニターメニューボタンを有効（true）または無効（false）にします。デフォルト：false。

アーカイブサポート

archiveEnabledは、アーカイブトレースボタンを有効（true）または無効（false）にします。デフォルト：false。クエリサービスでのアーカイブストレージの設定が必要です。アーカイブされたトレースはIDで直接アクセスできるだけであり、検索できません。

アプリの分析トラッキング

tracking.gaIDは、Google AnalyticsトラッキングIDを定義します。これはGoogle Analyticsトラッキングに必要であり、これをnull以外の値に設定するとGoogle Analyticsトラッキングが有効になります。デフォルト：null。

tracking.customWebAnalyticsは、カスタムトラッキングプラグインのファクトリ関数を定義します（UI設定のJavaScript形式を使用する場合のみ）。

tracking.trackErrorsは、エラー追跡を有効（true）または無効（false）にします。エラーは、有効な分析トラッカーが設定されている場合にのみ追跡できます。デフォルト：true。

アプリの分析の詳細については、UIリポジトリのトラッキングREADME 外部リンク を参照してください。

カスタムメニュー項目

menuを使用すると、グローバルナビゲーションに追加のリンクを追加できます。追加のリンクは右揃えになります。

上記のサンプルJSON構成では、構成されたメニューには「GitHub」および「ドキュメント」のサブオプションを持つ「Jaegerについて」というラベルの付いたドロップダウンがあります。右上のメニューのリンクの形式は次のとおりです。

{
  "label": "Some text here",
  "url": "https://example.com"
}

リンクは、menu配列のメンバーとして直接配置するか、ドロップダウンメニューオプションにグループ化することができます。リンクのグループの形式は次のとおりです。

{
  "label": "Dropdown button",
  "items": [ ]
}

items配列には、1つ以上のリンク構成を含める必要があります。

検索入力制限

search.maxLimitは、入力によって検索できる最大結果数を設定します。

search.maxLookbackは、ユーザーがトレースをクエリできる現在時刻より前の最大時間を設定します。この値より大きい「ルックバック」ドロップダウンのオプションは表示されません。

フィールド説明
label検索フォームのドロップダウンに表示されるテキスト
valueラベルが選択された場合に検索クエリで送信される値

linkPatternsノードを使用すると、Jaeger UIに表示されるフィールドからリンクを作成できます。

フィールド説明
typeリンクが追加されるメタデータセクション：process、tags、logs、traces
keyリンクとして値が表示されるタグ/プロセス/ログ属性の名前。このフィールドはタイプtracesでは必須ではありません。
urlリンクが指すURL。外部サイトまたはJaeger UI内の相対パスを使用できます。
textリンクのツールチップに表示されるテキスト

urlとtextの両方をテンプレートとして定義できます（つまり、#{field-name}を使用します）。Jaeger UIはタグ/ログ/トレースデータに基づいて値を動的に置き換えます。

トレースの場合、サポートされるテンプレートフィールドは、duration、endTime、startTime、traceName、traceIDです。

さらに、トレーステンプレートフィールドは、トレーステンプレートフィールドにtrace.プレフィックスが付いている場合、プロセス/ログ/タグタイプで置換に使用できます。たとえば、trace.traceID、trace.startTimeなどです。

埋め込みモード

バージョン1.9以降、Jaeger UIは、Jaeger UIを他のアプリケーションに統合することを目的とした「埋め込み」レイアウトモードを提供します。現在（v0の時点）、採用されているアプローチは、UIをスペースに制約のあるレイアウトに適したものにするために、ページからさまざまなUI要素を削除することです。

埋め込みモードは、URLクエリパラメータを介して誘導および構成されます。

埋め込みモードに入るには、uiEmbed=v0クエリパラメータと値をURLに追加する必要があります。たとえば、次のURLは、ID abc123を持つトレースを埋め込みモードで表示します。

http://localhost:16686/trace/abc123?uiEmbed=v0

uiEmbed=v0は必須です。

さらに、サポートされている各ページには、新しいタブで埋め込みなしのページを開くボタンが追加されています。

次のページは埋め込みモードをサポートしています

  • 検索ページ
  • トレースページ

検索ページ

検索トレースページをアプリケーションに統合するには、uiEmbed=v0を使用して埋め込みモードを使用するようにJaeger UIに示す必要があります。

例

http://localhost:16686/search?
    service=my-service&
    start=1543917759557000&
    end=1543921359557000&
    limit=20&
    lookback=1h&
    maxDuration&
    minDuration&
    uiEmbed=v0

Embed Search Traces

設定オプション

以下のクエリパラメータを使用して、検索ページのレイアウトを設定できます。

  • uiSearchHideGraph=1 - 検索結果の上に表示される散布図を無効にします。
http://localhost:16686/search?
    service=my-service&
    start=1543917759557000&
    end=1543921359557000&
    limit=20&
    lookback=1h&
    maxDuration&
    minDuration&
    uiEmbed=v0&
    uiSearchHideGraph=1

Embed Search Traces without Graph

トレースページ

トレースページをアプリケーションに統合するには、uiEmbed=v0を指定して、Jaeger UIに埋め込みモードを使用することを指示する必要があります。

例

http://localhost:16686/trace/{trace-id}?uiEmbed=v0

Embed Trace view

検索トレースページからこのビューに移動した場合、結果ページに戻るためのボタンが表示されます。

Embed Trace view

設定オプション

以下のクエリパラメータを使用して、トレースページのレイアウトを設定できます。

  • uiTimelineCollapseTitle=1を指定すると、トレースヘッダーが折りたたまれた状態で開始され、概要とミニマップが非表示になります。
http://localhost:16686/trace/{trace-id}?
    uiEmbed=v0&
    uiTimelineCollapseTitle=1

Embed Trace view

  • uiTimelineHideMinimap=1を指定すると、トレースヘッダーが展開されているかどうかにかかわらず、ミニマップが完全に削除されます。
http://localhost:16686/trace/{trace-id}?
    uiEmbed=v0&
    uiTimelineHideMinimap=1

Embed Trace view

  • uiTimelineHideSummary=1 - トレースの概要情報（サービス数など）を、トレースヘッダーが展開されているかどうかにかかわらず、完全に削除します。
http://localhost:16686/trace/{trace-id}?
    uiEmbed=v0&
    uiTimelineHideSummary=1

Embed Trace view

これらのオプションを組み合わせることもできます。

http://localhost:16686/trace/{trace-id}?
    uiEmbed=v0&
    uiTimelineHideMinimap=1&
    uiTimelineHideSummary=1

Embed Trace view