Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / salt-formulas / grafana / ae47c9fd959cb90486ccb3828ebeccf39a4194d9 / . / README.rst
blob: 2b9f6a0b05830599c174b0b40e1b45ff03a592ff [file] [log] [blame]
Ales Komarek4b6c8662014-02-24 21:48:29 +0100[diff] [blame]1
Ales Komarek86490892015-12-04 16:43:48 +0100[diff] [blame]2=======
3Grafana
4=======
Ales Komarek4b6c8662014-02-24 21:48:29 +0100[diff] [blame]5
6A beautiful, easy to use and feature rich Graphite dashboard replacement and graph editor.
7
Ales Komarek5a23b512015-12-08 11:20:02 +0100[diff] [blame]8Sample pillars
9==============
Ales Komarek4b6c8662014-02-24 21:48:29 +0100[diff] [blame]10
Ales Komarek9e054912016-10-22 00:36:50 +0200[diff] [blame]11Server deployments
12------------------
13
14Server installed from system package
15
16.. code-block:: yaml
Michael Kutýa79bbdb2014-03-03 20:46:34 +0100[diff] [blame]17
18 grafana:
19 server:
20 enabled: true
Ales Komarek9e054912016-10-22 00:36:50 +0200[diff] [blame]21 admin:
22 user: admin
23 password: passwd
24 database:
25 engine: sqlite
26
27Server installed with PostgreSQL database
28
29.. code-block:: yaml
30
31 grafana:
32 server:
33 enabled: true
34 admin:
35 user: admin
36 password: passwd
Ales Komarek98588222015-12-08 10:43:59 +0100[diff] [blame]37 database:
38 engine: postgresql
Michael Kutýa79bbdb2014-03-03 20:46:34 +0100[diff] [blame]39 host: localhost
Ales Komarek98588222015-12-08 10:43:59 +0100[diff] [blame]40 port: 5432
Ales Komarek9e054912016-10-22 00:36:50 +0200[diff] [blame]41 name: grafana
42 user: grafana
43 password: passwd
44
Ales Komarekae47c9f2016-10-22 12:30:30 +0200[diff] [blame^]45Collector setup
46---------------
47
48Used to aggregate dashboards
49
50.. code-block:: yaml
51
52 grafana:
53 collector:
54 enabled: true
55
56
Ales Komarek9e054912016-10-22 00:36:50 +0200[diff] [blame]57Client setups
58-------------
59
60Client enforced data sources
61
62.. code-block:: yaml
63
64 grafana:
65 client:
66 enabled: true
67 server:
68 protocol: https
69 host: grafana.host
70 port: 3000
71 token: token
72 datasource:
73 graphite:
74 type: graphite
75 host: mtr01.domain.com
76 protocol: https
Ales Komarek98588222015-12-08 10:43:59 +0100[diff] [blame]77 port: 443
Ales Komarek9e054912016-10-22 00:36:50 +0200[diff] [blame]78 elasticsearch:
79 type: elasticsearch
80 host: log01.domain.com
Ales Komarek5a23b512015-12-08 11:20:02 +0100[diff] [blame]81 port: 80
Ales Komarek9e054912016-10-22 00:36:50 +0200[diff] [blame]82 user: admin
83 password: password
Ales Komarek5a23b512015-12-08 11:20:02 +0100[diff] [blame]84 index: grafana-dash
Ales Komarek9e054912016-10-22 00:36:50 +0200[diff] [blame]85
86Client enforced dashboards
87
88.. code-block:: yaml
89
90 grafana:
91 client:
92 enabled: true
93 server:
94 host: grafana.host
95 port: 3000
96 token: token
97 dashboard:
98 system_metrics:
99 title: "Generic system metrics"
100 style: dark
101 editable: false
102 row:
103 top:
104 title: "First row"
105
106Client enforced dashboards defined in salt-mine
107
108.. code-block:: yaml
109
110 grafana:
111 client:
112 enabled: true
Ales Komarekae47c9f2016-10-22 12:30:30 +0200[diff] [blame^]113 remote_data:
114 engine: salt_mine
Ales Komarek9e054912016-10-22 00:36:50 +0200[diff] [blame]115 server:
116 host: grafana.host
117 port: 3000
118 token: token
119
Ales Komarekae47c9f2016-10-22 12:30:30 +0200[diff] [blame^]120Usage
121=====
122
123There's a difference between JSON dashboard representation and models we us. Lists are replaced by dictionaries to support mergings and interpolations.
124
125Client enforced dashboards defined in salt-mine
126
127.. code-block:: yaml
128
129 system_metrics:
130 title: graph
131 editable: true
132 hideControls: false
133 rows:
134 - title: Usage
135 height: 250px
136 panels:
137 - title: Panel Title
138 span: 6
139 editable: false
140 type: graph
141 targets:
142 - refId: A
143 target: "support_prd.cfg01_iot_tcpcloud_eu.cpu.0.idle"
144 datasource: graphite01
145 renderer: flot
146 showTitle: true
147
148
149.. code-block:: yaml
150
151 system_metrics:
152 title: graph
153 editable: true
154 hideControls: false
155 rows:
156 - title: Usage
157 height: 250px
158 panels:
159 - title: Panel Title
160 span: 6
161 editable: false
162 type: graph
163 targets:
164 - refId: A
165 target: "support_prd.cfg01_iot_tcpcloud_eu.cpu.0.idle"
166 datasource: graphite01
167 renderer: flot
168 showTitle: true
169
170
171
Ales Komarek9e054912016-10-22 00:36:50 +0200[diff] [blame]172
Ales Komarek86490892015-12-04 16:43:48 +0100[diff] [blame]173Read more
174=========
Ales Komarek4b6c8662014-02-24 21:48:29 +0100[diff] [blame]175
176* http://grafana.org/
Ales Komarek5a23b512015-12-08 11:20:02 +0100[diff] [blame]177* http://docs.grafana.org/reference/export_import/