README
¶
The open-source platform for monitoring and observability
Grafana allows you to query, visualize, alert on and understand your metrics no matter where they are stored. Create, explore, and share dashboards with your team and foster a data-driven culture:
- Visualizations: Fast and flexible client side graphs with a multitude of options. Panel plugins offer many different ways to visualize metrics and logs.
- Dynamic Dashboards: Create dynamic & reusable dashboards with template variables that appear as dropdowns at the top of the dashboard.
- Explore Metrics: Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side.
- Explore Logs: Experience the magic of switching from metrics to logs with preserved label filters. Quickly search through all your logs or streaming them live.
- Alerting: Visually define alert rules for your most important metrics. Grafana will continuously evaluate and send notifications to systems like Slack, PagerDuty, VictorOps, OpsGenie.
- Mixed Data Sources: Mix different data sources in the same graph! You can specify a data source on a per-query basis. This works for even custom datasources.
Get started
Unsure if Grafana is for you? Watch Grafana in action on play.grafana.org!
Documentation
The Grafana documentation is available at grafana.com/docs.
Contributing
If you're interested in contributing to the Grafana project:
- Start by reading the Contributing guide.
- Learn how to set up your local environment, in our Developer guide.
- Explore our beginner-friendly issues.
- Look through our style guide and Storybook.
Get involved
- Follow @grafana on X (formerly Twitter).
- Read and subscribe to the Grafana blog.
- If you have a specific question, check out our discussion forums.
- For general discussions, join us on the official Slack team.
This project is tested with BrowserStack.
License
Grafana is distributed under AGPL-3.0-only. For Apache-2.0 exceptions, see LICENSING.md.
Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
apps
|
|
|
advisor
module
|
|
|
alerting/notifications
module
|
|
|
dashboard
module
|
|
|
folder
module
|
|
|
iam
module
|
|
|
investigations
module
|
|
|
playlist
module
|
|
|
plugins
module
|
|
|
preferences
module
|
|
|
provisioning
module
|
|
|
secret
module
|
|
|
shorturl
module
|
|
|
devenv
|
|
|
docker/blocks/slow_proxy
command
|
|
|
docker/blocks/stateful_webhook
command
|
|
|
docker/ha-test-unified-alerting
command
|
|
|
pkg
|
|
|
api
Package api Grafana HTTP API.
|
Package api Grafana HTTP API. |
|
cmd/grafana
command
|
|
|
cmd/grafana-cli
command
|
|
|
cmd/grafana-server
command
|
|
|
components/imguploader
Package imguploader is a generated GoMock package.
|
Package imguploader is a generated GoMock package. |
|
components/imguploader/gcs
Package gcs provides an image uploader for GCS.
|
Package gcs provides an image uploader for GCS. |
|
components/satokengen/cmd
command
|
|
|
components/simplejson
Package simplejson provides a wrapper for arbitrary JSON objects that adds methods to access properties.
|
Package simplejson provides a wrapper for arbitrary JSON objects that adds methods to access properties. |
|
expr/mathexp/parse
Package parse builds parse trees for expressions as defined by expr.
|
Package parse builds parse trees for expressions as defined by expr. |
|
generated/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
generated/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
generated/clientset/versioned/typed/service/v0alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
generated/clientset/versioned/typed/service/v0alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
ifaces/gcsifaces
Package gcsifaces provides interfaces for Google Cloud Storage.
|
Package gcsifaces provides interfaces for Google Cloud Storage. |
|
infra/metrics/graphitebridge
Package graphitebridge provides a bridge to push Prometheus metrics to a Graphite server.
|
Package graphitebridge provides a bridge to push Prometheus metrics to a Graphite server. |
|
mocks/mock_gcsifaces
Package mock_gcsifaces is a generated GoMock package.
|
Package mock_gcsifaces is a generated GoMock package. |
|
plugins/backendplugin
Package backendplugin contains backend plugin related logic.
|
Package backendplugin contains backend plugin related logic. |
|
plugins/manager/pipeline/termination
Package termination defines the Termination stage of the plugin loader pipeline.
|
Package termination defines the Termination stage of the plugin loader pipeline. |
|
server
Server defines the main entrypoints to Grafana and the Grafana CLI, as well as test environments.
|
Server defines the main entrypoints to Grafana and the Grafana CLI, as well as test environments. |
|
services/authapi
Package authapi contains the connector for Grafana internal auth service.
|
Package authapi contains the connector for Grafana internal auth service. |
|
services/contexthandler
Package contexthandler contains the ContextHandler service.
|
Package contexthandler contains the ContextHandler service. |
|
services/live/features
Package features is a generated GoMock package.
|
Package features is a generated GoMock package. |
|
services/live/pipeline
Package pipeline is a generated GoMock package.
|
Package pipeline is a generated GoMock package. |
|
services/live/runstream
Package runstream is a generated GoMock package.
|
Package runstream is a generated GoMock package. |
|
services/ngalert/api
Package api contains base API implementation of unified alerting
|
Package api contains base API implementation of unified alerting |
|
services/ngalert/api/tooling/definitions
Grafana Alerting API.
|
Grafana Alerting API. |
|
services/ngalert/eval
Package eval executes the condition for an alert definition, evaluates the condition results, and returns the alert instance states.
|
Package eval executes the condition for an alert definition, evaluates the condition results, and returns the alert instance states. |
|
services/ngalert/image
Package image is a generated GoMock package.
|
Package image is a generated GoMock package. |
|
services/ngalert/sender
nolint
|
nolint |
|
services/ngalert/state
Package state is a generated GoMock package.
|
Package state is a generated GoMock package. |
|
services/pluginsintegration
package pluginsintegration instantiate the plugins package (pkg/plugins) and all of its services/dependencies that Grafana needs to provide plugin support.
|
package pluginsintegration instantiate the plugins package (pkg/plugins) and all of its services/dependencies that Grafana needs to provide plugin support. |
|
services/pluginsintegration/adapters
Package adapters contains plugin SDK adapters.
|
Package adapters contains plugin SDK adapters. |
|
services/pluginsintegration/cachekvstore
Package cachekvstore implements a key-value store that also keeps track of the last update time of the store.
|
Package cachekvstore implements a key-value store that also keeps track of the last update time of the store. |
|
services/preference/prefapi
shared logic between httpserver and teamapi
|
shared logic between httpserver and teamapi |
|
services/provisioning/values
Package values is a set of value types to use in provisioning.
|
Package values is a set of value types to use in provisioning. |
|
services/rendering
Package rendering is a generated GoMock package.
|
Package rendering is a generated GoMock package. |
|
services/screenshot
Package screenshot is a generated GoMock package.
|
Package screenshot is a generated GoMock package. |
|
services/sqlstore
DO NOT ADD METHODS TO THIS FILES.
|
DO NOT ADD METHODS TO THIS FILES. |
|
services/sqlstore/searchstore
Package searchstore converts search queries to SQL.
|
Package searchstore converts search queries to SQL. |
|
storage/unified/apistore
Package apistore provides an implementation of k8s.io/apiserver/pkg/storage.Interface that persists data into a [ResourceServer] (backend for unified storage)
|
Package apistore provides an implementation of k8s.io/apiserver/pkg/storage.Interface that persists data into a [ResourceServer] (backend for unified storage) |
|
storage/unified/resource
Package resource creates a ResourceServer that handles generic storage operations
|
Package resource creates a ResourceServer that handles generic storage operations |
|
storage/unified/sql/dbutil
Package dbutil provides utilities to perform common database operations and appropriate error handling.
|
Package dbutil provides utilities to perform common database operations and appropriate error handling. |
|
tsdb/azuremonitor/standalone
command
|
|
|
tsdb/cloud-monitoring/standalone
command
|
|
|
tsdb/cloud-monitoring/time
Copied from https://github.com/capitalrx/grafana/blob/main/pkg/tsdb/intervalv2/intervalv2.go We're copying this to not block ourselves from decoupling until the conversation here is resolved https://raintank-corp.slack.com/archives/C05QFJUHUQ6/p1700064431005089
|
Copied from https://github.com/capitalrx/grafana/blob/main/pkg/tsdb/intervalv2/intervalv2.go We're copying this to not block ourselves from decoupling until the conversation here is resolved https://raintank-corp.slack.com/archives/C05QFJUHUQ6/p1700064431005089 |
|
tsdb/jaeger/standalone
command
|
|
|
tsdb/loki/standalone
command
|
|
|
tsdb/mssql/standalone
command
|
|
|
tsdb/mysql/standalone
command
|
|
|
tsdb/parca/standalone
command
|
|
|
tsdb/tempo/standalone
command
|
|
|
tsdb/zipkin/standalone
command
|
|
|
web
Package macaron is a high productive and modular web framework in Go.
|
Package macaron is a high productive and modular web framework in Go. |
|
aggregator
module
|
|
|
apimachinery
module
|
|
|
apiserver
module
|
|
|
semconv
module
|
|
|
scripts
|
|
|
build/release_publisher
command
|
|
|
openapi3
command
|
|
Click to show internal directories.
Click to hide internal directories.