-
Notifications
You must be signed in to change notification settings - Fork 892
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace runtime.jvm.gc.time/runtime.jvm.gc.count metrics with process…
….runtime.jvm.gc.duration histogram (#6964) Replaces #6362. I've reduced the attributes to only record the gc name and the action that was taken (i.e. I've removed the gc cause). If needed we can add the cause later, but for now this should be sufficient to determine total time spent in GC, and categorize time spent as stop the world or parallel.
- Loading branch information
Showing
6 changed files
with
225 additions
and
50 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
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
134 changes: 134 additions & 0 deletions
134
...y/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/GarbageCollectorTest.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,134 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.instrumentation.runtimemetrics; | ||
|
|
||
| import static io.opentelemetry.instrumentation.runtimemetrics.ScopeUtil.EXPECTED_SCOPE; | ||
| import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.verify; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import com.sun.management.GarbageCollectionNotificationInfo; | ||
| import com.sun.management.GcInfo; | ||
| import io.opentelemetry.api.common.Attributes; | ||
| import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension; | ||
| import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension; | ||
| import java.lang.management.GarbageCollectorMXBean; | ||
| import java.util.Collections; | ||
| import java.util.concurrent.atomic.AtomicLong; | ||
| import javax.management.Notification; | ||
| import javax.management.NotificationEmitter; | ||
| import javax.management.NotificationListener; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.ExtendWith; | ||
| import org.junit.jupiter.api.extension.RegisterExtension; | ||
| import org.mockito.ArgumentCaptor; | ||
| import org.mockito.Captor; | ||
| import org.mockito.Mock; | ||
| import org.mockito.junit.jupiter.MockitoExtension; | ||
| import org.mockito.junit.jupiter.MockitoSettings; | ||
| import org.mockito.quality.Strictness; | ||
|
|
||
| @ExtendWith(MockitoExtension.class) | ||
| @MockitoSettings(strictness = Strictness.LENIENT) | ||
| class GarbageCollectorTest { | ||
|
|
||
| @RegisterExtension | ||
| static final InstrumentationExtension testing = LibraryInstrumentationExtension.create(); | ||
|
|
||
| @Mock(extraInterfaces = NotificationEmitter.class) | ||
| private GarbageCollectorMXBean gcBean; | ||
|
|
||
| @Captor private ArgumentCaptor<NotificationListener> listenerCaptor; | ||
|
|
||
| @Test | ||
| void registerObservers() { | ||
| GarbageCollector.registerObservers( | ||
| testing.getOpenTelemetry(), | ||
| Collections.singletonList(gcBean), | ||
| GarbageCollectorTest::getGcNotificationInfo); | ||
|
|
||
| NotificationEmitter notificationEmitter = (NotificationEmitter) gcBean; | ||
| verify(notificationEmitter).addNotificationListener(listenerCaptor.capture(), any(), any()); | ||
| NotificationListener listener = listenerCaptor.getValue(); | ||
|
|
||
| listener.handleNotification( | ||
| createTestNotification("G1 Young Generation", "end of minor GC", 10), null); | ||
| listener.handleNotification( | ||
| createTestNotification("G1 Young Generation", "end of minor GC", 12), null); | ||
| listener.handleNotification( | ||
| createTestNotification("G1 Old Generation", "end of major GC", 11), null); | ||
|
|
||
| testing.waitAndAssertMetrics( | ||
| "io.opentelemetry.runtime-metrics", | ||
| "process.runtime.jvm.gc.duration", | ||
| metrics -> | ||
| metrics.anySatisfy( | ||
| metricData -> | ||
| assertThat(metricData) | ||
| .hasInstrumentationScope(EXPECTED_SCOPE) | ||
| .hasDescription("Duration of JVM garbage collection actions") | ||
| .hasUnit("ms") | ||
| .hasHistogramSatisfying( | ||
| histogram -> | ||
| histogram.hasPointsSatisfying( | ||
| point -> | ||
| point | ||
| .hasCount(2) | ||
| .hasSum(22) | ||
| .hasAttributes( | ||
| Attributes.builder() | ||
| .put("gc", "G1 Young Generation") | ||
| .put("action", "end of minor GC") | ||
| .build()), | ||
| point -> | ||
| point | ||
| .hasCount(1) | ||
| .hasSum(11) | ||
| .hasAttributes( | ||
| Attributes.builder() | ||
| .put("gc", "G1 Old Generation") | ||
| .put("action", "end of major GC") | ||
| .build()))))); | ||
| } | ||
|
|
||
| private static Notification createTestNotification( | ||
| String gcName, String gcAction, long duration) { | ||
| GarbageCollectionNotificationInfo gcNotificationInfo = | ||
| mock(GarbageCollectionNotificationInfo.class); | ||
| when(gcNotificationInfo.getGcName()).thenReturn(gcName); | ||
| when(gcNotificationInfo.getGcAction()).thenReturn(gcAction); | ||
| GcInfo gcInfo = mock(GcInfo.class); | ||
| when(gcInfo.getDuration()).thenReturn(duration); | ||
| when(gcNotificationInfo.getGcInfo()).thenReturn(gcInfo); | ||
| return new TestNotification(gcNotificationInfo); | ||
| } | ||
|
|
||
| private static GarbageCollectionNotificationInfo getGcNotificationInfo( | ||
| Notification notification) { | ||
| return ((TestNotification) notification).gcNotificationInfo; | ||
| } | ||
|
|
||
| /** | ||
| * A {@link Notification} when is initialized with a mock {@link | ||
| * GarbageCollectionNotificationInfo}. | ||
| */ | ||
| private static class TestNotification extends Notification { | ||
|
|
||
| private static final AtomicLong sequence = new AtomicLong(0); | ||
|
|
||
| private final GarbageCollectionNotificationInfo gcNotificationInfo; | ||
|
|
||
| private TestNotification(GarbageCollectionNotificationInfo gcNotificationInfo) { | ||
| super( | ||
| GarbageCollectionNotificationInfo.GARBAGE_COLLECTION_NOTIFICATION, | ||
| "test", | ||
| sequence.incrementAndGet()); | ||
| this.gcNotificationInfo = gcNotificationInfo; | ||
| } | ||
| } | ||
| } |