YunoHost-Apps/grafana_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/grafana_ynh.git synced 2024-09-03 20:36:29 +02:00
Code Issues Activity Actions

Add useful badges to README

Browse source
This commit is contained in:
Jimmy Monin 2017-09-10 10:46:37 +02:00
parent 17b2dae582
commit 9a207690ff
1 changed files with 113 additions and 110 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

223
README.md
View file

@ -1,110 +1,113 @@
Grafana for YunoHost Grafana for YunoHost
----------------------------- -----------------------------
[![Install Grafana with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=grafana)
**Important: This package is designed to be fed by the NetData application for monitoring measures, so please make sure the YunoHost [NetData package](https://github.com/YunoHost-Apps/netdata_ynh/) is installed before installing it!**
[![Integration level](https://dash.yunohost.org/integration/grafana.svg)](https://ci-apps.yunohost.org/jenkins/job/grafana%20%28Community%29/lastBuild/consoleFull)
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.
**Important: This package is designed to be fed by the NetData application for monitoring measures, so please make sure the YunoHost [NetData package](https://github.com/YunoHost-Apps/netdata_ynh/) is installed before installing it!**
Note: You can use it without NetData, but you'll have to install a collection application (e.g. collectd) to gather data.
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.
**Important at first login:**
Note: You can use it without NetData, but you'll have to install a collection application (e.g. collectd) to gather data.
* 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 **Important at first login:**
**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! * 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
**Warnings**:
**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!
* 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**! **Warnings**:
--- * The default dashboard may be updated in a further release of this package, so please make sure you create your own dashboards!
# Package description: * 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**!
* installs InfluxDB as time series database ---
* if the NetData package is installed, configures NetData to feed InfluxDB every minute # Package description:
* installs Grafana as dashboard server
* creates a Grafana Data Source to fetch data from InfluxDB (and hence NetData!) * installs InfluxDB as time series database
* creates a default dashboard to plot some data from NetData (doesn't cover every metric, can be greatly enhanced!) * if the NetData package is installed, configures NetData to feed InfluxDB every minute
* installs Grafana as dashboard server
It has been tested on x86_64 and ARM. * 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
It has been tested on x86_64 and ARM.
![image](https://cloud.githubusercontent.com/assets/2662304/20649711/29f182ba-b4ce-11e6-97c8-ab2c0ab59833.png)
## General architecture
--- ![image](https://cloud.githubusercontent.com/assets/2662304/20649711/29f182ba-b4ce-11e6-97c8-ab2c0ab59833.png)
# InfluxDB
InfluxDB is an open source **time series database** with
**no external dependencies**. It's useful for recording metrics, ---
events, and performing analytics. # InfluxDB
InfluxDB is an open source **time series database** with
**Shipped version:** versions from Debian repositories (updated with the system) **no external dependencies**. It's useful for recording metrics,
events, and performing analytics.
## Features
**Shipped version:** versions from Debian repositories (updated with the system)
* Built-in [HTTP API](https://docs.influxdata.com/influxdb/latest/guides/writing_data/) so you don't have to write any server side code to get up and running.
* Data can be tagged, allowing very flexible querying. ## Features
* SQL-like query language.
* Simple to install and manage, and fast to get data in and out. * Built-in [HTTP API](https://docs.influxdata.com/influxdb/latest/guides/writing_data/) so you don't have to write any server side code to get up and running.
* It aims to answer queries in real-time. That means every data point is * Data can be tagged, allowing very flexible querying.
indexed as it comes in and is immediately available in queries that * SQL-like query language.
should return in < 100ms. * Simple to install and manage, and fast to get data in and out.
* It aims to answer queries in real-time. That means every data point is
--- indexed as it comes in and is immediately available in queries that
# Grafana should return in < 100ms.
Grafana is an open source, feature rich metrics dashboard and graph editor for ---
Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB. # Grafana
![](http://grafana.org/assets/img/features/dashboard_ex1.png) Grafana is an open source, feature rich metrics dashboard and graph editor for
Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB.
## Features
### Graphite Target Editor ![](http://grafana.org/assets/img/features/dashboard_ex1.png)
- Graphite target expression parser
- Feature rich query composer ## Features
- Quickly add and edit functions & parameters ### Graphite Target Editor
- Templated queries - Graphite target expression parser
- [See it in action](http://docs.grafana.org/datasources/graphite/) - Feature rich query composer
- Quickly add and edit functions & parameters
### Graphing - Templated queries
- Fast rendering, even over large timespans - [See it in action](http://docs.grafana.org/datasources/graphite/)
- Click and drag to zoom
- Multiple Y-axis, logarithmic scales ### Graphing
- Bars, Lines, Points - Fast rendering, even over large timespans
- Smart Y-axis formatting - Click and drag to zoom
- Series toggles & color selector - Multiple Y-axis, logarithmic scales
- Legend values, and formatting options - Bars, Lines, Points
- Grid thresholds, axis labels - Smart Y-axis formatting
- [Annotations](http://docs.grafana.org/reference/annotations/) - Series toggles & color selector
- Any panel can be rendered to PNG (server side using phantomjs) - Legend values, and formatting options
- Grid thresholds, axis labels
### Dashboards - [Annotations](http://docs.grafana.org/reference/annotations/)
- Create, edit, save & search dashboards - Any panel can be rendered to PNG (server side using phantomjs)
- Change column spans and row heights
- Drag and drop panels to rearrange ### Dashboards
- [Templating](http://docs.grafana.org/reference/templating/) - Create, edit, save & search dashboards
- [Scripted dashboards](http://docs.grafana.org/reference/scripting/) - Change column spans and row heights
- [Dashboard playlists](http://docs.grafana.org/reference/playlist/) - Drag and drop panels to rearrange
- [Time range controls](http://docs.grafana.org/reference/timerange/) - [Templating](http://docs.grafana.org/reference/templating/)
- [Share snapshots publicly](http://docs.grafana.org/v2.0/reference/sharing/) - [Scripted dashboards](http://docs.grafana.org/reference/scripting/)
- [Dashboard playlists](http://docs.grafana.org/reference/playlist/)
### Elasticsearch - [Time range controls](http://docs.grafana.org/reference/timerange/)
- Feature rich query editor UI - [Share snapshots publicly](http://docs.grafana.org/v2.0/reference/sharing/)
### InfluxDB ### Elasticsearch
- Use InfluxDB as a metric data source, annotation source - Feature rich query editor UI
- Query editor with series and column typeahead, easy group by and function selection
### InfluxDB
### OpenTSDB - Use InfluxDB as a metric data source, annotation source
- Use as metric data source - Query editor with series and column typeahead, easy group by and function selection
- Query editor with metric name typeahead and tag filtering
### OpenTSDB
# Links - Use as metric data source
- Query editor with metric name typeahead and tag filtering
* Report a bug: https://github.com/YunoHost-Apps/grafana_ynh/issues
* InfluxDB website: https://www.influxdata.com/ # Links
* Grafana website: http://grafana.org/
* YunoHost website: https://yunohost.org/ * Report a bug: https://github.com/YunoHost-Apps/grafana_ynh/issues
* InfluxDB website: https://www.influxdata.com/
* Grafana website: http://grafana.org/
* YunoHost website: https://yunohost.org/