Product monitoring: Create concepts page

Open
#331 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
58/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
prometheus
Domain
documentation, observability

Research direction

Start with the existing monitoring page at docs.stackable.tech/home/stable/operators/monitoring/ and review its current guidance. Expand it with Prometheus screenshots, a link to the monitoring stack, and the recommendation to deploy a Prometheus ServiceMonitor; done means the setup and automatic metrics collection are clearly explained.

Written by the indexing model from the issue text.

Description

We should document that we recommend a Prometheus Servicemonitor and point to the monitoring stack.
Mention that we label all Services accordingly, so users only need to deploy a Servicemonitor and get all metrics instantly.
Provide some nice screenshots from Prometheus

This is mostly done on https://docs.stackable.tech/home/stable/operators/monitoring/
Expand it with

  • some screenshots from Prometheus
  • link to the monitoring stack to showcase the setup
Dominant language
CSS
Stars
13
Forks
14
Avg merge
4d 8h
Merged PRs (30d)
10

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from stackabletech/documentation

All issues in stackabletech/documentation

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.