YunoHost-Apps/netdata_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/netdata_ynh.git synced 2024-09-03 19:46:33 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-07-05 14:14:36 +00:00
parent f75b63cad8
commit 321e6e8a1d
2 changed files with 231 additions and 231 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

460
README.md
View file

@ -1,230 +1,230 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
# NetData for YunoHost # NetData for YunoHost
[![Integration level](https://dash.yunohost.org/integration/netdata.svg)](https://dash.yunohost.org/appci/app/netdata) ![Working status](https://ci-apps.yunohost.org/ci/badges/netdata.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/netdata.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/netdata.svg)](https://dash.yunohost.org/appci/app/netdata) ![Working status](https://ci-apps.yunohost.org/ci/badges/netdata.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/netdata.maintain.svg)
[![Install NetData with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=netdata) [![Install NetData with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=netdata)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install NetData quickly and simply on a YunoHost server. > *This package allows you to install NetData quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
[NetData](http://my-netdata.io/) is a system for **distributed real-time performance and health monitoring**. [NetData](http://my-netdata.io/) is a system for **distributed real-time performance and health monitoring**.
It provides **unparalleled insights, in real-time**, of everything happening on the It provides **unparalleled insights, in real-time**, of everything happening on the
system it runs (including applications such as web and database servers), using system it runs (including applications such as web and database servers), using
**modern interactive web dashboards**. **modern interactive web dashboards**.
_netdata is **fast** and **efficient**, designed to permanently run on all systems _netdata is **fast** and **efficient**, designed to permanently run on all systems
(**physical** & **virtual** servers, **containers**, **IoT** devices), without (**physical** & **virtual** servers, **containers**, **IoT** devices), without
disrupting their core function._ disrupting their core function._
**Shipped version:** 1.35.1~ynh2 **Shipped version:** 1.35.1~ynh1
**Demo:** https://learn.netdata.cloud/docs/agent/demo-sites/ **Demo:** https://learn.netdata.cloud/docs/agent/demo-sites/
## Disclaimers / important information ## Disclaimers / important information
**Customization brought by the package:** **Customization brought by the package:**
* Netdata Cloud functionality disabled * Netdata Cloud functionality disabled
* grant MySQL statistics access via a `netdata` user * grant MySQL statistics access via a `netdata` user
* nginx root log statistics via putting `netdata` user in the `adm` group * nginx root log statistics via putting `netdata` user in the `adm` group
* Dovecot statistics via giving access to Dovecot stats stocket to `netdata` user (works only with Dovecot 2.2.16+) * Dovecot statistics via giving access to Dovecot stats stocket to `netdata` user (works only with Dovecot 2.2.16+)
**Further recommendations:** **Further recommendations:**
We don't allow YunoHost packages to make changes to sensitive system files. So here are further customizations you can make to allow more monitoring: We don't allow YunoHost packages to make changes to sensitive system files. So here are further customizations you can make to allow more monitoring:
* Nginx: * Nginx:
* requests/connections: follow [these recommandations](https://github.com/netdata/netdata/tree/master/collectors/python.d.plugin/nginx) to enable `/stab_status`; for example by creating the file `/etc/nginx/conf.d/default.d/netdat_stub.conf` with the following content: * requests/connections: follow [these recommandations](https://github.com/netdata/netdata/tree/master/collectors/python.d.plugin/nginx) to enable `/stab_status`; for example by creating the file `/etc/nginx/conf.d/default.d/netdat_stub.conf` with the following content:
``` ```
# For Netdata # For Netdata
location /stub_status { location /stub_status {
stub_status on; stub_status on;
# Security: Only allow access from the IP below. # Security: Only allow access from the IP below.
allow 127.0.0.1; allow 127.0.0.1;
# Deny anyone else # Deny anyone else
deny all; deny all;
} }
``` ```
* weblogs: you can monitor all your nginx weblogs for errors; follow [these recommendations](https://github.com/firehol/netdata/tree/master/python.d#nginx_log) * weblogs: you can monitor all your nginx weblogs for errors; follow [these recommendations](https://github.com/firehol/netdata/tree/master/python.d#nginx_log)
* phpfpm: follow [these recommandations](https://github.com/firehol/netdata/tree/master/python.d#phpfpm) * phpfpm: follow [these recommandations](https://github.com/firehol/netdata/tree/master/python.d#phpfpm)
* NetData registry: set the instance as its own NetData registry server to avoid leaking any information by default * NetData registry: set the instance as its own NetData registry server to avoid leaking any information by default
It has been tested on x86_64 and ARM. It has been tested on x86_64 and ARM.
## How it works ## How it works
Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for
concurrent operations on the metrics. concurrent operations on the metrics.
![image](https://user-images.githubusercontent.com/2662304/48323827-b4c17580-e636-11e8-842c-0ee72fcb4115.png) ![image](https://user-images.githubusercontent.com/2662304/48323827-b4c17580-e636-11e8-842c-0ee72fcb4115.png)
This is how it works: This is how it works:
| Function | Description | Documentation | | Function | Description | Documentation |
| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- | | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- |
| **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](/collectors/README.md) | | **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](/collectors/README.md) |
| **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](/database/README.md) | | **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](/database/README.md) |
| **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](/health/README.md) | | **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](/health/README.md) |
| **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](/streaming/README.md) | | **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](/streaming/README.md) |
| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`backends`](/backends/README.md) | | **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`backends`](/backends/README.md) |
| **Query** | Multiple independent workers are attached to the [internal web server](/web/server/README.md), servicing API requests, including [data queries](/web/api/queries/README.md). | [`web/api`](/web/api/README.md) | | **Query** | Multiple independent workers are attached to the [internal web server](/web/server/README.md), servicing API requests, including [data queries](/web/api/queries/README.md). | [`web/api`](/web/api/README.md) |
The result is a highly efficient, low-latency system, supporting multiple readers and one writer on each metric. The result is a highly efficient, low-latency system, supporting multiple readers and one writer on each metric.
## Infographic ## Infographic
This is a high level overview of Netdata feature set and architecture. Click it to to interact with it (it has direct This is a high level overview of Netdata feature set and architecture. Click it to to interact with it (it has direct
links to our documentation). links to our documentation).
[![image](https://user-images.githubusercontent.com/43294513/60951037-8ba5d180-a2f8-11e9-906e-e27356f168bc.png)](https://my-netdata.io/infographic.html) [![image](https://user-images.githubusercontent.com/43294513/60951037-8ba5d180-a2f8-11e9-906e-e27356f168bc.png)](https://my-netdata.io/infographic.html)
## Features ## Features
![finger-video](https://user-images.githubusercontent.com/2662304/48346998-96cf3180-e685-11e8-9f4e-059d23aa3aa5.gif) ![finger-video](https://user-images.githubusercontent.com/2662304/48346998-96cf3180-e685-11e8-9f4e-059d23aa3aa5.gif)
This is what you should expect from Netdata: This is what you should expect from Netdata:
### General ### General
- **1s granularity** - The highest possible resolution for all metrics. - **1s granularity** - The highest possible resolution for all metrics.
- **Unlimited metrics** - Netdata collects all the available metrics—the more, the better. - **Unlimited metrics** - Netdata collects all the available metrics—the more, the better.
- **1% CPU utilization of a single core** - It's unbelievably optimized. - **1% CPU utilization of a single core** - It's unbelievably optimized.
- **A few MB of RAM** - The highly-efficient database engine stores per-second metrics in RAM and then "spills" - **A few MB of RAM** - The highly-efficient database engine stores per-second metrics in RAM and then "spills"
historical metrics to disk long-term storage. historical metrics to disk long-term storage.
- **Minimal disk I/O** - While running, Netdata only writes historical metrics and reads `error` and `access` logs. - **Minimal disk I/O** - While running, Netdata only writes historical metrics and reads `error` and `access` logs.
- **Zero configuration** - Netdata auto-detects everything, and can collect up to 10,000 metrics per server out of the - **Zero configuration** - Netdata auto-detects everything, and can collect up to 10,000 metrics per server out of the
box. box.
- **Zero maintenance** - You just run it. Netdata does the rest. - **Zero maintenance** - You just run it. Netdata does the rest.
- **Zero dependencies** - Netdata runs a custom web server for its static web files and its web API (though its - **Zero dependencies** - Netdata runs a custom web server for its static web files and its web API (though its
plugins may require additional libraries, depending on the applications monitored). plugins may require additional libraries, depending on the applications monitored).
- **Scales to infinity** - You can install it on all your servers, containers, VMs, and IoT devices. Metrics are not - **Scales to infinity** - You can install it on all your servers, containers, VMs, and IoT devices. Metrics are not
centralized by default, so there is no limit. centralized by default, so there is no limit.
- **Several operating modes** - Autonomous host monitoring (the default), headless data collector, forwarding proxy, - **Several operating modes** - Autonomous host monitoring (the default), headless data collector, forwarding proxy,
store and forward proxy, central multi-host monitoring, in all possible configurations. Each node may have different store and forward proxy, central multi-host monitoring, in all possible configurations. Each node may have different
metrics retention policies and run with or without health monitoring. metrics retention policies and run with or without health monitoring.
### Health Monitoring & Alarms ### Health Monitoring & Alarms
- **Sophisticated alerting** - Netdata comes with hundreds of alarms **out of the box**! It supports dynamic - **Sophisticated alerting** - Netdata comes with hundreds of alarms **out of the box**! It supports dynamic
thresholds, hysteresis, alarm templates, multiple role-based notification methods, and more. thresholds, hysteresis, alarm templates, multiple role-based notification methods, and more.
- **Notifications**: [alerta.io](/health/notifications/alerta/), [amazon sns](/health/notifications/awssns/), - **Notifications**: [alerta.io](/health/notifications/alerta/), [amazon sns](/health/notifications/awssns/),
[discordapp.com](/health/notifications/discord/), [email](/health/notifications/email/), [discordapp.com](/health/notifications/discord/), [email](/health/notifications/email/),
[flock.com](/health/notifications/flock/), [hangouts](/health/notifications/hangouts/), [flock.com](/health/notifications/flock/), [hangouts](/health/notifications/hangouts/),
[irc](/health/notifications/irc/), [kavenegar.com](/health/notifications/kavenegar/), [irc](/health/notifications/irc/), [kavenegar.com](/health/notifications/kavenegar/),
[messagebird.com](/health/notifications/messagebird/), [pagerduty.com](/health/notifications/pagerduty/), [messagebird.com](/health/notifications/messagebird/), [pagerduty.com](/health/notifications/pagerduty/),
[prowl](health/notifications/prowl/), [pushbullet.com](/health/notifications/pushbullet/), [prowl](health/notifications/prowl/), [pushbullet.com](/health/notifications/pushbullet/),
[pushover.net](health/notifications/pushover/), [rocket.chat](/health/notifications/rocketchat/), [pushover.net](health/notifications/pushover/), [rocket.chat](/health/notifications/rocketchat/),
[slack.com](/health/notifications/slack/), [smstools3](/health/notifications/smstools3/), [slack.com](/health/notifications/slack/), [smstools3](/health/notifications/smstools3/),
[syslog](/health/notifications/syslog/), [telegram.org](/health/notifications/telegram/), [syslog](/health/notifications/syslog/), [telegram.org](/health/notifications/telegram/),
[twilio.com](/health/notifications/twilio/), [web](/health/notifications/web/) and [custom [twilio.com](/health/notifications/twilio/), [web](/health/notifications/web/) and [custom
notifications](/health/notifications/custom/). notifications](/health/notifications/custom/).
### Integrations ### Integrations
- **Time-series databases** - Netdata can archive its metrics to **Graphite**, **OpenTSDB**, **Prometheus**, **AWS - **Time-series databases** - Netdata can archive its metrics to **Graphite**, **OpenTSDB**, **Prometheus**, **AWS
Kinesis**, **MongoDB**, **JSON document DBs**, in the same or lower resolution (lower: to prevent it from congesting Kinesis**, **MongoDB**, **JSON document DBs**, in the same or lower resolution (lower: to prevent it from congesting
these servers due to the amount of data collected). Netdata also supports **Prometheus remote write API**, which these servers due to the amount of data collected). Netdata also supports **Prometheus remote write API**, which
allows storing metrics to **Elasticsearch**, **Gnocchi**, **InfluxDB**, **Kafka**, **PostgreSQL/TimescaleDB**, allows storing metrics to **Elasticsearch**, **Gnocchi**, **InfluxDB**, **Kafka**, **PostgreSQL/TimescaleDB**,
**Splunk**, **VictoriaMetrics** and a lot of other [storage **Splunk**, **VictoriaMetrics** and a lot of other [storage
providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage). providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage).
## Visualization ## Visualization
- **Stunning interactive dashboards** - Our dashboard is mouse-, touchpad-, and touch-screen friendly in 2 themes: - **Stunning interactive dashboards** - Our dashboard is mouse-, touchpad-, and touch-screen friendly in 2 themes:
`slate` (dark) and `white`. `slate` (dark) and `white`.
- **Amazingly fast visualization** - Even on low-end hardware, the dashboard responds to all queries in less than 1 ms - **Amazingly fast visualization** - Even on low-end hardware, the dashboard responds to all queries in less than 1 ms
per metric. per metric.
- **Visual anomaly detection** - Our UI/UX emphasizes the relationships between charts so you can better detect - **Visual anomaly detection** - Our UI/UX emphasizes the relationships between charts so you can better detect
anomalies visually. anomalies visually.
- **Embeddable** - Charts can be embedded on your web pages, wikis and blogs. You can even use [Atlassian's Confluence - **Embeddable** - Charts can be embedded on your web pages, wikis and blogs. You can even use [Atlassian's Confluence
as a monitoring dashboard](/web/gui/confluence/README.md). as a monitoring dashboard](/web/gui/confluence/README.md).
- **Customizable** - You can build custom dashboards using simple HTML. No JavaScript needed! - **Customizable** - You can build custom dashboards using simple HTML. No JavaScript needed!
### Positive and negative values ### Positive and negative values
To improve clarity on charts, Netdata dashboards present **positive** values for metrics representing `read`, `input`, To improve clarity on charts, Netdata dashboards present **positive** values for metrics representing `read`, `input`,
`inbound`, `received` and **negative** values for metrics representing `write`, `output`, `outbound`, `sent`. `inbound`, `received` and **negative** values for metrics representing `write`, `output`, `outbound`, `sent`.
![positive-and-negative-values](https://user-images.githubusercontent.com/2662304/48309090-7c5c6180-e57a-11e8-8e03-3a7538c14223.gif) ![positive-and-negative-values](https://user-images.githubusercontent.com/2662304/48309090-7c5c6180-e57a-11e8-8e03-3a7538c14223.gif)
_Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is _Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is
negative._ negative._
### Autoscaled y-axis ### Autoscaled y-axis
Netdata charts automatically zoom vertically, to visualize the variation of each metric within the visible time-frame. Netdata charts automatically zoom vertically, to visualize the variation of each metric within the visible time-frame.
![non-zero-based](https://user-images.githubusercontent.com/2662304/48309139-3d2f1000-e57c-11e8-9a44-b91758134b00.gif) ![non-zero-based](https://user-images.githubusercontent.com/2662304/48309139-3d2f1000-e57c-11e8-9a44-b91758134b00.gif)
_A zero-based `stacked` chart, automatically switches to an auto-scaled `area` chart when a single dimension is _A zero-based `stacked` chart, automatically switches to an auto-scaled `area` chart when a single dimension is
selected._ selected._
### Charts are synchronized ### Charts are synchronized
Charts on Netdata dashboards are synchronized to each other. There is no master chart. Any chart can be panned or zoomed Charts on Netdata dashboards are synchronized to each other. There is no master chart. Any chart can be panned or zoomed
at any time, and all other charts will follow. at any time, and all other charts will follow.
![charts-are-synchronized](https://user-images.githubusercontent.com/2662304/48309003-b4fb3b80-e578-11e8-86f6-f505c7059c15.gif) ![charts-are-synchronized](https://user-images.githubusercontent.com/2662304/48309003-b4fb3b80-e578-11e8-86f6-f505c7059c15.gif)
_Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the _Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the
mouse pointer is over a chart._ mouse pointer is over a chart._
> The visible time-frame (pan and zoom) is propagated from Netdata server to Netdata server when navigating via the > The visible time-frame (pan and zoom) is propagated from Netdata server to Netdata server when navigating via the
> [My nodes menu](/registry/README.md). > [My nodes menu](/registry/README.md).
### Highlighted time-frame ### Highlighted time-frame
To improve visual anomaly detection across charts, the user can highlight a time-frame (by pressing `Alt` + `mouse To improve visual anomaly detection across charts, the user can highlight a time-frame (by pressing `Alt` + `mouse
selection`) on all charts. selection`) on all charts.
![highlighted-timeframe](https://user-images.githubusercontent.com/2662304/48311876-f9093300-e5ae-11e8-9c74-e3e291741990.gif) ![highlighted-timeframe](https://user-images.githubusercontent.com/2662304/48311876-f9093300-e5ae-11e8-9c74-e3e291741990.gif)
_A highlighted time-frame can be given by pressing `Alt` + `mouse selection` on any chart. Netdata will highlight the _A highlighted time-frame can be given by pressing `Alt` + `mouse selection` on any chart. Netdata will highlight the
same range on all charts._ same range on all charts._
> Highlighted ranges are propagated from Netdata server to Netdata server, when navigating via the [My nodes > Highlighted ranges are propagated from Netdata server to Netdata server, when navigating via the [My nodes
> menu](/registry/README.md). > menu](/registry/README.md).
## What Netdata monitors ## What Netdata monitors
Netdata can collect metrics from 200+ popular services and applications, on top of dozens of system-related metrics Netdata can collect metrics from 200+ popular services and applications, on top of dozens of system-related metrics
jocs, such as CPU, memory, disks, filesystems, networking, and more. We call these **collectors**, and they're managed jocs, such as CPU, memory, disks, filesystems, networking, and more. We call these **collectors**, and they're managed
by [**plugins**](/collectors/plugins.d/README.md), which support a variety of programming languages, including Go and by [**plugins**](/collectors/plugins.d/README.md), which support a variety of programming languages, including Go and
Python. Python.
Popular collectors include **Nginx**, **Apache**, **MySQL**, **statsd**, **cgroups** (containers, Docker, Kubernetes, Popular collectors include **Nginx**, **Apache**, **MySQL**, **statsd**, **cgroups** (containers, Docker, Kubernetes,
LXC, and more), **Traefik**, **web server `access.log` files**, and much more. LXC, and more), **Traefik**, **web server `access.log` files**, and much more.
See the **full list of [supported collectors](/collectors/COLLECTORS.md)**. See the **full list of [supported collectors](/collectors/COLLECTORS.md)**.
Netdata's data collection is **extensible**, which means you can monitor anything you can get a metric for. You can even Netdata's data collection is **extensible**, which means you can monitor anything you can get a metric for. You can even
write a collector for your custom application using our [plugin API](/collectors/plugins.d/README.md). write a collector for your custom application using our [plugin API](/collectors/plugins.d/README.md).
## Documentation and resources ## Documentation and resources
* Official app website: <http://my-netdata.io> * Official app website: <http://my-netdata.io>
* Official admin documentation: <https://learn.netdata.cloud/docs> * Official admin documentation: <https://learn.netdata.cloud/docs>
* Upstream app code repository: <https://github.com/netdata/netdata> * Upstream app code repository: <https://github.com/netdata/netdata>
* YunoHost documentation for this app: <https://yunohost.org/app_netdata> * YunoHost documentation for this app: <https://yunohost.org/app_netdata>
* Report a bug: <https://github.com/YunoHost-Apps/netdata_ynh/issues> * Report a bug: <https://github.com/YunoHost-Apps/netdata_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/netdata_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/netdata_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` bash ``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/netdata_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/netdata_ynh/tree/testing --debug
or or
sudo yunohost app upgrade netdata -u https://github.com/YunoHost-Apps/netdata_ynh/tree/testing --debug sudo yunohost app upgrade netdata -u https://github.com/YunoHost-Apps/netdata_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps> **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

2
README_fr.md
View file

@ -25,7 +25,7 @@ _netdata is **fast** and **efficient**, designed to permanently run on all syste
disrupting their core function._ disrupting their core function._
**Version incluse :** 1.33.0~ynh2 **Version incluse :** 1.35.1~ynh1
**Démo :** https://learn.netdata.cloud/docs/agent/demo-sites/ **Démo :** https://learn.netdata.cloud/docs/agent/demo-sites/
## Avertissements / informations importantes ## Avertissements / informations importantes