Skip to content

feat(memorystore): migrate Redis client-side metrics sample to OTLP #10360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fosky94 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(memorystore): migrate Redis client-side metrics sample to OTLP #10360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 19 additions & 9 deletions memorystore/redis/client_side_metrics/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,32 @@
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-api</artifactId>
<version>1.36.0</version>
<version>1.44.1</version>
</dependency>
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-sdk</artifactId>
<version>1.36.0</version>
<version>1.44.1</version>
</dependency>
<dependency>
<groupId>com.google.cloud.opentelemetry</groupId>
<artifactId>exporter-trace</artifactId>
<version>0.28.0</version>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-exporter-otlp</artifactId>
<version>1.44.1</version>
</dependency>
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-sdk-extension-autoconfigure-spi</artifactId>
<version>1.44.1</version>
</dependency>
<dependency>
<groupId>io.opentelemetry.contrib</groupId>
<artifactId>opentelemetry-gcp-resources</artifactId>
<version>1.37.0-alpha</version>
</dependency>
<dependency>
<groupId>com.google.cloud.opentelemetry</groupId>
<artifactId>exporter-metrics</artifactId>
<version>0.28.0</version>
<groupId>com.google.auth</groupId>
<artifactId>google-auth-library-oauth2-http</artifactId>
<version>1.24.0</version>
</dependency>

<!-- Testing Dependencies -->
Expand Down Expand Up @@ -97,4 +107,4 @@
</plugin>
</plugins>
</build>
</project>
</project>
134 changes: 103 additions & 31 deletions ...is/client_side_metrics/src/main/java/com/example/memorystore/redis/RedisTelemetryApp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@
package com.example.memorystore.redis;

// [START memorystore_redis_client_side_metrics]
import com.google.cloud.opentelemetry.metric.GoogleCloudMetricExporter;
import com.google.cloud.opentelemetry.trace.TraceExporter;
import com.google.auth.oauth2.GoogleCredentials;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
Expand All @@ -27,10 +26,13 @@
import io.opentelemetry.api.metrics.Meter;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter;
import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.metrics.export.MetricExporter;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.metrics.export.MetricExporter;
import io.opentelemetry.sdk.metrics.export.PeriodicMetricReader;
import io.opentelemetry.sdk.resources.Resource;
import io.opentelemetry.sdk.trace.SdkTracerProvider;
import io.opentelemetry.sdk.trace.export.BatchSpanProcessor;
import io.opentelemetry.sdk.trace.export.SpanExporter;
Expand All @@ -39,18 +41,44 @@
import redis.clients.jedis.JedisPoolConfig;
import redis.clients.jedis.exceptions.JedisConnectionException;

import java.io.IOException;
import java.time.Duration;
import java.util.Collections;
import java.util.Map;
import java.util.function.Function;
import java.util.function.Supplier;

/**
* Sample application demonstrating client-side metrics and tracing for
* Google Cloud Memorystore for Redis.
* Google Cloud Memorystore for Redis using OpenTelemetry OTLP exporters.
*/
public final class RedisTelemetryApp {
/** Attribute key for Redis operation names. */
private static final AttributeKey<String> ATTR_OPERATION =
AttributeKey.stringKey("operation");

/** Attribute key for the detected cloud account/project ID. */
private static final AttributeKey<String> ATTR_CLOUD_ACCOUNT_ID =
AttributeKey.stringKey("cloud.account.id");

/** Attribute key required by the Google Cloud Telemetry API. */
private static final AttributeKey<String> ATTR_GCP_PROJECT_ID =
AttributeKey.stringKey("gcp.project_id");

/** Google Cloud Telemetry API OTLP endpoint. */
private static final String TELEMETRY_ENDPOINT =
"https://telemetry.googleapis.com:443";

/** OAuth2 scope for Google Cloud APIs. */
private static final String CLOUD_PLATFORM_SCOPE =
"https://www.googleapis.com/auth/cloud-platform";

/** HTTP/gRPC Authorization header name. */
private static final String AUTHORIZATION_HEADER = "Authorization";

/** Prefix for OAuth2 Bearer tokens. */
private static final String BEARER_PREFIX = "Bearer ";

/** Maximum number of Redis reconnection attempts. */
private static final int MAX_RETRIES = 3;

Expand All @@ -69,6 +97,9 @@ public final class RedisTelemetryApp {
/** Default Redis port. */
private static final int DEFAULT_REDIS_PORT = 6379;

/** OpenTelemetry SDK instance used for flushing telemetry on shutdown. */
private static OpenTelemetrySdk openTelemetrySdk;

/** OpenTelemetry Tracer instance for recording trace spans. */
private static Tracer tracer;

Expand Down Expand Up @@ -100,8 +131,9 @@ private RedisTelemetryApp() {
* Main entry point for running the sample application.
*
* @param args Command line arguments (not used).
* @throws IOException If Google Cloud credentials cannot be loaded.
*/
public static void main(final String[] args) {
public static void main(final String[] args) throws IOException {
setupTelemetry();

final String host = System.getenv()
Expand All @@ -121,6 +153,9 @@ public static void main(final String[] args) {
if (jedisPool != null) {
jedisPool.close();
}
if (openTelemetrySdk != null) {
openTelemetrySdk.close();
}
}
}

Expand Down Expand Up @@ -151,7 +186,7 @@ static String run() {
/**
* Injects mocked or no-op telemetry and pool instances for unit testing.
*
* @param pool The mocked or test JedisPool instance.
* @param pool The mocked or test JedisPool instance.
* @param testOpenTelemetry The OpenTelemetry instance to use for testing.
*/
static void initForTest(
Expand Down Expand Up @@ -180,36 +215,73 @@ static void initForTest(

/**
* Configures the production OpenTelemetry SDK to export Traces and Metrics
* to Google Cloud Operations.
* via OTLP to Google Cloud.
*
* @throws IOException If Google Application Default Credentials fail.
*/
private static void setupTelemetry() {
final SpanExporter traceExporter =
TraceExporter.createWithDefaultConfiguration();
final SdkTracerProvider tracerProvider =
SdkTracerProvider.builder()
.addSpanProcessor(
BatchSpanProcessor.builder(traceExporter)
.build())
.build();

final MetricExporter metricExporter =
GoogleCloudMetricExporter.createWithDefaultConfiguration();
final SdkMeterProvider meterProvider =
SdkMeterProvider.builder()
.registerMetricReader(
PeriodicMetricReader.builder(metricExporter)
.setInterval(Duration.ofSeconds(
METRIC_INTERVAL_SECONDS))
.build())
.build();

final OpenTelemetry openTelemetry = OpenTelemetrySdk.builder()
private static void setupTelemetry() throws IOException {
final GoogleCredentials credentials = GoogleCredentials
.getApplicationDefault()
.createScoped(Collections.singletonList(CLOUD_PLATFORM_SCOPE));
credentials.refreshIfExpired();

final Supplier<Map<String, String>> headerSupplier = () -> {
try {
synchronized (credentials) {
credentials.refreshIfExpired();
return Collections.singletonMap(
AUTHORIZATION_HEADER,
BEARER_PREFIX
+ credentials.getAccessToken()
.getTokenValue());
}
} catch (IOException e) {
throw new RuntimeException(
"Failed to refresh Google credentials", e);
}
};

final Resource defaultResource = Resource.getDefault();
String projectId =
defaultResource.getAttributes().get(ATTR_CLOUD_ACCOUNT_ID);
if (projectId == null || projectId.isEmpty()) {
projectId = System.getenv("GOOGLE_CLOUD_PROJECT");
}
final Resource resource = projectId != null && !projectId.isEmpty()
? defaultResource.merge(Resource.create(
Attributes.of(ATTR_GCP_PROJECT_ID, projectId)))
: defaultResource;

final SpanExporter traceExporter = OtlpGrpcSpanExporter.builder()
.setEndpoint(TELEMETRY_ENDPOINT)
.setHeaders(headerSupplier)
.build();
final SdkTracerProvider tracerProvider = SdkTracerProvider.builder()
.setResource(resource)
.addSpanProcessor(
BatchSpanProcessor.builder(traceExporter).build())
.build();

final MetricExporter metricExporter = OtlpGrpcMetricExporter.builder()
.setEndpoint(TELEMETRY_ENDPOINT)
.setHeaders(headerSupplier)
.build();
final SdkMeterProvider meterProvider = SdkMeterProvider.builder()
.setResource(resource)
.registerMetricReader(
PeriodicMetricReader.builder(metricExporter)
.setInterval(Duration.ofSeconds(
METRIC_INTERVAL_SECONDS))
.build())
.build();

openTelemetrySdk = OpenTelemetrySdk.builder()
.setTracerProvider(tracerProvider)
.setMeterProvider(meterProvider)
.buildAndRegisterGlobal();

tracer = openTelemetry.getTracer("jedis.client");
final Meter meter = openTelemetry.getMeter("jedis.metrics");
tracer = openTelemetrySdk.getTracer("jedis.client");
final Meter meter = openTelemetrySdk.getMeter("jedis.metrics");

rttHist = meter.histogramBuilder("redis_client_rtt")
.setUnit("ms").build();
Expand Down
Loading