apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
41410 Commits
5948 Branches
591 Tags
1.7 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 548a5054ad
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '548a5054ad'
${ noResults }
grafana/docs/sources/developers/kinds/_index.md

1.7 KiB
Raw Blame History

title weight _build
Grafana schema 200 [{list false}]

Grafana schema

Grafana’s schemas, kind system and related code generation are in active development.

Grafana is moving to a schema-centric model of development, where schemas are the single source of truth that specify the shape of objects - for example, dashboards, datasources, users - in the frontend, backend, and plugin code. Eventually, all of Grafana’s object types will be schematized within the “Kind System.” Kinds, their schemas, the Kind system rules, and associated code generators will collectively provide a clear, consistent foundation for Grafana’s APIs, documentation, persistent storage, clients, as-code tooling, and so forth.

It’s exciting to imagine the possibilities that a crisp, consistent development workflow will enable - this is why companies build developer platforms! At the same time, it’s also overwhelming - any schema system that can meet Grafana’s complex requirements will necessarily have a lot of moving parts. Additionally, we must account for having Grafana continue to work as we make the transition - a prerequisite for every large-scale refactoring.

In the Grafana ecosystem, there are three basic Kind categories and associated schema categories:

  • [Core Kinds]({{< relref "core/" >}})
  • Custom Kinds
  • [Composable Kinds]({{< relref "composable/" >}})

The schema authoring workflow for each varies, as does the path to maturity. [Grafana Kinds - From Zero to Maturity]({{< relref "maturity/" >}}) contains general reference material applicable to all Kind-writing, and links to the guides for each category of Kind.