summaryrefslogtreecommitdiffstats
path: root/streaming
diff options
context:
space:
mode:
authorChris Akritidis <43294513+cakrit@users.noreply.github.com>2018-11-12 21:34:59 +0100
committerCosta Tsaousis <costa@tsaousis.gr>2018-11-12 22:34:59 +0200
commit3aae8f6c2ceea7f74cde61a2044aa50c5f252fae (patch)
tree781412f323c0183c520e4ff1c9fdac53a900b463 /streaming
parenta29b433526f56fe983d88dc4e86585bad65916c4 (diff)
Htmldoc (#4607)
* First html documentation debug set * Test 2 * Relative path changed * Updated comments * Cleanup, installation draft added * fixes * test * test * test * First html documentation debug set * Test 2 * Relative path changed * Updated comments * Cleanup, installation draft added * fixes * test * test * test * First set of major cleanup/deduplication * 2nd major cleanup * update getting started structure * Cleanup in using netdata * Final cleanup/deduplication * Added initial CONTRIBUTING.md, updated some info related to contributing on the orchestrators * Removed Why-Netdata (included in new README in master), added link to CONTRIBUTING.md * First html documentation debug set * Updated Makefile.am to ignore the new md and htmldoc generation files * Removing files from rebase * First html documentation debug set * Test 2 * Relative path changed * Updated comments * Cleanup, installation draft added * fixes * test * test * test * First html documentation debug set * Test 2 * Relative path changed * Updated comments * Cleanup, installation draft added * test * test * First set of major cleanup/deduplication * 2nd major cleanup * update getting started structure * Cleanup in using netdata * Final cleanup/deduplication * Added initial CONTRIBUTING.md, updated some info related to contributing on the orchestrators * Removed Why-Netdata (included in new README in master), added link to CONTRIBUTING.md * First html documentation debug set * Updated Makefile.am to ignore the new md and htmldoc generation files * Removing files from rebase * Fixed Makefile.am * Same line header and badges * Fixed broken link * CPU monitoring is in apps plugin * Removed obsolete files * Remove obsolete files * - Make the Health API part of health/README.md new file web/api/health/README.md - Make installer/LAUNCH.md part of deamon/README.md - Move installer/MAINTAINERS.md to packaging/maintainers/README.md - Move installer/DOCKER.md to docker/README.md - Move system/README.md to daemon/config/README.md - Move web/CUSTOM-DASHBOARDS.md to web/gui/custom/README.md - Move web/CONFLUENCE-DASHBOARDS.md to web/gui/confluence/README.md * Resolve codacy issue $(..) syntax instead of `..` * Fix following warnings and add svgs to the data_structures/README.md - CHANGELOG.md - CODE_OF_CONDUCT.md - CONTRIBUTORS.md - REDISTRIBUTED.md - diagrams/data_structures/README.md - docker/README.md WARNING - Documentation file 'README.md' contains a link to 'collectors/plugins.d' which does not exist in the documentation directory. WARNING - Documentation file 'README.md' contains a link to 'collectors/statsd.plugin' which does not exist in the documentation directory. WARNING - Documentation file 'CONTRIBUTING.md' contains a link to 'web/CUSTOM-DASHBOARDS.md' which does not exist in the documentation directory. WARNING - Documentation file 'CONTRIBUTING.md' contains a link to 'web/CONFLUENCE-DASHBOARDS.md' which does not exist in the documentation directory. * Wrong urls in data_structures/README.md svgs * Fix svg URLs number 2 * Modify the first line of the main README.md, to enable proper static html generation. Executed after copying the file to htmldoc/src * Added back Why Netdata * Fixed link to registry in Why-Netdata.md * Added Why-Netdata to buildyaml and to Makefile.am * Replaced http links causing mixed content warnings * Made buildhtml ignore the directory node_modules created by Netlify * Corrected CONTRIBUTING.MD to CONTRIBUTING.md
Diffstat (limited to 'streaming')
-rw-r--r--streaming/README.md32
1 files changed, 17 insertions, 15 deletions
diff --git a/streaming/README.md b/streaming/README.md
index 7cf8bf53ee..93683078bd 100644
--- a/streaming/README.md
+++ b/streaming/README.md
@@ -11,9 +11,9 @@ a netdata performs:
- run health checks that trigger alarms and send alarm notifications
- archive metrics to a backend time-series database
-The following configurations are supported:
+## Supported configurations
-#### Netdata without a database or web API (headless collector)
+### netdata without a database or web API (headless collector)
Local netdata (`slave`), **without any database or alarms**, collects metrics and sends them to
another netdata (`master`).
@@ -28,7 +28,7 @@ of maintaining a local database and accepting dashboard requests, it streams all
The same `master` can collect data for any number of `slaves`.
-#### Database replication
+### database replication
Local netdata (`slave`), **with a local database (and possibly alarms)**, collects metrics and
sends them to another netdata (`master`).
@@ -41,7 +41,7 @@ The `slave` and the `master` may have different data retention policies for the
Alarms for the `slave` are triggered by **both** the `slave` and the `master` (and actually
each can have different alarms configurations or have alarms disabled).
-#### netdata proxies
+### netdata proxies
Local netdata (`slave`), with or without a database, collects metrics and sends them to another
netdata (`proxy`), which may or may not maintain a database, which forwards them to another
@@ -52,7 +52,7 @@ Alarms for the slave can be triggered by any of the involved hosts that maintain
Any number of daisy chaining netdata servers are supported, each with or without a database and
with or without alarms for the `slave` metrics.
-#### mix and match with backends
+### mix and match with backends
All nodes that maintain a database can also send their data to a backend database.
This allows quite complex setups.
@@ -67,7 +67,7 @@ Example:
6. alarms are triggered by `H` for all hosts
7. users can use all the netdata that maintain a database to view metrics (i.e. at `H` all hosts can be viewed).
-#### netdata.conf configuration
+## Configuration
These are options that affect the operation of netdata in this area:
@@ -98,9 +98,9 @@ This also disables the registry (there cannot be a registry without an API).
`[backend]` configures data archiving to a backend (it archives all databases maintained on
this host).
-#### streaming configuration
+### streaming configuration
-A new file is introduced: [stream.conf](stream.conf) (to edit it on your system run
+A new file is introduced: [stream.conf](https://github.com/netdata/netdata/tree/master/streaming/stream.conf) (to edit it on your system run
`/etc/netdata/edit-config stream.conf`). This file holds streaming configuration for both the
sending and the receiving netdata.
@@ -167,7 +167,7 @@ the unique id the netdata generating the metrics (i.e. the netdata that original
them `/var/lib/netdata/registry/netdata.unique.id`). So, metrics for netdata `A` that pass through
any number of other netdata, will have the same `MACHINE_GUID`.
-####### allow from
+##### allow from
`allow from` settings are [netdata simple patterns](../libnetdata/simple_pattern): string matches
that use `*` as wildcard (any number of times) and a `!` prefix for a negative match.
@@ -176,7 +176,7 @@ important: left to right, the first positive or negative match is used.
`allow from` is available in netdata v1.9+
-#### tracing
+##### tracing
When a `slave` is trying to push metrics to a `master` or `proxy`, it logs entries like these:
@@ -203,7 +203,7 @@ The receiving end (`proxy` or `master`) logs entries like these:
For netdata v1.9+, streaming can also be monitored via `access.log`.
-#### Viewing remote host dashboards, using mirrored databases
+## Viewing remote host dashboards, using mirrored databases
On any receiving netdata, that maintains remote databases and has its web server enabled,
`my-netdata` menu will include a list of the mirrored databases.
@@ -240,7 +240,7 @@ Following the netdata way of monitoring, we wanted:
3. **zero configuration**, all ephemeral servers should have exactly the same configuration, and nothing should be configured at any system for each of the ephemeral nodes. We shouldn't care if 10 or 100 servers are spawned to handle the load.
4. **self-cleanup**, so that nothing needs to be done for cleaning up the monitoring infrastructure from the hundreds of nodes that may have been monitored through time.
-#### How it works
+### How it works
All monitoring solutions, including netdata, work like this:
@@ -306,10 +306,10 @@ On each of the slaves, edit `/etc/netdata/stream.conf` (to edit it on your syste
[stream]
# stream metrics to another netdata
enabled = yes
-
+
# the IP and PORT of the master
destination = 10.11.12.13:19999
-
+
# the API key to use
api key = 11111111-2222-3333-4444-555555555555
```
@@ -340,6 +340,7 @@ The file `/var/lib/netdata/registry/netdata.public.unique.id` contains a random
Both the sender and the receiver of metrics log information at `/var/log/netdata/error.log`.
+
On both master and slave do this:
```
@@ -393,6 +394,7 @@ This means a setup like the following is also possible:
<img src="https://cloud.githubusercontent.com/assets/2662304/23629551/bb1fd9c2-02c0-11e7-90f5-cab5a3ed4c53.png"/>
</p>
+
## proxies
A proxy is a netdata that is receiving metrics from a netdata, and streams them to another netdata.
@@ -402,7 +404,7 @@ When they maintain a database, they can also run health checks (alarms and notif
for the remote host that is streaming the metrics.
To configure a proxy, configure it as a receiving and a sending netdata at the same time,
-using [stream.conf](stream.conf).
+using [stream.conf](https://github.com/netdata/netdata/tree/master/streaming/stream.conf).
The sending side of a netdata proxy, connects and disconnects to the final destination of the
metrics, following the same pattern of the receiving side.