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 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 |
|---|---|
|
devenv
|
|
|
pkg
|
|
|
api
Package api Grafana HTTP API.
|
Package api Grafana HTTP API. |
|
build
Package build contains the command / functions for the Grafana build process used when running the "build" target in the makefile
|
Package build contains the command / functions for the Grafana build process used when running the "build" target in the makefile |
|
build/cmd
Package verifystorybook contains the sub-command "verify-storybook".
|
Package verifystorybook contains the sub-command "verify-storybook". |
|
build/droneutil
Package droneutil provides utility functions for working with Drone.
|
Package droneutil provides utility functions for working with Drone. |
|
build/golangutils
Package golangutils holds utility functions, wrappers, and types for building Go binaries for Grafana.
|
Package golangutils holds utility functions, wrappers, and types for building Go binaries for Grafana. |
|
build/packaging
Package packaging holds functions and types for creating the tar.gz, deb, and rpm packages of Grafana.
|
Package packaging holds functions and types for creating the tar.gz, deb, and rpm packages of Grafana. |
|
build/validation
Package validation provides functions and types for validating Grafana releases in both the pre-release and post-release phases.
|
Package validation provides functions and types for validating Grafana releases in both the pre-release and post-release phases. |
|
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/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. |
|
ifaces/gcsifaces
Package gcsifaces provides interfaces for Google Cloud Storage.
|
Package gcsifaces provides interfaces for Google Cloud Storage. |
|
infra/grn
A GRN string is expressed in the format:
|
A GRN string is expressed in the format: |
|
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/backendplugin/instrumentation
Package instrumentation contains backend plugin instrumentation logic.
|
Package instrumentation contains backend plugin instrumentation 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. |
|
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/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. |
|
services/store/kind/dummy
Package dummy provides a dummy kind useful for testing
|
Package dummy provides a dummy kind useful for testing |
|
tsdb/legacydata
Package legacydata contains old/legacy interfaces/contracts that uses a data format of series/tables.
|
Package legacydata contains old/legacy interfaces/contracts that uses a data format of series/tables. |
|
util/errutil
Package errutil provides utilities for working with errors in Grafana.
|
Package errutil provides utilities for working with errors in Grafana. |
|
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. |
|
scripts
|
|
Click to show internal directories.
Click to hide internal directories.