newrelic / newrelic/newrelic-telemetry-sdk-python
Document common field usage as instance of telemetry type.
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 42
- Forks
- 28
- PR merge metrics
- No merged PRs in 30d
Description
The common field is expected to be an instance of the telemetry type that's being sent. For example, sending a batch of Span means that the common field is an instance of Span where every field is optional.
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 by locating the documentation for the common field and telemetry types in the repository. Document that the field is an instance of the telemetry type being sent, using a batch of Span as the example and noting that every field is optional; the work is done when this usage is clearly explained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100