Document telemetry usage and configuration in DEVELOPER_GUIDE.md
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation, observability-sre
Research direction
Update DEVELOPER_GUIDE.md using osbenchmark/telemetry.py as the source of truth. First inspect the telemetry devices, their defaults and requirements, then document configuration through telemetry.devices and the extension path. Done means the guide covers the requested devices, enablement rules, provisioning requirements, and how contributors add devices.
Written by the indexing model from the issue text.
Description
Summary
DEVELOPER_GUIDE.md covers environment setup, testing, and contributing workflow, but does
not describe Solr Orbit's telemetry system.
What's needed
Add a section to DEVELOPER_GUIDE.md that covers:
- The available telemetry devices and what each measures (JVM, node stats, collection stats,
query stats, indexing stats, cache stats, segment stats, shard stats, etc.) - Which devices are always-on vs. opt-in
- Which devices require a provisioned (managed) Solr vs. an external cluster
- How to enable/disable devices via the
telemetry.devicesparameter in a track/workload - How to extend or add new telemetry devices
Why
New contributors and users are left to read the source in osbenchmark/telemetry.py to
understand what telemetry is collected — this should be documented at the guide level.
- Dominant language
- Python
- Stars
- 3
- Forks
- 5
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 8
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.
More from apache/solr-orbit
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
apache/solr-orbit#34 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
apache/solr-orbit#79 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 64/100
apache/solr-orbit#45 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
apache/solr-orbit#13 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
apache/solr-orbit#12 ·
All issues in apache/solr-orbit
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100