You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: DOCUMENTATION.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Welcome! You've arrived at the documentation for Netdata. Use the links below to
14
14
15
15
</div>
16
16
<divclass="nav-getting-started">
17
-
<a class="nav-button" href="docs/GettingStarted/">Getting started guide</a>
17
+
<a class="nav-button" href="docs/getting-started/">Getting started guide</a>
18
18
<p>The perfect place for Netdata beginners to start. Learn how to access Netdata's dashboard, start and stop the service, basic configuration, and more.</p>
Copy file name to clipboardexpand all lines: SECURITY.md
+3-1
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,9 @@
10
10
11
11
We’re extremely grateful for security researchers and users that report vulnerabilities to Netdata Open Source Community. All reports are thoroughly investigated by a set of community volunteers.
12
12
13
-
To make a report, please create a post [here](https://groups.google.com/a/netdata.cloud/forum/#!newtopic/security) with the vulnerability details and the details expected for [all Netdata bug reports](.github/ISSUE_TEMPLATE/bug_report.md).
13
+
To make a report, please create a post [here](https://groups.google.com/a/netdata.cloud/forum/#!newtopic/security) with
14
+
the vulnerability details and the details expected for [all Netdata bug
Copy file name to clipboardexpand all lines: collectors/tc.plugin/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ QoS is about 2 features:
62
62
63
63
When your system is under a DDoS attack, it will get a lot more bandwidth compared to the one it can handle and probably your applications will crash. Setting a limit on the inbound traffic using QoS, will protect your servers (throttle the requests) and depending on the size of the attack may allow your legitimate users to access the server, while the attack is taking place.
64
64
65
-
Using QoS together with a [SYNPROXY](../proc.plugin/README.md#linux-anti-ddos) will provide a great degree of protection against most DDoS attacks. Actually when I wrote that article, a few folks tried to DDoS the Netdata demo site to see in real-time the SYNPROXY operation. They did not do it right, but anyway a great deal of requests reached the Netdata server. What saved Netdata was QoS. The Netdata demo server has QoS installed, so the requests were throttled and the server did not even reach the point of resource starvation. Read about it [here](../proc.plugin/README.md#linux-anti-ddos).
65
+
Using QoS together with a [SYNPROXY](../../collectors/proc.plugin/README.md) will provide a great degree of protection against most DDoS attacks. Actually when I wrote that article, a few folks tried to DDoS the Netdata demo site to see in real-time the SYNPROXY operation. They did not do it right, but anyway a great deal of requests reached the Netdata server. What saved Netdata was QoS. The Netdata demo server has QoS installed, so the requests were throttled and the server did not even reach the point of resource starvation. Read about it [here](../../collectors/proc.plugin/README.md).
66
66
67
67
On top of all these, QoS is extremely light. You will configure it once, and this is it. It will not bother you again and it will not use any noticeable CPU resources, especially on application and database servers.
Copy file name to clipboardexpand all lines: docs/contributing/contributing-documentation.md
+6-4
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ followed by [Mastering Markdown](https://guides.github.com/features/mastering-ma
19
19
20
20
There are two ways to contribute to Netdata's documentation:
21
21
22
-
1. Edit documentation [directly in GitHub](#edit-documentation-directly-on-gitHub).
22
+
1. Edit documentation [directly in GitHub](#edit-documentation-directly-on-github).
23
23
2. Download the repository and [edit documentation locally](#edit-documentation-locally).
24
24
25
25
Editing in GitHub is a simpler process and is perfect for quick edits to a single document,
@@ -45,7 +45,7 @@ Start editing documentation on GitHub by clicking the small pencil icon on any p
45
45
You can find them at the top of every page.
46
46
47
47
Clicking on this icon will take you to the associated page in the `netdata/netdata` repository.
48
-
Then click the small pencil icon on any documentation file (those ending in the `.md`[Markdown] extension) in the `netdata/netdata` repository.
48
+
Then click the small pencil icon on any documentation file (those ending in the `.md` Markdown extension) in the `netdata/netdata` repository.
49
49
50
50

51
51
@@ -109,7 +109,8 @@ folder and either name it `README.md` for generic documentation, or with another
109
109
110
110
At the root of the Netdata repository is a `docs/` folder. Inside this folder we place documentation that does not have
111
111
a direct relationship to a specific component of Netdata. It's where we house our [getting started
112
-
guide](../getting-started.md), guides on [running Netdata behind Nginx](../Running-behind-nginx.md), and more.
112
+
guide](../../docs/getting-started.md), guides on [running Netdata behind Nginx](../../docs/Running-behind-nginx.md), and
113
+
more.
113
114
114
115
If the documentation you're working on doesn't have a direct relaionship to a component of Netdata,
115
116
it can be placed in this `docs/` folder.
@@ -168,7 +169,8 @@ cd docs/generator/build/
168
169
python3 -m http.server 20000
169
170
```
170
171
171
-
Feel free to replace the port number you want this web server to listen on (port `20000` in this case [only one higher than the agent!]).
172
+
Feel free to replace the port number you want this web server to listen on (port `20000` in this case (only one higher
173
+
than the agent!)).
172
174
173
175
Open your web browser and navigate to `http://localhost:20000`.
174
176
If you replaced the port earlier, change it here as well.
Copy file name to clipboardexpand all lines: docs/what-is-netdata.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ We provide docker images for the most common architectures. These are statistics
43
43
44
44
### Registry
45
45
46
-
When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata registry](../registry/#registry). This is a web browser feature and it allows us to count the number of unique users and unique Netdata servers installed. The following information comes from the global public Netdata registry we run:
46
+
When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata registry](../registry/). This is a web browser feature and it allows us to count the number of unique users and unique Netdata servers installed. The following information comes from the global public Netdata registry we run:
|**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/#data-collection-plugins)|
95
-
|**Store**|Metrics are stored in RAM in a round robin database (ring buffer), using a custom made floating point number for minimal footprint.|[`database`](../database/#database)|
96
-
|**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/#health-monitoring)|
97
-
|**Stream**|An 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/#streaming-and-replication)|
94
+
|**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/)|
95
+
|**Store**|Metrics are stored in RAM in a round robin database (ring buffer), using a custom made floating point number for minimal footprint.|[`database`](../database/)|
96
+
|**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/)|
97
+
|**Stream**|An 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/)|
98
98
|**Archive**|A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases.|[`backends`](../backends/)|
99
-
|**Query**|Multiple independent workers are attached to the [internal web server](../web/server/#web-server), servicing API requests, including [data queries](../web/api/queries/#database-queries).|[`web/api`](../web/api/#api)|
99
+
|**Query**|Multiple independent workers are attached to the [internal web server](../web/server/), servicing API requests, including [data queries](../web/api/queries/README.md).|[`web/api`](../web/api/)|
100
100
101
101
The result is a highly efficient, low latency system, supporting multiple readers and one writer on each metric.
0 commit comments