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

Improve Metrics Exporter #5

Open
7 tasks
viral32111 opened this issue Jul 10, 2023 · 0 comments
Open
7 tasks

Improve Metrics Exporter #5

viral32111 opened this issue Jul 10, 2023 · 0 comments
Assignees
Labels
Enhancement New feature or request.
Milestone

Comments

@viral32111
Copy link
Owner

Improve the Prometheus Metrics Exporter with the new options below.

Remove the metrics command too:

Do not give any commands to act as a daemon, useful for exporting metrics & serving requests from the JSON API.

Proposed CLI flags including types, defaults & usage:

  • [--metrics-address <string (def. '127.0.0.1')>] - The IP address to listen on for the HTTP Prometheus metrics exporter.
  • [--metrics-port <number (def. 5000)>] - The port number to listen on for the HTTP Prometheus metrics exporter.
    • Can serve on the same port as the JSON API (--api-port).
    • Set to 0 to disable the metrics exporter.
  • [--metrics-path <string (def. '/metrics')>] - The HTTP path to the metrics page.
    • If serving on the same port as the JSON API, ensure this is not the same as an API route.
  • [-u/--metrics-authentication <string>] - Colon separated username & password for HTTP basic authentication.
    • Authentication is disabled if this is not given, allowing unrestricted access.
  • [-i/--metrics-interval <number (def. 15)>] - The time in seconds to wait between collecting metrics.
  • [--disable-metrics-logging] - Disables logging of metrics collection and HTTP requests/responses to the console.
  • [--metrics-log-file <string (def. 'metrics.log')>] - The path to a file to log metrics collection and HTTP requests/responses to.
    • Leave blank or set to /dev/null to disable logging to file.
@viral32111 viral32111 added the Enhancement New feature or request. label Jul 10, 2023
@viral32111 viral32111 added this to the 2.0.0 milestone Jul 10, 2023
@viral32111 viral32111 self-assigned this Jul 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request.
Projects
Status: To Do
Development

No branches or pull requests

1 participant