Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions java-sandbox/opentelemetry-v2/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/target/
88 changes: 88 additions & 0 deletions java-sandbox/opentelemetry-v2/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<project xmlns="http://maven.apache.org/POM/4.0.0">
<modelVersion>4.0.0</modelVersion>

<groupId>io.temporal.docs</groupId>
<artifactId>opentelemetry-v2</artifactId>
<version>1.0.0</version>

<properties>
<maven.compiler.release>21</maven.compiler.release>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- TODO: switch to the first release that includes temporal-opentelemetry-v2. -->
<temporal.version>1.41.0-SNAPSHOT</temporal.version>
</properties>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-bom</artifactId>
<version>1.66.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<dependency>
<groupId>io.temporal</groupId>
<artifactId>temporal-sdk</artifactId>
<version>${temporal.version}</version>
</dependency>
<dependency>
<groupId>io.temporal</groupId>
<artifactId>temporal-opentelemetry-v2</artifactId>
<version>${temporal.version}</version>
</dependency>
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-exporter-otlp</artifactId>
</dependency>
<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>opentelemetry-micrometer-1.5</artifactId>
<version>2.32.0-alpha</version>
</dependency>
<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>opentelemetry-logback-appender-1.0</artifactId>
<version>2.32.0-alpha</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.5.6</version>
</dependency>
<dependency>
<groupId>io.temporal</groupId>
<artifactId>temporal-testing</artifactId>
<version>${temporal.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-sdk-testing</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>6.1.1</version>
<scope>test</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.13.0</version>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.5.4</version>
</plugin>
</plugins>
</build>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package io.temporal.docs.opentelemetryv2;

import io.temporal.activity.ActivityInterface;

@ActivityInterface
public interface GreetingActivities {
String composeGreeting(String name);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package io.temporal.docs.opentelemetryv2;

import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.context.Scope;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class GreetingActivitiesImpl implements GreetingActivities {
private static final Logger logger = LoggerFactory.getLogger(GreetingActivitiesImpl.class);

@Override
public String composeGreeting(String name) {
logger.info("Formatting greeting for {}", name);

Span span =
GlobalOpenTelemetry.getTracer(GreetingWorkflowImpl.INSTRUMENTATION_NAME)
.spanBuilder("format-greeting")
.startSpan();
try (Scope ignored = span.makeCurrent()) {
return "Hello, " + name + "!";
} finally {
span.end();
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package io.temporal.docs.opentelemetryv2;

import io.temporal.workflow.WorkflowInterface;
import io.temporal.workflow.WorkflowMethod;

@WorkflowInterface
public interface GreetingWorkflow {
@WorkflowMethod
String greet(String name);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
package io.temporal.docs.opentelemetryv2;

import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.context.Scope;
import io.temporal.activity.ActivityOptions;
import io.temporal.workflow.Workflow;
import java.time.Duration;
import org.slf4j.Logger;

public class GreetingWorkflowImpl implements GreetingWorkflow {
static final String INSTRUMENTATION_NAME = "io.temporal.docs.opentelemetryv2";

// @@@SNIPSTART java-opentelemetry-v2-workflow-logger
private static final Logger logger = Workflow.getLogger(GreetingWorkflowImpl.class);
// @@@SNIPEND

private final GreetingActivities activities =
Workflow.newActivityStub(
GreetingActivities.class,
ActivityOptions.newBuilder().setStartToCloseTimeout(Duration.ofSeconds(10)).build());

@Override
public String greet(String name) {
// @@@SNIPSTART java-opentelemetry-v2-workflow-counter
GlobalOpenTelemetry.getMeter(INSTRUMENTATION_NAME)
.counterBuilder("greeting.workflow.runs")
.build()
.add(1);
// @@@SNIPEND

logger.info("Requesting greeting for {}", name);

// @@@SNIPSTART java-opentelemetry-v2-workflow-span
Span span =
GlobalOpenTelemetry.getTracer(INSTRUMENTATION_NAME)
.spanBuilder("request-greeting")
.startSpan();
try (Scope ignored = span.makeCurrent()) {
return activities.composeGreeting(name);
} finally {
span.end();
}
// @@@SNIPEND
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
package io.temporal.docs.opentelemetryv2;

import com.uber.m3.tally.RootScopeBuilder;
import com.uber.m3.tally.Scope;
import io.micrometer.core.instrument.MeterRegistry;
import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.exporter.otlp.logs.OtlpGrpcLogRecordExporter;
import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter;
import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
import io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender;
import io.opentelemetry.instrumentation.micrometer.v1_5.OpenTelemetryMeterRegistry;
import io.opentelemetry.sdk.logs.SdkLoggerProvider;
import io.opentelemetry.sdk.logs.export.BatchLogRecordProcessor;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.metrics.export.PeriodicMetricReader;
import io.opentelemetry.sdk.trace.SdkTracerProvider;
import io.opentelemetry.sdk.trace.export.BatchSpanProcessor;
import io.temporal.client.WorkflowClient;
import io.temporal.common.reporter.MicrometerClientStatsReporter;
import io.temporal.opentelemetry.v2.OpenTelemetryPlugin;
import io.temporal.opentelemetry.v2.ReplaySafeOpenTelemetry;
import io.temporal.serviceclient.WorkflowServiceStubs;
import io.temporal.serviceclient.WorkflowServiceStubsOptions;
import io.temporal.worker.WorkerFactory;

class OpenTelemetrySetupExamples {
static ReplaySafeOpenTelemetry createOpenTelemetry() {
// @@@SNIPSTART java-opentelemetry-v2-setup
// Batch processors perform exporter I/O outside the Workflow thread.
ReplaySafeOpenTelemetry openTelemetry =
ReplaySafeOpenTelemetry.newBuilder()
.setTracerProviderBuilder(
SdkTracerProvider.builder()
.addSpanProcessor(
BatchSpanProcessor.builder(OtlpGrpcSpanExporter.builder().build()).build()))
.setMeterProviderBuilder(
SdkMeterProvider.builder()
.registerMetricReader(
PeriodicMetricReader.builder(OtlpGrpcMetricExporter.builder().build())
.build()))
.setLoggerProviderBuilder(
SdkLoggerProvider.builder()
.addLogRecordProcessor(
BatchLogRecordProcessor.builder(
OtlpGrpcLogRecordExporter.builder().build())
.build()))
.build();
GlobalOpenTelemetry.set(openTelemetry);
// @@@SNIPEND
return openTelemetry;
}

static WorkerFactory addPlugin() {
// @@@SNIPSTART java-opentelemetry-v2-plugin
OpenTelemetryPlugin plugin = OpenTelemetryPlugin.newBuilder().build();

WorkflowServiceStubs service =
WorkflowServiceStubs.newServiceStubs(
WorkflowServiceStubsOptions.newBuilder().setPlugins(plugin).build());
WorkflowClient client = WorkflowClient.newInstance(service);
WorkerFactory factory = WorkerFactory.newInstance(client);
// @@@SNIPEND
return factory;
}

static OpenTelemetryPlugin addTemporalSpans() {
// @@@SNIPSTART java-opentelemetry-v2-temporal-spans
OpenTelemetryPlugin plugin = OpenTelemetryPlugin.newBuilder().setAddTemporalSpans(true).build();
// @@@SNIPEND
return plugin;
}

static WorkflowServiceStubs exportSdkMetrics(ReplaySafeOpenTelemetry openTelemetry) {
// @@@SNIPSTART java-opentelemetry-v2-sdk-metrics
MeterRegistry registry = OpenTelemetryMeterRegistry.builder(openTelemetry).build();
Scope scope =
new RootScopeBuilder()
.reporter(new MicrometerClientStatsReporter(registry))
.reportEvery(com.uber.m3.util.Duration.ofSeconds(10));

WorkflowServiceStubs service =
WorkflowServiceStubs.newServiceStubs(
WorkflowServiceStubsOptions.newBuilder().setMetricsScope(scope).build());
// @@@SNIPEND
return service;
}

static void installLogAppender(ReplaySafeOpenTelemetry openTelemetry) {
// @@@SNIPSTART java-opentelemetry-v2-log-appender
OpenTelemetryAppender.install(openTelemetry);
// @@@SNIPEND
}

static void shutdown(WorkerFactory factory, ReplaySafeOpenTelemetry openTelemetry) {
// @@@SNIPSTART java-opentelemetry-v2-shutdown
factory.shutdown();
openTelemetry.close();
// @@@SNIPEND
}
}
10 changes: 10 additions & 0 deletions java-sandbox/opentelemetry-v2/src/main/resources/logback.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<configuration>
<!-- @@@SNIPSTART java-opentelemetry-v2-logback-config -->
<appender name="OpenTelemetry"
class="io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender"/>

<root level="INFO">
<appender-ref ref="OpenTelemetry"/>
</root>
<!-- @@@SNIPEND -->
</configuration>
Loading
Loading