Skip to content

Add OxQL example queries to timeseries TOML #7007

Open
@bnaecker

Description

@bnaecker

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions