Skip to content

Fix NPE in sanitizeMetricName when unit or aggregationTemporality is … #6687

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

Merged
dlvenable merged 6 commits into from
Apr 2, 2026
Merged

Fix NPE in sanitizeMetricName when unit or aggregationTemporality is … #6687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
572a745
Fix NPE in sanitizeMetricName when unit or aggregationTemporality is …
srikanthpadakanti Mar 30, 2026
4105386
Merge remote-tracking branch 'upstream/main' into prometheus-sink-npe…
srikanthpadakanti Mar 31, 2026
204e984
Add test for counter Sum metric with null unit
srikanthpadakanti Mar 31, 2026
cd7d133
Merge remote-tracking branch 'upstream/main' into prometheus-sink-npe…
srikanthpadakanti Mar 31, 2026
dae7fb7
Merge remote-tracking branch 'upstream/main' into prometheus-sink-npe…
srikanthpadakanti Mar 31, 2026
3786679
Move null unit check to top of sanitizeMetricName
srikanthpadakanti Mar 31, 2026
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
6 changes: 5 additions & 1 deletion ...java/org/opensearch/dataprepper/plugins/sink/prometheus/service/PrometheusTimeSeries.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,11 +302,15 @@ static String sanitizeMetricName(final Metric metric) {
final boolean isGauge = metric.getKind().equals(Metric.KIND.GAUGE.toString());
final boolean isCounter = metric.getKind().equals(Metric.KIND.SUM.toString()) &&
((Sum) metric).isMonotonic() &&
((Sum) metric).getAggregationTemporality().equals("AGGREGATION_TEMPORALITY_CUMULATIVE");
"AGGREGATION_TEMPORALITY_CUMULATIVE".equals(((Sum) metric).getAggregationTemporality());
Comment thread
srikanthpadakanti marked this conversation as resolved.

StringBuilder metricNameBuilder = new StringBuilder(sanitizeName(name, true, false));
String suffix = isCounter ? TOTAL_SUFFIX : "";

if (unit == null) {
return metricNameBuilder.append(suffix).toString();
}

if (unit.startsWith("{")) {
return metricNameBuilder.append(suffix).toString();
}
Expand Down
33 changes: 33 additions & 0 deletions .../org/opensearch/dataprepper/plugins/sink/prometheus/service/PrometheusTimeSeriesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

import org.apache.commons.lang3.RandomStringUtils;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
Expand Down Expand Up @@ -187,6 +188,38 @@ public void testHistogramMetricKey(String unit, String expectedUnitName) throws
assertTrue(timeSeries.getMetricKey().equals(expectedKey1) || timeSeries.getMetricKey().equals(expectedKey2));
}

@Test
public void testSumMetricWithNullAggregationTemporality() {
final String name = RandomStringUtils.randomAlphabetic(10);
Sum sum = createSumMetric(name, "s", true, null);
String sanitizedName = PrometheusTimeSeries.sanitizeMetricName(sum);
assertThat(sanitizedName, equalTo(name + "_seconds"));
}

@Test
public void testGaugeMetricWithNullUnit() {
final String name = RandomStringUtils.randomAlphabetic(10);
Gauge gauge = createGaugeMetric(name, null);
String sanitizedName = PrometheusTimeSeries.sanitizeMetricName(gauge);
assertThat(sanitizedName, equalTo(name));
}

@Test
public void testSumMetricCounterWithNullUnit() {
final String name = RandomStringUtils.randomAlphabetic(10);
Sum sum = createSumMetric(name, null, true, "AGGREGATION_TEMPORALITY_CUMULATIVE");
String sanitizedName = PrometheusTimeSeries.sanitizeMetricName(sum);
assertThat(sanitizedName, equalTo(name + "_total"));
}

@Test
public void testSumMetricWithNullUnitAndNullAggregationTemporality() {
final String name = RandomStringUtils.randomAlphabetic(10);
Sum sum = createSumMetric(name, null, true, null);
String sanitizedName = PrometheusTimeSeries.sanitizeMetricName(sum);
assertThat(sanitizedName, equalTo(name));
}

private Summary createSummaryMetric(final String name, final String unit) {
List<Quantile> quantiles = Arrays.asList(
new DefaultQuantile(0.5d, 10d),
Expand Down
Loading