metrics-export-role: update information
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: metrics-export-role
Since: 0.2.0
Audience/target: customers
Root document: where to add or update documentation
SME: @themilchenko
Details
Since 0.2.0 version a few features were introduced that was forgotten to update in doc:
- Latency observation for http endpoint.
- Integration with
httpdrole. - Support TLS with
listenparameter. - Integration with
Graphite.
All examples and definitions can be found in README of module.
Planning checklist
-
metrics.enabledoption; - write up about integration with
httpdrole; - TLS with
listenparameter; - Graphite integration.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the monitoring getting_started document linked as the root document, then compare its metrics-export-role content with the module README sections on latency observation, httpd, TLS listen, Graphite, and metrics.enabled. Update the documentation with the missing definitions and examples, and confirm every item in the planning checklist is covered.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100