README.md 2.85 KB
Newer Older
Marcus Olsson's avatar
Marcus Olsson committed
1
![Grafana](docs/logo-horizontal.png)
2

Marcus Olsson's avatar
Marcus Olsson committed
3
The open-source platform for monitoring and observability.
Rashid Khan's avatar
Rashid Khan committed
4

Marcus Olsson's avatar
Marcus Olsson committed
5
[![License](https://img.shields.io/github/license/grafana/grafana)](LICENSE)
6
[![Drone](https://drone.grafana.net/api/badges/grafana/grafana/status.svg)](https://drone.grafana.net/grafana/grafana)
Marcus Olsson's avatar
Marcus Olsson committed
7
[![Go Report Card](https://goreportcard.com/badge/github.com/grafana/grafana)](https://goreportcard.com/report/github.com/grafana/grafana)
Torkel Ödegaard's avatar
Torkel Ödegaard committed
8

Marcus Olsson's avatar
Marcus Olsson committed
9
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:
Torkel Ödegaard's avatar
Torkel Ödegaard committed
10

11
- **Visualize:** Fast and flexible client side graphs with a multitude of options. Panel plugins offer many different ways to visualize metrics and logs.
Marcus Olsson's avatar
Marcus Olsson committed
12
13
14
15
16
- **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.
17

Marcus Olsson's avatar
Marcus Olsson committed
18
## Get started
19

Marcus Olsson's avatar
Marcus Olsson committed
20
21
- [Get Grafana](https://grafana.com/get)
- [Installation guides](http://docs.grafana.org/installation/)
22

Marcus Olsson's avatar
Marcus Olsson committed
23
Unsure if Grafana is for you? Watch Grafana in action on [play.grafana.org](https://play.grafana.org/)!
Torkel Ödegaard's avatar
Torkel Ödegaard committed
24

Marcus Olsson's avatar
Marcus Olsson committed
25
## Documentation
26

Marcus Olsson's avatar
Marcus Olsson committed
27
The Grafana documentation is available at [grafana.com/docs](https://grafana.com/docs/).
Torkel Ödegaard's avatar
Torkel Ödegaard committed
28

Marcus Olsson's avatar
Marcus Olsson committed
29
## Contributing
Torkel Ödegaard's avatar
Torkel Ödegaard committed
30

Marcus Olsson's avatar
Marcus Olsson committed
31
If you're interested in contributing to the Grafana project:
32

Marcus Olsson's avatar
Marcus Olsson committed
33
34
35
- Start by reading the [Contributing guide](/CONTRIBUTING.md).
- Learn how to set up your local environment, in our [Developer guide](/contribute/developer-guide.md).
- Explore our [beginner-friendly issues](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22).
Richard Hartmann's avatar
Richard Hartmann committed
36
- Look through our [style guide and Storybook](https://developers.grafana.com/ui/latest/index.html).
37

Marcus Olsson's avatar
Marcus Olsson committed
38
## Get involved
Torkel Ödegaard's avatar
Torkel Ödegaard committed
39

40
41
- Follow [@grafana on Twitter](https://twitter.com/grafana/).
- Read and subscribe to the [Grafana blog](https://grafana.com/blog/).
Marcus Olsson's avatar
Marcus Olsson committed
42
43
- If you have a specific question, check out our [discussion forums](https://community.grafana.com/).
- For general discussions, join us on the [official Slack](http://slack.raintank.io/) team.
Torkel Ödegaard's avatar
Torkel Ödegaard committed
44

Torkel Ödegaard's avatar
Torkel Ödegaard committed
45
## License
Torkel Ödegaard's avatar
Torkel Ödegaard committed
46

47
Grafana is distributed under [AGPL-3.0-only](LICENSE). For Apache-2.0 exceptions, see [LICENSING.md](LICENSING.md).