Ukraine flag 我们与我们在乌克兰的朋友和同事站在一起。为了支持乌克兰度过难关，请访问此页面：支持乌克兰。

前端/UI 配置

版本  2.6 最新 前往最新的 1.x 版本

配置

UI 的几个方面可以进行配置

这些选项可以通过一个 JSON 配置文件进行配置。启动查询服务时，必须将查询服务的 --query.ui-config 命令行参数设置为该 JSON 文件的路径。

一个示例配置文件（在此处查看完整模式 外部链接 - Jaeger 分布式追踪平台）

{
  "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"
  },
  {
    "type": "traces",
    "url": "https://my-logs.server?from=#{startTime | add -60000000 | epoch_micros_to_date_iso}&to=#{endTime | add 60000000 | epoch_micros_to_date_iso}'",
    "text": "Redirect to kibana to view log with formatted dates"
  }]
}

依赖关系

dependencies.dagMaxNumServices 定义了在 DAG 依赖关系视图被禁用之前允许的最大服务数量。默认值：200。

dependencies.menuEnabled 启用 (true) 或禁用 (false) 依赖关系菜单按钮。默认值：true。

监控

monitor.menuEnabled 启用 (true) 或禁用 (false) 监控菜单按钮。默认值：false。

归档支持

archiveEnabled 启用 (true) 或禁用 (false) 归档链路按钮。默认值：false。这需要在 Query 服务中配置归档存储。归档的链路只能通过 ID 直接访问，无法搜索。

应用分析跟踪

tracking.gaID 定义了 Google Analytics 跟踪 ID。这对于 Google Analytics 跟踪是必需的，将其设置为非 null 值将启用 Google Analytics 跟踪。默认值：null。

tracking.customWebAnalytics 定义了一个自定义跟踪插件的工厂函数（仅在使用 Javascript 形式的 UI 配置时可用）。

tracking.trackErrors 启用 (true) 或禁用 (false) 错误跟踪。只有配置了有效的分析跟踪器才能跟踪错误。默认值：true。

有关应用分析的更多详细信息，请参阅 UI 仓库中的tracking README 外部链接 - Jaeger 分布式追踪平台。

自定义菜单项

menu 允许将额外的链接添加到全局导航。这些额外的链接会靠右对齐。

在上面的示例 JSON 配置中，配置的菜单将有一个标有“About Jaeger”的下拉菜单，其中包含“GitHub”和“Docs”子选项。右上角菜单中链接的格式如下

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

链接可以直接是 menu 数组的成员，也可以分组到下拉菜单选项中。链接组的格式是

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

items 数组应包含一个或多个链接配置。

搜索输入限制

search.maxLimit 配置了输入允许您搜索的最大结果数量。

search.maxLookback 配置了用户可以查询当前时间之前链路的最大时间。Lookback 下拉菜单中大于此值的选项将不会显示。

字段描述
label搜索表单下拉菜单中显示的文本
value如果选中了 label，则在搜索查询中提交的值

linkPatterns 节点可用于从 Jaeger UI 中显示的字段创建链接。

字段描述
type您的链接将被添加到的元数据部分：process、tags、logs、traces
key将与其值显示为链接的 tag/process/log 属性的名称，对于 traces 类型，此字段不是必需的。
url链接应指向的 URL，可以是外部站点或 Jaeger UI 中的相对路径
text链接工具提示中显示的文本

url 和 text 都可以定义为模板（即使用 #{field-name}），其中 Jaeger UI 将根据 tags/logs/traces 数据动态替换值。

对于链路，支持的模板字段有：duration、endTime、startTime、traceName 和 traceID。

此外，当链路模板字段前缀为 trace. 时，链路模板字段可用于 process/logs/tags 类型中的替换。例如：trace.traceID、trace.startTime。

格式化

除了将字段插入到链接中，还可以使用格式化函数。语法是 #{field | function}（例如 #{endTime | epoch_micros_to_date_iso}）。格式化函数可以链式使用（例如 #{startTime | add 60000000 | epoch_micros_to_date_iso}）。

可用的格式化函数及其行为描述如下

epoch_micros_to_date_iso

将自 epoch 以来的微秒格式的日期格式化为 ISO 日期时间。

示例：#{endTime | epoch_micros_to_date_iso}

pad_start

用给定字符填充字符串的开头，直到结果字符串达到给定长度。此行为由 javascript 的 String.padStart 外部链接 - Jaeger 分布式追踪平台 实现，并与之匹配

参数

  • targetLength (整数) - 填充后所需字符串的长度
  • padCharacter (字符串) - 用于填充输入字符串开头的字符串

示例：#{traceID | pad_start 32 0}

add

将一个值添加到另一个数字。可以是正数或负数。

参数

  • offset (整数) - 要添加到输入数字的值

示例：#{startTime | add 1000000}

嵌入模式

从 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 是必需的。

此外，对于每个支持的页面，都会添加一个按钮 嵌入打开窗口，该按钮将在新标签页中打开非嵌入页面。

以下页面支持嵌入模式

  • 搜索页面
  • 链路页面

搜索页面

要将搜索链路页面集成到我们的应用程序中，我们需要向 Jaeger UI 表明我们希望使用嵌入模式，并带有 uiEmbed=v0 参数。

例如

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

链路页面

要将链路页面集成到我们的应用程序中，我们需要向 Jaeger UI 表明我们希望使用嵌入模式，并带有 uiEmbed=v0 参数。

例如

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