SCHEMA | Grafana Labs

Grafana Products Open Source Learn

Downloads Login

Contact us

Grafana

Features

Plugins

Contribute

Dashboards

Products

Grafana Cloud

Grafana Enterprise

Grafana Metrics Enterprise

Open Source

Grafana

Cortex

Graphite

Grafana Loki

Grafana Metrictank

Prometheus

Grafana Tanka

Grafana Tempo

Learn

Blog

Success stories

Community

Documentation

Grafana ObservabilityCON 2020

Tutorials

Webinars and videos

Downloads

Login

Contact us

Features

Learn about the monitoring solution for every database.

Plugins

Customize your Grafana experience with specialized dashboards, data sources, and apps.

Contribute

Love Grafana? Help us make it even better!

Dashboards

Browse a library of official and community-built dashboards.

Get Grafana

An easy-to-use, fully composable observability stack. Create your free account.

Grafana Cloud

An easy-to-use, fully composable observability stack. Create your free account.

Grafana Enterprise

Enhanced version of Grafana with enterprise features, plugins and support

Grafana Metrics Enterprise

Enables Prometheus-as-a-Service for large organizations running at scale

Grafana

Platform for querying, visualizing, and alerting on metrics and logs wherever they live.

Cortex

Highly scalable, multi-tenant, durable, and fast Prometheus implementation.

Graphite

Scalable monitoring system for timeseries data.

Grafana Loki

Horizontally scalable, multi-tenant log aggregation system inspired by Prometheus.

Grafana Metrictank

Multi-tenant timeseries platform for Graphite.

Prometheus

De facto monitoring system for Kubernetes and cloud native.

Grafana Tanka

Configuration utility for Kubernetes clusters, powered by Jsonnet.

Grafana Tempo

Tempo is an easy-to-operate, high-scale, and cost-effective distributed tracing system.

Blog

The latest news, releases, features, and how-tos.

Success stories

What end users are saying about Grafana, Cortex, Loki, and more.

Community

Ask questions, request help, and discuss all things Grafana.

Documentation

Guides for installation, getting started, and more.

Grafana ObservabilityCON 2020

On-demand recordings of expert-led sessions on Prometheus, Loki, Cortex, Tempo tracing, plugins, and more.

Tutorials

Step-by-step guides to help you make the most of Grafana.

Webinars and videos

Step-by-step guides to help you make the most of Grafana.

Blog Successes Community Documentation Grafana ObservabilityCON Tutorials

Grafana documentation

What's new
Getting started

With Grafana
With Grafana and Prometheus
With Grafana and MS SQL Server
Time series
Time series dimensions
Histograms and heatmaps
Glossary

Best practices

Best practices for creating dashboards
Best practices for managing dashboards
Common observability strategies
Dashboard management maturity model

Authentication

Overview
Grafana Authentication
Auth Proxy
LDAP Authentication
Enhanced LDAP Integration
OAuth authentication
Google OAuth2 Authentication
Azure AD OAuth2 authentication
GitHub OAuth2 Authentication
GitLab OAuth2 Authentication
Okta OAuth2 authentication
SAML Authentication
Team Sync

Installation

Requirements
Install on Debian/Ubuntu
Install on RPM-based Linux
Install on Windows
Install on macOS
Run Grafana Docker image
Upgrade Grafana

Administration

Grafana CLI
Image rendering
Internal Grafana metrics
Provisioning
Jaeger instrumentation
Change the default home dashboard
Change your password
Change your preferences
Configuration
View server settings
Configure Grafana Docker image
Security
View server stats
Set up Grafana for high availability

Manage users

Add or remove a user
Enable or disable a user
Add or remove a user from a team
Create or remove a team

Permissions

Organization roles
Dashboard and Folder Permissions
Data source permissions

Data sources

Add data source
AWS CloudWatch
Cloud Monitoring
Azure Monitor
Elasticsearch
Graphite
InfluxDB
Jaeger
Loki
Microsoft SQL Server
MySQL
OpenTSDB
PostgreSQL
Prometheus
Tempo
TestData
Zipkin

Panels

Add a panel
Panel editor
Calculations list
Queries
Thresholds
Transformations

Apply a transformation
Transformation types and options

Share query results
Inspect a panel
Field options and overrides

Configure all fields
Configure specific fields
Standard field options

Visualizations

Alert list panel
Bar gauge panel
Dashboard list panel
Gauge panel
Graph panel
Heatmap
Logs panel
News panel
Stat panel
Table panel

Table field options
Filter table columns

Text panel

Dashboards

Annotations
Dashboard Folders
Playlist
Search
Keyboard shortcuts
Time range controls
Reporting
Dashboard Version History
Export and import
JSON model
Scripted dashboards

Sharing

Share a dashboard
Share a panel

Explore
Alerts

Alert notifications
Alert notification templating
Create alerts
Pause alert rule
View alerts
Troubleshoot alerts

Linking

Linking overview
Dashboard links
Panel links
URL variables
Data links

Templates and variables

Variable syntax
Manage variables
Inspect variables
Add variables

Add a query variable
Add a custom variable
Add a text box variable
Add a constant variable
Add a data source variable
Add an interval variable
Add ad hoc filters
Chained variables
Global variables

Variable examples
Variable selection options
Variable value group tags
Advanced variable format options
Multi-value variables
Filter variables with regex
Repeat panels or rows

Grafana Enterprise

Activate an Enterprise license
License Expiration
Data source permissions
Enhanced LDAP Integration
Enterprise configuration
Reporting
SAML Authentication
Team sync
Auditing
Usage insights
Vault
White labeling
Export dashboard as PDF

Plugins

Install plugins
Plugin signatures

HTTP API

API Tutorial: Create API tokens and dashboards for an organization
Admin HTTP API
Alerting HTTP API
Alerting Notification Channels HTTP API
Annotations HTTP API
Authentication HTTP API
cURL examples
Dashboard HTTP API
Dashboard Permissions HTTP API
Dashboard Versions HTTP API
Data source HTTP API
Datasource Permissions HTTP API
External Group Sync HTTP API
Folder HTTP API
Folder Permissions HTTP API
Folder/Dashboard Search HTTP API
HTTP Preferences API
HTTP Snapshot API
Licensing HTTP API
Organization HTTP API
Other HTTP API
Playlist HTTP API
Reporting API
Short URL HTTP API
Team HTTP API
User HTTP API

Troubleshooting

Troubleshoot dashboards
Enable diagnostics
Troubleshoot queries

Developers

Build a plugin

Add authentication for data source plugins
Add query editor help
Add support for annotations
Add support for Explore queries
Add support for variables in plugins
Backend plugins

Grafana Plugin SDK for Go
Plugin protocol

Build a logs data source plugin
Build a streaming data source plugin
Data frames
Error handling
Legacy plugins

Legacy app plugins
Legacy code style guide
Legacy data source plugins
Legacy defaults and editor mode
Legacy panel plugins
Legacy review guidelines
Legacy snapshot mode

Package a plugin
Plugin migration guide
plugin.json
Sign a plugin
Working with data frames

Contribute to Grafana
Contributor License Agreement (CLA)

Release notes
API Reference

@grafana/data

@grafana/e2e

e2e

@grafana/e2e-selectors

CssSelector
E2ESelectors
FunctionSelector
selectors
StringSelector
UrlSelector

@grafana/runtime

@grafana/ui

› API Reference › @grafana/ui › SCHEMA

SCHEMA variable

SCHEMA variable

Signature

SCHEMA: SchemaProperties

Import

import { SCHEMA } from '@grafana/ui';

Grafana

Request doc changes
Get Support
Community

On this page:

SCHEMA variable
- SCHEMA variable

Get Product Updates and News

waving hand emoji

Keep up with us.
Product developments and observability innovations.

Copyright 2021 © Grafana Labs

Legal and Security

Terms of Service

Trademark Policy

Grafana
Features
Contribute
Dashboards
Plugins

Products
Grafana Cloud
Grafana Enterprise
Grafana Metrics Enterprise

Open Source
Grafana
Cortex
Graphite
Loki
Metrictank
Prometheus
Tanka
Tempo
GitHub

Learn
Blog
Documentation
Downloads
Community
Grafana ObservabilityCON
Successes
Training
Webinars and videos

Company
Our Mission
The Team
Press
We're Hiring!
Events
Partnerships
Grafana Cloud Status
Contact

Grafana Labs uses cookies for the normal operation of this website. Learn more.

New free and paid plans for Grafana Cloud
Beautiful dashboards, logs (Loki), metrics (Prometheus & Graphite) & more

Create account Learn more