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

docs: Metrics, Logging and Prometheus #566

Open
illume opened this issue Feb 2, 2022 · 0 comments
Open

docs: Metrics, Logging and Prometheus #566

illume opened this issue Feb 2, 2022 · 0 comments

Comments

@illume
Copy link
Contributor

illume commented Feb 2, 2022

Description

We're lacking documentation on setting up and using metrics/logging/prometheus.

Impact

It's not clear how metrics and logging works, what it can do for people, or if it's working as expected.

Environment and steps to reproduce

cd docs/
$ cat metrics.md
cat: metrics.md: No such file or directory

Expected behavior

Looking at metrics.md should show me how to set it up, how to use it, and tell me what information I can see in there.

Maybe we should have a separate doc section on logging and Prometheus?

Additional information

Information about metrics is in these files, and also in some closed PRs.

Some other open questions:

  • is information from our home page also exported as a metric?
  • what's important to alert on?
  • is there any logging useful for general maintenance?
@illume illume changed the title docs: Metrics and prometheus docs: Metrics, Logging and Prometheus Feb 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant