Add OpenTelemetry exporter

Signed-off-by: Fabian Stäber <[email protected]>

Author: fstab

.circleci/config.yml

@@ -3,20 +3,20 @@ machine: true
 jobs:
   build:
     machine:
-      image: ubuntu-2204:2023.04.2
+      image: ubuntu-2204:2023.07.2
     working_directory: ~/circleci-java
     steps:
       - run:
-          name: Install OpenJDK 11
+          name: Install OpenJDK 17
           command: |
-              sudo apt-get update && sudo apt-get install openjdk-11-jdk
-              sudo update-alternatives --set java /usr/lib/jvm/java-11-openjdk-amd64/bin/java
-              sudo update-alternatives --set javac /usr/lib/jvm/java-11-openjdk-amd64/bin/javac
+              sudo apt-get update && sudo apt-get install -y openjdk-17-jdk
+              sudo update-alternatives --set java /usr/lib/jvm/java-17-openjdk-amd64/bin/java
+              sudo update-alternatives --set javac /usr/lib/jvm/java-17-openjdk-amd64/bin/javac
               java -version
       - checkout
       - restore_cache:
           key: maven-dependencies-{{ checksum "pom.xml" }}
-      # - run: cd protobuf-shaded && ../mvnw install && cd ..
+      - run: cd prometheus-metrics-shaded-dependencies && ../mvnw clean install && cd ..
       - run: ./mvnw clean install
       - run: ./mvnw javadoc:jar
       - save_cache:

examples/example-exemplars-tail-sampling/README.md

@@ -60,7 +60,7 @@ The example is built as part of the `client_java` parent project with
 ./mvnw package
 ```
 
-This should generate two Java services `.../example-greeting-service/target/example-greeting-service-[version].jar` and `.../example-hello-world-app/target/example-hello-world-app-[version].jar`.
+This should generate two Java services `.../example-greeting-service/target/example-greeting-service.jar` and `.../example-hello-world-app/target/example-hello-world-app.jar`.
 
 ## Run the Example
 

examples/example-exemplars-tail-sampling/docker-compose.yaml

@@ -12,7 +12,7 @@ services:
     ports:
       - "8080:8080"
     volumes:
-      - ./example-hello-world-app/target/example-hello-world-app-1.0.0-alpha-2-SNAPSHOT.jar:/hello-world-app.jar
+      - ./example-hello-world-app/target/example-hello-world-app.jar:/example-hello-world-app.jar
     environment:
       - OTEL_TRACES_EXPORTER=otlp
       - OTEL_METRICS_EXPORTER=none
@@ -21,15 +21,15 @@ services:
       - java
       - -javaagent:/opentelemetry-javaagent.jar
       - -jar
-      - /hello-world-app.jar
+      - /example-hello-world-app.jar
   greeting-service:
     # The opentelemetry-java-agent image is coming from the hello-world-up service above.
     image: opentelemetry-java-agent
     network_mode: host
     ports:
       - "8081:8081"
     volumes:
-      - ./example-greeting-service/target/example-greeting-service-1.0.0-alpha-2-SNAPSHOT.jar:/greeting-service.jar
+      - ./example-greeting-service/target/example-greeting-service.jar:/example-greeting-service.jar
     environment:
       - OTEL_TRACES_EXPORTER=otlp
       - OTEL_METRICS_EXPORTER=none
@@ -38,7 +38,7 @@ services:
       - java
       - -javaagent:/opentelemetry-javaagent.jar
       - -jar
-      - /greeting-service.jar
+      - /example-greeting-service.jar
   collector:
     image: otel/opentelemetry-collector-contrib:0.79.0
     network_mode: host

examples/example-exemplars-tail-sampling/example-greeting-service/pom.xml

@@ -50,6 +50,7 @@
     </dependencies>
 
     <build>
+        <finalName>${project.artifactId}</finalName>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

examples/example-exemplars-tail-sampling/example-hello-world-app/pom.xml

@@ -50,6 +50,7 @@
     </dependencies>
 
     <build>
+        <finalName>${project.artifactId}</finalName>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

examples/example-httpserver/README.md …es/example-exporter-httpserver/README.mdexamples/example-httpserver/README.md renamed to examples/example-exporter-httpserver/README.md examples/example-httpserver/README.md renamed to examples/example-exporter-httpserver/README.md

@@ -10,10 +10,10 @@ This example is built as part of the `client_java` project.
 
 ## Run
 
-The build creates a JAR file with the example application in `./examples/example-httpserver/target/`.
+The build creates a JAR file with the example application in `./examples/example-exporter-httpserver/target/`.
 
 ```
-java -jar ./examples/example-httpserver/target/example-tomcat-servlet-1.0.0-alpha-3-SNAPSHOT.jar
+java -jar ./examples/example-exporter-httpserver/target/example-exporter-httpserver.jar
 ```
 
 ## Manually testing the Metrics Endpoint
@@ -31,7 +31,3 @@ The exporter supports a `debug` URL parameter to quickly view other formats in y
 * [http://localhost:9400/metrics?debug=text](http://localhost:9400/metrics?debug=text): Prometheus text format, same as without the `debug` option.
 * [http://localhost:9400/metrics?debug=openmetrics](http://localhost:9400/metrics?debug=openmetrics): OpenMetrics text format.
 * [http://localhost:9400/metrics?debug=prometheus-protobuf](http://localhost:9400/metrics?debug=prometheus-protobuf): Text representation of the Prometheus protobuf format.
-
-## TODO
-
-Implement an example of a histogram and show how to use this with Prometheus, see [../example-tomcat-servlet](../example-tomcat-servlet).

examples/example-httpserver/pom.xml …ples/example-exporter-httpserver/pom.xmlexamples/example-httpserver/pom.xml renamed to examples/example-exporter-httpserver/pom.xml examples/example-httpserver/pom.xml renamed to examples/example-exporter-httpserver/pom.xml

@@ -8,9 +8,9 @@
         <version>1.0.0-alpha-3-SNAPSHOT</version>
     </parent>
 
-    <artifactId>example-httpserver</artifactId>
+    <artifactId>example-exporter-httpserver</artifactId>
 
-    <name>Example - HTTPServer</name>
+    <name>>Example - HTTPServer Exporter</name>
     <description>
         Prometheus Metrics Example using the HTTPServer for exposing the metrics endpoint
     </description>
@@ -45,6 +45,7 @@
     </dependencies>
 
     <build>
+        <finalName>${project.artifactId}</finalName>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

…us/metrics/examples/httpserver/Main.java …us/metrics/examples/httpserver/Main.javaexamples/example-httpserver/src/main/java/io/prometheus/metrics/examples/httpserver/Main.java renamed to examples/example-exporter-httpserver/src/main/java/io/prometheus/metrics/examples/httpserver/Main.java examples/example-httpserver/src/main/java/io/prometheus/metrics/examples/httpserver/Main.java renamed to examples/example-exporter-httpserver/src/main/java/io/prometheus/metrics/examples/httpserver/Main.java

@@ -0,0 +1,28 @@
+# OpenTelemetry Exporter Example
+
+## Build
+
+This example is built as part of the `client_java` project.
+
+```
+./mvnw package
+```
+
+## Run
+
+Assuming `./examples/example-exporter-opentelemetry/target/example-exporter-opentelemetry.jar` is present, run the demo with:
+
+```bash
+cd ./examples/example-exporter-opentelemetry/
+docker-compose up
+```
+
+This will set up the following scenario:
+
+```mermaid
+flowchart LR
+   A[example app] -->|OTLP|B[OpenTelemetry collector] -->|Prometheus remote write|C[Prometheus server]
+```
+
+The OpenTelemetry collector is configured to log incoming metrics to the console.
+The Prometheus server is running on [http://localhost:9090](http://localhost:9090).

examples/example-exporter-opentelemetry/README.md

@@ -0,0 +1,21 @@
+receivers:
+  otlp:
+    protocols:
+      grpc:
+      http:
+
+processors:
+  batch:
+
+exporters:
+  prometheusremotewrite:
+    endpoint: http://localhost:9090/api/v1/write
+  logging:
+    verbosity: detailed
+
+service:
+  pipelines:
+    metrics:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [logging, prometheusremotewrite]