Document metrics export options in AppConstants by AzazelSensei · Pull Request #11526 · frankframework/frankframework · GitHub
Skip to content

Document metrics export options in AppConstants - #11526

Merged
nielsm5 merged 2 commits into
frankframework:masterfrom
AzazelSensei:docs-6691-metrics-export
Sep 1, 2026
Merged

Document metrics export options in AppConstants#11526
nielsm5 merged 2 commits into
frankframework:masterfrom
AzazelSensei:docs-6691-metrics-export

Conversation

@AzazelSensei

Copy link
Copy Markdown
Contributor

AppConstants already had the export flags, but nothing described how to turn a registry on, where Prometheus is scraped, or what meters go out.

I added that next to the properties. Local stays the default; Prometheus is GET /metrics/prometheus when enabled.

Fixes #6691

Describe how to enable local/prometheus/cloudwatch/statsd/influx/kairos,
the Prometheus scrape path, and which meters are exported.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Great start, it would help if you would document the individual properties as well.
For example this one, the namespace, which defaults to the instance name (lower case).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added comments on the individual properties. namespace defaults to the instance name in lowercase.

@AzazelSensei

Copy link
Copy Markdown
Contributor Author

@nielsm5 nielsm5 changed the title Document metrics export options in AppConstants #6691 Document metrics export options in AppConstants Sep 1, 2026
@nielsm5
nielsm5 enabled auto-merge (squash) September 1, 2026 09:01
@nielsm5
nielsm5 merged commit 251530d into frankframework:master Sep 1, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing documentation on how to configure metrics for observability

2 participants