Skip to content

Not throw if endpoint is not set correctly, log and noop #154976

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
mamazzol wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Not throw if endpoint is not set correctly, log and noop #154976

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
24 changes: 13 additions & 11 deletions ...a/org/elasticsearch/telemetry/apm/internal/export/otelsdk/OtelSdkExportMeterSupplier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.ssl.TrustEverythingConfig;
import org.elasticsearch.core.Booleans;
import org.elasticsearch.logging.LogManager;
import org.elasticsearch.logging.Logger;
import org.elasticsearch.telemetry.apm.internal.APMAgentSettings;
import org.elasticsearch.telemetry.apm.internal.export.MeterSupplier;

Expand Down Expand Up @@ -58,6 +60,8 @@ public class OtelSdkExportMeterSupplier implements MeterSupplier {
// Per-instrument-stream cardinality limit
private static final int METRIC_CARDINALITY_LIMIT = 1000;

private static final Logger logger = LogManager.getLogger(OtelSdkExportMeterSupplier.class);

private final Settings settings;
private final Path diskBufferPath;
private volatile OTelMetricsResources resources;
Expand All @@ -77,12 +81,7 @@ public OtelSdkExportMeterSupplier(Settings settings, Path diskBufferPath) {

@Override
public Meter get() {
synchronized (mutex) {
if (resources == null) {
resources = createMeteringResources();
}
return resources.meterProvider().get("elasticsearch");
}
return getMeterProvider().get("elasticsearch");
}

private OTelMetricsResources createMeteringResources() {
Expand Down Expand Up @@ -147,11 +146,6 @@ private SdkMeterProvider sdkMeterProvider(PeriodicMetricReader reader) {

private OtlpGrpcMetricExporter createOTLPExporter(Supplier<MeterProvider> meterProviderSupplier) {
String endpoint = OtelSdkSettings.TELEMETRY_EXPORT_ENDPOINT.get(settings);
if (endpoint == null || endpoint.isEmpty()) {
throw new IllegalStateException(
OTEL_METRICS_ENABLED_SYSTEM_PROPERTY + "=true requires telemetry.export.endpoint to be configured"
);
}
OtlpGrpcMetricExporterBuilder builder = OtlpGrpcMetricExporter.builder()
.setEndpoint(endpoint)
.setMeterProvider(meterProviderSupplier)
Expand Down Expand Up @@ -215,6 +209,14 @@ public CompletableResultCode attemptFlushMetrics() {
public MeterProvider getMeterProvider() {
synchronized (mutex) {
if (resources == null) {
String endpoint = OtelSdkSettings.TELEMETRY_EXPORT_ENDPOINT.get(settings);
if (endpoint == null || endpoint.isEmpty()) {
logger.warn(
"{}=true but [telemetry.export.endpoint] is not configured; OTel SDK metrics export is disabled",
OTEL_METRICS_ENABLED_SYSTEM_PROPERTY
);
return MeterProvider.noop();
}
resources = createMeteringResources();
}
return resources.meterProvider();
Expand Down
20 changes: 15 additions & 5 deletions .../org/elasticsearch/telemetry/apm/internal/export/otelsdk/OtelSdkExportTracerSupplier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@

import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.core.TimeValue;
import org.elasticsearch.logging.LogManager;
import org.elasticsearch.logging.Logger;
import org.elasticsearch.telemetry.apm.internal.export.TraceSupplier;

import java.util.concurrent.TimeUnit;
Expand All @@ -37,15 +39,21 @@
*/
public class OtelSdkExportTracerSupplier implements TraceSupplier {

private static final Logger logger = LogManager.getLogger(OtelSdkExportTracerSupplier.class);

private final SdkTracerProvider tracerProvider;
private final OpenTelemetrySdk openTelemetrySdk;

public OtelSdkExportTracerSupplier(Settings settings, Supplier<MeterProvider> meterProvider) {
String endpoint = OtelSdkSettings.TELEMETRY_EXPORT_ENDPOINT.get(settings);
if (endpoint == null || endpoint.isEmpty()) {
throw new IllegalStateException(
OTEL_TRACES_ENABLED_SYSTEM_PROPERTY + "=true requires telemetry.export.endpoint to be configured"
logger.warn(
"{}=true but [telemetry.export.endpoint] is not configured; OTel SDK trace export is disabled",
OTEL_TRACES_ENABLED_SYSTEM_PROPERTY
);
this.tracerProvider = null;
this.openTelemetrySdk = null;
return;
}

TimeValue interval = OtelSdkSettings.TELEMETRY_EXPORT_INTERVAL.get(settings);
Expand Down Expand Up @@ -94,16 +102,18 @@ public OtelSdkExportTracerSupplier(Settings settings, Supplier<MeterProvider> me

@Override
public OpenTelemetry get() {
return openTelemetrySdk;
return openTelemetrySdk != null ? openTelemetrySdk : OpenTelemetry.noop();
}

@Override
public CompletableResultCode attemptFlushTraces() {
return tracerProvider.forceFlush();
return tracerProvider == null ? CompletableResultCode.ofSuccess() : tracerProvider.forceFlush();
}

@Override
public void close() {
tracerProvider.close();
if (tracerProvider != null) {
tracerProvider.close();
}
}
}
21 changes: 6 additions & 15 deletions .../elasticsearch/telemetry/apm/internal/export/otelsdk/OtelSdkExportMeterSupplierTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

package org.elasticsearch.telemetry.apm.internal.export.otelsdk;

import io.opentelemetry.api.metrics.MeterProvider;
import io.opentelemetry.sdk.common.CompletableResultCode;
import io.opentelemetry.sdk.common.InternalTelemetryVersion;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
Expand All @@ -25,27 +26,21 @@
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.test.ESTestCase;

import static org.elasticsearch.telemetry.TelemetryProvider.OTEL_METRICS_ENABLED_SYSTEM_PROPERTY;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.hasItem;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.nullValue;

@ThreadLeakFilters(filters = { OkHttpThreadsFilter.class })
public class OtelSdkExportMeterSupplierTests extends ESTestCase {

public void testGetWithoutEndpointThrows() {
IllegalStateException e = expectThrows(
IllegalStateException.class,
() -> new OtelSdkExportMeterSupplier(Settings.EMPTY, null).get()
);
assertThat(e.getMessage(), containsString(OTEL_METRICS_ENABLED_SYSTEM_PROPERTY));
assertThat(e.getMessage(), containsString("telemetry.export.endpoint"));
public void testMissingEndpointReturnsNoopInsteadOfThrowing() {
assertThat(new OtelSdkExportMeterSupplier(Settings.EMPTY, null).getMeterProvider(), is(MeterProvider.noop()));
}

public void testGetWithEmptyEndpointThrows() {
public void testEmptyEndpointReturnsNoopInsteadOfThrowing() {
Settings settings = Settings.builder().put(OtelSdkSettings.TELEMETRY_EXPORT_ENDPOINT.getKey(), "").build();
expectThrows(IllegalStateException.class, () -> new OtelSdkExportMeterSupplier(settings, null).get());
assertThat(new OtelSdkExportMeterSupplier(settings, null).getMeterProvider(), is(MeterProvider.noop()));
}

public void testBuildOtlpAuthorizationHeaderWithNeitherCredential() {
Expand Down Expand Up @@ -74,10 +69,6 @@ public void testBuildOtlpAuthorizationHeaderWithApiKeyOnly() {
assertThat(OtelSdkExportMeterSupplier.buildOtlpAuthorizationHeader(settings), equalTo("ApiKey xyz"));
}

public void testGetMeterProviderWithoutEndpointThrows() {
expectThrows(IllegalStateException.class, () -> new OtelSdkExportMeterSupplier(Settings.EMPTY, null).getMeterProvider());
}

public void testGetMeterProviderAfterGetReturnsSdkProvider() {
String bogusUrl = "http://127.0.0.1:9";
Settings settings = Settings.builder().put(OtelSdkSettings.TELEMETRY_EXPORT_ENDPOINT.getKey(), bogusUrl).build();
Expand Down
30 changes: 13 additions & 17 deletions ...elasticsearch/telemetry/apm/internal/export/otelsdk/OtelSdkExportTracerSupplierTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

package org.elasticsearch.telemetry.apm.internal.export.otelsdk;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.metrics.MeterProvider;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.metrics.data.MetricData;
Expand All @@ -19,30 +20,25 @@
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.test.ESTestCase;

import static org.elasticsearch.telemetry.TelemetryProvider.OTEL_TRACES_ENABLED_SYSTEM_PROPERTY;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.hasItem;
import static org.hamcrest.Matchers.is;

@ThreadLeakFilters(filters = { OkHttpThreadsFilter.class })
public class OtelSdkExportTracerSupplierTests extends ESTestCase {

public void testConstructorWithoutEndpointThrows() {
IllegalStateException e = expectThrows(
IllegalStateException.class,
() -> new OtelSdkExportTracerSupplier(Settings.EMPTY, MeterProvider::noop)
);
assertThat(e.getMessage(), containsString(OTEL_TRACES_ENABLED_SYSTEM_PROPERTY));
assertThat(e.getMessage(), containsString("telemetry.export.endpoint"));
public void testMissingEndpointReturnsNoopInsteadOfThrowing() {
assertDegradesToNoop(Settings.EMPTY);
}

public void testConstructorWithEmptyEndpointThrows() {
Settings settings = Settings.builder().put(OtelSdkSettings.TELEMETRY_EXPORT_ENDPOINT.getKey(), "").build();
IllegalStateException e = expectThrows(
IllegalStateException.class,
() -> new OtelSdkExportTracerSupplier(settings, MeterProvider::noop)
);
assertThat(e.getMessage(), containsString(OTEL_TRACES_ENABLED_SYSTEM_PROPERTY));
assertThat(e.getMessage(), containsString("telemetry.export.endpoint"));
public void testEmptyEndpointReturnsNoopInsteadOfThrowing() {
assertDegradesToNoop(Settings.builder().put(OtelSdkSettings.TELEMETRY_EXPORT_ENDPOINT.getKey(), "").build());
}

private void assertDegradesToNoop(Settings settings) {
try (var supplier = new OtelSdkExportTracerSupplier(settings, MeterProvider::noop)) {
assertThat(supplier.get(), is(OpenTelemetry.noop()));
assertThat(supplier.attemptFlushTraces().isSuccess(), is(true));
}
}

public void testConstructorWithNoopMeterProviderDoesNotThrow() {
Expand Down