oxidecomputer / oxidecomputer/omicron
Add OxQL example queries to timeseries TOML
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
Our timeseries definitions live in a bunch of TOML files in oximeter/oximeter/schema. These include names, types, and descriptions for everything, which is really useful. I've also started a WIP to generate a docs page based on these definitions, to ensure we keep those in sync and have better discoverability.
In a similar vein, it would be very nice to include some example OxQL queries in this file as well. This could be a free-form text key that has examples or any other usage guidance the owner of the timeseries finds relevant. We could also add some more structure to it, but there's not an obvious need for that right now.
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 reviewing the TOML definitions under oximeter/oximeter/schema and the WIP docs-page generation work mentioned in the issue. Determine how example OxQL queries or usage guidance should be represented and carried into generated documentation. Done means the schema can hold the added guidance and the generated docs expose it while remaining synchronized.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100