system-config/doc/source/grafana.rst
Ian Wienand 882b730fdf Update to openstackdocstheme
This modernises the openstack-infra documentation by switching to
openstackdocstheme.  Update dependencies as required.

To remove non-relevant stuff from conf.py, I have just taken the demo
file from openstackdocstheme and lightly modified it.

It seems later sphinx has included it's own ":file:" role which now
conflicts.  Change it it ":cgit_file:" in our documentation.  Remove
the custom header template which no longer applies.  Add the
post-2.0-pbr sphinx-based warning-as-error, which fixes the original
problem that I actually noticed that errors could slip through the
gate tests :)

Change-Id: Ic7bec57b971bb4c75fc839e7269d1f69a576b85c
2018-06-25 11:19:43 +10:00

47 lines
961 B
ReStructuredText

:title: Grafana
.. _grafana:
Grafana
#######
Grafana is an open source, feature rich metrics dashboard and graph editor for
Graphite, InfluxDB & OpenTSDB. OpenStack runs Graphite which stores all the
metrics related to Nodepool, Zuul and Jenkins (to name a few).
At a Glance
===========
:Hosts:
* http://grafana.openstack.org
:Puppet:
* https://github.com/bfraser/puppet-grafana
* :cgit_file:`modules/openstack_project/manifests/grafana.pp`
:Projects:
* http://grafana.org
:Bugs:
* https://storyboard.openstack.org/#!/project/748
Overview
========
Apache is configured as a reverse proxy and there is a MySQL database
backend.
Sysadmin
========
After bringing up a Grafana node with puppet, log in and configure Grafana by
hand:
#. Log in as the admin user.
#. Under 'Data Sources', add a new entry with following:
- name: OpenStack
- type: Graphite
- default: checked
- url: http://graphite.openstack.org
- access: direct