Skip to content

fix: use universe domain when creating the monitoring client #2570

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.

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

Merged
merged 2 commits into from
Apr 28, 2025
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,19 @@ public static BigtableClientContext create(EnhancedBigtableStubSettings settings
}
builder.setCredentialsProvider(FixedCredentialsProvider.create(credentials));

String universeDomain = settings.getUniverseDomain();

// Set up OpenTelemetry
OpenTelemetry openTelemetry = null;
try {
// We don't want client side metrics to crash the client, so catch any exception when getting
// the OTEL instance and log the exception instead.
openTelemetry =
getOpenTelemetryFromMetricsProvider(
settings.getMetricsProvider(), credentials, settings.getMetricsEndpoint());
settings.getMetricsProvider(),
credentials,
settings.getMetricsEndpoint(),
universeDomain);
} catch (Throwable t) {
logger.log(Level.WARNING, "Failed to get OTEL, will skip exporting client side metrics", t);
}
Expand Down Expand Up @@ -194,7 +199,8 @@ public void close() throws Exception {
private static OpenTelemetry getOpenTelemetryFromMetricsProvider(
MetricsProvider metricsProvider,
@Nullable Credentials defaultCredentials,
@Nullable String metricsEndpoint)
@Nullable String metricsEndpoint,
String universeDomain)
throws IOException {
if (metricsProvider instanceof CustomOpenTelemetryMetricsProvider) {
CustomOpenTelemetryMetricsProvider customMetricsProvider =
Expand All @@ -206,7 +212,7 @@ private static OpenTelemetry getOpenTelemetryFromMetricsProvider(
? BigtableDataSettings.getMetricsCredentials()
: defaultCredentials;
DefaultMetricsProvider defaultMetricsProvider = (DefaultMetricsProvider) metricsProvider;
return defaultMetricsProvider.getOpenTelemetry(metricsEndpoint, credentials);
return defaultMetricsProvider.getOpenTelemetry(metricsEndpoint, universeDomain, credentials);
} else if (metricsProvider instanceof NoopMetricsProvider) {
return null;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,15 +113,19 @@ static BigtableCloudMonitoringExporter create(
String exporterName,
@Nullable Credentials credentials,
@Nullable String endpoint,
String universeDomain,
TimeSeriesConverter converter)
throws IOException {

Preconditions.checkNotNull(universeDomain);
MetricServiceSettings.Builder settingsBuilder = MetricServiceSettings.newBuilder();
CredentialsProvider credentialsProvider =
Optional.ofNullable(credentials)
.<CredentialsProvider>map(FixedCredentialsProvider::create)
.orElse(NoCredentialsProvider.create());
settingsBuilder.setCredentialsProvider(credentialsProvider);

settingsBuilder.setUniverseDomain(universeDomain);

if (MONITORING_ENDPOINT_OVERRIDE_SYS_PROP != null) {
logger.warning(
"Setting the monitoring endpoint through system variable will be removed in future"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,22 @@ public static void registerBuiltinMetrics(
public static void registerBuiltinMetrics(
@Nullable Credentials credentials, SdkMeterProviderBuilder builder, @Nullable String endpoint)
throws IOException {
registerBuiltinMetricsWithUniverseDomain(
credentials, builder, endpoint, Credentials.GOOGLE_DEFAULT_UNIVERSE);
}

static void registerBuiltinMetricsWithUniverseDomain(
@Nullable Credentials credentials,
SdkMeterProviderBuilder builder,
@Nullable String endpoint,
String universeDomain)
throws IOException {
MetricExporter publicExporter =
BigtableCloudMonitoringExporter.create(
"bigtable metrics",
credentials,
endpoint,
universeDomain,
new BigtableCloudMonitoringExporter.PublicTimeSeriesConverter());

for (Map.Entry<InstrumentSelector, View> entry :
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,11 @@ private DefaultMetricsProvider() {}

@InternalApi
public OpenTelemetry getOpenTelemetry(
@Nullable String metricsEndpoint, @Nullable Credentials credentials) throws IOException {
@Nullable String metricsEndpoint, String universeDomain, @Nullable Credentials credentials)
throws IOException {
SdkMeterProviderBuilder meterProvider = SdkMeterProvider.builder();
BuiltinMetricsView.registerBuiltinMetrics(credentials, meterProvider, metricsEndpoint);
BuiltinMetricsView.registerBuiltinMetricsWithUniverseDomain(
credentials, meterProvider, metricsEndpoint, universeDomain);
return OpenTelemetrySdk.builder().setMeterProvider(meterProvider.build()).build();
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@ public static OpenTelemetrySdk newInternalOpentelemetry(
"application metrics",
credentials,
settings.getMetricsEndpoint(),
settings.getUniverseDomain(),
new BigtableCloudMonitoringExporter.InternalTimeSeriesConverter(
Suppliers.memoize(
() -> BigtableExporterUtils.createInternalMonitoredResource(settings))))));
Expand Down
Loading