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

Add metrics to API, update to APIv25 #3692

Merged
merged 7 commits into from Jul 18, 2018
Merged

Conversation

gschueler
Copy link
Member

@gschueler gschueler commented Jul 13, 2018

paths: /api/25/metrics - list of metric hrefs

/api/25/metrics/{metrics,ping,threads,healthcheck} - endpoints

configuration, the servlets must be enabled for each endpoint, plus
api must be enabled for each endpoint

rundeck.web.metrics.servlets.$endpoint.enabled=true
rundeck.api.metrics.$endpoint.enabled=true

TODO:

  • access control?
  • unit tests
  • api functional tests
  • documentation

paths: /api/25/metrics  - list of metric hrefs

/api/25/metrics/{metrics,ping,threads,healthcheck} - endpoints

configuration, the servlets must be enabled for each endpoint, plus
api must be enabled for each endpoint

rundeck.web.metrics.servlets.$endpoint.enabled=true
rundeck.api.metrics.$endpoint.enabled=true
@gschueler gschueler changed the title Add metrics to API, update to APIv25 WIP: Add metrics to API, update to APIv25 Jul 17, 2018
@gschueler gschueler added the needs documentation Requires documentation change to be submitted to the rundeck/docs repo label Jul 17, 2018
@gschueler
Copy link
Member Author

gschueler commented Jul 17, 2018

Previously we had configuration to enable each metrics servlet, like rundeck.web.metrics.servlets.[name].enabled=true/false, however the metrics servlets were not very useful by themselves without API access. Now that I've enabled API access, should that config be replaced with an API specific one, and the previous use of servlets directly be removed? @ahonor

rundeck.metrics.enabled=true/false global metrics toggle
rundeck.metrics.api.enabled=true/false API enabled
rundeck.metrics.api.[name].enabled=true/false selective api
@gschueler
Copy link
Member Author

Documentation pr: rundeck/docs#33

@gschueler gschueler removed the needs documentation Requires documentation change to be submitted to the rundeck/docs repo label Jul 17, 2018
@gschueler gschueler changed the title WIP: Add metrics to API, update to APIv25 Add metrics to API, update to APIv25 Jul 18, 2018
@gschueler gschueler merged commit 6088c8d into master Jul 18, 2018
@gschueler gschueler deleted the feature/metrics-api-endpoints branch July 18, 2018 19:35
@gschueler gschueler added this to the 3.0.0 milestone Jul 18, 2018
@lukasged
Copy link

lukasged commented Aug 2, 2019

by chance, is there a way to enable anonymous access to the /api/25/metrics/healthcheck endpoint?

@monsdar
Copy link

monsdar commented Nov 14, 2023

Late to the party, but as I stranded here from Google others might as well:
Anonymous access to health-check is available at /health now. Docs: https://docs.rundeck.com/rundeck-cloud/administration/cluster/loadbalancer/health-check.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants