Skip to content

[BugFix] Emit valid Prometheus # TYPE lines for BE/CN JVM metrics #75240

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
alvin-phoenix-ai merged 1 commit into from
Jun 25, 2026
Merged

[BugFix] Emit valid Prometheus # TYPE lines for BE/CN JVM metrics #75240

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
5 changes: 3 additions & 2 deletions be/src/util/jvm_metrics.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,9 @@ void JVMMetrics::install(MetricRegistry* registry) {
return;
}

#define REGISTER_JVM_METRIC(name, type) \
registry->register_metric("jvm_" #name "_size_bytes{type=\"" #type "\"}", &jvm_##name##_##type##_bytes)
#define REGISTER_JVM_METRIC(name, type) \
registry->register_metric("jvm_" #name "_size_bytes", MetricLabels().add("type", #type), \
&jvm_##name##_##type##_bytes)

REGISTER_JVM_METRIC(heap, used);
REGISTER_JVM_METRIC(heap, committed);
Expand Down
59 changes: 34 additions & 25 deletions be/test/util/jvm_metrics_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,31 +36,40 @@ TEST_F(JVMMetricsTest, normal) {
ASSERT_TRUE(st.ok());
jvm_metrics.install(&registry);

ASSERT_NE(nullptr, registry.get_metric("jvm_heap_size_bytes{type=\"used\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_heap_size_bytes{type=\"committed\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_heap_size_bytes{type=\"max\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_non_heap_size_bytes{type=\"used\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_non_heap_size_bytes{type=\"committed\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_young_size_bytes{type=\"used\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_young_size_bytes{type=\"committed\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_young_size_bytes{type=\"max\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_young_size_bytes{type=\"peak_used\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_young_size_bytes{type=\"peak_max\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_old_size_bytes{type=\"used\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_old_size_bytes{type=\"committed\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_old_size_bytes{type=\"max\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_old_size_bytes{type=\"peak_used\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_old_size_bytes{type=\"peak_max\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_survivor_size_bytes{type=\"used\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_survivor_size_bytes{type=\"committed\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_survivor_size_bytes{type=\"max\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_survivor_size_bytes{type=\"peak_used\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_survivor_size_bytes{type=\"peak_max\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_perm_size_bytes{type=\"used\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_perm_size_bytes{type=\"committed\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_perm_size_bytes{type=\"max\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_perm_size_bytes{type=\"peak_used\"}"));
ASSERT_NE(nullptr, registry.get_metric("jvm_perm_size_bytes{type=\"peak_max\"}"));
// Each JVM gauge is registered under a bare metric name plus a `type` label, so that the
// Prometheus exposition emits one valid `# TYPE <name>` line per name (see issue #75159).
auto type_label = [](const std::string& type) { return MetricLabels().add("type", type); };

ASSERT_NE(nullptr, registry.get_metric("jvm_heap_size_bytes", type_label("used")));
ASSERT_NE(nullptr, registry.get_metric("jvm_heap_size_bytes", type_label("committed")));
ASSERT_NE(nullptr, registry.get_metric("jvm_heap_size_bytes", type_label("max")));
ASSERT_NE(nullptr, registry.get_metric("jvm_non_heap_size_bytes", type_label("used")));
ASSERT_NE(nullptr, registry.get_metric("jvm_non_heap_size_bytes", type_label("committed")));
ASSERT_NE(nullptr, registry.get_metric("jvm_young_size_bytes", type_label("used")));
ASSERT_NE(nullptr, registry.get_metric("jvm_young_size_bytes", type_label("committed")));
ASSERT_NE(nullptr, registry.get_metric("jvm_young_size_bytes", type_label("max")));
ASSERT_NE(nullptr, registry.get_metric("jvm_young_size_bytes", type_label("peak_used")));
ASSERT_NE(nullptr, registry.get_metric("jvm_young_size_bytes", type_label("peak_max")));
ASSERT_NE(nullptr, registry.get_metric("jvm_old_size_bytes", type_label("used")));
ASSERT_NE(nullptr, registry.get_metric("jvm_old_size_bytes", type_label("committed")));
ASSERT_NE(nullptr, registry.get_metric("jvm_old_size_bytes", type_label("max")));
ASSERT_NE(nullptr, registry.get_metric("jvm_old_size_bytes", type_label("peak_used")));
ASSERT_NE(nullptr, registry.get_metric("jvm_old_size_bytes", type_label("peak_max")));
ASSERT_NE(nullptr, registry.get_metric("jvm_survivor_size_bytes", type_label("used")));
ASSERT_NE(nullptr, registry.get_metric("jvm_survivor_size_bytes", type_label("committed")));
ASSERT_NE(nullptr, registry.get_metric("jvm_survivor_size_bytes", type_label("max")));
ASSERT_NE(nullptr, registry.get_metric("jvm_survivor_size_bytes", type_label("peak_used")));
ASSERT_NE(nullptr, registry.get_metric("jvm_survivor_size_bytes", type_label("peak_max")));
ASSERT_NE(nullptr, registry.get_metric("jvm_perm_size_bytes", type_label("used")));
ASSERT_NE(nullptr, registry.get_metric("jvm_perm_size_bytes", type_label("committed")));
ASSERT_NE(nullptr, registry.get_metric("jvm_perm_size_bytes", type_label("max")));
ASSERT_NE(nullptr, registry.get_metric("jvm_perm_size_bytes", type_label("peak_used")));
ASSERT_NE(nullptr, registry.get_metric("jvm_perm_size_bytes", type_label("peak_max")));

// Regression guard for #75159: the label must NOT be baked into the metric name. If it were,
// the `# TYPE` line would contain `{...}` and break the entire Prometheus scrape.
ASSERT_EQ(nullptr, registry.get_metric("jvm_heap_size_bytes{type=\"used\"}"));
ASSERT_EQ(nullptr, registry.get_metric("jvm_perm_size_bytes{type=\"peak_max\"}"));

registry.trigger_hook();

Expand Down
Loading