open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add toString to OTLP exporters (#5686) 

Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com>
This commit is contained in:
jack-berg 2023-08-09 13:39:38 -05:00 committed by GitHub
parent e980e8b97d
commit 37f901afbc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 224 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/apidiffs/current_vs_latest/opentelemetry-exporter-otlp.txt
View File

@ -2,18 +2,24 @@ Comparing source compatibility of against
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.exporter.otlp.http.logs.OtlpHttpLogRecordExporter (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.logs.OtlpHttpLogRecordExporterBuilder toBuilder()
+++ NEW METHOD: PUBLIC(+) java.lang.String toString()
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporterBuilder toBuilder()
+++ NEW METHOD: PUBLIC(+) java.lang.String toString()
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder toBuilder()
+++ NEW METHOD: PUBLIC(+) java.lang.String toString()
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.exporter.otlp.logs.OtlpGrpcLogRecordExporter (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.logs.OtlpGrpcLogRecordExporterBuilder toBuilder()
+++ NEW METHOD: PUBLIC(+) java.lang.String toString()
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporterBuilder toBuilder()
+++ NEW METHOD: PUBLIC(+) java.lang.String toString()
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter (not serializable)
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporterBuilder toBuilder()
+++ NEW METHOD: PUBLIC(+) java.lang.String toString()

31
exporters/common/src/main/java/io/opentelemetry/exporter/internal/grpc/GrpcExporterBuilder.java
View File

@ -25,6 +25,7 @@ import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.StringJoiner;
import java.util.concurrent.TimeUnit;
import java.util.function.BiFunction;
import java.util.function.Supplier;
@ -202,6 +203,36 @@ public class GrpcExporterBuilder<T extends Marshaler> {
compressionEnabled);
}
public String toString(boolean includePrefixAndSuffix) {
StringJoiner joiner =
includePrefixAndSuffix
? new StringJoiner(", ", "GrpcExporterBuilder{", "}")
: new StringJoiner(", ");
joiner.add("exporterName=" + exporterName);
joiner.add("type=" + type);
joiner.add("endpoint=" + endpoint.toString());
joiner.add("endpointPath=" + grpcEndpointPath);
joiner.add("timeoutNanos=" + timeoutNanos);
joiner.add("compressionEnabled=" + compressionEnabled);
StringJoiner headersJoiner = new StringJoiner(", ", "Headers{", "}");
headers.forEach((key, value) -> headersJoiner.add(key + "=OBFUSCATED"));
joiner.add("headers=" + headersJoiner);
if (retryPolicy != null) {
joiner.add("retryPolicy=" + retryPolicy);
}
if (grpcChannel != null) {
joiner.add("grpcChannel=" + grpcChannel);
}
// Note: omit tlsConfigHelper because we can't log the configuration in any readable way
// Note: omit meterProviderSupplier because we can't log the configuration in any readable way
return joiner.toString();
}
@Override
public String toString() {
return toString(true);
}
// Use an inner class to ensure GrpcExporterBuilder does not have classloading dependencies on
// upstream gRPC.
private class UpstreamGrpcExporterFactory {

31
exporters/common/src/main/java/io/opentelemetry/exporter/internal/http/HttpExporterBuilder.java
View File

@ -19,6 +19,7 @@ import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.ServiceLoader;
import java.util.StringJoiner;
import java.util.concurrent.TimeUnit;
import java.util.function.Supplier;
import java.util.logging.Level;
@ -166,6 +167,36 @@ public final class HttpExporterBuilder<T extends Marshaler> {
return new HttpExporter<>(exporterName, type, httpSender, meterProviderSupplier, exportAsJson);
}
public String toString(boolean includePrefixAndSuffix) {
StringJoiner joiner =
includePrefixAndSuffix
? new StringJoiner(", ", "HttpExporterBuilder{", "}")
: new StringJoiner(", ");
joiner.add("exporterName=" + exporterName);
joiner.add("type=" + type);
joiner.add("endpoint=" + endpoint);
joiner.add("timeoutNanos=" + timeoutNanos);
joiner.add("compressionEnabled=" + compressionEnabled);
joiner.add("exportAsJson=" + exportAsJson);
if (headers != null) {
StringJoiner headersJoiner = new StringJoiner(", ", "Headers{", "}");
headers.forEach((key, value) -> headersJoiner.add(key + "=OBFUSCATED"));
joiner.add("headers=" + headersJoiner);
}
if (retryPolicy != null) {
joiner.add("retryPolicy=" + retryPolicy);
}
// Note: omit tlsConfigHelper because we can't log the configuration in any readable way
// Note: omit meterProviderSupplier because we can't log the configuration in any readable way
// Note: omit authenticator because we can't log the configuration in any readable way
return joiner.toString();
}
@Override
public String toString() {
return toString(true);
}
/**
* Resolve the {@link HttpSenderProvider}.
*

5
exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/http/logs/OtlpHttpLogRecordExporter.java
View File

@ -84,4 +84,9 @@ public final class OtlpHttpLogRecordExporter implements LogRecordExporter {
public CompletableResultCode shutdown() {
return delegate.shutdown();
}
@Override
public String toString() {
return "OtlpHttpLogRecordExporter{" + builder.toString(false) + "}";
}
}

5
exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/http/metrics/OtlpHttpMetricExporter.java
View File

@ -110,4 +110,9 @@ public final class OtlpHttpMetricExporter implements MetricExporter {
public CompletableResultCode shutdown() {
return delegate.shutdown();
}
@Override
public String toString() {
return "OtlpHttpMetricExporter{" + builder.toString(false) + "}";
}
}

5
exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/http/trace/OtlpHttpSpanExporter.java
View File

@ -89,4 +89,9 @@ public final class OtlpHttpSpanExporter implements SpanExporter {
public CompletableResultCode shutdown() {
return delegate.shutdown();
}
@Override
public String toString() {
return "OtlpHttpSpanExporter{" + builder.toString(false) + "}";
}
}

5
exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/logs/OtlpGrpcLogRecordExporter.java
View File

@ -87,4 +87,9 @@ public final class OtlpGrpcLogRecordExporter implements LogRecordExporter {
public CompletableResultCode shutdown() {
return delegate.shutdown();
}
@Override
public String toString() {
return "OtlpGrpcLogRecordExporter{" + builder.toString(false) + "}";
}
}

5
exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/metrics/OtlpGrpcMetricExporter.java
View File

@ -114,4 +114,9 @@ public final class OtlpGrpcMetricExporter implements MetricExporter {
public CompletableResultCode shutdown() {
return delegate.shutdown();
}
@Override
public String toString() {
return "OtlpGrpcMetricExporter{" + builder.toString(false) + "}";
}
}

5
exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/trace/OtlpGrpcSpanExporter.java
View File

@ -89,4 +89,9 @@ public final class OtlpGrpcSpanExporter implements SpanExporter {
public CompletableResultCode shutdown() {
return delegate.shutdown();
}
@Override
public String toString() {
return "OtlpGrpcSpanExporter{" + builder.toString(false) + "}";
}
}

62
exporters/otlp/testing-internal/src/main/java/io/opentelemetry/exporter/otlp/testing/internal/AbstractGrpcTelemetryExporterTest.java
View File

@ -783,6 +783,68 @@ public abstract class AbstractGrpcTelemetryExporterTest<T, U extends Message> {
}
}
@Test
void stringRepresentation() throws IOException, CertificateEncodingException {
TelemetryExporter<T> telemetryExporter =
exporterBuilder().setEndpoint("http://localhost:4317").build();
try {
assertThat(telemetryExporter.unwrap().toString())
.matches(
"OtlpGrpc[a-zA-Z]*Exporter\\{"
+ "exporterName=otlp, "
+ "type=[a-zA_Z]*, "
+ "endpoint=http://localhost:4317, "
+ "endpointPath=.*, "
+ "timeoutNanos="
+ TimeUnit.SECONDS.toNanos(10)
+ ", "
+ "compressionEnabled=false, "
+ "headers=Headers\\{User-Agent=OBFUSCATED\\}"
+ ".*" // Maybe additional grpcChannel field
+ "\\}");
} finally {
telemetryExporter.shutdown();
}
telemetryExporter =
exporterBuilder()
.setTimeout(Duration.ofSeconds(5))
.setEndpoint("http://example:4317")
.setCompression("gzip")
.addHeader("foo", "bar")
.setTrustedCertificates(certificate.certificate().getEncoded())
.setClientTls(
Files.readAllBytes(clientCertificate.privateKeyFile().toPath()),
Files.readAllBytes(clientCertificate.certificateFile().toPath()))
.setRetryPolicy(
RetryPolicy.builder()
.setMaxAttempts(2)
.setMaxBackoff(Duration.ofSeconds(3))
.setInitialBackoff(Duration.ofMillis(50))
.setBackoffMultiplier(1.3)
.build())
.build();
try {
assertThat(telemetryExporter.unwrap().toString())
.matches(
"OtlpGrpc[a-zA-Z]*Exporter\\{"
+ "exporterName=otlp, "
+ "type=[a-zA_Z]*, "
+ "endpoint=http://example:4317, "
+ "endpointPath=.*, "
+ "timeoutNanos="
+ TimeUnit.SECONDS.toNanos(5)
+ ", "
+ "compressionEnabled=true, "
+ "headers=Headers\\{.*foo=OBFUSCATED.*\\}, "
+ "retryPolicy=RetryPolicy\\{maxAttempts=2, initialBackoff=PT0\\.05S, maxBackoff=PT3S, backoffMultiplier=1\\.3\\}"
+ ".*" // Maybe additional grpcChannel field
+ "\\}");
} finally {
telemetryExporter.shutdown();
}
}
protected abstract TelemetryExporterBuilder<T> exporterBuilder();
protected abstract TelemetryExporterBuilder<T> toBuilder(TelemetryExporter<T> exporter);

59
exporters/otlp/testing-internal/src/main/java/io/opentelemetry/exporter/otlp/testing/internal/AbstractHttpTelemetryExporterTest.java
View File

@ -715,6 +715,65 @@ public abstract class AbstractHttpTelemetryExporterTest<T, U extends Message> {
}
}
@Test
void stringRepresentation() throws IOException, CertificateEncodingException {
TelemetryExporter<T> telemetryExporter = exporterBuilder().build();
try {
assertThat(telemetryExporter.unwrap().toString())
.matches(
"OtlpHttp[a-zA-Z]*Exporter\\{"
+ "exporterName=otlp, "
+ "type=[a-zA_Z]*, "
+ "endpoint=http://localhost:4318/v1/[a-zA-Z]*, "
+ "timeoutNanos="
+ TimeUnit.SECONDS.toNanos(10)
+ ", "
+ "compressionEnabled=false, "
+ "exportAsJson=false, "
+ "headers=Headers\\{User-Agent=OBFUSCATED\\}"
+ "\\}");
} finally {
telemetryExporter.shutdown();
}
telemetryExporter =
exporterBuilder()
.setTimeout(Duration.ofSeconds(5))
.setEndpoint("http://example:4318/v1/logs")
.setCompression("gzip")
.addHeader("foo", "bar")
.setTrustedCertificates(certificate.certificate().getEncoded())
.setClientTls(
Files.readAllBytes(clientCertificate.privateKeyFile().toPath()),
Files.readAllBytes(clientCertificate.certificateFile().toPath()))
.setRetryPolicy(
RetryPolicy.builder()
.setMaxAttempts(2)
.setMaxBackoff(Duration.ofSeconds(3))
.setInitialBackoff(Duration.ofMillis(50))
.setBackoffMultiplier(1.3)
.build())
.build();
try {
assertThat(telemetryExporter.unwrap().toString())
.matches(
"OtlpHttp[a-zA-Z]*Exporter\\{"
+ "exporterName=otlp, "
+ "type=[a-zA_Z]*, "
+ "endpoint=http://example:4318/v1/[a-zA-Z]*, "
+ "timeoutNanos="
+ TimeUnit.SECONDS.toNanos(5)
+ ", "
+ "compressionEnabled=true, "
+ "exportAsJson=false, "
+ "headers=Headers\\{.*foo=OBFUSCATED.*\\}, "
+ "retryPolicy=RetryPolicy\\{maxAttempts=2, initialBackoff=PT0\\.05S, maxBackoff=PT3S, backoffMultiplier=1\\.3\\}"
+ "\\}");
} finally {
telemetryExporter.shutdown();
}
}
protected abstract TelemetryExporterBuilder<T> exporterBuilder();
protected abstract TelemetryExporterBuilder<T> toBuilder(TelemetryExporter<T> exporter);

5
exporters/otlp/testing-internal/src/main/java/io/opentelemetry/exporter/otlp/testing/internal/ManagedChannelTelemetryExporterBuilder.java
View File

@ -90,6 +90,7 @@ public final class ManagedChannelTelemetryExporterBuilder<T>
@Override
public TelemetryExporterBuilder<T> setAuthenticator(Authenticator authenticator) {
delegate.setAuthenticator(authenticator);
return this;
}
@ -99,18 +100,21 @@ public final class ManagedChannelTelemetryExporterBuilder<T>
@Override
public TelemetryExporterBuilder<T> setTrustedCertificates(byte[] certificates) {
delegate.setTrustedCertificates(certificates);
tlsConfigHelper.setTrustManagerFromCerts(certificates);
return this;
}
@Override
public TelemetryExporterBuilder<T> setClientTls(byte[] privateKeyPem, byte[] certificatePem) {
delegate.setClientTls(privateKeyPem, certificatePem);
tlsConfigHelper.setKeyManagerFromCerts(privateKeyPem, certificatePem);
return this;
}
@Override
public TelemetryExporterBuilder<T> setRetryPolicy(RetryPolicy retryPolicy) {
delegate.setRetryPolicy(retryPolicy);
String grpcServiceName;
if (delegate instanceof GrpcLogRecordExporterBuilderWrapper) {
grpcServiceName = "opentelemetry.proto.collector.logs.v1.LogsService";
@ -167,6 +171,7 @@ public final class ManagedChannelTelemetryExporterBuilder<T>
@Override
public TelemetryExporterBuilder<T> setSslContext(
SSLContext sslContext, X509TrustManager trustManager) {
delegate.setSslContext(sslContext, trustManager);
tlsConfigHelper.setSslContext(sslContext, trustManager);
return this;
}