[Docs] Document telemetry pkg(s) & best practices - Githubissues

pokt-network / poktroll

The official Shannon upgrade implementation of the Pocket Network Protocol implemented using the Cosmos SDK

MIT License

15 stars 8 forks source link

[Docs] Document telemetry pkg(s) & best practices #638

Closed bryanchriswhite closed 3 months ago

bryanchriswhite commented 4 months ago

Objective

Document current thinking regarding best practices around telemetry calls.

Origin Document

Goals

Establish best practices for telemetry API usage
Document examples of different kinds of telemetry objects.

Deliverables

[ ] A PR that adds any missing godoc comments (pkg-level too).
[ ] A PR that adds the initial docs regarding telemetry best practices. Should reference godocs.

Non-goals / Non-deliverables

Expanding the telemetry API.
Refactoring existing telemetry API usage.

General deliverables

[ ] Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
[ ] Testing: Add new tests (unit and/or E2E) to the test suite.
[ ] Makefile: Add new targets to the Makefile to make the new functionality easier to use.
[ ] Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @bryanchriswhite