====== Introduction ======

Grafana allows you to query, visualize, alert on and understand your metrics no matter where they are stored. Grafana has pluggable data source model and comes bundled with rich support for many of the most popular time series databases like Graphite, Prometheus, Elasticsearch, OpenTSDB and InfluxDB. It also has built-in support for cloud monitoring vendors like Google Stackdriver, Amazon Cloudwatch, Microsoft Azure and SQL databases like MySQL and Postgres. Grafana is the only tool that can combine data from so many places into a single dashboard.

Create, explore, and share dashboards with your team and foster a data driven culture:

  * Visualize: Fast and flexible client side graphs with a multitude of options. Panel plugins for many different way 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. <

====== Links ======

===== General =====

[[https://grafana.com/]]\\
[[https://github.com/grafana/grafana|Grafana GiHub repository]]\\

===== Dashboards =====

[[https://grafana.com/grafana/dashboards/17781-loki-metrics-dashboard/|A Grafana metrics dashboard for the metrics provided by Grafana Loki.]] See also [[https://github.com/frank-fegert/grafana-dashboards/blob/main/Loki_Metrics_Dashboard.json|This Grafana dashboard in the Github Repository.]]\\

====== Docs ======

[[https://grafana.com/docs/grafana/latest/|Grafana documentation]]\\
[[https://grafana.com/docs/grafana/latest/installation/debian/|Install on Debian or Ubuntu]]\\

====== Files and Directories ======

===== General Files and Directories =====

^ File or Directory                                 ^ Description                                                                            ^
| ''/etc/grafana/''                                                        | The //Grafana// configuration directory.               |
| ''/usr/sbin/grafana-cli''                                            | The //Grafana// CLI binary.                                    |
| ''/usr/sbin/grafana-server''                                      | The //Grafana// server binary.                               |
| ''/usr/lib/systemd/system/grafana-server.service''  | The //Grafana// systemd unit file.                           |
| ''/usr/share/grafana/''                                              | The //Grafana// HTML, JS, CSS, font and other files.    |
| ''/var/lib/grafana/grafana.db''                                 | The //Grafana// SQLite3 database.                        |
| ''/var/log/grafana/grafana.log''                               | The //Grafana// log file.                                         |

===== Configuration Files =====

^ File or Directory                          ^ Description                                                                           ^
| ''/etc/default/grafana-server''       | The configuration file with environment files for the //Grafana// server.                 |
| ''/etc/grafana/grafana.ini''            | The //Grafana// server configuration file.                 |

====== Getting Help ======

FIXME

Manual pages: 

<cli>
user@host:~$ 
</cli>

====== Install ======

To install //Grafana// on Debian: 

<note important>
If installing //Grafana// on a Raspberry consider this: The ''grafana-rpi'' packages in the //Grafana// Debian repository are intended for the Raspberry Pi 1 and the Raspberry Pi Zero. 
</note>

<cli>
root@host:~$ apt-get install -y apt-transport-https wget
root@host:~$ wget -q -O - https://packages.grafana.com/gpg.key | apt-key add -
root@host:~$ echo "deb https://packages.grafana.com/oss/deb stable main" > /etc/apt/sources.list.d/grafana.list
root@host:~$ apt-get update
root@host:~$ apt-get install grafana
</cli> 

If a local IPTables firewall is active on the system running //Grafana// open the TCP port ''3000'' for access to the //Grafana// WebUI:

<file config iptables.conf>
# Allow access to Grafana from local networks
-A INPUT -p tcp -s <YOUR-NETWORK> --dport 3000 -j ACCEPT
</file>

and reload the IPTables rules:

<cli>
root@host:~$ iptables-restore < iptables.conf
</cli>


====== Configuration ======

===== Initial =====

  - Navigate to [[http://your-grafana-host:3000/]] in a Web browser. <
  - Log into //Grafana// with the default credentials. User ''admin'' and password ''admin''. <
  - You will be prompted to change the password for the ''admin'' user. Choose a reasonable strong password. <

===== Adding Prometheus to Grafana =====

  - Navigate to [[http://your-grafana-host:3000/]] in a Web browser. <
  - Log into //Grafana// with the default credentials. User ''admin'' and password ''admin''. <
  - Click on the "cogwheel" icon in the sidebar to open the Configuration menu. <
  - Click on "Data Sources". <
  - Click on "Add data source". <
  - Select "Prometheus" as the type. <
  - Set the appropriate Prometheus server URL (for example, ''http://localhost:9090/'') <
  - Adjust other data source settings as desired (for example, choosing the right Access method). <
  - Click "Save & Test" to save the new data source. <

====== Usage ======

FIXME

===== Start =====

To start //Grafana//:

<cli>
root@host:~$ systemctl enable grafana-server.service
root@host:~$ systemctl start grafana-server.service
</cli>

===== Stop =====

To stop //Grafana//:

<cli>
root@host:~$ systemctl stop grafana-server.service
</cli>

===== Status Check =====

To check the status of //Grafana//:

<cli>
root@host:~$ systemctl status grafana-server.service
</cli>

====== Recipies ======

FIXME

<nspages .:recipies -subns -pagesInNs -simpleList -title -hideNoSubns -hideNoPages -textNS="" -exclude:start>

====== Known Issues ======

FIXME