chenmudu / open-telemetry-java-guides

Java OpenTelemetry 测试指南 :Open-Telemetry-Java-Guides 案例,用于测试常用中间件支持及 Otel 相关组件的使用情况。
MIT License
78 stars 30 forks source link
guides-otel java-8 observability open-telemetry-java opentelemetry opentelemetry-collector otel otel-javaagent spring-open-telemetry test-otel

Open-Telemetry-Java-Guides 案例工程

Open-Telemetry-Java-Guides案例,用于测试常用中间件支持及Otel相关组件的使用情况。关于更多Otel请访问Otel官网。

必读部分:数据展示前言环境准备参数设置启动测试服务结果观测测试服务列表测试环境测试库及框架列表.

🔈:希望各位先fork,后clone,这样关于我新提交的东西您就可以观测到。如果仅仅clone,我的最新提交您可能感知不到。 个人无偿测试和搭建不易,麻烦赏颗星星,感谢您。🙇‍。

数据展示

Otel-Col Info By ItSelf :

avatar

App-Trace Info By Jaeger:

avatar

App-Jvm-Metrics Info By Prometheus And Prometheus Gateway:

avatar

前言

环境准备

  1. 暂时不选择Otel-Collector,选择使用最小版Jaeger进行观测。关于如何安装All in One的Jaeger。

  2. 下载Otel-Javaagent.jar至磁盘目录下,关于Latest release ,目前最新版本为Beta 0.12.0

  3. 拉取Otel-Col-Docker-Image.

  4. 关于docker 安装相关组件请移步这儿

参数设置

  1. 设置VmOptions,指向磁盘中的otel-javaagent.jar的置放目录。

    java -javaagent:path/to/opentelemetry-javaagent-all.jar
  2. 设置VmOptions,关于Exporter,otel默认为自己的OTLP Exporter,这里我们选择使用zipkin作为默认Exporter,其兼容jaeger的RestApi。使用Http方式上报至Jaeger的Collector中(也可以使用Otel-Collector)

    // 省略此步骤,当你使用Otel-Collector的时候。
    -Dotel.exporter=zipkin
  3. 向Environment variable添加参数对:

    OTEL_RESOURCE_ATTRIBUTES=service.name=otel-simple-moudlename
  4. 关于Otel官方参数设置。

关于Otel-Collector

  1. Docker/Windows 安装 Otel-Collector即可。

  2. 向Environment variable添加参数对:

    OTEL_RESOURCE_ATTRIBUTES=service.name=your service name
  3. 关于Otel-Collector-Design

启动测试服务

git clone 当前项目. 选择测试的模块(确保环境准备参数设置已经完成)。详情请进入子模块测试服务read me file,启动子模块。

结果观测

  1. 确保环境准备参数设置启动测试服务已按步完成。

  2. 访问Jaeger-Ui即可观测结果,按步完成后UI默认地址为:http://localhost:16686/

测试服务列表

测试环境

测试库及框架列表

Library/Framework Versions Test Result 官方最低版本支持
Servlet 4.0 Y 2.2+
WebMvc 5.1.15 Y 3.1+
WebFlux 5.1.15 Y 5.0+
RestTemplate(sync & async) 5.1.15 N/Y(错当rest temeplate为http client. 且不支持 async resttemplate.)故此推荐,如果生产使用RestTemplate,将其底层替换为HttpClient,包括连接池、其他参数等 官方无支持
ApacheHttpClient(sync & async) 4.5.12/4.1.4 Y 2.0+/1.9+ (not including 2.x yet)
HttpUrlConnection java8 Y Java 7+
OkHttp(sync & async) 3.6.0 Y 3.0+
JdbcMysqlConnector 8.0.22 Y
Spring-Data-Jdbc 2.1.14(1.0.17.RELEASE) Y 1.8+
Spring-Data-Jpa 2.1.14(2.1.17.RELEASE) Y 1.8+
Spring-Data-Rest 2.1.14(3.1.17.RELEASE) Y 1.8+
Spring-Data-Mongo 2.1.14(2.1.17.RELEASE) Y 1.8+
Spring-data-Redis 2.1.14(2.1.17.RELEASE) Y 1.8+
lettuce-core 5.1.8.RELEASE Y 4.0+ (not including 6.x yet)
Jedis-Client 2.9.0 Y 1.4+
Redisson-Client 0.0.0 N 还未测试 3.0+
Spring-data-Es 2.1.14(3.1.17.RELEASE) Y 1.8+
Spring-data-Neo4j 2.1.14(5.1.17.RELEASE) N 还未测试 1.8+
Spring-Rabbit 2.1.14(2.1.14.RELEASE) Y
Rabbit-Client 5.4.3 Y 2.7+
Spring-Kafka 2.1.13 Y
Kafka-Client 2.0.1 Y 0.11+
....... ..... Y

关于其他