mirror of https://github.com/YunoHost-Apps/grafana_ynh.git synced 2024-09-03 20:36:29 +02:00

Grafana package for YunoHost

dashboard grafana influxdb metrics netdata yunohost yunohost-apps

Find a file

JimboJoe 795fc30726 Merge pull request #28 from yunohost-bot/issue-and-pr-template [autopatch] Update issue and PR templates		2021-05-11 20:18:28 +02:00
conf	Complete refactoring + buster support	2020-05-17 09:28:22 +02:00
scripts	Upgrade to upstream version 7.5.5	2021-04-30 18:33:16 +02:00
CHANGELOG.md	Upgrade to upstream version 7.4.0	2021-02-05 22:00:38 +01:00
check_process	Update upgrade reference	2021-02-07 18:03:49 +01:00
LICENSE	Initial commit	2017-03-04 09:07:23 +01:00
manifest.json	Upgrade to upstream version 7.5.5	2021-04-30 18:33:16 +02:00
README.md	Upgrade to upstream version 7.5.5	2021-04-30 18:33:16 +02:00

README.md

Grafana for YunoHost

This package allows you to install grafana quickly and simply on a YunoHost server.
If you don't have YunoHost, please see here to know how to install and enjoy it.

Overview

Important: This package is designed to be fed by the NetData application for monitoring measures, so please make sure the YunoHost NetData package is installed before installing it!

NetData only collects, displays and sets alarms based on data from the last hour; this packages allows to archive every metrics and put up statistics and dashboards on the long term.

Note: You can use it without NetData, but you'll have to install a collection application (e.g. collectd) to gather data.

Shipped version: 7.5.5

Screenshots

Demo

Official demo

Configuration

Important at first login:

you have to go the Grafana Menu (Grafana icon), select your account menu and select Switch to Main Org.
you can now access the default NetData dashboard via the Home menu

Don't hesitate to create new dashboards: the default dashboard contains metrics from NetData, but only generic ones that are generated on every machine. NetData dynamically detects services and applications (e.g.redis, nginx, etc.) and enriches its dashboard and generated metrics. Many NetData metrics don't appear in the provided default Grafana dashboard!

Documentation

Official Grafana documentation: https://grafana.com/docs/grafana/latest/
Official InfluxdB documentation: https://docs.influxdata.com/influxdb/
YunoHost documentation: If specific documentation is needed, feel free to contribute.

YunoHost specific features

installs InfluxDB as time series database
if the NetData package is installed, configures NetData to feed InfluxDB every minute
installs Grafana as dashboard server
creates a Grafana Data Source to fetch data from InfluxDB (and hence NetData!)
creates a default dashboard to plot some data from NetData (doesn't cover every metric, can be greatly enhanced!)

General architecture

Multi-users support

LDAP and HTTP auth are supported.

Supported architectures

x86-64 -
ARMv8-A -

Limitations

The default dashboard may be updated in a further release of this package, so please make sure you create your own dashboards!
Organizations creation doesn't play well with LDAP integration; it is disabled for standard users, but can't be disabled for administrators: please do not create organizations!

Additional information

None.

Developers info

Please do your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/grafana_ynh/tree/testing --debug
or
sudo yunohost app upgrade grafana -u https://github.com/YunoHost-Apps/grafana_ynh/tree/testing --debug