|
1 | 1 | # Netdata data source for Grafana |
2 | 2 |
|
3 | | -[](https://github.com/grafana/grafana-starter-datasource/actions?query=workflow%3A%22CI%22) |
4 | | - |
5 | 3 | _Enhanced high-fidelity troubleshooting data source for the Open Source community!_ |
6 | 4 |
|
7 | 5 |  |
8 | 6 |
|
9 | | -## What is Netdata data source plugin for Grafana? |
10 | | - |
11 | | -We are huge fans of Open Source culture and it is rooted deeply into our DNA, so we thought that the Open Source community would hugely benefit from Netdata providing a Grafana data source plugin that would expose its powerful data collection engine. |
12 | | - |
13 | | -With this data source plugin we expose the troubleshooting capabilities of Netdata in Grafana, making them available more widely. Some of the key capabilities: |
14 | | -- Real-time monitoring with single-second granularity. |
15 | | -- Installation and out-of-the-box integrations available in seconds from one line of code. |
16 | | -- 2,000+ metrics from across your whole Infrastructure, with insightful metadata associated with them. |
17 | | -- Access to our fresh ML metrics (anomaly rates) - exposing our ML capabilities at the edge! |
18 | | - |
19 | | - |
20 | | -## Getting started |
21 | | - |
22 | | -### 1. Connect your Nodes to Netdata Cloud |
23 | | - |
24 | | -Netdata’s data source plugin connects directly to our Netdata Cloud API’s, meaning that you’ll need to have your nodes (hosts) connected to [Netdata Cloud](https://app.netdata.cloud/?utm_source=grafana&utm_content=data_source_plugin) in order to be able to have them exposed on our plugin. For security purposes you will also need an API token for authentication (which you can get from within your Netdata profile). |
25 | | - |
26 | | -Note: If you don't have an account [sign-up](https://app.netdata.cloud/?utm_source=grafana&utm_content=data_source_plugin) for free to get one! |
27 | | - |
28 | | -> Netdata Agent will need to be installed and running on your server, VM and/or cluster, so that it can start collecting all the relevant metrics you have from the server |
29 | | -and applications running on it. More info at https://learn.netdata.cloud/docs/get-started. |
30 | | - |
31 | | -### 2. Ensure you have an API Token for authentication purposes. |
32 | | - |
33 | | -Once you have all your nodes connected to Netdata Hub you must proceed with creating an API token, which will be linked to your Netdata Cloud account. The API token provides a means to authenticate external calls to our APIs, allowing the same access as you to the Spaces and Rooms you can see on Netdata Hub. |
34 | | - |
35 | | - |
36 | | - |
37 | | -### 3. Install Netdata data source plugin on Grafana OSS or Enterprise (local) |
38 | | - |
39 | | -For detailed instructions on how to install the plugin on Grafana OSS or Enterprise check the section [How to install the plugin?](#how-to-install-the-plugin). |
40 | | - |
41 | | -### 4. Add your API token to the Netdata data source plugin configuration |
42 | | - |
43 | | -Once you have added your API token to Netdata data source plugin you’re ready to start taking advantage of Netdata’s troubleshooting capabilities in Grafana by starting creating your charts and dashboards! |
44 | | - |
45 | | - |
46 | | - |
47 | 7 | ## How to install the plugin? |
48 | 8 |
|
49 | 9 | To start using the Netdata data source plugin on your Grafana environment, local or Cloud. Here are some tips to get through this depending on your setup: |
@@ -165,4 +125,3 @@ For any of the above steps if you prefer to build this plugin locally instead of |
165 | 125 | ``` |
166 | 126 |
|
167 | 127 | 3. Place the contents of the `/dist` folder under the netdata folder in Grafana plugins directory. |
168 | | - |
0 commit comments