Skip to content
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

Jump to bottom

Specify ...jvm.gc.duration buckets using advice API #8436

Merged
merged 1 commit into from
May 15, 2023
Merged

Specify ...jvm.gc.duration buckets using advice API #8436

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
1 change: 1 addition & 0 deletions instrumentation/runtime-metrics/library/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ plugins {

dependencies {
implementation(project(":instrumentation-api"))
implementation("io.opentelemetry:opentelemetry-extension-incubator")

testImplementation("io.opentelemetry:opentelemetry-sdk-metrics")
testImplementation(project(":testing-common"))
Expand Down
38 changes: 27 additions & 11 deletions ...brary/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/GarbageCollector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,20 @@

package io.opentelemetry.instrumentation.runtimemetrics;

import static java.util.Collections.emptyList;

import com.sun.management.GarbageCollectionNotificationInfo;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.metrics.LongHistogram;
import io.opentelemetry.api.metrics.DoubleHistogram;
import io.opentelemetry.api.metrics.DoubleHistogramBuilder;
import io.opentelemetry.api.metrics.Meter;
import io.opentelemetry.extension.incubator.metrics.ExtendedDoubleHistogramBuilder;
import java.lang.management.GarbageCollectorMXBean;
import java.lang.management.ManagementFactory;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import java.util.logging.Logger;
import javax.management.Notification;
Expand All @@ -35,6 +40,8 @@ public final class GarbageCollector {

private static final Logger logger = Logger.getLogger(GarbageCollector.class.getName());

private static final double MILLIS_PER_S = TimeUnit.SECONDS.toMillis(1);

private static final AttributeKey<String> GC_KEY = AttributeKey.stringKey("gc");
private static final AttributeKey<String> ACTION_KEY = AttributeKey.stringKey("action");

Expand Down Expand Up @@ -66,43 +73,52 @@ static void registerObservers(
Function<Notification, GarbageCollectionNotificationInfo> notificationInfoExtractor) {
Meter meter = RuntimeMetricsUtil.getMeter(openTelemetry);

LongHistogram gcTime =
DoubleHistogramBuilder gcDurationBuilder =
meter
.histogramBuilder("process.runtime.jvm.gc.duration")
.setDescription("Duration of JVM garbage collection actions")
.setUnit("ms")
.ofLongs()
.build();
.setUnit("s");
setGcDurationBuckets(gcDurationBuilder);
DoubleHistogram gcDuration = gcDurationBuilder.build();

for (GarbageCollectorMXBean gcBean : gcBeans) {
if (!(gcBean instanceof NotificationEmitter)) {
continue;
}
NotificationEmitter notificationEmitter = (NotificationEmitter) gcBean;
notificationEmitter.addNotificationListener(
new GcNotificationListener(gcTime, notificationInfoExtractor), GC_FILTER, null);
new GcNotificationListener(gcDuration, notificationInfoExtractor), GC_FILTER, null);
}
}

private static void setGcDurationBuckets(DoubleHistogramBuilder builder) {
if (!(builder instanceof ExtendedDoubleHistogramBuilder)) {
// that shouldn't really happen
breedx-splk marked this conversation as resolved.
Show resolved Hide resolved
return;
}
((ExtendedDoubleHistogramBuilder) builder)
.setAdvice(advice -> advice.setExplicitBucketBoundaries(emptyList()));
breedx-splk marked this conversation as resolved.
Show resolved Hide resolved
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @mateuszrzeszutek, sorry for tagging in an old PR, but I am just wondering the reason for making explicitBucketBoundaries as an empty list?
Before version 1.26.0 I am pretty sure it used to have the explicitBucketBoundaries.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @kes2464 ,
We've had many discussions on what the buckets for the gc metrics should be; and for a long while we were of the opinion that we should not provide any, and instead allow the users to set the buckets they want via the SDK Views. The current implementation reflects that.
We'll likely add some buckets when the JVM metrics become stable in the 2.0 version, see open-telemetry/semantic-conventions#317

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the detailed explanation @mateuszrzeszutek, I think it makes sense for GC metrics as it may vary depending on the apps and so on. For me, as long as they can be created it's fine, and adding a new View worked perfectly.

}

private static final class GcNotificationListener implements NotificationListener {

private final LongHistogram gcTime;
private final DoubleHistogram gcDuration;
private final Function<Notification, GarbageCollectionNotificationInfo>
notificationInfoExtractor;

private GcNotificationListener(
LongHistogram gcTime,
DoubleHistogram gcDuration,
Function<Notification, GarbageCollectionNotificationInfo> notificationInfoExtractor) {
this.gcTime = gcTime;
this.gcDuration = gcDuration;
this.notificationInfoExtractor = notificationInfoExtractor;
}

@Override
public void handleNotification(Notification notification, Object unused) {
GarbageCollectionNotificationInfo notificationInfo =
notificationInfoExtractor.apply(notification);
gcTime.record(
notificationInfo.getGcInfo().getDuration(),
gcDuration.record(
notificationInfo.getGcInfo().getDuration() / MILLIS_PER_S,
Attributes.of(
GC_KEY, notificationInfo.getGcName(), ACTION_KEY, notificationInfo.getGcAction()));
}
Expand Down
12 changes: 7 additions & 5 deletions ...y/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/GarbageCollectorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,28 +72,30 @@ void registerObservers() {
assertThat(metricData)
.hasInstrumentationScope(EXPECTED_SCOPE)
.hasDescription("Duration of JVM garbage collection actions")
.hasUnit("ms")
.hasUnit("s")
.hasHistogramSatisfying(
histogram ->
histogram.hasPointsSatisfying(
point ->
point
.hasCount(2)
.hasSum(22)
.hasSum(0.022)
.hasAttributes(
Attributes.builder()
.put("gc", "G1 Young Generation")
.put("action", "end of minor GC")
.build()),
.build())
.hasBucketBoundaries(),
point ->
point
.hasCount(1)
.hasSum(11)
.hasSum(0.011)
.hasAttributes(
Attributes.builder()
.put("gc", "G1 Old Generation")
.put("action", "end of major GC")
.build())))));
.build())
.hasBucketBoundaries()))));
}

private static Notification createTestNotification(
Expand Down