-
Notifications
You must be signed in to change notification settings - Fork 123
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: client metrics * Review comments * Few issues and code optimisations * review comments * directpath_used attribute * removed directpath enabled attribute * removed directpath enabled attribute * lint * bucket boundaries
- Loading branch information
1 parent
163782b
commit 9c47ea4
Showing
11 changed files
with
844 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
144 changes: 144 additions & 0 deletions
144
...d-spanner/src/main/java/com/google/cloud/spanner/BuiltInOpenTelemetryMetricsProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| /* | ||
| * Copyright 2024 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.spanner; | ||
|
|
||
| import static com.google.cloud.opentelemetry.detection.GCPPlatformDetector.SupportedPlatform.GOOGLE_KUBERNETES_ENGINE; | ||
| import static com.google.cloud.spanner.BuiltInMetricsConstant.CLIENT_NAME_KEY; | ||
| import static com.google.cloud.spanner.BuiltInMetricsConstant.CLIENT_UID_KEY; | ||
| import static com.google.cloud.spanner.BuiltInMetricsConstant.INSTANCE_CONFIG_ID_KEY; | ||
| import static com.google.cloud.spanner.BuiltInMetricsConstant.LOCATION_ID_KEY; | ||
| import static com.google.cloud.spanner.BuiltInMetricsConstant.PROJECT_ID_KEY; | ||
|
|
||
| import com.google.auth.Credentials; | ||
| import com.google.cloud.opentelemetry.detection.AttributeKeys; | ||
| import com.google.cloud.opentelemetry.detection.DetectedPlatform; | ||
| import com.google.cloud.opentelemetry.detection.GCPPlatformDetector; | ||
| import io.opentelemetry.api.OpenTelemetry; | ||
| import io.opentelemetry.sdk.OpenTelemetrySdk; | ||
| import io.opentelemetry.sdk.metrics.SdkMeterProvider; | ||
| import io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder; | ||
| import java.io.IOException; | ||
| import java.lang.management.ManagementFactory; | ||
| import java.lang.reflect.Method; | ||
| import java.net.InetAddress; | ||
| import java.net.UnknownHostException; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.UUID; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| final class BuiltInOpenTelemetryMetricsProvider { | ||
|
|
||
| static BuiltInOpenTelemetryMetricsProvider INSTANCE = new BuiltInOpenTelemetryMetricsProvider(); | ||
|
|
||
| private static final Logger logger = | ||
| Logger.getLogger(BuiltInOpenTelemetryMetricsProvider.class.getName()); | ||
|
|
||
| private static String taskId; | ||
|
|
||
| private OpenTelemetry openTelemetry; | ||
|
|
||
| private BuiltInOpenTelemetryMetricsProvider() {} | ||
|
|
||
| OpenTelemetry getOrCreateOpenTelemetry(String projectId, @Nullable Credentials credentials) { | ||
| try { | ||
| if (this.openTelemetry == null) { | ||
| SdkMeterProviderBuilder sdkMeterProviderBuilder = SdkMeterProvider.builder(); | ||
| BuiltInOpenTelemetryMetricsView.registerBuiltinMetrics( | ||
| SpannerCloudMonitoringExporter.create(projectId, credentials), sdkMeterProviderBuilder); | ||
| this.openTelemetry = | ||
| OpenTelemetrySdk.builder().setMeterProvider(sdkMeterProviderBuilder.build()).build(); | ||
| } | ||
| return this.openTelemetry; | ||
| } catch (IOException ex) { | ||
| logger.log( | ||
| Level.WARNING, | ||
| "Unable to get OpenTelemetry object for client side metrics, will skip exporting client side metrics", | ||
| ex); | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| Map<String, String> createClientAttributes(String projectId, String client_name) { | ||
| Map<String, String> clientAttributes = new HashMap<>(); | ||
| clientAttributes.put(LOCATION_ID_KEY.getKey(), detectClientLocation()); | ||
| clientAttributes.put(PROJECT_ID_KEY.getKey(), projectId); | ||
| // TODO: Replace this with real value. | ||
| clientAttributes.put(INSTANCE_CONFIG_ID_KEY.getKey(), "unknown"); | ||
| clientAttributes.put(CLIENT_NAME_KEY.getKey(), client_name); | ||
| clientAttributes.put(CLIENT_UID_KEY.getKey(), getDefaultTaskValue()); | ||
| return clientAttributes; | ||
| } | ||
|
|
||
| static String detectClientLocation() { | ||
| GCPPlatformDetector detector = GCPPlatformDetector.DEFAULT_INSTANCE; | ||
| DetectedPlatform detectedPlatform = detector.detectPlatform(); | ||
| // All platform except GKE uses "cloud_region" for region attribute. | ||
| String region = detectedPlatform.getAttributes().get("cloud_region"); | ||
| if (detectedPlatform.getSupportedPlatform() == GOOGLE_KUBERNETES_ENGINE) { | ||
| region = detectedPlatform.getAttributes().get(AttributeKeys.GKE_LOCATION_TYPE_REGION); | ||
| } | ||
| return region == null ? "global" : region; | ||
| } | ||
|
|
||
| /** | ||
| * Generates a unique identifier for the Client_uid metric field. The identifier is composed of a | ||
| * UUID, the process ID (PID), and the hostname. | ||
| * | ||
| * <p>For Java 9 and later, the PID is obtained using the ProcessHandle API. For Java 8, the PID | ||
| * is extracted from ManagementFactory.getRuntimeMXBean().getName(). | ||
| * | ||
| * @return A unique identifier string in the format UUID@PID@hostname | ||
| */ | ||
| private static String getDefaultTaskValue() { | ||
| if (taskId == null) { | ||
| String identifier = UUID.randomUUID().toString(); | ||
| String pid = getProcessId(); | ||
|
|
||
| try { | ||
| String hostname = InetAddress.getLocalHost().getHostName(); | ||
| taskId = identifier + "@" + pid + "@" + hostname; | ||
| } catch (UnknownHostException e) { | ||
| logger.log(Level.INFO, "Unable to get the hostname.", e); | ||
| taskId = identifier + "@" + pid + "@localhost"; | ||
| } | ||
| } | ||
| return taskId; | ||
| } | ||
|
|
||
| private static String getProcessId() { | ||
| try { | ||
| // Check if Java 9+ and ProcessHandle class is available | ||
| Class<?> processHandleClass = Class.forName("java.lang.ProcessHandle"); | ||
| Method currentMethod = processHandleClass.getMethod("current"); | ||
| Object processHandleInstance = currentMethod.invoke(null); | ||
| Method pidMethod = processHandleClass.getMethod("pid"); | ||
| long pid = (long) pidMethod.invoke(processHandleInstance); | ||
| return Long.toString(pid); | ||
| } catch (Exception e) { | ||
| // Fallback to Java 8 method | ||
| final String jvmName = ManagementFactory.getRuntimeMXBean().getName(); | ||
| if (jvmName != null && jvmName.contains("@")) { | ||
| return jvmName.split("@")[0]; | ||
| } else { | ||
| return "unknown"; | ||
| } | ||
| } | ||
| } | ||
| } |
33 changes: 33 additions & 0 deletions
33
...cloud-spanner/src/main/java/com/google/cloud/spanner/BuiltInOpenTelemetryMetricsView.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| /* | ||
| * Copyright 2024 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.spanner; | ||
|
|
||
| import io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder; | ||
| import io.opentelemetry.sdk.metrics.export.MetricExporter; | ||
| import io.opentelemetry.sdk.metrics.export.PeriodicMetricReader; | ||
|
|
||
| class BuiltInOpenTelemetryMetricsView { | ||
|
|
||
| private BuiltInOpenTelemetryMetricsView() {} | ||
|
|
||
| /** Register built-in metrics on the {@link SdkMeterProviderBuilder} with credentials. */ | ||
| static void registerBuiltinMetrics( | ||
| MetricExporter metricExporter, SdkMeterProviderBuilder builder) { | ||
| BuiltInMetricsConstant.getAllViews().forEach(builder::registerView); | ||
| builder.registerMetricReader(PeriodicMetricReader.create(metricExporter)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.