OpenTelemetry In Java 快速开始

在不到 5 分钟的时间内为您的应用程序获取遥测数据！

此页面将向您展示如何开始使用 Java 中的 OpenTelemetry。您将学习如何自动检测一个简单的 Java 应用程序，通过把跟踪、指标和日志发送到控制台的方式。

必要条件

确保您在本地安装了以下内容：

• Java SDK
• Gradle

示例应用程序

以下示例使用基本的 Spring Boot应用程序，如果你没有在使用Spring Boot，也木有没关系，您也可以将 OpenTelemetry Java 与其他 Web 框架一起使用，例如 Apache Wicket 和 Play。有关受支持框架的完整库列表，请参阅注册表。有关更详细的示例，请参阅示例。

依赖

首先，在名为 java-simple 的新目录中设置环境，在该目录中，创建一个名为 build.gradle.kts 的文件，其中包含以下内容：

plugins {
  id("java")
  id("org.springframework.boot") version "3.0.6"
  id("io.spring.dependency-management") version "1.1.0"
}

sourceSets {
  main {
    java.setSrcDirs(setOf("."))
  }
}

repositories {
  mavenCentral()
}

dependencies {
  implementation("org.springframework.boot:spring-boot-starter-web")
}

创建并启动HTTP服务

在同一个文件夹中，创建一个名为 DiceApplication.java 的文件并将以下代码添加到该文件中：

package otel;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.Banner;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DiceApplication {
  public static void main(String[] args) {
    SpringApplication app = new SpringApplication(DiceApplication.class);
    app.setBannerMode(Banner.Mode.OFF);
    app.run(args);
  }
}

创建另一个名为 RollController.java 的文件并将以下代码添加到文件中：

package otel;

import java.util.Optional;
import java.util.concurrent.ThreadLocalRandom;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class RollController {
  private static final Logger logger = LoggerFactory.getLogger(RollController.class);

  @GetMapping("/rolldice")
  public String index(@RequestParam("player") Optional<String> player) {
    int result = this.getRandomNumber(1, 6);
    if (player.isPresent()) {
      logger.info("{} is rolling the dice: {}", player.get(), result);
    } else {
      logger.info("Anonymous player is rolling the dice: {}", result);
    }
    return Integer.toString(result);
  }

  public int getRandomNumber(int min, int max) {
    return ThreadLocalRandom.current().nextInt(min, max + 1);
  }
}

使用以下命令构建并运行应用程序，然后在 Web 浏览器中打开 http://localhost:8080/rolldice 以确保其已经正常运行。

gradle assemble
java -jar ./build/libs/java-simple.jar

仪器仪表

接下来，您将使用 Java 代理在应用程序启动时自动检测应用程序。虽然您可以通过多种方式配置 Java 代理，但下面步骤讲述使用环境变量的方式配置Java 代理。

1. 从 opentelemetry-java-instrumentation 存储库的发行版下载 opentelemetry-javaagent.jar，JAR 文件包含代理和所有自动检测包：

curl -L -O https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar

     PS：记录下Jar文件的所在目录

      2.使用适合您的 shell/终端环境的符号来设置和导出指定 Java agent JAR 和控制台导出器的变量——我们说明了类似 bash shell 的符号：

$ export JAVA_TOOL_OPTIONS="-javaagent:PATH/TO/opentelemetry-javaagent.jar" \
  OTEL_TRACES_EXPORTER=logging \
  OTEL_METRICS_EXPORTER=logging \
  OTEL_LOGS_EXPORTER=logging

       PS：将上面的 PATH/TO 替换为您的 JAR 路径。

      3.再次运行你的应用程序

$ java -jar ./build/libs/java-simple.jar
...

      PS：请注意 otel.javaagent 的输出。    

       4.从另一个终端，使用 curl 发送请求 ：

$ curl localhost:8080/rolldice

      5.停止服务器进程。

在第四步的时候，你应该已经看到了从服务中返送出来的 trace & log，在客户端中你可以看到像下面的内容（为方便起见，跟踪输出换行）：

[otel.javaagent 2023-04-24 17:33:54:567 +0200] [http-nio-8080-exec-1] INFO
io.opentelemetry.exporter.logging.LoggingSpanExporter - 'RollController.index' :
 70c2f04ec863a956e9af975ba0d983ee 7fd145f5cda13625 INTERNAL [tracer:
 io.opentelemetry.spring-webmvc-6.0:1.25.0-alpha] AttributesMap{data=
 {thread.id=39, thread.name=http-nio-8080-exec-1}, capacity=128,
 totalAddedValues=2}
[otel.javaagent 2023-04-24 17:33:54:568 +0200] [http-nio-8080-exec-1] INFO
io.opentelemetry.exporter.logging.LoggingSpanExporter - 'GET /rolldice' :
70c2f04ec863a956e9af975ba0d983ee 647ad186ad53eccf SERVER [tracer:
io.opentelemetry.tomcat-10.0:1.25.0-alpha] AttributesMap{
  data={user_agent.original=curl/7.87.0, net.host.name=localhost,
  net.transport=ip_tcp, http.target=/rolldice, net.sock.peer.addr=127.0.0.1,
  thread.name=http-nio-8080-exec-1, net.sock.peer.port=53422,
  http.route=/rolldice, net.sock.host.addr=127.0.0.1, thread.id=39,
  net.protocol.name=http, http.status_code=200, http.scheme=http,
  net.protocol.version=1.1, http.response_content_length=1,
  net.host.port=8080, http.method=GET}, capacity=128, totalAddedValues=17}

在第五步的时候，当你停掉服务时，您应该看到需收集的所有指标的输出（为方便起见，指标输出被换行和缩短）：

[otel.javaagent 2023-04-24 17:34:25:347 +0200] [PeriodicMetricReader-1] INFO
io.opentelemetry.exporter.logging.LoggingMetricExporter - Received a collection
 of 19 metrics for export.
[otel.javaagent 2023-04-24 17:34:25:347 +0200] [PeriodicMetricReader-1] INFO
io.opentelemetry.exporter.logging.LoggingMetricExporter - metric:
ImmutableMetricData{resource=Resource{schemaUrl=
https://opentelemetry.io/schemas/1.19.0, attributes={host.arch="aarch64",
host.name="OPENTELEMETRY", os.description="Mac OS X 13.3.1", os.type="darwin",
process.command_args=[/bin/java, -jar, java-simple.jar],
process.executable.path="/bin/java", process.pid=64497,
process.runtime.description="Homebrew OpenJDK 64-Bit Server VM 20",
process.runtime.name="OpenJDK Runtime Environment",
process.runtime.version="20", service.name="java-simple",
telemetry.auto.version="1.25.0", telemetry.sdk.language="java",
telemetry.sdk.name="opentelemetry", telemetry.sdk.version="1.25.0"}},
instrumentationScopeInfo=InstrumentationScopeInfo{name=io.opentelemetry.runtime-metrics,
version=1.25.0, schemaUrl=null, attributes={}},
name=process.runtime.jvm.buffer.limit, description=Total capacity of the buffers
in this pool, unit=By, type=LONG_SUM, data=ImmutableSumData{points=
[ImmutableLongPointData{startEpochNanos=1682350405319221000,
epochNanos=1682350465326752000, attributes=
{pool="mapped - 'non-volatile memory'"}, value=0, exemplars=[]},
ImmutableLongPointData{startEpochNanos=1682350405319221000,
epochNanos=1682350465326752000, attributes={pool="mapped"},
value=0, exemplars=[]},
ImmutableLongPointData{startEpochNanos=1682350405319221000,
epochNanos=1682350465326752000, attributes={pool="direct"},
value=8192, exemplars=[]}], monotonic=false, aggregationTemporality=CUMULATIVE}}
...

接下来做什么？

更多：

• 使用另一个可观测数据导出器运行此示例。

• 在您自己的应用程序之一上尝试自动检测。

• 对于轻量级自定义检测，请尝试注释。

• 了解手动检测并尝试更多示例。