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

Document new version of Health Check extension #4659

Open
tiffany76 opened this issue Jun 11, 2024 · 0 comments
Open

Document new version of Health Check extension #4659

tiffany76 opened this issue Jun 11, 2024 · 0 comments

Comments

@tiffany76
Copy link
Contributor

Desired feature or idea: The Health Check extension is currently under redevelopment. Once the new extension is released, we should document it on the Troubleshooting page of the website.

Collector-Contrib issues and PR to track progress of redevelopment:

Additional context: See this comment for related discussion.

The following documentation refers to the old Health Check extension and is pasted here for reference. It is not included on the website.

Health Check

The Health Check extension, which by default is available on all interfaces on port 13133, can be used to ensure the Collector is functioning properly. For example:

extensions:
  health_check:
service:
  extensions: [health_check]

It returns a response like the following:

{
  "status": "Server available",
  "upSince": "2020-11-11T04:12:31.6847174Z",
  "uptime": "49.0132518s"
}

cc: @mwear (just FYI)

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

No branches or pull requests

2 participants