-
Notifications
You must be signed in to change notification settings - Fork 831
Add GC duration histogram #1738
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
Open
gniadeck
wants to merge
8
commits into
prometheus:main
Choose a base branch
from
gniadeck:gniadeck/gc-pause-histogram
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b732151
Add GC pause duration histogram
gniadeck 7f5ad1b
align gc label name with opentelemetry spec
gniadeck 42cf5ef
simplification, spotless fixes
gniadeck 042e03c
align naming with opentelemetry semantic conventions
gniadeck e5cc0c8
Label test and migration to opentelemetry naming
gniadeck 4f4d36f
Add useOtelMetrics to MetricsProperties
gniadeck 3cdc384
Add type info to remove compilation warning
gniadeck 83d9ee6
apply spotless
gniadeck File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -1,26 +1,38 @@ | ||
| package io.prometheus.metrics.instrumentation.jvm; | ||
|
|
||
| import static com.sun.management.GarbageCollectionNotificationInfo.GARBAGE_COLLECTION_NOTIFICATION; | ||
| import static io.prometheus.metrics.instrumentation.jvm.TestUtil.convertToOpenMetricsFormat; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.ArgumentCaptor.forClass; | ||
| import static org.mockito.Mockito.*; | ||
| import static org.mockito.Mockito.times; | ||
| import static org.mockito.Mockito.verify; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import io.prometheus.metrics.config.MetricsProperties; | ||
| import io.prometheus.metrics.config.PrometheusProperties; | ||
| import io.prometheus.metrics.model.registry.MetricNameFilter; | ||
| import io.prometheus.metrics.model.registry.PrometheusRegistry; | ||
| import io.prometheus.metrics.model.snapshots.MetricSnapshots; | ||
| import java.io.IOException; | ||
| import java.lang.management.GarbageCollectorMXBean; | ||
| import java.util.Arrays; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.concurrent.TimeUnit; | ||
| import javax.management.Notification; | ||
| import javax.management.NotificationEmitter; | ||
| import javax.management.NotificationListener; | ||
| import javax.management.openmbean.*; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.mockito.Mockito; | ||
| import org.mockito.ArgumentCaptor; | ||
|
|
||
| class JvmGarbageCollectorMetricsTest { | ||
|
|
||
| private final GarbageCollectorMXBean mockGcBean1 = Mockito.mock(GarbageCollectorMXBean.class); | ||
| private final GarbageCollectorMXBean mockGcBean2 = Mockito.mock(GarbageCollectorMXBean.class); | ||
| private final GarbageCollectorMXBean mockGcBean1 = mock(GarbageCollectorMXBean.class); | ||
| private final GarbageCollectorMXBean mockGcBean2 = mock(GarbageCollectorMXBean.class); | ||
|
|
||
| @BeforeEach | ||
| public void setUp() { | ||
|
|
@@ -58,7 +70,9 @@ public void testGoodCase() throws IOException { | |
| @Test | ||
| public void testIgnoredMetricNotScraped() { | ||
| MetricNameFilter filter = | ||
| MetricNameFilter.builder().nameMustNotBeEqualTo("jvm_gc_collection_seconds").build(); | ||
| MetricNameFilter.builder() | ||
| .nameMustNotBeEqualTo("jvm_gc_collection_seconds", "jvm_gc_duration") | ||
zeitlinger marked this conversation as resolved.
Show resolved
Hide resolved
zeitlinger marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| .build(); | ||
|
Comment on lines
+73
to
+75
|
||
|
|
||
| PrometheusRegistry registry = new PrometheusRegistry(); | ||
| JvmGarbageCollectorMetrics.builder() | ||
|
|
@@ -70,4 +84,148 @@ public void testIgnoredMetricNotScraped() { | |
| verify(mockGcBean1, times(0)).getCollectionCount(); | ||
| assertThat(snapshots.size()).isZero(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testNonOtelMetricsAbsentWhenUseOtelEnabled() { | ||
|
|
||
| PrometheusRegistry registry = new PrometheusRegistry(); | ||
| PrometheusProperties properties = | ||
| PrometheusProperties.builder() | ||
| .defaultMetricsProperties(MetricsProperties.builder().useOtelMetrics(true).build()) | ||
| .build(); | ||
| JvmGarbageCollectorMetrics.builder(properties) | ||
| .garbageCollectorBeans(Arrays.asList(mockGcBean1, mockGcBean2)) | ||
| .register(registry); | ||
| registry.scrape(); | ||
|
|
||
| verify(mockGcBean1, times(0)).getCollectionTime(); | ||
| verify(mockGcBean1, times(0)).getCollectionCount(); | ||
| } | ||
|
|
||
| @Test | ||
| @SuppressWarnings("rawtypes") | ||
| public void testGCDurationHistogramLabels() throws Exception { | ||
| GarbageCollectorMXBean mockGcBean = | ||
| mock( | ||
| GarbageCollectorMXBean.class, | ||
| withSettings().extraInterfaces(NotificationEmitter.class)); | ||
| when(mockGcBean.getName()).thenReturn("MyGC"); | ||
|
|
||
| PrometheusProperties properties = | ||
| PrometheusProperties.builder() | ||
| .defaultMetricsProperties(MetricsProperties.builder().useOtelMetrics(true).build()) | ||
| .build(); | ||
|
|
||
| PrometheusRegistry registry = new PrometheusRegistry(); | ||
| JvmGarbageCollectorMetrics.builder(properties) | ||
| .garbageCollectorBeans(Collections.singletonList(mockGcBean)) | ||
| .register(registry); | ||
|
|
||
| NotificationListener listener; | ||
| ArgumentCaptor<NotificationListener> captor = forClass(NotificationListener.class); | ||
| verify((NotificationEmitter) mockGcBean) | ||
| .addNotificationListener(captor.capture(), isNull(), isNull()); | ||
| listener = captor.getValue(); | ||
|
|
||
| TabularType memoryTabularType = getMemoryTabularType(); | ||
| TabularData memoryBefore = new TabularDataSupport(memoryTabularType); | ||
| TabularData memoryAfter = new TabularDataSupport(memoryTabularType); | ||
|
|
||
| CompositeType gcInfoType = | ||
| new CompositeType( | ||
| "sun.management.BaseGcInfoCompositeType", | ||
| "gcInfo", | ||
| new String[] { | ||
| "id", "startTime", "endTime", "duration", "memoryUsageBeforeGc", "memoryUsageAfterGc" | ||
| }, | ||
| new String[] { | ||
| "id", "startTime", "endTime", "duration", "memoryUsageBeforeGc", "memoryUsageAfterGc" | ||
| }, | ||
| new OpenType<?>[] { | ||
| SimpleType.LONG, | ||
| SimpleType.LONG, | ||
| SimpleType.LONG, | ||
| SimpleType.LONG, | ||
| memoryTabularType, | ||
| memoryTabularType | ||
| }); | ||
|
|
||
| java.util.Map<String, Object> gcInfoMap = new HashMap<>(); | ||
| gcInfoMap.put("id", 0L); | ||
| gcInfoMap.put("startTime", 100L); | ||
| gcInfoMap.put("endTime", 200L); | ||
| gcInfoMap.put("duration", 100L); | ||
| gcInfoMap.put("memoryUsageBeforeGc", memoryBefore); | ||
| gcInfoMap.put("memoryUsageAfterGc", memoryAfter); | ||
|
|
||
| CompositeData notificationData = getGcNotificationData(gcInfoType, gcInfoMap); | ||
|
|
||
| Notification notification = | ||
| new Notification( | ||
| GARBAGE_COLLECTION_NOTIFICATION, mockGcBean, 1, System.currentTimeMillis(), "gc"); | ||
| notification.setUserData(notificationData); | ||
|
|
||
| listener.handleNotification(notification, null); | ||
|
|
||
| MetricSnapshots snapshots = registry.scrape(); | ||
|
|
||
| String expected = | ||
| """ | ||
| {"jvm.gc.duration_bucket","jvm.gc.action"="end of minor GC","jvm.gc.cause"="testCause","jvm.gc.name"="MyGC",le="0.01"} 0 | ||
| {"jvm.gc.duration_bucket","jvm.gc.action"="end of minor GC","jvm.gc.cause"="testCause","jvm.gc.name"="MyGC",le="0.1"} 1 | ||
| {"jvm.gc.duration_bucket","jvm.gc.action"="end of minor GC","jvm.gc.cause"="testCause","jvm.gc.name"="MyGC",le="1.0"} 1 | ||
| {"jvm.gc.duration_bucket","jvm.gc.action"="end of minor GC","jvm.gc.cause"="testCause","jvm.gc.name"="MyGC",le="10.0"} 1 | ||
| {"jvm.gc.duration_bucket","jvm.gc.action"="end of minor GC","jvm.gc.cause"="testCause","jvm.gc.name"="MyGC",le="+Inf"} 1 | ||
| {"jvm.gc.duration_count","jvm.gc.action"="end of minor GC","jvm.gc.cause"="testCause","jvm.gc.name"="MyGC"} 1 | ||
| {"jvm.gc.duration_sum","jvm.gc.action"="end of minor GC","jvm.gc.cause"="testCause","jvm.gc.name"="MyGC"} 0.1 | ||
| """; | ||
|
|
||
| String metrics = convertToOpenMetricsFormat(snapshots); | ||
|
|
||
| assertThat(metrics).contains(expected); | ||
| } | ||
|
|
||
| private TabularType getMemoryTabularType() throws OpenDataException { | ||
| CompositeType memoryUsageType = | ||
| new CompositeType( | ||
| "java.lang.management.MemoryUsage", | ||
| "MemoryUsage", | ||
| new String[] {"init", "used", "committed", "max"}, | ||
| new String[] {"init", "used", "committed", "max"}, | ||
| new OpenType<?>[] {SimpleType.LONG, SimpleType.LONG, SimpleType.LONG, SimpleType.LONG}); | ||
|
|
||
| CompositeType memoryUsageEntryType = | ||
| new CompositeType( | ||
| "memoryUsageEntry", | ||
| "memoryUsageEntry", | ||
| new String[] {"key", "value"}, | ||
| new String[] {"key", "value"}, | ||
| new OpenType<?>[] {SimpleType.STRING, memoryUsageType}); | ||
|
|
||
| return new TabularType( | ||
| "memoryUsageTabular", "memoryUsageTabular", memoryUsageEntryType, new String[] {"key"}); | ||
| } | ||
|
|
||
| private static CompositeData getGcNotificationData( | ||
| CompositeType gcInfoType, Map<String, Object> gcInfoMap) throws OpenDataException { | ||
| CompositeData gcInfoData = new CompositeDataSupport(gcInfoType, gcInfoMap); | ||
|
|
||
| CompositeType notificationType = | ||
| new CompositeType( | ||
| "sun.management.BaseGarbageCollectionNotifInfoCompositeType", | ||
| "GarbageCollectionNotificationInfo", | ||
| new String[] {"gcAction", "gcName", "gcCause", "gcInfo"}, | ||
| new String[] {"gcAction", "gcName", "gcCause", "gcInfo"}, | ||
| new OpenType<?>[] { | ||
| SimpleType.STRING, SimpleType.STRING, SimpleType.STRING, gcInfoType | ||
| }); | ||
|
|
||
| Map<String, Object> notifMap = new HashMap<>(); | ||
| notifMap.put("gcAction", "end of minor GC"); | ||
| notifMap.put("gcName", "MyGC"); | ||
| notifMap.put("gcCause", "testCause"); | ||
| notifMap.put("gcInfo", gcInfoData); | ||
|
|
||
| return new CompositeDataSupport(notificationType, notifMap); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The histogram should include
.unit(Unit.SECONDS)to be consistent with other time-based metrics in this codebase. This is present injvm_gc_collection_seconds(line 62) and other time-based metrics likeprocess_cpu_seconds_totalandjvm_compilation_time_seconds_total.