Home

Documentation versions (currently viewingVaadin 24)
Documentation translations (currently viewingChinese)

此页面是从官方文档 http://vaadin.com/docs 机器翻译而来。内容可能存在错误、不准确或误述。Vaadin 不保证翻译的准确性、可靠性或时效性。

Jaeger 和 Prometheus 集成

如何集成 Jaeger 和 Prometheus。

本页面包含如何在本地设置 Jaeger 和 Prometheus 的说明,这是一个简单的本地设置,可用于测试,支持指标(metrics)和跟踪(traces),并通过 Observability Kit 来收集 Vaadin 应用程序的遥测数据。

Caution
非生产就绪
此设置仅用于本地测试,不适用于生产环境。有关如何为生产环境准备设置的更多信息,请参见 Jaeger 文档

下载和运行 Jaeger

Jaeger 是一个用于收集跟踪(traces)的工具。可通过点击此处的按钮下载:

然后解压下载的存档文件(例如 tar.gz 文件)。之后,打开一个终端,进入 Jaeger 所在目录并启动 Jaeger:

Source code
terminal
./jaeger-all-in-one

下载和运行 Prometheus

Prometheus 是一个用于收集指标数据(metrics)的工具。

解压下载的存档文件(例如 tar.gz 文件)。创建一个 Prometheus 配置文件,其中包含用于从 OpenTelemetry 导出器读取指标数据的抓取器(scraper):

Source code
config.yml
global:
  scrape_interval: 15s # 默认每 1 分钟一次抓取。

scrape_configs:
  - job_name: 'opentelemetry'
    # metrics_path 默认是 '/metrics'
    # scheme 默认是 'http'。
    static_configs:
      - targets: ['localhost:9464']
    # 主机和端口需要匹配
    # OpenTelemetry prometheus 导出器的配置

打开终端,进入 Prometheus 所在目录,使用上述配置文件启动 Prometheus:

Source code
terminal
./prometheus --config.file=/PATH/TO/config.yml

请记得将路径替换为正确的 config.yml 文件路径。

Observability Kit 配置

创建一个名为 agent.properties 的新属性文件,并添加以下内容:

Source code
agent.properties
otel.traces.exporter=jaeger
otel.exporter.jaeger.endpoint=http://localhost:14250
otel.metrics.exporter=prometheus
otel.exporter.prometheus.host=0.0.0.0
otel.exporter.prometheus.port=9464

运行应用程序

使用 Java 二进制文件运行应用程序,并传入 Agent 和配置的相应参数,示例如下:

Source code
terminal
java -javaagent:PATH/TO/observability-kit-agent-VERSION.jar \
     -Dotel.javaagent.configuration-file=PATH/TO/agent.properties \
     -jar myapp.jar
terminal
terminal
terminal
terminal
terminal
terminal
terminal
terminal
terminal
terminal
terminal
Note
替换占位符的路径及版本
请注意修改 agent.properties 文件的路径,以及 Agent .jar 文件的路径和版本号。

在 Jaeger 中查看跟踪数据

Jaeger 用户界面的默认地址是 http://localhost:16686。打开后,您可以在 Service 字段中选择您的服务名称(默认情况下为 vaadin),然后点击 Find Traces 按钮。

默认的搜索时间范围为过去一小时。如果希望搜索更久之前的数据,请在 Lookback 字段选择时间范围。

默认返回的结果数量为 20 条。如需查看更多结果,请在 Limit Results 字段中增加数值。

右侧显示了一个时间线与持续时间的图表,您可以通过此图表查看导致延迟的事件(以较大的圆圈表示)或错误(以红色圆圈表示)。点击任一圆圈将打开跟踪详细页面

另有一个根跨度(root spans)的列表可供查看,每个跨度都会显示持续时间相对于其他根跨度的关系,其中包含多少个嵌套跨度以及错误数量。同样地,点击任一项将打开跟踪详细页面。

跟踪详细信息

跟踪详细页面以树状列表形式展示根跨度及所有嵌套跨度。若任何跨度存在错误,它会以一个红色感叹号 (!) 图标标记。

点击列表中的行可查看更多跨度细节。在跨度详情中,您可以展开 Tags 查看跨度的属性值。Vaadin 特定的属性在相关参考页面中有详细说明。如有错误,您可以在 Logs 中找到相关的堆栈跟踪信息。

在 Prometheus 中查看指标数据

Prometheus 用户界面的默认地址是 http://localhost:9090。在搜索栏中输入指标名称后,点击 Execute

如果您不知道相关指标名称,可以通过点击 Execute 旁边的地球图标打开指标浏览器,查看可用指标的字母顺序列表。

若要以图形形式查看结果,点击 Graph 标签页即可。