NIFI-15351 Show NiFi build information in Prometheus metrics #10655

agturley · 2025-12-17T03:09:22Z

Summary

NIFI-15351

Tracking

Please complete the following tracking steps prior to pull request creation.

Issue Tracking

Apache NiFi Jira issue created

Pull Request Tracking

Pull Request title starts with Apache NiFi Jira issue number, such as NIFI-00000
Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-00000

Pull Request Formatting

Pull Request based on current revision of the main branch
Pull Request refers to a feature branch with one commit containing changes

Verification

Please indicate the verification steps performed prior to pull request creation.

Build

Build completed using ./mvnw clean install -P contrib-check
- JDK 21
- JDK 25

Licensing

New dependencies are compatible with the Apache License 2.0 according to the License Policy
New dependencies are documented in applicable LICENSE and NOTICE files

Documentation

Documentation formatting appears as expected in rendered files

dan-s1 · 2025-12-17T19:32:06Z

@agturley Thanks for the contribution. In the scan build there is the following error

Warning:  PMD Failure: org.apache.nifi.prometheusutil.VersionInfoRegistry:75 Rule:EmptyCatchBlock Priority:3 Avoid empty catch blocks.
Error:  Failed to execute goal org.apache.maven.plugins:maven-pmd-plugin:3.28.0:check (default-cli) on project nifi-web-api: PMD 7.19.0 has found 1 violation.

and in the Validate build there is the following errors
Error: Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.6.0:check (check-style) on project nifi-web-api: You have 15 Checkstyle violations.

These errors must be fixed before this PR can be accepted.

agturley · 2025-12-18T14:08:04Z

Hopefully I addressed the build errors. Thanks!

.../nifi-web/nifi-web-api/src/main/java/org/apache/nifi/prometheusutil/VersionInfoRegistry.java

dan-s1 · 2025-12-18T16:42:29Z

.../nifi-web/nifi-web-api/src/main/java/org/apache/nifi/prometheusutil/VersionInfoRegistry.java

+            LOGGER.debug("Could not retrieve NiFi bundle details for version info metric: {}", e.getMessage());
+        }


Stack trace may be helpful

Suggested change

LOGGER.debug("Could not retrieve NiFi bundle details for version info metric: {}", e.getMessage());

}

LOGGER.debug("Could not retrieve NiFi bundle details for version info metric", e);

}

agturley · 2025-12-18T19:31:11Z

added license block and added stack trace to debug message

exceptionfactory

Thanks for this addition @agturley. The basic approach looks good, I recommended a few adjustments.

exceptionfactory · 2025-12-20T03:24:21Z

.../nifi-web/nifi-web-api/src/main/java/org/apache/nifi/prometheusutil/VersionInfoRegistry.java

+    public static class VersionDetails {
+
+        public final String nifiVersion;
+        public final String revision;
+        public final String tag;
+        public final String buildBranch;
+        public final String javaVersion;
+        public final String javaVendor;
+        public final String osVersion;
+        public final String osName;
+        public final String osArchitecture;


Instead of a class with public variables, this should be a record.

.../nifi-web/nifi-web-api/src/main/java/org/apache/nifi/prometheusutil/VersionInfoRegistry.java

exceptionfactory · 2025-12-20T03:30:01Z

...ifi-web/nifi-web-api/src/main/java/org/apache/nifi/prometheusutil/PrometheusMetricsUtil.java

+    // 1. Retrieve the calculated version details
+    final VersionInfoRegistry.VersionDetails details = versionInfoRegistry.getVersionDetails();
+    versionInfoRegistry.setDataPoint(1, "NIFI_VERSION_INFO", instanceId,
+        details.nifiVersion, details.javaVersion, details.revision, details.tag,
+        details.buildBranch, details.osName, details.osVersion, details.osArchitecture, details.javaVendor);
+}


It looks like this block needs to be indented.

agturley · 2025-12-20T16:48:46Z

made the requested changes. I also changed the the actual output from "nifi_version" to "framework_version". Should I change this back or leave it as-is.

pvillard31

Please make sure to fix the checkstyle issues:

Warning:  src/main/java/org/apache/nifi/prometheusutil/VersionInfoRegistry.java:[26,8] (imports) UnusedImports: Unused import - java.util.Objects.
Warning:  src/main/java/org/apache/nifi/prometheusutil/VersionInfoRegistry.java:[33,47] (whitespace) WhitespaceAfter: ',' is not followed by whitespace.
Warning:  src/main/java/org/apache/nifi/prometheusutil/VersionInfoRegistry.java:[56] (regexp) RegexpSinglelineJava: Line has trailing whitespace.
Warning:  src/main/java/org/apache/nifi/prometheusutil/VersionInfoRegistry.java:[67,7] (whitespace) WhitespaceAround: '{' is not followed by whitespace.
Warning:  src/main/java/org/apache/nifi/prometheusutil/VersionInfoRegistry.java:[67,8] (whitespace) WhitespaceAround: '}' is not preceded with whitespace.

You can confirm everything is ok by building locally the nifi-web-api module using mvn clean install -Pcontrib-check

exceptionfactory · 2025-12-23T20:01:06Z

made the requested changes. I also changed the the actual output from "nifi_version" to "framework_version". Should I change this back or leave it as-is.

Thanks, that renaming looks good.

This looks closer to completion, but needs to resolve the Checkstyle warnings.

agturley · 2025-12-29T18:25:26Z

compliance tests are passing now. let me know if there is anything else missed. Thanks!

exceptionfactory

Thanks for the updates @agturley.

Recent changes to the repository configuration require commits to be signed. The Contributor Guide now includes a section on enabling commit signing with links to configuring Git and registering your key in GitHub.

If you can follow those steps, you can squash the commits in this branch, then force-push an update with the signed commits to prepare this for final review.

.../nifi-web/nifi-web-api/src/main/java/org/apache/nifi/prometheusutil/VersionInfoRegistry.java

...ifi-web/nifi-web-api/src/main/java/org/apache/nifi/prometheusutil/PrometheusMetricsUtil.java

agturley · 2025-12-30T14:54:56Z

Pushed the requested changes. Please let me know if there is anything else.

pvillard31

+1, merging, taking care of the checkstyle/PMD issue as part of the merge

dan-s1 reviewed Dec 18, 2025

View reviewed changes

exceptionfactory requested changes Dec 20, 2025

View reviewed changes

agturley requested a review from exceptionfactory December 20, 2025 16:48

pvillard31 requested changes Dec 23, 2025

View reviewed changes

agturley requested a review from pvillard31 December 27, 2025 00:01

exceptionfactory reviewed Dec 29, 2025

View reviewed changes

agturley force-pushed the NIFI-15351 branch from 781632b to 8a8892e Compare December 29, 2025 22:32

agturley requested a review from exceptionfactory December 30, 2025 02:54

pvillard31 requested changes Dec 30, 2025

View reviewed changes

.../nifi-web/nifi-web-api/src/main/java/org/apache/nifi/prometheusutil/VersionInfoRegistry.java Outdated Show resolved Hide resolved

...ifi-web/nifi-web-api/src/main/java/org/apache/nifi/prometheusutil/PrometheusMetricsUtil.java Outdated Show resolved Hide resolved

agturley force-pushed the NIFI-15351 branch 2 times, most recently from ac046f7 to 70fe04c Compare December 30, 2025 14:44

NIFI-15351 Show NiFi build information in Prometheus metrics

072e867

agturley force-pushed the NIFI-15351 branch from 70fe04c to 072e867 Compare December 30, 2025 14:51

pvillard31 approved these changes Dec 30, 2025

View reviewed changes

pvillard31 closed this in 5699759 Dec 30, 2025

		LOGGER.debug("Could not retrieve NiFi bundle details for version info metric: {}", e.getMessage());
		}

NIFI-15351 Show NiFi build information in Prometheus metrics #10655

NIFI-15351 Show NiFi build information in Prometheus metrics #10655

Uh oh!

Conversation

agturley commented Dec 17, 2025 • edited by dan-s1 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Tracking

Issue Tracking

Pull Request Tracking

Pull Request Formatting

Verification

Build

Licensing

Documentation

Uh oh!

dan-s1 commented Dec 17, 2025

Uh oh!

agturley commented Dec 18, 2025

Uh oh!

Uh oh!

dan-s1 Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

agturley commented Dec 18, 2025

Uh oh!

exceptionfactory left a comment

Choose a reason for hiding this comment

Uh oh!

exceptionfactory Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

exceptionfactory Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

agturley commented Dec 20, 2025

Uh oh!

pvillard31 left a comment

Choose a reason for hiding this comment

Uh oh!

exceptionfactory commented Dec 23, 2025

Uh oh!

agturley commented Dec 29, 2025

Uh oh!

exceptionfactory left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

agturley commented Dec 30, 2025

Uh oh!

pvillard31 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

agturley commented Dec 17, 2025 •

edited by dan-s1

Loading

exceptionfactory left a comment •

edited

Loading