prometheus/prometheus

Provide JSON Schemas for Config YAML

Offen

#8.511 geöffnet am 17.02.2021

 (2 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)Go (10.408 Forks)batch import
component/configcomponent/documentationhelp wantedkind/featurepriority/P3

Repository-Metriken

Stars
 (64.042 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Proposal

Provide a json schema for the config yaml (ideally as a released/documentation artifact). The rules yaml would be a nice to have, but its format is not as complex so is not a priority.

Use Case

The usecase is that our prometheus config has gotten complex enough that hand editing yaml is no longer sustainable (think 8000+ lines of yaml). There are a few yaml generation tools we have been using for Kubernetes resources that offer strongly typed interfaces. I.e. https://github.com/awslabs/cdk8s and https://github.com/dhall-lang/dhall-haskell (among many others). The idea here is that if one has a json schema, the correct types can be imported into these languages from json schema as interfaces to be written against. This allows all yaml management to be done in a centralized/deduplicated/abstract way for K8S, prometheus, etc

Contributor Guide