Skip to content
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.

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

Prometheus Metrics #62

Open
codello opened this issue Sep 9, 2023 · 0 comments
Open

Prometheus Metrics #62

codello opened this issue Sep 9, 2023 · 0 comments
Labels
non essential Low priority issue proposal A Karman feature proposal status/draft A proposal that is still being drafted
Milestone

Comments

@codello
Copy link
Contributor

codello commented Sep 9, 2023

What feature do you want to propose?

The API server should expose metrics in a prometheus compatible format.

Why does Karman need this feature?

Prometheus metrics are a standardized way for applications to provide observability. The /healthz endpoint does not provide an adequate level of detail.

How do users access the feature?

Server admins should be able to decide whether to run the metrics on the same port as the API or a different port. By default the metrics should be available on :9090/metrics. The /metrics path should probably be configurable as well.

Additional context

  • The asynq library provides an example how to implement some metrics.
  • There are probably metrics packages for pgx
  • Karman should also provide custom metrics about the library.

Implementation Considerations

This issue does not affect the frontend.

@codello codello added non essential Low priority issue proposal A Karman feature proposal status/draft A proposal that is still being drafted labels Sep 9, 2023
@codello codello added this to the Version 0.2 milestone Sep 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
non essential Low priority issue proposal A Karman feature proposal status/draft A proposal that is still being drafted
Projects
None yet
Development

No branches or pull requests

1 participant