Add metrics ingestion documentation

giantswarm / docs

The Giant Swarm documentation site

http://docs.giantswarm.io

Apache License 2.0

4 stars 8 forks source link

Add metrics ingestion documentation #2247

Closed QuentinBisson closed 3 months ago

QuentinBisson commented 4 months ago

What this PR does / why we need it

Closes https://github.com/giantswarm/roadmap/issues/3517 this PR explains to all our customers how they can start ingesting metrics in the Giant Swarm Observability Platform using ServiceMonitors.

Things to check/remember before submitting

If you made content changes
- Run make dev to render and proofread content changes locally.
- Bump last_review_date in the front matter header if you reviewed the entire page.

marians commented 4 months ago

Formatting nitpicks incoming

A note on code literal formatting with backticks. These are meant to be used in order to highlight a word that has to be used in this exact spelling, like the name of a CLI to execute, or the exact string value to use somewhere.

You are using them in places where there is no need. For example, the name of a CRD in the middle of a text needs no formatting. Likewise, a phrase like "agent mode". If you want to make "agent mode" stand out a bit, you can use italics (underscore wrapper).

QuentinBisson commented 4 months ago

Thanks a lot, i'll update the Doc on monday with the remaining feedback :)