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

[Feature] Expose OIDC server status via monitoring #1940

Open
2 tasks done
viq opened this issue May 14, 2024 · 0 comments
Open
2 tasks done

[Feature] Expose OIDC server status via monitoring #1940

viq opened this issue May 14, 2024 · 0 comments
Labels
enhancement New feature or request needs design doc

Comments

@viq
Copy link

viq commented May 14, 2024

Use case

This would allow easy checking of what headscale thinks of availability of the OIDC server, and to set up alerting based on such.

Description

Currently if the OIDC server is not available, headscale (if configured to do so) will switch to "standard" mode, and emit a message in logs. But if someone doesn't look at logs constantly, the only warning about this will be when registering a new machine instead of getting redirected to OIDC login, one will get the information about commands to run on server.

Headscale already has support for exposing some of internal information to prometheus. It would be great if this information was available there as well.

Contribution

  • I can write the design doc for this feature
  • I can contribute this feature

How can it be implemented?

Possibly metrics like headscale_oidc_configured or headscale_oidc_info with some information about the configured OIDC server, if any, and headscale_oidc_functional with 0 or 1 depending what the internal checks show.

@viq viq added the enhancement New feature or request label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request needs design doc
Projects
None yet
Development

No branches or pull requests

2 participants