Skip to content

Set up Flink to report metrics via Prometheus #678

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
merged 2 commits into from
Apr 22, 2025
Merged

Set up Flink to report metrics via Prometheus #678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
086fa80
Set up Flink to report metrics via Prometheus
piyush-zlai Apr 21, 2025
aaffc96
style: Apply scalafix and scalafmt changes
piyush-zlai Apr 21, 2025
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
9 changes: 8 additions & 1 deletion cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/DataprocSubmitter.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,14 @@ class DataprocSubmitter(jobControllerClient: JobControllerClient, conf: Submitte
// override the local dir for rocksdb as the default ends up being too large file name size wise
"state.backend.rocksdb.localdir" -> "/tmp/flink-state",
"state.checkpoint-storage" -> "filesystem",
"rest.flamegraph.enabled" -> "true"
"rest.flamegraph.enabled" -> "true",
// wire up prometheus reporter - prom reporter plays well with Google ops agent that can be installed in DataProc
// as we can have a couple of containers on a given node, we use a port range
"metrics.reporters" -> "prom",
"metrics.reporter.prom.factory.class" -> "org.apache.flink.metrics.prometheus.PrometheusReporterFactory",
"metrics.reporter.prom.host" -> "localhost",
"metrics.reporter.prom.port" -> "9250-9260",
"metrics.reporter.statsd.interval" -> "60 SECONDS"
Comment on lines +151 to +155
Copy link
Contributor

@coderabbitai coderabbitai bot Apr 21, 2025

Choose a reason for hiding this comment

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

💡 Verification agent

❓ Verification inconclusive

Added Prometheus metrics configuration.

The configuration properly enables Prometheus metrics reporting with appropriate settings for host and port range.

Is the StatsD reporting interval (line 155) intended to be used alongside Prometheus? If so, verify that metrics.reporters should include both reporters:

🏁 Script executed:

#!/bin/bash
# Check if StatsDreporter is imported or used anywhere
rg -A 2 -B 2 "StatsDReporter" --glob "*.{scala,java}"

# Check if metrics.reporters setting includes statsd in any other files
rg "metrics\.reporters.*statsd" --glob "*.{scala,java,properties,yaml,conf}"

Length of output: 132

Unintended StatsD interval remains without StatsD reporter
The "metrics.reporter.statsd.interval" setting is inert because only Prometheus is enabled. Either remove the StatsD interval line or explicitly add and import a StatsD reporter.

• File: cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/DataprocSubmitter.scala (lines 151–155)
• Action:
- Remove the "metrics.reporter.statsd.interval" entry if you don’t plan to use StatsD,
- OR add "statsd" to the "metrics.reporters" list and import/instantiate the StatsD reporter class.

)

val flinkJobBuilder = FlinkJob
Expand Down
1 change: 1 addition & 0 deletions flink/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ scala_library(
maven_artifact("org.apache.hadoop:hadoop-client-api"),
maven_artifact("org.apache.hadoop:hadoop-yarn-api"),
maven_artifact("org.apache.commons:commons-lang3"),
maven_artifact("org.apache.flink:flink-metrics-prometheus"),
],
)

Expand Down
40 changes: 38 additions & 2 deletions maven_install.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"__AUTOGENERATED_FILE_DO_NOT_MODIFY_THIS_FILE_MANUALLY": "THERE_IS_NO_DATA_ONLY_ZUUL",
"__INPUT_ARTIFACTS_HASH": -1077230992,
"__RESOLVED_ARTIFACTS_HASH": 1195036016,
"__INPUT_ARTIFACTS_HASH": -1448107542,
"__RESOLVED_ARTIFACTS_HASH": -193250516,
"artifacts": {
"ant:ant": {
"shasums": {
Expand Down Expand Up @@ -2828,6 +2828,13 @@
},
"version": "1.17.0"
},
"org.apache.flink:flink-metrics-prometheus": {
"shasums": {
"jar": "0e1cbd8a012fd7d8588117e82d6bfde7bf0d138c9766e561b2d806b8dc92a9e2",
"sources": "a6dbcb2de09ae49f593ad654d92ec2bca809de96b9e79a90328f5fff9e6204a0"
},
"version": "1.17.0"
},
"org.apache.flink:flink-optimizer": {
"shasums": {
"jar": "0ee4fedac51b4e811fa0f30065b1b3ff7c2eff84f208df5f946ae6c58b2f5736",
Expand Down Expand Up @@ -7136,6 +7143,11 @@
"io.dropwizard.metrics:metrics-core",
"org.slf4j:slf4j-api"
],
"org.apache.flink:flink-metrics-prometheus": [
"com.google.code.findbugs:jsr305",
"org.apache.flink:flink-shaded-force-shading",
"org.slf4j:slf4j-api"
],
"org.apache.flink:flink-optimizer": [
"com.google.code.findbugs:jsr305",
"org.apache.flink:flink-core",
Expand Down Expand Up @@ -13699,6 +13711,12 @@
"org.apache.flink.dropwizard",
"org.apache.flink.dropwizard.metrics"
],
"org.apache.flink:flink-metrics-prometheus": [
"io.prometheus.client",
"io.prometheus.client.exporter",
"io.prometheus.client.exporter.common",
"org.apache.flink.metrics.prometheus"
],
"org.apache.flink:flink-optimizer": [
"org.apache.flink.optimizer",
"org.apache.flink.optimizer.costs",
Expand Down Expand Up @@ -24586,6 +24604,8 @@
"org.apache.flink:flink-metrics-core:jar:sources",
"org.apache.flink:flink-metrics-dropwizard",
"org.apache.flink:flink-metrics-dropwizard:jar:sources",
"org.apache.flink:flink-metrics-prometheus",
"org.apache.flink:flink-metrics-prometheus:jar:sources",
"org.apache.flink:flink-optimizer",
"org.apache.flink:flink-optimizer:jar:sources",
"org.apache.flink:flink-queryable-state-client-java",
Expand Down Expand Up @@ -26016,6 +26036,8 @@
"org.apache.flink:flink-metrics-core:jar:sources",
"org.apache.flink:flink-metrics-dropwizard",
"org.apache.flink:flink-metrics-dropwizard:jar:sources",
"org.apache.flink:flink-metrics-prometheus",
"org.apache.flink:flink-metrics-prometheus:jar:sources",
"org.apache.flink:flink-optimizer",
"org.apache.flink:flink-optimizer:jar:sources",
"org.apache.flink:flink-queryable-state-client-java",
Expand Down Expand Up @@ -27446,6 +27468,8 @@
"org.apache.flink:flink-metrics-core:jar:sources",
"org.apache.flink:flink-metrics-dropwizard",
"org.apache.flink:flink-metrics-dropwizard:jar:sources",
"org.apache.flink:flink-metrics-prometheus",
"org.apache.flink:flink-metrics-prometheus:jar:sources",
"org.apache.flink:flink-optimizer",
"org.apache.flink:flink-optimizer:jar:sources",
"org.apache.flink:flink-queryable-state-client-java",
Expand Down Expand Up @@ -29969,6 +29993,18 @@
"org.apache.flink.util.TestLoggerExtension"
]
},
"org.apache.flink:flink-metrics-prometheus": {
"org.apache.flink.metrics.reporter.MetricReporterFactory": [
"org.apache.flink.metrics.prometheus.PrometheusPushGatewayReporterFactory",
"org.apache.flink.metrics.prometheus.PrometheusReporterFactory"
]
},
"org.apache.flink:flink-metrics-prometheus:jar:sources": {
"org.apache.flink.metrics.reporter.MetricReporterFactory": [
"org.apache.flink.metrics.prometheus.PrometheusPushGatewayReporterFactory",
"org.apache.flink.metrics.prometheus.PrometheusReporterFactory"
]
},
"org.apache.flink:flink-rpc-akka-loader": {
"org.apache.flink.runtime.rpc.RpcSystemLoader": [
"org.apache.flink.runtime.rpc.akka.AkkaRpcSystemLoader"
Expand Down
1 change: 1 addition & 0 deletions tools/build_rules/dependencies/maven_repository.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ maven_repository = repository(

# Flink
"org.apache.flink:flink-metrics-dropwizard:1.17.0",
"org.apache.flink:flink-metrics-prometheus:1.17.0",
"org.apache.flink:flink-clients:1.17.0",
"org.apache.flink:flink-yarn:1.17.0",
"org.apache.flink:flink-runtime:1.17.0",
Expand Down