temporalio / temporalio/sdk-java
Provide default implementation of Prometheus scrape endpoint
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 433
- Forks
- 249
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 26
Description
Is your feature request related to a problem? Please describe.
Right now users who want to export metrics into Prometheus have to implement a scrape endpoint to publish metrics from micrometer reporter following one of the ways described here: https://tanzu.vmware.com/developer/learningpaths/application-observability/exposing-metrics-java-prometheus/
Describe the solution you'd like
For the convenience of users, Temporal JavaSDK should have a built-in implementation of a scrape endpoint for prometheus. This endpoint should allow port/url configuration to be passed to avoid any port conflicts with other instances of scraping endpoints that may be running on the host.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Java SDK's micrometer reporter and reviewing how users currently expose its metrics; the issue names no file or test entry point. Define the configurable Prometheus scrape endpoint and port or URL behavior, then verify that metrics can be scraped without conflicting with another endpoint.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, prometheus
- Domain
- observability
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100