7332919cf · cryptotaxi247/netdata-1

REDISTRIBUTED.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Redistributed software"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/REDISTRIBUTED.md

4 -sidebar_label: "Redistributed Software"

5 -learn_status: "Published"

6 -learn_topic_type: "Concepts"

7 -learn_rel_path: "Developers"

8 --->

9 -

1 # Redistributed software

2

3 Netdata copyright info:<br/>

docs/.templates/.page-level/_concept-page-template.md

-7

@@ -1,10 +1,3 @@

1 -<!--

2 -title: Noun that describes the concept

3 -description: Short summary (will be displayed in search engines)

4 -custom_edit_url: Edit URL of the source file

5 -keywords: [keywords, describing, the main topics]

6 --->

7 -

1 # Title

2

3 Why should the reader care: “What’s in it for me?”

docs/Demo-Sites.md

-10

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Live demos"

3 -date: 2020-03-26

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Demo-Sites.md

5 -sidebar_label: "Live demos"

6 -learn_status: "Published"

7 -learn_topic_type: "Getting started"

8 -learn_rel_path: "Getting started"

9 -sidebar_position: "90"

10 --->

1

2 # Live demos

3

docs/dashboards-and-charts/import-export-print-snapshot.md

-14

@@ -1,17 +1,3 @@

1 -<!--

2 -title: "Import, export, and print a snapshot"

3 -description: >-

4 - "Snapshots can be incredibly useful for diagnosing anomalies after

5 - they've already happened, and are interoperable with any other node

6 - running Netdata."

7 -type: "how-to"

8 -custom_edit_url: "/docs/dashboards-and-charts/import-export-print-snapshot.md"

9 -sidebar_label: "Import, export, and print a snapshot"

10 -learn_status: "Published"

11 -learn_topic_type: "Tasks"

12 -learn_rel_path: "Operations"

13 --->

14 -

1 # Import, export, and print a snapshot

2

3 >❗This feature is only available on v1 dashboards, it hasn't been port-forwarded to v2.

docs/developer-and-contributor-corner/collect-unbound-metrics.md

+1 -11

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Monitor Unbound DNS servers with Netdata"

3 -sidebar_label: "Monitor Unbound DNS servers with Netdata"

4 -date: 2020-03-31

5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/collect-unbound-metrics.md

6 -learn_status: "Published"

7 -learn_topic_type: "Tasks"

8 -learn_rel_path: "Miscellaneous"

9 --->

10 -

1 # Monitor Unbound DNS servers with Netdata

2

3 [Unbound](https://nlnetlabs.nl/projects/unbound/about/) is a "validating, recursive, caching DNS resolver" from NLNet

@@ -35,7 +25,7 @@ the TLS key files that will encrypt connections to the remote interface. Then ad

25 documentation](https://nlnetlabs.nl/documentation/unbound/howto-setup/#setup-remote-control) for more details on using

26 `unbound-control`, such as how to handle situations when Unbound is run under a unique user.

27

38 -```conf

28 +```text

29 # enable remote-control

30 remote-control:

31 control-enable: yes

docs/developer-and-contributor-corner/customize.md

+1 -1

@@ -66,7 +66,7 @@ dashboard.

66 Save the file, then navigate to your [Netdata config directory](/docs/netdata-agent/configuration/README.md) to edit `netdata.conf`. Add

67 the following line to the `[web]` section to tell Netdata where to find your custom configuration.

68

69 -```conf

69 +```text

70 [web]

71 custom dashboard_info.js = your_dashboard_info_file.js

72 ```

docs/developer-and-contributor-corner/lamp-stack.txt

+1 -1

@@ -124,7 +124,7 @@ sudo nano /etc/php/7.4/fpm/pool.d/www.conf

124

125 Find the line that reads `;pm.status_path = /status` and remove the `;` so it looks like this:

126

127 -```conf

127 +```text

128 pm.status_path = /status

129 ```

130

docs/developer-and-contributor-corner/monitor-debug-applications-ebpf.md

+3 -13

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Monitor, troubleshoot, and debug applications with eBPF metrics"

3 -sidebar_label: "Monitor, troubleshoot, and debug applications with eBPF metrics"

4 -description: "Use Netdata's built-in eBPF metrics collector to monitor, troubleshoot, and debug your custom application using low-level kernel feedback."

5 -image: /img/seo/guides/troubleshoot/monitor-debug-applications-ebpf.png

6 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md

7 -learn_status: "Published"

8 -learn_rel_path: "Operations"

9 --->

10 -

1 # Monitor, troubleshoot, and debug applications with eBPF metrics

2

3 When trying to troubleshoot or debug a finicky application, there's no such thing as too much information. At Netdata,

@@ -48,7 +38,7 @@ your application's process name.

38

39 Your file should now look like this:

40

51 -```conf

41 +```text

42 ...

43 # -----------------------------------------------------------------------------

44 # Custom applications to monitor with apps.plugin and ebpf.plugin

@@ -67,7 +57,7 @@ You can set up `apps_groups.conf` to more show more precise eBPF metrics for any

57 system, even if it's a standard package like Redis, Apache, or any other [application/service Netdata collects

58 from](/src/collectors/COLLECTORS.md).

59

70 -```conf

60 +```text

61 # -----------------------------------------------------------------------------

62 # Custom applications to monitor with apps.plugin and ebpf.plugin

63

@@ -98,7 +88,7 @@ sudo ./edit-config ebpf.d.conf

88

89 Replace `entry` with `return`:

90

101 -```conf

91 +```text

92 [global]

93 ebpf load mode = return

94 disable apps = no

docs/developer-and-contributor-corner/monitor-hadoop-cluster.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Monitor a Hadoop cluster with Netdata"

3 -sidebar_label: "Monitor a Hadoop cluster with Netdata"

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor-hadoop-cluster.md

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Miscellaneous"

8 --->

9 -

1 # Monitor a Hadoop cluster with Netdata

2

3 Hadoop is an [Apache project](https://hadoop.apache.org/) is a framework for processing large sets of data across a

docs/developer-and-contributor-corner/process.txt

+3 -3

@@ -142,7 +142,7 @@ Inside the file are lists of process names, oftentimes using wildcards (`*`), th

142 groups together. For example, the Netdata Agent looks for processes starting with `mysqld`, `mariad`, `postgres`, and

143 others, and groups them into `sql`. That makes sense, since all these processes are for SQL databases.

144

145 -```conf

145 +```text

146 sql: mysqld* mariad* postgres* postmaster* oracle_* ora_* sqlservr

147 ```

148

@@ -170,7 +170,7 @@ the [section above](#configure-the-netdata-agent-to-recognize-a-specific-process

170 the `database servers` section. Create new groups for MySQL and PostgreSQL, and move their process queries into the

171 unique groups.

172

173 -```conf

173 +```text

174 # -----------------------------------------------------------------------------

175 # database servers

176

@@ -194,7 +194,7 @@ to `# NETDATA processes accounting`.

194 Above that, paste in the following text, which creates a new `custom-app` group with the `custom-app` process. Replace

195 `custom-app` with the name of your application's Linux process. `apps_groups.conf` should now look like this:

196

197 -```conf

197 +```text

198 ...

199 # -----------------------------------------------------------------------------

200 # Custom applications to monitor with apps.plugin and ebpf.plugin

docs/developer-and-contributor-corner/raspberry-pi-anomaly-detection.txt

+1 -1

@@ -27,7 +27,7 @@ Next, open `netdata.conf` using [`edit-config`](/docs/netdata-agent/configuratio

27 from within the [Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). Scroll down to the

28 `[plugin:python.d]` section to pass in the `-ppython3` command option.

29

30 -```conf

30 +```text

31 [plugin:python.d]

32 # update every = 1

33 command options = -ppython3

docs/exporting-metrics/enable-an-exporting-connector.md

+2 -2

@@ -19,7 +19,7 @@ Use `edit-config` from your [Netdata config directory](/docs/netdata-agent/confi

19

20 Enable the exporting engine itself by setting `enabled` to `yes`:

21

22 -```conf

22 +```text

23 [exporting:global]

24 enabled = yes

25 ```

@@ -30,7 +30,7 @@ Save the file but keep it open, as you will edit it again to enable specific con

30

31 Use the following configuration as a starting point. Copy and paste it into `exporting.conf`.

32

33 -```conf

33 +```text

34 [opentsdb:http:my_opentsdb_http_instance]

35 enabled = yes

36 destination = localhost:4242

docs/guidelines.md

+1 -1

@@ -49,7 +49,7 @@ Please ensure that any links to a different documentation resource are fully exp

49

50 e.g.

51

52 -```txt

52 +```text

53 [Correct link to this document](/docs/guidelines.md)

54 vs

55 [Incorrect link to this document](https://learn.netdata.cloud/XYZ)

docs/netdata-agent/configuration/cheatsheet.md

+3 -3

@@ -31,7 +31,7 @@ You are expected to use this method in all following configuration changes.

31 sudo ./edit-config netdata.conf

32 ```

33

34 -```conf

34 +```text

35 [plugins]

36 go.d = yes # enabled

37 node.d = no # disabled

@@ -77,7 +77,7 @@ sudo ./edit-config health.d/example-alert.conf

77 sudo ./edit-config health.d/example-alert.conf

78 ```

79

80 -```txt

80 +```text

81 to: silent

82 ```

83

@@ -94,7 +94,7 @@ sudo ./edit-config health.d/example-alert.conf

94

95 ### Change the port Netdata listens to (example, set it to port 39999)

96

97 -```conf

97 +```text

98 [web]

99 default port = 39999

100 ```

docs/netdata-agent/configuration/common-configuration-changes.md

+2 -2

@@ -29,7 +29,7 @@ of `netdata.conf` so

29 that it is greater than `1`. An `update every` of `5` means the Netdata Agent enforces a _minimum_ collection frequency

30 of 5 seconds.

31

32 -```conf

32 +```text

33 [global]

34 update every = 5

35 ```

@@ -90,7 +90,7 @@ Because the source path contains `health.d/cpu.conf`, run `sudo edit-config heal

90

91 Open the configuration file for that alert and set the `to` line to `silent`.

92

93 -```conf

93 +```text

94 template: disk_fill_rate

95 on: disk.space

96 lookup: max -1s at -30m unaligned of avail

docs/netdata-agent/configuration/optimize-the-netdata-agents-performance.md

+15 -15

@@ -116,7 +116,7 @@ and makes it easier to configure or disable alerts and agent notifications.

116 The parents by default run health checks for each child, as long as the child is connected (the details are

117 in `stream.conf`). On the child nodes you should add to `netdata.conf` the following:

118

119 -```conf

119 +```text

120 [health]

121 enabled = no

122 ```

@@ -136,12 +136,12 @@ actively collecting metrics.

136 Open `netdata.conf` and scroll down to the `[plugins]` section. To disable any plugin, uncomment it and set the value to

137 `no`. For example, to explicitly keep the `proc` and `go.d` plugins enabled while disabling `python.d` and `charts.d`.

138

139 -```conf

139 +```text

140 [plugins]

141 proc = yes

142 - python.d = no

143 - charts.d = no

144 - go.d = yes

142 + python.d = no

143 + charts.d = no

144 + go.d = yes

145 ```

146

147 Disable specific collectors by opening their respective plugin configuration files, uncommenting the line for the

@@ -155,11 +155,11 @@ sudo ./edit-config charts.d.conf

155

156 For example, to disable a few Python collectors:

157

158 -```conf

158 +```text

159 modules:

160 - apache: no

161 - dockerd: no

162 - fail2ban: no

160 + apache: no

161 + dockerd: no

162 + fail2ban: no

163 ```

164

165 ## Reduce collection frequency

@@ -179,7 +179,7 @@ If you change this to `2`, Netdata enforces a minimum `update every` setting of

179 other second, which will effectively halve CPU utilization. Set this to `5` or `10` to collect metrics every 5 or 10

180 seconds, respectively.

181

182 -```conf

182 +```text

183 [global]

184 update every = 5

185 ```

@@ -197,7 +197,7 @@ an [internal_plugin/collector](/src/collectors/README.md#collector-architecture-

197 open `netdata.conf` and find the appropriate section. For example, to reduce the frequency of the `apps` plugin, which

198 collects and visualizes metrics on application resource utilization:

199

200 -```conf

200 +```text

201 [plugin:apps]

202 update every = 5

203 ```

@@ -206,7 +206,7 @@ To [configure an individual collector](/src/collectors/REFERENCE.md#configure-a-

206 open its specific configuration file with `edit-config` and look for the `update_every` setting. For example, to reduce

207 the frequency of the `nginx` collector, run `sudo ./edit-config go.d/nginx.conf`:

208

209 -```conf

209 +```text

210 # [ GLOBAL ]

211 update_every: 10

212 ```

@@ -227,7 +227,7 @@ on [streaming and replication](/docs/observability-centralization-points/README.

227 Automated anomaly detection may be a powerful tool, but we recommend it to only be enabled on Netdata parents that sit

228 outside your production infrastructure, or if you have cpu and memory to spare. You can disable ML with the following:

229

230 -```conf

230 +```text

231 [ml]

232 enabled = no

233 ```

@@ -249,14 +249,14 @@ looking at the local Agent dashboard.

249

250 To disable gzip compression, open `netdata.conf` and find the `[web]` section:

251

252 -```conf

252 +```text

253 [web]

254 enable gzip compression = no

255 ```

256

257 Or to lower the default compression level:

258

259 -```conf

259 +```text

260 [web]

261 enable gzip compression = yes

262 gzip compression level = 1

docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md

+1 -1

@@ -111,7 +111,7 @@ for the parent node and all of its children.

111 To configure the database engine, look for the `page cache size MB` and `dbengine multihost disk space MB` settings in

112 the `[db]` section of your `netdata.conf`.

113

114 -```conf

114 +```text

115 [db]

116 dbengine page cache size MB = 32

117 dbengine multihost disk space MB = 256

docs/netdata-agent/configuration/organize-systems-metrics-and-alerts.md

+4 -4

@@ -90,7 +90,7 @@ sudo ./edit-config netdata.conf

90 Create a new `[host labels]` section defining a new host label and its value for the system in question. Make sure not

91 to violate any of the [host label naming rules](/docs/netdata-agent/configuration/common-configuration-changes.md#organize-nodes-with-host-labels).

92

93 -```conf

93 +```text

94 [host labels]

95 type = webserver

96 location = us-seattle

@@ -154,7 +154,7 @@ alerts to them.

154

155 For example, let's use configuration example from earlier:

156

157 -```conf

157 +```text

158 [host labels]

159 type = webserver

160 location = us-seattle

@@ -201,7 +201,7 @@ If you have enabled any metrics exporting via our experimental [exporters](/src/

201 labels you created manually are sent to the destination database alongside metrics. You can change this behavior by

202 editing `exporting.conf`, and you can even send automatically-generated labels on with exported metrics.

203

204 -```conf

204 +```text

205 [exporting:global]

206 enabled = yes

207 send configured labels = yes

@@ -210,7 +210,7 @@ send automatic labels = no

210

211 You can also change this behavior per exporting connection:

212

213 -```conf

213 +```text

214 [opentsdb:my_instance3]

215 enabled = yes

216 destination = localhost:4242

docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/README.md

+2 -2

@@ -26,9 +26,9 @@ The above will prevent anyone except your web server to access a Netdata dashboa

26

27 You can also use `netdata.conf`:

28

29 -```txt

29 +```text

30 [web]

31 - allow connections from = localhost 1.2.3.4

31 + allow connections from = localhost 1.2.3.4

32 ```

33

34 Of course, you can add more IPs.

docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-apache.md

+96 -94

@@ -38,29 +38,29 @@ On any **existing** and already **working** apache virtual host, you can redirec

38

39 Add the following on top of any existing virtual host. It will allow you to access Netdata as `http://virtual.host/netdata/`.

40

41 -```conf

41 +```text

42 <VirtualHost *:80>

43

44 - RewriteEngine On

45 - ProxyRequests Off

46 - ProxyPreserveHost On

44 + RewriteEngine On

45 + ProxyRequests Off

46 + ProxyPreserveHost On

47

48 - <Proxy *>

49 - Require all granted

50 - </Proxy>

48 + <Proxy *>

49 + Require all granted

50 + </Proxy>

51

52 - # Local Netdata server accessed with '/netdata/', at localhost:19999

53 - ProxyPass "/netdata/" "http://localhost:19999/" connectiontimeout=5 timeout=30 keepalive=on

54 - ProxyPassReverse "/netdata/" "http://localhost:19999/"

52 + # Local Netdata server accessed with '/netdata/', at localhost:19999

53 + ProxyPass "/netdata/" "http://localhost:19999/" connectiontimeout=5 timeout=30 keepalive=on

54 + ProxyPassReverse "/netdata/" "http://localhost:19999/"

55

56 - # if the user did not give the trailing /, add it

57 - # for HTTP (if the virtualhost is HTTP, use this)

58 - RewriteRule ^/netdata$ http://%{HTTP_HOST}/netdata/ [L,R=301]

59 - # for HTTPS (if the virtualhost is HTTPS, use this)

60 - #RewriteRule ^/netdata$ https://%{HTTP_HOST}/netdata/ [L,R=301]

56 + # if the user did not give the trailing /, add it

57 + # for HTTP (if the virtualhost is HTTP, use this)

58 + RewriteRule ^/netdata$ http://%{HTTP_HOST}/netdata/ [L,R=301]

59 + # for HTTPS (if the virtualhost is HTTPS, use this)

60 + #RewriteRule ^/netdata$ https://%{HTTP_HOST}/netdata/ [L,R=301]

61 +

62 + # rest of virtual host config here

63

62 - # rest of virtual host config here

63 -

64 </VirtualHost>

65 ```

66

@@ -68,16 +68,16 @@ Add the following on top of any existing virtual host. It will allow you to acce

68

69 Add the following on top of any existing virtual host. It will allow you to access multiple Netdata as `http://virtual.host/netdata/HOSTNAME/`, where `HOSTNAME` is the hostname of any other Netdata server you have (to access the `localhost` Netdata, use `http://virtual.host/netdata/localhost/`).

70

71 -```conf

71 +```text

72 <VirtualHost *:80>

73

74 - RewriteEngine On

75 - ProxyRequests Off

76 - ProxyPreserveHost On

74 + RewriteEngine On

75 + ProxyRequests Off

76 + ProxyPreserveHost On

77

78 - <Proxy *>

79 - Require all granted

80 - </Proxy>

78 + <Proxy *>

79 + Require all granted

80 + </Proxy>

81

82 # proxy any host, on port 19999

83 ProxyPassMatch "^/netdata/([A-Za-z0-9\._-]+)/(.*)" "http://$1:19999/$2" connectiontimeout=5 timeout=30 keepalive=on

@@ -88,8 +88,8 @@ Add the following on top of any existing virtual host. It will allow you to acce

88 # for HTTPS (if the virtualhost is HTTPS, use this)

89 RewriteRule "^/netdata/([A-Za-z0-9\._-]+)$" https://%{HTTP_HOST}/netdata/$1/ [L,R=301]

90

91 - # rest of virtual host config here

92 -

91 + # rest of virtual host config here

92 +

93 </VirtualHost>

94 ```

95

@@ -98,7 +98,7 @@ Add the following on top of any existing virtual host. It will allow you to acce

98

99 If you want to control the servers your users can connect to, replace the `ProxyPassMatch` line with the following. This allows only `server1`, `server2`, `server3` and `server4`.

100

101 -```txt

101 +```text

102 ProxyPassMatch "^/netdata/(server1|server2|server3|server4)/(.*)" "http://$1:19999/$2" connectiontimeout=5 timeout=30 keepalive=on

103 ```

104

@@ -114,22 +114,24 @@ nano /etc/apache2/sites-available/netdata.conf

114

115 with this content:

116

117 -```conf

117 +```text

118 <VirtualHost *:80>

119 - ProxyRequests Off

120 - ProxyPreserveHost On

121 -

122 - ServerName netdata.domain.tld

119

124 - <Proxy *>

125 - Require all granted

126 - </Proxy>

120 + ProxyRequests Off

121 + ProxyPreserveHost On

122 +

123 + ServerName netdata.domain.tld

124 +

125 + <Proxy *>

126 + Require all granted

127 + </Proxy>

128 +

129 + ProxyPass "/" "http://localhost:19999/" connectiontimeout=5 timeout=30 keepalive=on

130 + ProxyPassReverse "/" "http://localhost:19999/"

131

128 - ProxyPass "/" "http://localhost:19999/" connectiontimeout=5 timeout=30 keepalive=on

129 - ProxyPassReverse "/" "http://localhost:19999/"

132 + ErrorLog ${APACHE_LOG_DIR}/netdata-error.log

133 + CustomLog ${APACHE_LOG_DIR}/netdata-access.log combined

134

131 - ErrorLog ${APACHE_LOG_DIR}/netdata-error.log

132 - CustomLog ${APACHE_LOG_DIR}/netdata-access.log combined

135 </VirtualHost>

136 ```

137

@@ -146,7 +148,7 @@ _Assuming the main goal is to make Netdata running in HTTPS._

148 1. Make a subdomain for Netdata on which you enable and force HTTPS - You can use a free Let's Encrypt certificate

149 2. Go to "Apache & nginx Settings", and in the following section, add:

150

149 - ```conf

151 + ```text

152 RewriteEngine on

153 RewriteRule (.*) http://localhost:19999/$1 [P,L]

154 ```

@@ -166,49 +168,49 @@ Then, generate password for user `netdata`, using `htpasswd -c /etc/apache2/.htp

168 **Apache 2.2 Example:**\

169 Modify the virtual host with these:

170

169 -```conf

170 - # replace the <Proxy *> section

171 - <Proxy *>

172 - Order deny,allow

173 - Allow from all

174 - </Proxy>

175 -

176 - # add a <Location /netdata/> section

177 - <Location /netdata/>

178 - AuthType Basic

179 - AuthName "Protected site"

180 - AuthUserFile /etc/apache2/.htpasswd

181 - Require valid-user

182 - Order deny,allow

183 - Allow from all

184 - </Location>

171 +```text

172 + # replace the <Proxy *> section

173 + <Proxy *>

174 + Order deny,allow

175 + Allow from all

176 + </Proxy>

177 +

178 + # add a <Location /netdata/> section

179 + <Location /netdata/>

180 + AuthType Basic

181 + AuthName "Protected site"

182 + AuthUserFile /etc/apache2/.htpasswd

183 + Require valid-user

184 + Order deny,allow

185 + Allow from all

186 + </Location>

187 ```

188

189 Specify `Location /` if Netdata is running on dedicated virtual host.

190

191 **Apache 2.4 (dedicated virtual host) Example:**

192

191 -```conf

193 +```text

194 <VirtualHost *:80>

193 - RewriteEngine On

194 - ProxyRequests Off

195 - ProxyPreserveHost On

196 -

197 - ServerName netdata.domain.tld

198 -

199 - <Proxy *>

200 - AllowOverride None

201 - AuthType Basic

202 - AuthName "Protected site"

203 - AuthUserFile /etc/apache2/.htpasswd

204 - Require valid-user

205 - </Proxy>

206 -

207 - ProxyPass "/" "http://localhost:19999/" connectiontimeout=5 timeout=30 keepalive=on

208 - ProxyPassReverse "/" "http://localhost:19999/"

209 -

210 - ErrorLog ${APACHE_LOG_DIR}/netdata-error.log

211 - CustomLog ${APACHE_LOG_DIR}/netdata-access.log combined

195 + RewriteEngine On

196 + ProxyRequests Off

197 + ProxyPreserveHost On

198 +

199 + ServerName netdata.domain.tld

200 +

201 + <Proxy *>

202 + AllowOverride None

203 + AuthType Basic

204 + AuthName "Protected site"

205 + AuthUserFile /etc/apache2/.htpasswd

206 + Require valid-user

207 + </Proxy>

208 +

209 + ProxyPass "/" "http://localhost:19999/" connectiontimeout=5 timeout=30 keepalive=on

210 + ProxyPassReverse "/" "http://localhost:19999/"

211 +

212 + ErrorLog ${APACHE_LOG_DIR}/netdata-error.log

213 + CustomLog ${APACHE_LOG_DIR}/netdata-access.log combined

214 </VirtualHost>

215 ```

216

@@ -218,8 +220,8 @@ Note: Changes are applied by reloading or restarting Apache.

220

221 If you want to enable CSP within your Apache, you should consider some special requirements of the headers. Modify your configuration like that:

222

221 -```txt

222 - Header always set Content-Security-Policy "default-src http: 'unsafe-inline' 'self' 'unsafe-eval'; script-src http: 'unsafe-inline' 'self' 'unsafe-eval'; style-src http: 'self' 'unsafe-inline'"

223 +```text

224 + Header always set Content-Security-Policy "default-src http: 'unsafe-inline' 'self' 'unsafe-eval'; script-src http: 'unsafe-inline' 'self' 'unsafe-eval'; style-src http: 'self' 'unsafe-inline'"

225 ```

226

227 Note: Changes are applied by reloading or restarting Apache.

@@ -243,7 +245,7 @@ exceed that threshold, and `mod_evasive` will add your IP address to a blocklist

245 Our users have found success by setting `DOSPageCount` to `30`. Try this, and raise the value if you continue to see 403

246 errors while accessing the dashboard.

247

246 -```conf

248 +```text

249 DOSPageCount 30

250 ```

251

@@ -256,13 +258,13 @@ To adjust the `DOSPageCount` for a specific virtual host, open your virtual host

258 `/etc/httpd/conf/sites-available/my-domain.conf` or `/etc/apache2/sites-available/my-domain.conf` and add the

259 following:

260

259 -```conf

261 +```text

262 <VirtualHost *:80>

261 - ...

262 - # Increase the DOSPageCount to prevent 403 errors and IP addresses being blocked.

263 - <IfModule mod_evasive20.c>

264 - DOSPageCount 30

265 - </IfModule>

263 + ...

264 + # Increase the DOSPageCount to prevent 403 errors and IP addresses being blocked.

265 + <IfModule mod_evasive20.c>

266 + DOSPageCount 30

267 + </IfModule>

268 </VirtualHost>

269 ```

270

@@ -277,7 +279,7 @@ You might edit `/etc/netdata/netdata.conf` to optimize your setup a bit. For app

279

280 If you plan to use Netdata exclusively via apache, you can gain some performance by preventing double compression of its output (Netdata compresses its response, apache re-compresses it) by editing `/etc/netdata/netdata.conf` and setting:

281

280 -```txt

282 +```text

283 [web]

284 enable gzip compression = no

285 ```

@@ -288,48 +290,48 @@ Once you disable compression at Netdata (and restart it), please verify you rece

290

291 You would also need to instruct Netdata to listen only on `localhost`, `127.0.0.1` or `::1`.

292

291 -```txt

293 +```text

294 [web]

295 bind to = localhost

296 ```

297

298 or

299

298 -```txt

300 +```text

301 [web]

302 bind to = 127.0.0.1

303 ```

304

305 or

306

305 -```txt

307 +```text

308 [web]

309 bind to = ::1

310 ```

311

312 You can also use a unix domain socket. This will also provide a faster route between apache and Netdata:

313

312 -```txt

314 +```text

315 [web]

316 bind to = unix:/tmp/netdata.sock

317 ```

318

319 Apache 2.4.24+ can not read from `/tmp` so create your socket in `/var/run/netdata`

320

319 -```txt

321 +```text

322 [web]

323 bind to = unix:/var/run/netdata/netdata.sock

324 ```

325

326 At the apache side, prepend the 2nd argument to `ProxyPass` with `unix:/tmp/netdata.sock|`, like this:

327

326 -```txt

328 +```text

329 ProxyPass "/netdata/" "unix:/tmp/netdata.sock|http://localhost:19999/" connectiontimeout=5 timeout=30 keepalive=on

330 ```

331

332 If your apache server is not on localhost, you can set:

333

332 -```txt

334 +```text

335 [web]

336 bind to = *

337 allow connections from = IP_OF_APACHE_SERVER

@@ -341,7 +343,7 @@ If your apache server is not on localhost, you can set:

343

344 apache logs accesses and Netdata logs them too. You can prevent Netdata from generating its access log, by setting this in `/etc/netdata/netdata.conf`:

345

344 -```txt

346 +```text

347 [logs]

348 access = off

349 ```

docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-h2o.md

+5 -14

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Running Netdata behind H2O"

3 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-h2o.md"

4 -sidebar_label: "Running Netdata behind H2O"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Configuration/Secure your nodes"

8 --->

9 -

1 # Running Netdata behind H2O

2

3 [H2O](https://h2o.examp1e.net/) is a new generation HTTP server that provides quicker response to users with less CPU utilization when compared to older generation of web servers.

@@ -141,27 +132,27 @@ For more information on using basic authentication with H2O, see [their official

132

133 If your H2O server is on `localhost`, you can use this to ensure external access is only possible through H2O:

134

144 -```txt

135 +```text

136 [web]

137 bind to = 127.0.0.1 ::1

138 ```

139

140 You can also use a unix domain socket. This will provide faster communication between H2O and Netdata as well:

141

151 -```txt

142 +```text

143 [web]

144 bind to = unix:/run/netdata/netdata.sock

145 ```

146

147 In the H2O configuration, use a line like the following to connect to Netdata via the unix socket:

148

158 -```txt

149 +```text

150 proxy.reverse.url http://[unix:/run/netdata/netdata.sock]

151 ```

152

153 If your H2O server is not on localhost, you can set:

154

164 -```txt

155 +```text

156 [web]

157 bind to = *

158 allow connections from = IP_OF_H2O_SERVER

@@ -177,7 +168,7 @@ the connection IP address.

168 H2O logs accesses and Netdata logs them too. You can prevent Netdata from generating its access log, by setting

169 this in `/etc/netdata/netdata.conf`:

170

180 -```txt

171 +```text

172 [logs]

173 access = off

174 ```

docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-haproxy.md

+12 -12

@@ -15,7 +15,7 @@ the following configuration can be used:

15

16 For all examples, set the mode to `http`

17

18 -```conf

18 +```text

19 defaults

20 mode http

21 ```

@@ -28,7 +28,7 @@ A simple example where the base URL, say `http://example.com`, is used with no s

28

29 Create a frontend to receive the request.

30

31 -```conf

31 +```text

32 frontend http_frontend

33 ## HTTP ipv4 and ipv6 on all ips ##

34 bind :::80 v4v6

@@ -40,7 +40,7 @@ frontend http_frontend

40

41 Create the Netdata backend which will send requests to port `19999`.

42

43 -```conf

43 +```text

44 backend netdata_backend

45 option forwardfor

46 server netdata_local 127.0.0.1:19999

@@ -59,7 +59,7 @@ An example where the base URL is used with a subpath `/netdata/`:

59

60 To use a subpath, create an ACL, which will set a variable based on the subpath.

61

62 -```conf

62 +```text

63 frontend http_frontend

64 ## HTTP ipv4 and ipv6 on all ips ##

65 bind :::80 v4v6

@@ -82,7 +82,7 @@ frontend http_frontend

82

83 Same as simple example, except remove `/netdata/` with regex.

84

85 -```conf

85 +```text

86 backend netdata_backend

87 option forwardfor

88 server netdata_local 127.0.0.1:19999

@@ -104,7 +104,7 @@ This example will only use Netdata if host matches example.com (replace with you

104

105 This frontend uses a certificate list.

106

107 -```conf

107 +```text

108 frontend https_frontend

109 ## HTTP ##

110 bind :::80 v4v6

@@ -129,7 +129,7 @@ In the cert list file place a mapping from a certificate file to the domain used

129

130 `/etc/letsencrypt/certslist.txt`:

131

132 -```txt

132 +```text

133 example.com /etc/letsencrypt/live/example.com/example.com.pem

134 ```

135

@@ -146,7 +146,7 @@ cat /etc/letsencrypt/live/example.com/fullchain.pem \

146

147 Same as simple, except set protocol `https`.

148

149 -```conf

149 +```text

150 backend netdata_backend

151 option forwardfor

152 server netdata_local 127.0.0.1:19999

@@ -162,7 +162,7 @@ backend netdata_backend

162

163 To use basic HTTP Authentication, create an authentication list:

164

165 -```conf

165 +```text

166 # HTTP Auth

167 userlist basic-auth-list

168 group is-admin

@@ -179,13 +179,13 @@ $5$l7Gk0VPIpKO$f5iEcxvjfdF11khw.utzSKqP7W.0oq8wX9nJwPLwzy1

179

180 Replace `YOUR_PASSWORD` with hash:

181

182 -```conf

182 +```text

183 user admin password $5$l7Gk0VPIpKO$f5iEcxvjfdF11khw.utzSKqP7W.0oq8wX9nJwPLwzy1 groups is-admin

184 ```

185

186 Now add at the top of the backend:

187

188 -```conf

188 +```text

189 acl devops-auth http_auth_group(basic-auth-list) is-admin

190 http-request auth realm netdata_local unless devops-auth

191 ```

@@ -194,7 +194,7 @@ http-request auth realm netdata_local unless devops-auth

194

195 Full example configuration with HTTP auth over TLS with subpath:

196

197 -```conf

197 +```text

198 global

199 maxconn 20000

200

docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-lighttpd.md

+5 -5

@@ -2,7 +2,7 @@

2

3 Here is a config for accessing Netdata in a suburl via lighttpd 1.4.46 and newer:

4

5 -```txt

5 +```text

6 $HTTP["url"] =~ "^/netdata/" {

7 proxy.server = ( "" => ("netdata" => ( "host" => "127.0.0.1", "port" => 19999 )))

8 proxy.header = ( "map-urlpath" => ( "/netdata/" => "/") )

@@ -11,7 +11,7 @@ $HTTP["url"] =~ "^/netdata/" {

11

12 If you have older lighttpd you have to use a chain (such as below), as explained [at this Stack Overflow answer](http://stackoverflow.com/questions/14536554/lighttpd-configuration-to-proxy-rewrite-from-one-domain-to-another).

13

14 -```txt

14 +```text

15 $HTTP["url"] =~ "^/netdata/" {

16 proxy.server = ( "" => ("" => ( "host" => "127.0.0.1", "port" => 19998 )))

17 }

@@ -25,13 +25,13 @@ $SERVER["socket"] == ":19998" {

25 If the only thing the server is exposing via the web is Netdata (and thus no suburl rewriting required),

26 then you can get away with just

27

28 -```txt

28 +```text

29 proxy.server = ( "" => ( ( "host" => "127.0.0.1", "port" => 19999 )))

30 ```

31

32 Though if it's public facing you might then want to put some authentication on it. `htdigest` support looks like:

33

34 -```txt

34 +```text

35 auth.backend = "htdigest"

36 auth.backend.htdigest.userfile = "/etc/lighttpd/lighttpd.htdigest"

37 auth.require = ( "" => ( "method" => "digest",

@@ -48,7 +48,7 @@ To solve this issue, disable web response compression in Netdata.

48

49 Open `/etc/netdata/netdata.conf` and set in `[global]`:

50

51 -```txt

51 +```text

52 enable web responses gzip compression = no

53 ```

54

docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/Running-behind-nginx.md

+18 -18

@@ -38,7 +38,7 @@ After making changes to the configuration files:

38

39 With this method instead of `SERVER_IP_ADDRESS:19999`, the Netdata dashboard can be accessed via a human-readable URL such as `netdata.example.com` used in the configuration below.

40

41 -```conf

41 +```text

42 upstream backend {

43 # the Netdata server

44 server 127.0.0.1:19999;

@@ -72,7 +72,7 @@ server {

72 This method is recommended when Netdata is to be served from a subfolder (or directory).

73 In this case, the virtual host `netdata.example.com` already exists and Netdata has to be accessed via `netdata.example.com/netdata/`.

74

75 -```conf

75 +```text

76 upstream netdata {

77 server 127.0.0.1:19999;

78 keepalive 64;

@@ -114,7 +114,7 @@ server {

114

115 This is the recommended configuration when one Nginx will be used to manage multiple Netdata servers via sub-folders.

116

117 -```conf

117 +```text

118 upstream backend-server1 {

119 server 10.1.1.103:19999;

120 keepalive 64;

@@ -168,7 +168,7 @@ In case Netdata's web server has been [configured to use TLS](/src/web/server/RE

168 necessary to specify inside the Nginx configuration that the final destination is using TLS. To do this, please, append

169 the following parameters in your `nginx.conf`

170

171 -```conf

171 +```text

172 proxy_set_header X-Forwarded-Proto https;

173 proxy_pass https://localhost:19999;

174 ```

@@ -189,7 +189,7 @@ printf "yourusername:$(openssl passwd -apr1)" > /etc/nginx/passwords

189

190 And then enable the authentication inside your server directive:

191

192 -```conf

192 +```text

193 server {

194 # ...

195 auth_basic "Protected";

@@ -202,21 +202,21 @@ server {

202

203 If your Nginx is on `localhost`, you can use this to protect your Netdata:

204

205 -```txt

205 +```text

206 [web]

207 bind to = 127.0.0.1 ::1

208 ```

209

210 You can also use a unix domain socket. This will also provide a faster route between Nginx and Netdata:

211

212 -```txt

212 +```text

213 [web]

214 bind to = unix:/var/run/netdata/netdata.sock

215 ```

216

217 At the Nginx side, use something like this to use the same unix domain socket:

218

219 -```conf

219 +```text

220 upstream backend {

221 server unix:/var/run/netdata/netdata.sock;

222 keepalive 64;

@@ -225,7 +225,7 @@ upstream backend {

225

226 If your Nginx server is not on localhost, you can set:

227

228 -```txt

228 +```text

229 [web]

230 bind to = *

231 allow connections from = IP_OF_NGINX_SERVER

@@ -238,7 +238,7 @@ connection IP address.

238

239 Nginx logs accesses and Netdata logs them too. You can prevent Netdata from generating its access log, by setting this in `/etc/netdata/netdata.conf`:

240

241 -```txt

241 +```text

242 [logs]

243 access = off

244 ```

@@ -247,18 +247,18 @@ Nginx logs accesses and Netdata logs them too. You can prevent Netdata from gene

247

248 By default, netdata compresses its responses. You can have nginx do that instead, with the following options in the `location /` block:

249

250 -```conf

251 - location / {

252 - ...

253 - gzip on;

254 - gzip_proxied any;

255 - gzip_types *;

256 - }

250 +```text

251 +location / {

252 + ...

253 + gzip on;

254 + gzip_proxied any;

255 + gzip_types *;

256 +}

257 ```

258

259 To disable Netdata's gzip compression, open `netdata.conf` and in the `[web]` section put:

260

261 -```conf

261 +```text

262 [web]

263 enable gzip compression = no

264 ```

docs/netdata-agent/securing-netdata-agents.md

+5 -5

@@ -55,7 +55,7 @@ need to view metrics and troubleshoot issues with Netdata Cloud.

55 Open `netdata.conf` with `./edit-config netdata.conf`. Scroll down to the `[web]` section, and find the `mode =

56 static-threaded` setting, and change it to `none`.

57

58 -```conf

58 +```text

59 [web]

60 mode = none

61 ```

@@ -74,9 +74,9 @@ If you are using Netdata with Docker, make sure to set the `NETDATA_HEALTHCHECK_

74 If your organization has a private administration and management LAN, you can bind Netdata on this network interface on all your servers.

75 This is done in `Netdata.conf` with these settings:

76

77 -```txt

77 +```text

78 [web]

79 - bind to = 10.1.1.1:19999 localhost:19999

79 + bind to = 10.1.1.1:19999 localhost:19999

80 ```

81

82 You can bind Netdata to multiple IPs and ports. If you use hostnames, Netdata will resolve them and use all the IPs

@@ -109,7 +109,7 @@ By default, this setting is `localhost *`. This setting allows connections from

109 connections, using the `*` wildcard. You can change this setting using Netdata's [simple

110 patterns](/src/libnetdata/simple_pattern/README.md).

111

112 -```conf

112 +```text

113 [web]

114 # Allow only localhost connections

115 allow connections from = localhost

@@ -124,7 +124,7 @@ patterns](/src/libnetdata/simple_pattern/README.md).

124 The `allow connections from` setting is global and restricts access to the dashboard, badges, streaming, API, and

125 `netdata.conf`, but you can also set each of those access lists more granularly if you choose:

126

127 -```conf

127 +```text

128 [web]

129 allow connections from = localhost *

130 allow dashboard from = localhost *

docs/netdata-agent/sizing-netdata-agents/bandwidth-requirements.md

+1 -1

@@ -23,7 +23,7 @@ The expected bandwidth consumption using `zstd` for 1 million samples per second

23

24 The order compression algorithms is selected is configured in `stream.conf`, per `[API KEY]`, like this:

25

26 -```txt

26 +```text

27 compression algorithms order = zstd lz4 brotli gzip

28 ```

29

docs/netdata-agent/sizing-netdata-agents/ram-requirements.md

+2 -2

@@ -14,7 +14,7 @@ This number can be lowered by limiting the number of database tier or switching

14

15 The general formula, with the default configuration of database tiers, is:

16

17 -```txt

17 +```text

18 memory = UNIQUE_METRICS x 16KiB + CONFIGURED_CACHES

19 ```

20

@@ -22,7 +22,7 @@ The default `CONFIGURED_CACHES` is 32MiB.

22

23 For 1 million concurrently collected time-series (independently of their data collection frequency), the memory required is:

24

25 -```txt

25 +```text

26 UNIQUE_METRICS = 1000000

27 CONFIGURED_CACHES = 32MiB

28

docs/observability-centralization-points/logs-centralization-points-with-systemd-journald/active-journal-source-without-encryption.md

+1 -1

@@ -47,7 +47,7 @@ sudo systemctl enable --now systemd-journal-gatewayd.socket

47

48 To use it, open your web browser and navigate to:

49

50 -```txt

50 +```url

51 http://server.ip:19531/browse

52 ```

53

docs/observability-centralization-points/logs-centralization-points-with-systemd-journald/passive-journal-centralization-with-encryption-using-self-signed-certificates.md

+2 -2

@@ -150,7 +150,7 @@ sudo apt-get install systemd-journal-remote

150

151 Edit `/etc/systemd/journal-upload.conf` and set the IP address and the port of the server, like so:

152

153 -```conf

153 +```text

154 [Upload]

155 URL=https://centralization.server.ip:19532

156 ```

@@ -165,7 +165,7 @@ sudo systemctl edit systemd-journal-upload.service

165

166 At the top, add:

167

168 -```conf

168 +```text

169 [Service]

170 Restart=always

171 ```

docs/observability-centralization-points/logs-centralization-points-with-systemd-journald/passive-journal-centralization-without-encryption.md

+2 -2

@@ -74,7 +74,7 @@ sudo apt-get install systemd-journal-remote

74

75 Edit `/etc/systemd/journal-upload.conf` and set the IP address and the port of the server, like so:

76

77 -```conf

77 +```text

78 [Upload]

79 URL=http://centralization.server.ip:19532

80 ```

@@ -87,7 +87,7 @@ sudo systemctl edit systemd-journal-upload

87

88 At the top, add:

89

90 -```conf

90 +```text

91 [Service]

92 Restart=always

93 ```

docs/observability-centralization-points/metrics-centralization-points/configuration.md

+1 -1

@@ -70,7 +70,7 @@ This example uses self-signed certificates.

70 2. **Child node**

71 Update `stream.conf` to enable SSL/TLS and allow self-signed certificates. Append ':SSL' to the destination and uncomment 'ssl skip certificate verification'.

72

73 - ```conf

73 + ```text

74 [stream]

75 enabled = yes

76 destination = 203.0.113.0:SSL

packaging/installer/methods/ansible.md

+3 -3

@@ -63,7 +63,7 @@ The `hosts` file contains a list of IP addresses or hostnames that Ansible will

63 `hosts` file that comes with the repository contains two example IP addresses, which you should replace according to the

64 IP address/hostname of your nodes.

65

66 -```conf

66 +```text

67 203.0.113.0 hostname=node-01

68 203.0.113.1 hostname=node-02

69 ```

@@ -76,7 +76,7 @@ omit the `hostname=` string entirely to use the system's default hostname.

76 If you SSH into your nodes as a user other than `root`, you need to configure `hosts` according to those user names. Use

77 the `ansible_user` variable to set the login user. For example:

78

79 -```conf

79 +```text

80 203.0.113.0 hostname=ansible-01 ansible_user=example

81 ```

82

@@ -86,7 +86,7 @@ If you use an SSH key other than `~/.ssh/id_rsa` for logging into your nodes, yo

86 the `hosts` file with the `ansible_ssh_private_key_file` variable. For example, to log into a Lightsail instance using

87 two different SSH keys supplied by AWS.

88

89 -```conf

89 +```text

90 203.0.113.0 hostname=ansible-01 ansible_ssh_private_key_file=~/.ssh/LightsailDefaultKey-us-west-2.pem

91 203.0.113.1 hostname=ansible-02 ansible_ssh_private_key_file=~/.ssh/LightsailDefaultKey-us-east-1.pem

92 ```

packaging/installer/methods/aws.md

+1 -1

@@ -45,7 +45,7 @@ inbound rules**.

45

46 Add a new rule with the following options:

47

48 -```conf

48 +```text

49 Type: Custom TCP

50 Protocol: TCP

51 Port Range: 19999

packaging/installer/methods/azure.md

+1 -1

@@ -43,7 +43,7 @@ Sign in to the [Azure portal](https://portal.azure.com) and open the virtual mac

43

44 Add a new rule with the following options:

45

46 -```conf

46 +```text

47 Source: Any

48 Source port ranges: 19999

49 Destination: Any

packaging/installer/methods/gcp.md

+1 -1

@@ -44,7 +44,7 @@ click **Create firewall rule**.

44 The following configuration has previously worked for Netdata running on GCP instances

45 ([see #7786](https://github.com/netdata/netdata/issues/7786)):

46

47 -```conf

47 +```text

48 Name: <name>

49 Type: Ingress

50 Targets: <name-tag>

packaging/installer/methods/packages.md

+1 -1

@@ -81,7 +81,7 @@ These repositories are set up as what Debian calls ‘flat repositories’, and

81

82 As a result of this structure, the required APT sources entry for stable packages for Debian 11 (Bullseye) is:

83

84 -```txt

84 +```text

85 deb http://repo.netdata.cloud/repos/stable/debian/ bullseye/

86 ```

87

packaging/installer/methods/synology.md

+1 -1

@@ -43,7 +43,7 @@ installed. You'll have to do this manually:

43 executable with `chmod 0755 /etc/rc.netdata`.

44 2. Add or edit `/etc/rc.local` and add a line calling `/etc/rc.netdata` to have it start on boot:

45

46 - ```conf

46 + ```text

47 # Netdata startup

48 [ -x /etc/rc.netdata ] && /etc/rc.netdata start

49 ```

packaging/installer/methods/systems.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Install on specific environments"

3 -description: "Netdata can be installed as a DEB/RPM package, a static binary, a docker container or from source"

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/systems.md

5 -sidebar_label: "Install on specific environments"

6 -learn_status: "Published"

7 -learn_rel_path: "Installation/Install on specific environments"

8 --->

9 -

1 # Install on specific environments

2

3 This category contains specific instructions for some popular environments.

packaging/makeself/README.md

-10

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Netdata static binary build"

3 -description: "Users can build the static 64-bit binary package that we ship with every release of the open-source Netdata Agent for debugging or specialize purposes."

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/makeself/README.md

5 -sidebar_label: "Static binary packages"

6 -learn_status: "Published"

7 -learn_rel_path: "Installation/Installation methods"

8 -sidebar_position: 30

9 --->

10 -

1 # Netdata static binary build

2

3 We publish pre-built static builds of Netdata for Linux systems. Currently, these are published for 64-bit x86, ARMv7,

src/aclk/README.md

+2 -2

@@ -37,8 +37,8 @@ You can configure following keys in the `netdata.conf` section `[cloud]`:

37

38 ```text

39 [cloud]

40 - statistics = yes

41 - query thread count = 2

40 + statistics = yes

41 + query thread count = 2

42 ```

43

44 - `statistics` enables/disables ACLK related statistics and their charts. You can disable this to save some space in the database and slightly reduce memory usage of Netdata Agent.

src/collectors/REFERENCE.md

+21 -21

@@ -25,28 +25,28 @@ You can enable or disable individual plugins by opening `netdata.conf` and scrol

25 This section features a list of Netdata's plugins, with a boolean setting to enable or disable them. The exception is

26 `statsd.plugin`, which has its own `[statsd]` section. Your `[plugins]` section should look similar to this:

27

28 -```conf

28 +```text

29 [plugins]

30 - # timex = yes

31 - # idlejitter = yes

32 - # netdata monitoring = yes

33 - # tc = yes

34 - # diskspace = yes

35 - # proc = yes

36 - # cgroups = yes

37 - # enable running new plugins = yes

38 - # check for new plugins every = 60

39 - # slabinfo = no

40 - # python.d = yes

41 - # perf = yes

42 - # ioping = yes

43 - # fping = yes

44 - # nfacct = yes

45 - # go.d = yes

46 - # apps = yes

47 - # ebpf = yes

48 - # charts.d = yes

49 - # statsd = yes

30 + # timex = yes

31 + # idlejitter = yes

32 + # netdata monitoring = yes

33 + # tc = yes

34 + # diskspace = yes

35 + # proc = yes

36 + # cgroups = yes

37 + # enable running new plugins = yes

38 + # check for new plugins every = 60

39 + # slabinfo = no

40 + # python.d = yes

41 + # perf = yes

42 + # ioping = yes

43 + # fping = yes

44 + # nfacct = yes

45 + # go.d = yes

46 + # apps = yes

47 + # ebpf = yes

48 + # charts.d = yes

49 + # statsd = yes

50 ```

51

52 By default, most plugins are enabled, so you don't need to enable them explicitly to use their collectors. To enable or

src/collectors/apps.plugin/README.md

+33 -7

@@ -8,6 +8,7 @@

8 insightful breakdown of resource utilization:

9

10 - **Tree** or **Category**: Grouped by their position in the process tree.

11 +<<<<<<< HEAD

12 This is customizable and allows aggregation by process managers and

13 individual processes of interest. Allows also renaming the processes for

14 presentation purposes.

@@ -25,6 +26,22 @@ subprocesses, such as shell scripts that fork hundreds or thousands of times

26 per second. So, although processes may spawn short-lived sub-processes,

27 `apps.plugin` will aggregate their resources utilization providing a holistic

28 view of how resources are shared among the processes.

29 +=======

30 + This is customizable and allows aggregation by process managers and individual

31 + processes of interest. Allows also renaming the processes for presentation purposes.

32 +

33 +- **User**: Grouped by the effective user (UID) under which the processes run.

34 +

35 +- **Group**: Grouped by the effective group (GID) under which the processes run.

36 +

37 +## Short-Lived Process Handling

38 +

39 +`apps.plugin` accounts for resource utilization of both running and exited processes,

40 +capturing the impact of processes that spawn short-lived subprocesses, such as shell

41 +scripts that fork hundreds or thousands of times per second. So, although processes

42 +may spawn short lived sub-processes, `apps.plugin` will aggregate their resources

43 +utilization providing a holistic view of how resources are shared among the processes.

44 +>>>>>>> fedac6cde (apps plugin docs pass)

45

46 ## Charts sections

47

@@ -34,10 +51,15 @@ on the dashboard.

51

52 ### Custom Process Groups (Apps)

53

54 +<<<<<<< HEAD

55 In this section, apps.plugin summarizes the resources consumed by all

56 processes, grouped based on their position in the process tree and the groups

57 provided in `/etc/netdata/apps_groups.conf`. You can edit this file using our

58 [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script.

59 +=======

60 +In this section, apps.plugin summarizes the resources consumed by all processes, grouped based

61 +on the groups provided in `/etc/netdata/apps_groups.conf`. You can edit this file using our [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script.

62 +>>>>>>> fedac6cde (apps plugin docs pass)

63

64 For this section, `apps.plugin` builds a process tree (much like `ps fax` does

65 in Linux), and groups processes together (evaluating both child and parent

@@ -113,7 +135,7 @@ In such cases, you many need to lower its data collection frequency.

135

136 To do this, edit `/etc/netdata/netdata.conf` and find this section:

137

116 -```txt

138 +```text

139 [plugin:apps]

140 # update every = 1

141 # command options =

@@ -125,8 +147,12 @@ be once every 2 seconds.

147

148 ## Configuration

149

150 +<<<<<<< HEAD

151 The configuration file is `/etc/netdata/apps_groups.conf`. You can edit this

152 file using our [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script.

153 +=======

154 +The configuration file is `/etc/netdata/apps_groups.conf`. You can edit this file using our [`edit-config`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script.

155 +>>>>>>> fedac6cde (apps plugin docs pass)

156

157 ### Configuring process managers

158

@@ -137,7 +163,7 @@ consider all their sub-processes, important to monitor.

163 Process managers are configured in `apps_groups.conf` with the prefix

164 `managers:`, like this:

165

140 -```txt

166 +```text

167 managers: process1 process2 process3

168 ```

169

@@ -161,7 +187,7 @@ the name of that filename.

187 Interpreters are configured in `apps_groups.conf` with the prefix

188 `interpreters:`, like this:

189

164 -```txt

190 +```text

191 interpreters: process1 process2 process3

192 ```

193

@@ -174,7 +200,7 @@ can be provided.

200

201 The configuration file works accepts multiple lines, each having this format:

202

177 -```txt

203 +```text

204 group: process1 process2 ...

205 ```

206

@@ -223,7 +249,7 @@ set in the `netdata.conf` using the [`edit-config` script](/docs/netdata-agent/c

249

250 For example, to disable user and user group charts you would set:

251

226 -```txt

252 +```text

253 [plugin:apps]

254 command options = without-users without-groups

255 ```

@@ -275,7 +301,7 @@ but it will not be able to collect all the information.

301

302 You can create badges that you can embed anywhere you like, with URLs like this:

303

278 -```txt

304 +```text

305 https://your.netdata.ip:19999/api/v1/badge.svg?chart=apps.processes&dimensions=myapp&value_color=green%3E0%7Cred

306 ```

307

@@ -331,7 +357,7 @@ If you check the total system CPU utilization, it says there is no idle CPU at a

357 fails to provide a breakdown of the CPU consumption in the system. The sum of the CPU utilization

358 of all processes reported by `top`, is 15.6%.

359

334 -```txt

360 +```text

361 top - 18:46:28 up 3 days, 20:14, 2 users, load average: 0.22, 0.05, 0.02

362 Tasks: 76 total, 2 running, 74 sleeping, 0 stopped, 0 zombie

363 %Cpu(s): 32.8 us, 65.6 sy, 0.0 ni, 0.0 id, 0.0 wa, 1.3 hi, 0.3 si, 0.0 st

src/collectors/charts.d.plugin/README.md

+1 -1

@@ -24,7 +24,7 @@ By default, `charts.d.plugin` is not included as part of the install when using

24

25 In this file, you can place statements like this:

26

27 -```conf

27 +```text

28 enable_all_charts="yes"

29 X="yes"

30 Y="no"

src/collectors/charts.d.plugin/example/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Example"

3 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/charts.d.plugin/example/README.md"

4 -sidebar_label: "example-charts.d.plugin"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Integrations/Monitor/Mock Collectors"

8 --->

9 -

1 # Example

2

3 If you want to understand how charts.d data collector functions, check out the [charts.d example](https://raw.githubusercontent.com/netdata/netdata/master/src/collectors/charts.d.plugin/example/example.chart.sh).

src/collectors/ebpf.plugin/README.md

+9 -9

@@ -49,7 +49,7 @@ To enable or disable the entire eBPF collector:

49 3. Enable the collector by scrolling down to the `[plugins]` section. Uncomment the line `ebpf` (not

50 `ebpf_process`) and set it to `yes`.

51

52 - ```conf

52 + ```text

53 [plugins]

54 ebpf = yes

55 ```

@@ -101,7 +101,7 @@ interact with the Linux kernel.

101

102 If you want to enable `apps.plugin` integration, change the "apps" setting to "yes".

103

104 -```conf

104 +```text

105 [global]

106 apps = yes

107 ```

@@ -115,7 +115,7 @@ interacts with the Linux kernel.

115 The integration with `cgroups.plugin` is disabled by default to avoid creating overhead on your system. If you want to

116 _enable_ the integration with `cgroups.plugin`, change the `cgroups` setting to `yes`.

117

118 -```conf

118 +```text

119 [global]

120 cgroups = yes

121 ```

@@ -296,7 +296,7 @@ are divided in the following sections:

296

297 You can configure the information shown with function `ebpf_socket` using the settings in this section.

298

299 -```conf

299 +```text

300 [network connections]

301 enabled = yes

302 resolve hostname ips = no

@@ -338,7 +338,7 @@ section.

338 For example, Netdata's default port (`19999`) is not listed in `/etc/services`. To associate that port with the Netdata

339 service in network connection charts, and thus see the name of the service instead of its port, define it:

340

341 -```conf

341 +```text

342 [service name]

343 19999 = Netdata

344 ```

@@ -347,7 +347,7 @@ service in network connection charts, and thus see the name of the service inste

347

348 The sync configuration has specific options to disable monitoring for syscalls. All syscalls are monitored by default.

349

350 -```conf

350 +```text

351 [syscalls]

352 sync = yes

353 msync = yes

@@ -362,7 +362,7 @@ The sync configuration has specific options to disable monitoring for syscalls.

362 The filesystem configuration has specific options to disable monitoring for filesystems; by default, all filesystems are

363 monitored.

364

365 -```conf

365 +```text

366 [filesystem]

367 btrfsdist = yes

368 ext4dist = yes

@@ -620,7 +620,7 @@ in [disk latency](#disk) charts.

620 By default, MD flush is disabled. To enable it, configure your

621 `/etc/netdata/ebpf.d.conf` file as:

622

623 -```conf

623 +```text

624 [global]

625 mdflush = yes

626 ```

@@ -940,7 +940,7 @@ This will create two new files: `netdata_ebpf.te` and `netdata_ebpf.mod`.

940 Edit the `netdata_ebpf.te` file to change the options `class` and `allow`. You should have the following at the end of

941 the `netdata_ebpf.te` file.

942

943 -```conf

943 +```text

944 module netdata_ebpf 1.0;

945 require {

946 type unconfined_service_t;

src/collectors/log2journal/README.md

+3 -3

@@ -80,7 +80,7 @@ We have an nginx server logging in this standard combined log format:

80

81 First, let's find the right pattern for `log2journal`. We ask ChatGPT:

82

83 -```txt

83 +```text

84 My nginx log uses this log format:

85

86 log_format access '$remote_addr - $remote_user [$time_local] '

@@ -484,7 +484,7 @@ tail -F /var/log/nginx/access.log |\

484

485 Create the file `/etc/systemd/system/nginx-logs.service` (change `/path/to/nginx.yaml` to the right path):

486

487 -```txt

487 +```text

488 [Unit]

489 Description=NGINX Log to Systemd Journal

490 After=network.target

@@ -575,7 +575,7 @@ If on other hand your organization prefers to maintain the full logs and control

575

576 ## `log2journal` options

577

578 -```txt

578 +```text

579

580 Netdata log2journal v1.43.0-341-gdac4df856

581

src/collectors/proc.plugin/README.md

+28 -28

@@ -118,7 +118,7 @@ mv netdata.conf.new netdata.conf

118

119 Then edit `netdata.conf` and find the following section. This is the basic plugin configuration.

120

121 -```txt

121 +```text

122 [plugin:proc:/proc/diskstats]

123 # enable new disks detected at runtime = yes

124 # performance metrics for physical disks = auto

@@ -152,7 +152,7 @@ Then edit `netdata.conf` and find the following section. This is the basic plugi

152

153 For each virtual disk, physical disk and partition you will have a section like this:

154

155 -```txt

155 +```text

156 [plugin:proc:/proc/diskstats:sda]

157 # enable = yes

158 # enable performance metrics = auto

@@ -180,14 +180,14 @@ After saving `/etc/netdata/netdata.conf`, restart your Netdata to apply them.

180

181 You can pretty easy disable performance metrics for individual device, for ex.:

182

183 -```txt

183 +```text

184 [plugin:proc:/proc/diskstats:sda]

185 enable performance metrics = no

186 ```

187

188 But sometimes you need disable performance metrics for all devices with the same type, to do it you need to figure out device type from `/proc/diskstats` for ex.:

189

190 -```txt

190 +```text

191 7 0 loop0 1651 0 3452 168 0 0 0 0 0 8 168

192 7 1 loop1 4955 0 11924 880 0 0 0 0 0 64 880

193 7 2 loop2 36 0 216 4 0 0 0 0 0 4 4

@@ -200,7 +200,7 @@ But sometimes you need disable performance metrics for all devices with the same

200 All zram devices starts with `251` number and all loop devices starts with `7`.

201 So, to disable performance metrics for all loop devices you could add `performance metrics for disks with major 7 = no` to `[plugin:proc:/proc/diskstats]` section.

202

203 -```txt

203 +```text

204 [plugin:proc:/proc/diskstats]

205 performance metrics for disks with major 7 = no

206 ```

@@ -236,7 +236,7 @@ So, to disable performance metrics for all loop devices you could add `performan

236

237 #### configuration

238

239 -```txt

239 +```text

240 [plugin:proc:/proc/mdstat]

241 # faulty devices = yes

242 # nonredundant arrays availability = yes

@@ -267,7 +267,7 @@ If your system has more than 50 processors and you would like to see the CPU the

267 state charts that are automatically disabled, you can set the following boolean options in the

268 `[plugin:proc:/proc/stat]` section.

269

270 -```conf

270 +```text

271 keep per core files open = yes

272 keep cpuidle files open = yes

273 core_throttle_count = yes

@@ -319,7 +319,7 @@ each state.

319

320 ### Configuration

321

322 -```conf

322 +```text

323 [plugin:proc:/proc/vmstat]

324 filename to monitor = /proc/vmstat

325 swap i/o = auto

@@ -363,7 +363,7 @@ By default Netdata will enable monitoring metrics only when they are not zero. I

363

364 The settings for monitoring wireless is in the `[plugin:proc:/proc/net/wireless]` section of your `netdata.conf` file.

365

366 -```conf

366 +```text

367 status for all interfaces = yes

368 quality for all interfaces = yes

369 discarded packets for all interfaces = yes

@@ -408,26 +408,26 @@ The tricky ones are `inbound packets dropped` and `inbound packets dropped ratio

408

409 Module configuration:

410

411 -```txt

411 +```text

412 [plugin:proc:/proc/net/dev]

413 - # filename to monitor = /proc/net/dev

414 - # path to get virtual interfaces = /sys/devices/virtual/net/%s

415 - # path to get net device speed = /sys/class/net/%s/speed

416 - # enable new interfaces detected at runtime = auto

417 - # bandwidth for all interfaces = auto

418 - # packets for all interfaces = auto

419 - # errors for all interfaces = auto

420 - # drops for all interfaces = auto

421 - # fifo for all interfaces = auto

422 - # compressed packets for all interfaces = auto

423 - # frames, collisions, carrier counters for all interfaces = auto

424 - # disable by default interfaces matching = lo fireqos* *-ifb

425 - # refresh interface speed every seconds = 10

413 + # filename to monitor = /proc/net/dev

414 + # path to get virtual interfaces = /sys/devices/virtual/net/%s

415 + # path to get net device speed = /sys/class/net/%s/speed

416 + # enable new interfaces detected at runtime = auto

417 + # bandwidth for all interfaces = auto

418 + # packets for all interfaces = auto

419 + # errors for all interfaces = auto

420 + # drops for all interfaces = auto

421 + # fifo for all interfaces = auto

422 + # compressed packets for all interfaces = auto

423 + # frames, collisions, carrier counters for all interfaces = auto

424 + # disable by default interfaces matching = lo fireqos* *-ifb

425 + # refresh interface speed every seconds = 10

426 ```

427

428 Per interface configuration:

429

430 -```txt

430 +```text

431 [plugin:proc:/proc/net/dev:enp0s3]

432 # enabled = yes

433 # virtual = no

@@ -511,7 +511,7 @@ and metrics:

511

512 ### configuration

513

514 -```txt

514 +```text

515 [plugin:proc:/sys/class/power_supply]

516 # battery capacity = yes

517 # battery charge = no

@@ -566,7 +566,7 @@ If your vendor is supported, you'll also get HW-Counters statistics. These being

566

567 Default configuration will monitor only enabled infiniband ports, and refresh newly activated or created ports every 30 seconds

568

569 -```txt

569 +```text

570 [plugin:proc:/sys/class/infiniband]

571 # dirname to monitor = /sys/class/infiniband

572 # bandwidth counters = yes

@@ -602,7 +602,7 @@ The following charts will be provided:

602

603 The `drm` path can be configured if it differs from the default:

604

605 -```txt

605 +```text

606 [plugin:proc:/sys/class/drm]

607 # directory to monitor = /sys/class/drm

608 ```

@@ -626,7 +626,7 @@ As far as the message queue charts are dynamic, sane limits are applied for the

626

627 ### configuration

628

629 -```txt

629 +```text

630 [plugin:proc:ipc]

631 # message queues = yes

632 # semaphore totals = yes

src/collectors/profile.plugin/README.md

+6 -6

@@ -16,13 +16,13 @@ Edit the `netdata.conf` configuration file using [`edit-config`](/docs/netdata-a

16

17 Scroll down to the `[plugin:profile]` section to find the available options:

18

19 -```txt

19 +```text

20 [plugin:profile]

21 - update every = 5

22 - number of charts = 200

23 - number of dimensions per chart = 5

24 - seconds to backfill = 86400

25 - number of threads = 16

21 + update every = 5

22 + number of charts = 200

23 + number of dimensions per chart = 5

24 + seconds to backfill = 86400

25 + number of threads = 16

26 ```

27

28 The `number of threads` option will create the specified number of collection

src/collectors/python.d.plugin/haproxy/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "HAProxy monitoring with Netdata"

3 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/python.d.plugin/haproxy/README.md"

4 -sidebar_label: "haproxy-python.d.plugin"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Integrations/Monitor/Webapps"

8 --->

9 -

1 # HAProxy collector

2

3 Monitors frontend and backend metrics such as bytes in, bytes out, sessions current, sessions in queue current.

src/collectors/python.d.plugin/traefik/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Traefik monitoring with Netdata"

3 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/python.d.plugin/traefik/README.md"

4 -sidebar_label: "traefik-python.d.plugin"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Integrations/Monitor/Webapps"

8 --->

9 -

1 # Traefik collector

2

3 Uses the `health` API to provide statistics.

src/collectors/statsd.plugin/README.md

+1 -10

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "StatsD"

3 -description: "The Netdata Agent is a fully-featured StatsD server that collects metrics from any custom application and visualizes them in real-time."

4 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/statsd.plugin/README.md"

5 -sidebar_label: "StatsD"

6 -learn_status: "Published"

7 -learn_rel_path: "Integrations/Monitor/Anything"

8 --->

9 -

1 # StatsD

2

3 [StatsD](https://github.com/statsd/statsd) is a system to collect data from any application. Applications send metrics to it,

@@ -794,7 +785,7 @@ sudo ./edit-config statsd.d/k6.conf

785

786 Copy the following configuration into your file as a starting point.

787

797 -```conf

788 +```text

789 [app]

790 name = k6

791 metrics = k6*

src/collectors/statsd.plugin/asterisk.md

-8

@@ -1,11 +1,3 @@

1 -<!--

2 -title: "Asterisk monitoring with Netdata"

3 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/statsd.plugin/asterisk.md"

4 -sidebar_label: "Asterisk"

5 -learn_status: "Published"

6 -learn_rel_path: "Integrations/Monitor/VoIP"

7 --->

8 -

1 # Asterisk collector

2

3 Monitors [Asterisk](https://www.asterisk.org/) dialplan application's statistics.

src/collectors/statsd.plugin/k6.md

-8

@@ -1,11 +1,3 @@

1 -<!--

2 -title: "K6 load test monitoring with Netdata"

3 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/statsd.plugin/k6.md"

4 -sidebar_label: "K6 Load Testing"

5 -learn_status: "Published"

6 -learn_rel_path: "Integrations/Monitor/apps"

7 --->

8 -

1 # K6 load test collector

2

3 Monitors the impact of load testing experiments performed with [K6](https://k6.io/).

src/collectors/systemd-journal.plugin/active_journal_centralization_guide_no_encryption.md

+1 -1

@@ -47,7 +47,7 @@ sudo systemctl enable --now systemd-journal-gatewayd.socket

47

48 To use it, open your web browser and navigate to:

49

50 -```txt

50 +```text

51 http://server.ip:19531/browse

52 ```

53

src/collectors/systemd-journal.plugin/passive_journal_centralization_guide_no_encryption.md

+2 -2

@@ -74,7 +74,7 @@ sudo apt-get install systemd-journal-remote

74

75 Edit `/etc/systemd/journal-upload.conf` and set the IP address and the port of the server, like so:

76

77 -```conf

77 +```text

78 [Upload]

79 URL=http://centralization.server.ip:19532

80 ```

@@ -87,7 +87,7 @@ sudo systemctl edit systemd-journal-upload

87

88 At the top, add:

89

90 -```conf

90 +```text

91 [Service]

92 Restart=always

93 ```

src/collectors/systemd-journal.plugin/passive_journal_centralization_guide_self_signed_certs.md

+2 -2

@@ -150,7 +150,7 @@ sudo apt-get install systemd-journal-remote

150

151 Edit `/etc/systemd/journal-upload.conf` and set the IP address and the port of the server, like so:

152

153 -```conf

153 +```text

154 [Upload]

155 URL=https://centralization.server.ip:19532

156 ```

@@ -165,7 +165,7 @@ sudo systemctl edit systemd-journal-upload.service

165

166 At the top, add:

167

168 -```conf

168 +```text

169 [Service]

170 Restart=always

171 ```

src/collectors/tc.plugin/integrations/tc_qos_classes.md

+2 -2

@@ -93,7 +93,7 @@ There are no alerts configured by default for this integration.

93

94 In order to view tc classes, you need to create the file `/etc/netdata/tc-qos-helper.conf` with content:

95

96 -```conf

96 +```text

97 tc_show="class"

98 ```

99

@@ -144,7 +144,7 @@ A basic example configuration using classes defined in `/etc/iproute2/tc_cls`.

144

145 An example of class IDs mapped to names in that file can be:

146

147 -```conf

147 +```text

148 2:1 Standard

149 2:8 LowPriorityData

150 2:10 HighThroughputData

src/collectors/tc.plugin/metadata.yaml

+2 -2

@@ -41,7 +41,7 @@ modules:

41 description: |

42 In order to view tc classes, you need to create the file `/etc/netdata/tc-qos-helper.conf` with content:

43

44 - ```conf

44 + ```text

45 tc_show="class"

46 ```

47 configuration:

@@ -74,7 +74,7 @@ modules:

74

75 An example of class IDs mapped to names in that file can be:

76

77 - ```conf

77 + ```text

78 2:1 Standard

79 2:8 LowPriorityData

80 2:10 HighThroughputData

src/daemon/README.md

+7 -7

@@ -160,7 +160,7 @@ Data stored inside this file follows pattern already described for `error.log`.

160

161 The `access.log` logs web requests. The format is:

162

163 -```txt

163 +```text

164 DATE: ID: (sent/all = SENT_BYTES/ALL_BYTES bytes PERCENT_COMPRESSION%, prep/sent/total PREP_TIME/SENT_TIME/TOTAL_TIME ms): ACTION CODE URL

165 ```

166

@@ -191,7 +191,7 @@ issues with gaps in charts on busy systems while still keeping the impact on the

191

192 You can set Netdata scheduling policy in `netdata.conf`, like this:

193

194 -```conf

194 +```text

195 [global]

196 process scheduling policy = idle

197 ```

@@ -213,7 +213,7 @@ For more information see `man sched`.

213

214 Once the policy is set to one of `rr` or `fifo`, the following will appear:

215

216 -```conf

216 +```text

217 [global]

218 process scheduling priority = 0

219 ```

@@ -225,7 +225,7 @@ important.

225

226 When the policy is set to `other`, `nice`, or `batch`, the following will appear:

227

228 -```conf

228 +```text

229 [global]

230 process nice level = 19

231 ```

@@ -259,7 +259,7 @@ Run `systemctl daemon-reload` to reload these changes.

259 Now, tell Netdata to keep these settings, as set by systemd, by editing

260 `netdata.conf` and setting:

261

262 -```conf

262 +```text

263 [global]

264 process scheduling policy = keep

265 ```

@@ -272,7 +272,7 @@ will be maintained by netdata.

272 On a system that is not based on systemd, to make Netdata run with nice level -1 (a little bit higher to the default for

273 all programs), edit `netdata.conf` and set:

274

275 -```conf

275 +```text

276 [global]

277 process scheduling policy = other

278 process nice level = -1

@@ -285,7 +285,7 @@ then [restart Netdata](/docs/netdata-agent/start-stop-restart.md):

285 On a system that is based on systemd, to make Netdata run with nice level -1 (a little bit higher to the default for all

286 programs), edit `netdata.conf` and set:

287

288 -```conf

288 +```text

289 [global]

290 process scheduling policy = keep

291 ```

src/daemon/config/README.md

-10

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Daemon configuration"

3 -description: "The Netdata Agent's daemon is installed preconfigured to collect thousands of metrics every second, but is highly configurable for real-world workloads."

4 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/daemon/config/README.md"

5 -sidebar_label: "Daemon"

6 -learn_status: "Published"

7 -learn_rel_path: "Configuration"

8 -learn_doc_purpose: "Explain the daemon options, the log files, the process scheduling, virtual memory, explain how the netdata.conf is used and backlink to the netdata.conf file reference"

9 --->

10 -

1 # Daemon configuration

2

3 <details>

src/database/README.md

+1 -1

@@ -36,7 +36,7 @@ So,

36

37 You can select the database mode by editing `netdata.conf` and setting:

38

39 -```conf

39 +```text

40 [db]

41 # dbengine (default), ram (the default if dbengine not available), alloc, none

42 mode = dbengine

src/database/ram/README.md

-10

@@ -1,11 +1 @@

1 -<!--

2 -title: "RAM database modes"

3 -description: "Netdata's RAM database modes."

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/database/ram/README.md

5 -sidebar_label: "RAM database modes"

6 -learn_status: "Published"

7 -learn_topic_type: "References"

8 -learn_rel_path: "Developers/Database"

9 --->

10 -

1 # RAM database modes

src/exporting/README.md

+5 -5

@@ -52,14 +52,14 @@ connector to enable and configure for your database of choice.

52 Netdata can filter metrics, to send only a subset of the collected metrics. You can use the

53 configuration file

54

55 -```txt

55 +```text

56 [prometheus:exporter]

57 send charts matching = system.*

58 ```

59

60 or the URL parameter `filter` in the `allmetrics` API call.

61

62 -```txt

62 +```text

63 http://localhost:19999/api/v1/allmetrics?format=shell&filter=system.*

64 ```

65

@@ -106,7 +106,7 @@ different.

106 You can configure each connector individually using the available [options](#options). The

107 `[graphite:my_graphite_instance]` block contains examples of some of these additional options in action.

108

109 -```conf

109 +```text

110 [exporting:global]

111 enabled = yes

112 send configured labels = no

@@ -213,13 +213,13 @@ Configure individual connectors and override any global settings with the follow

213

214 Example IPv4:

215

216 -```conf

216 +```text

217 destination = 10.11.14.2:4242 10.11.14.3:4242 10.11.14.4:4242

218 ```

219

220 Example IPv6 and IPv4 together:

221

222 -```conf

222 +```text

223 destination = [ffff:...:0001]:2003 10.11.12.1:2003

224 ```

225

src/exporting/TIMESCALE.md

+2 -2

@@ -15,13 +15,13 @@ To get started archiving metrics to TimescaleDB right away, check out Mahlon's [

15 repository](https://github.com/mahlonsmith/netdata-timescale-relay) on GitHub. Please be aware that backends subsystem

16 was removed and Netdata configuration should be moved to the new `exporting.conf` configuration file. Use

17

18 -```conf

18 +```text

19 [json:my_instance]

20 ```

21

22 in `exporting.conf` instead of

23

24 -```conf

24 +```text

25 [backend]

26 type = json

27 ```

src/exporting/WALKTHROUGH.md

+2 -2

@@ -137,7 +137,7 @@ point to talk about Prometheus's data model which can be viewed here: <https://p

137 As explained we have two key elements in Prometheus metrics. We have the _metric_ and its _labels_. Labels allow for

138 granularity between metrics. Let's use our previous example to further explain.

139

140 -```conf

140 +```text

141 netdata_disk_space_GiB_average{chart="disk_space._run",dimension="avail",family="/run",mount_point="/run",filesystem="tmpfs",mount_root="/"} 0.0298195 1684951093000

142 ```

143

@@ -193,7 +193,7 @@ across a section of metrics with the first comments `# COMMENT homogeneous char

193 family "cpu", units "percentage"` followed by the metrics. This is a good start now let us drill down to the specific

194 metric we would like to graph.

195

196 -```conf

196 +```text

197 # COMMENT

198 netdata_system_cpu_percentage_average: dimension "system", value is percentage, gauge, dt 1501275951 to 1501275951 inclusive

199 netdata_system_cpu_percentage_average{chart="system.cpu",family="cpu",dimension="system"} 0.0000000 1501275951000

src/exporting/prometheus/README.md

+3 -3

@@ -203,7 +203,7 @@ interrupts, QoS classes, statsd synthetic charts, etc.

203

204 The default is controlled in `exporting.conf`:

205

206 -```conf

206 +```text

207 [prometheus:exporter]

208 send names instead of ids = yes | no

209 ```

@@ -217,7 +217,7 @@ You can overwrite it from Prometheus, by appending to the URL:

217

218 Netdata can filter the metrics it sends to Prometheus with this setting:

219

220 -```conf

220 +```text

221 [prometheus:exporter]

222 send charts matching = *

223 ```

@@ -233,7 +233,7 @@ used.

233

234 Netdata sends all metrics prefixed with `netdata_`. You can change this in `netdata.conf`, like this:

235

236 -```conf

236 +```text

237 [prometheus:exporter]

238 prefix = netdata

239 ```

src/go/pkg/matcher/README.md

-8

@@ -1,11 +1,3 @@

1 -<!--

2 -title: "matcher"

3 -custom_edit_url: "/src/go/plugin/go.d/pkg/matcher/README.md"

4 -sidebar_label: "matcher"

5 -learn_status: "Published"

6 -learn_rel_path: "Developers/External plugins/go.d.plugin/Helper Packages"

7 --->

8 -

1 # matcher

2 ## Supported Format

3

src/go/plugin/go.d/modules/bind/README.md

-10

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Bind9 monitoring with Netdata"

3 -description: "Monitor the health and performance of Bind9 DNS servers with zero configuration, per-second metric granularity, and interactive visualizations."

4 -custom_edit_url: "https://github.com/netdata/go.d.plugin/edit/master/modules/bind/README.md"

5 -sidebar_label: "Bind9"

6 -learn_status: "Published"

7 -learn_topic_type: "References"

8 -learn_rel_path: "Integrations/Monitor/Webapps"

9 --->

10 -

1 # Bind9 collector

2

3 [`Bind9`](https://www.isc.org/bind/) (or named) is a very flexible, full-featured DNS system.

src/go/plugin/go.d/pkg/README.md

-8

@@ -1,11 +1,3 @@

1 -<!--

2 -title: "Helper Packages"

3 -custom_edit_url: "/src/go/plugin/go.d/pkg/README.md"

4 -sidebar_label: "Helper Packages"

5 -learn_status: "Published"

6 -learn_rel_path: "Developers/External plugins/go.d.plugin/Helper Packages"

7 --->

8 -

1 # Helper Packages

2

3 - if you need IP ranges consider to

src/go/plugin/go.d/pkg/iprange/README.md

-8

@@ -1,11 +1,3 @@

1 -<!--

2 -title: "iprange"

3 -custom_edit_url: "/src/go/plugin/go.d/pkg/iprange/README.md"

4 -sidebar_label: "iprange"

5 -learn_status: "Published"

6 -learn_rel_path: "Developers/External plugins/go.d.plugin/Helper Packages"

7 --->

8 -

1 # iprange

2

3 This package helps you to work with IP ranges.

src/go/plugin/go.d/pkg/prometheus/selector/README.md

-8

@@ -1,11 +1,3 @@

1 -<!--

2 -title: "Time series selector"

3 -custom_edit_url: "/src/go/plugin/go.d/pkg/prometheus/selector/README.md"

4 -sidebar_label: "Time series selector"

5 -learn_status: "Published"

6 -learn_rel_path: "Developers/External plugins/go.d.plugin/Helper Packages"

7 --->

8 -

1 # Time series selector

2

3 Selectors allow selecting and filtering of a set of time series.

src/health/notifications/README.md

+6 -6

@@ -29,7 +29,7 @@ It uses **roles**. For example `sysadmin`, `webmaster`, `dba`, etc.

29

30 Each alert is assigned to one or more roles, using the `to` line of the alert configuration. For example, here is the alert configuration for `ram.conf` that defaults to the role `sysadmin`:

31

32 -```conf

32 +```text

33 alarm: ram_in_use

34 on: system.ram

35 class: Utilization

@@ -52,7 +52,7 @@ Then `alarm-notify.sh` uses its own configuration file `health_alarm_notify.conf

52 Here is an example, of the `sysadmin`'s role recipients for the email notification.

53 You can send the notification to multiple recipients by separating the emails with a space.

54

55 -```conf

55 +```text

56

57 ###############################################################################

58 # RECIPIENTS PER ROLE

@@ -84,7 +84,7 @@ You can edit `health_alarm_notify.conf` using the `edit-config` script to config

84

85 - **Recipients** per role per notification method

86

87 - ```conf

87 + ```text

88 role_recipients_email[sysadmin]="${DEFAULT_RECIPIENT_EMAIL}"

89 role_recipients_pushover[sysadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"

90 role_recipients_pushbullet[sysadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"

@@ -132,7 +132,7 @@ When you define recipients per role for notification methods, you can append `|c

132 In the following examples, the first recipient receives all the alerts, while the second one receives only notifications for alerts that have at some point become critical.

133 The second user may still receive warning and clear notifications, but only for the event that previously caused a critical alert.

134

135 -```conf

135 +```text

136 email : "user1@example.com user2@example.com|critical"

137 pushover : "2987343...9437837 8756278...2362736|critical"

138 telegram : "111827421 112746832|critical"

@@ -158,7 +158,7 @@ This works for all notification methods (including the default recipients).

158 If you need to send curl based notifications (pushover, pushbullet, slack, alerta,

159 flock, discord, telegram) via a proxy, you should set these variables to your proxy address:

160

161 -```conf

161 +```text

162 export http_proxy="http://10.0.0.1:3128/"

163 export https_proxy="http://10.0.0.1:3128/"

164 ```

@@ -173,7 +173,7 @@ If you have an Internet facing netdata (or you have copied the images/ folder

173 of netdata to your web server), set its URL here, to fetch the notification

174 images from it.

175

176 -```conf

176 +```text

177 images_base_url="http://my.public.netdata.server:19999"

178 ```

179

src/health/notifications/alerta/README.md

+1 -1

@@ -71,7 +71,7 @@ You will need an API key to send messages from any source, if Alerta is configur

71

72 The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:

73

74 -```conf

74 +```text

75 role_recipients_alerta[sysadmin]="Systems"

76 role_recipients_alerta[domainadmin]="Domains"

77 role_recipients_alerta[dba]="Databases Systems"

src/health/notifications/alerta/metadata.yaml

+1 -1

@@ -58,7 +58,7 @@

58 detailed_description: |

59 The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:

60

61 - ```conf

61 + ```text

62 role_recipients_alerta[sysadmin]="Systems"

63 role_recipients_alerta[domainadmin]="Domains"

64 role_recipients_alerta[dba]="Databases Systems"

src/health/notifications/awssns/README.md

+2 -2

@@ -124,7 +124,7 @@ All roles will default to this variable if left unconfigured.

124

125 You can have different recipient Topics per **role**, by editing `DEFAULT_RECIPIENT_AWSSNS` with the Topic ARN you want, in the following entries at the bottom of the same file:

126

127 -```conf

127 +```text

128 role_recipients_awssns[sysadmin]="arn:aws:sns:us-east-2:123456789012:Systems"

129 role_recipients_awssns[domainadmin]="arn:aws:sns:us-east-2:123456789012:Domains"

130 role_recipients_awssns[dba]="arn:aws:sns:us-east-2:123456789012:Databases"

@@ -143,7 +143,7 @@ role_recipients_awssns[sitemgr]="arn:aws:sns:us-east-2:123456789012:Sites"

143 An example working configuration would be:

144

145 ```yaml

146 -```conf

146 +```text

147 #------------------------------------------------------------------------------

148 # Amazon SNS notifications

149

src/health/notifications/awssns/metadata.yaml

+2 -2

@@ -104,7 +104,7 @@

104

105 You can have different recipient Topics per **role**, by editing `DEFAULT_RECIPIENT_AWSSNS` with the Topic ARN you want, in the following entries at the bottom of the same file:

106

107 - ```conf

107 + ```text

108 role_recipients_awssns[sysadmin]="arn:aws:sns:us-east-2:123456789012:Systems"

109 role_recipients_awssns[domainadmin]="arn:aws:sns:us-east-2:123456789012:Domains"

110 role_recipients_awssns[dba]="arn:aws:sns:us-east-2:123456789012:Databases"

@@ -122,7 +122,7 @@

122 enabled: false

123 description: 'An example working configuration would be:'

124 config: |

125 - ```conf

125 + ```text

126 #------------------------------------------------------------------------------

127 # Amazon SNS notifications

128

src/health/notifications/discord/README.md

+1 -1

@@ -61,7 +61,7 @@ The following options can be defined for this notification

61

62 All roles will default to this variable if left unconfigured.

63 You can then have different channels per role, by editing `DEFAULT_RECIPIENT_DISCORD` with the channel you want, in the following entries at the bottom of the same file:

64 -```conf

64 +```text

65 role_recipients_discord[sysadmin]="systems"

66 role_recipients_discord[domainadmin]="domains"

67 role_recipients_discord[dba]="databases systems"

src/health/notifications/discord/metadata.yaml

+1 -1

@@ -45,7 +45,7 @@

45 detailed_description: |

46 All roles will default to this variable if left unconfigured.

47 You can then have different channels per role, by editing `DEFAULT_RECIPIENT_DISCORD` with the channel you want, in the following entries at the bottom of the same file:

48 - ```conf

48 + ```text

49 role_recipients_discord[sysadmin]="systems"

50 role_recipients_discord[domainadmin]="domains"

51 role_recipients_discord[dba]="databases systems"

src/health/notifications/email/README.md

+1 -1

@@ -60,7 +60,7 @@ The following options can be defined for this notification

60

61 All roles will default to this variable if left unconfigured.

62 The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:

63 -```conf

63 +```text

64 role_recipients_email[sysadmin]="systems@example.com"

65 role_recipients_email[domainadmin]="domains@example.com"

66 role_recipients_email[dba]="databases@example.com systems@example.com"

src/health/notifications/email/metadata.yaml

+1 -1

@@ -44,7 +44,7 @@

44 detailed_description: |

45 All roles will default to this variable if left unconfigured.

46 The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:

47 - ```conf

47 + ```text

48 role_recipients_email[sysadmin]="systems@example.com"

49 role_recipients_email[domainadmin]="domains@example.com"

50 role_recipients_email[dba]="databases@example.com systems@example.com"

src/health/notifications/flock/README.md

+1 -1

@@ -59,7 +59,7 @@ The following options can be defined for this notification

59 ##### DEFAULT_RECIPIENT_FLOCK

60

61 You can have different channels per role, by editing DEFAULT_RECIPIENT_FLOCK with the channel you want, in the following entries at the bottom of the same file:

62 -```conf

62 +```text

63 role_recipients_flock[sysadmin]="systems"

64 role_recipients_flock[domainadmin]="domains"

65 role_recipients_flock[dba]="databases systems"

src/health/notifications/flock/metadata.yaml

+1 -1

@@ -43,7 +43,7 @@

43 required: true

44 detailed_description: |

45 You can have different channels per role, by editing DEFAULT_RECIPIENT_FLOCK with the channel you want, in the following entries at the bottom of the same file:

46 - ```conf

46 + ```text

47 role_recipients_flock[sysadmin]="systems"

48 role_recipients_flock[domainadmin]="domains"

49 role_recipients_flock[dba]="databases systems"

src/health/notifications/irc/README.md

+1 -1

@@ -76,7 +76,7 @@ nc="/usr/bin/nc"

76 ##### DEFAULT_RECIPIENT_IRC

77

78 The `DEFAULT_RECIPIENT_IRC` can be edited in the following entries at the bottom of the same file:

79 -```conf

79 +```text

80 role_recipients_irc[sysadmin]="#systems"

81 role_recipients_irc[domainadmin]="#domains"

82 role_recipients_irc[dba]="#databases #systems"

src/health/notifications/irc/metadata.yaml

+1 -1

@@ -69,7 +69,7 @@

69 required: true

70 detailed_description: |

71 The `DEFAULT_RECIPIENT_IRC` can be edited in the following entries at the bottom of the same file:

72 - ```conf

72 + ```text

73 role_recipients_irc[sysadmin]="#systems"

74 role_recipients_irc[domainadmin]="#domains"

75 role_recipients_irc[dba]="#databases #systems"

src/health/notifications/kavenegar/README.md

+1 -1

@@ -63,7 +63,7 @@ The following options can be defined for this notification

63 All roles will default to this variable if lest unconfigured.

64

65 You can then have different SMS recipients per role, by editing `DEFAULT_RECIPIENT_KAVENEGAR` with the SMS recipients you want, in the following entries at the bottom of the same file:

66 -```conf

66 +```text

67 role_recipients_kavenegar[sysadmin]="09100000000"

68 role_recipients_kavenegar[domainadmin]="09111111111"

69 role_recipients_kavenegar[dba]="0922222222"

src/health/notifications/kavenegar/metadata.yaml

+1 -1

@@ -50,7 +50,7 @@

50 All roles will default to this variable if lest unconfigured.

51

52 You can then have different SMS recipients per role, by editing `DEFAULT_RECIPIENT_KAVENEGAR` with the SMS recipients you want, in the following entries at the bottom of the same file:

53 - ```conf

53 + ```text

54 role_recipients_kavenegar[sysadmin]="09100000000"

55 role_recipients_kavenegar[domainadmin]="09111111111"

56 role_recipients_kavenegar[dba]="0922222222"

src/health/notifications/matrix/README.md

+1 -1

@@ -77,7 +77,7 @@ All roles will default to this variable if left unconfigured.

77

78 You can have different Rooms per role, by editing `DEFAULT_RECIPIENT_MATRIX` with the `!roomid:homeservername` you want, in the following entries at the bottom of the same file:

79

80 -```conf

80 +```text

81 role_recipients_matrix[sysadmin]="!roomid1:homeservername"

82 role_recipients_matrix[domainadmin]="!roomid2:homeservername"

83 role_recipients_matrix[dba]="!roomid3:homeservername"

src/health/notifications/matrix/metadata.yaml

+1 -1

@@ -61,7 +61,7 @@

61

62 You can have different Rooms per role, by editing `DEFAULT_RECIPIENT_MATRIX` with the `!roomid:homeservername` you want, in the following entries at the bottom of the same file:

63

64 - ```conf

64 + ```text

65 role_recipients_matrix[sysadmin]="!roomid1:homeservername"

66 role_recipients_matrix[domainadmin]="!roomid2:homeservername"

67 role_recipients_matrix[dba]="!roomid3:homeservername"

src/health/notifications/messagebird/README.md

+1 -1

@@ -62,7 +62,7 @@ The following options can be defined for this notification

62 All roles will default to this variable if left unconfigured.

63

64 You can then have different recipients per role, by editing `DEFAULT_RECIPIENT_MESSAGEBIRD` with the number you want, in the following entries at the bottom of the same file:

65 -```conf

65 +```text

66 role_recipients_messagebird[sysadmin]="+15555555555"

67 role_recipients_messagebird[domainadmin]="+15555555556"

68 role_recipients_messagebird[dba]="+15555555557"

src/health/notifications/messagebird/metadata.yaml

+1 -1

@@ -49,7 +49,7 @@

49 All roles will default to this variable if left unconfigured.

50

51 You can then have different recipients per role, by editing `DEFAULT_RECIPIENT_MESSAGEBIRD` with the number you want, in the following entries at the bottom of the same file:

52 - ```conf

52 + ```text

53 role_recipients_messagebird[sysadmin]="+15555555555"

54 role_recipients_messagebird[domainadmin]="+15555555556"

55 role_recipients_messagebird[dba]="+15555555557"

src/health/notifications/msteams/README.md

+1 -1

@@ -64,7 +64,7 @@ In Microsoft Teams the channel name is encoded in the URI after `/IncomingWebhoo

64 All roles will default to this variable if left unconfigured.

65

66 You can have different channels per role, by editing `DEFAULT_RECIPIENT_MSTEAMS` with the channel you want, in the following entries at the bottom of the same file:

67 -```conf

67 +```text

68 role_recipients_msteams[sysadmin]="CHANNEL1"

69 role_recipients_msteams[domainadmin]="CHANNEL2"

70 role_recipients_msteams[dba]="databases CHANNEL3"

src/health/notifications/msteams/metadata.yaml

+1 -1

@@ -50,7 +50,7 @@

50 All roles will default to this variable if left unconfigured.

51

52 You can have different channels per role, by editing `DEFAULT_RECIPIENT_MSTEAMS` with the channel you want, in the following entries at the bottom of the same file:

53 - ```conf

53 + ```text

54 role_recipients_msteams[sysadmin]="CHANNEL1"

55 role_recipients_msteams[domainadmin]="CHANNEL2"

56 role_recipients_msteams[dba]="databases CHANNEL3"

src/health/notifications/ntfy/README.md

+1 -1

@@ -67,7 +67,7 @@ You can define multiple recipient URLs like this: `https://SERVER1/TOPIC1` `http

67 All roles will default to this variable if left unconfigured.

68

69 You can then have different servers and/or topics per role, by editing DEFAULT_RECIPIENT_NTFY with the server-topic combination you want, in the following entries at the bottom of the same file:

70 -```conf

70 +```text

71 role_recipients_ntfy[sysadmin]="https://SERVER1/TOPIC1"

72 role_recipients_ntfy[domainadmin]="https://SERVER2/TOPIC2"

73 role_recipients_ntfy[dba]="https://SERVER3/TOPIC3"

src/health/notifications/ntfy/metadata.yaml

+1 -1

@@ -45,7 +45,7 @@

45 All roles will default to this variable if left unconfigured.

46

47 You can then have different servers and/or topics per role, by editing DEFAULT_RECIPIENT_NTFY with the server-topic combination you want, in the following entries at the bottom of the same file:

48 - ```conf

48 + ```text

49 role_recipients_ntfy[sysadmin]="https://SERVER1/TOPIC1"

50 role_recipients_ntfy[domainadmin]="https://SERVER2/TOPIC2"

51 role_recipients_ntfy[dba]="https://SERVER3/TOPIC3"

src/health/notifications/pagerduty/README.md

+1 -1

@@ -63,7 +63,7 @@ The following options can be defined for this notification

63 All roles will default to this variable if left unconfigured.

64

65 The `DEFAULT_RECIPIENT_PD` can be edited in the following entries at the bottom of the same file:

66 -```conf

66 +```text

67 role_recipients_pd[sysadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxa"

68 role_recipients_pd[domainadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxb"

69 role_recipients_pd[dba]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxc"

src/health/notifications/pagerduty/metadata.yaml

+1 -1

@@ -44,7 +44,7 @@

44 All roles will default to this variable if left unconfigured.

45

46 The `DEFAULT_RECIPIENT_PD` can be edited in the following entries at the bottom of the same file:

47 - ```conf

47 + ```text

48 role_recipients_pd[sysadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxa"

49 role_recipients_pd[domainadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxb"

50 role_recipients_pd[dba]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxc"

src/health/notifications/prowl/README.md

+1 -1

@@ -66,7 +66,7 @@ The following options can be defined for this notification

66 All roles will default to this variable if left unconfigured.

67

68 The `DEFAULT_RECIPIENT_PROWL` can be edited in the following entries at the bottom of the same file:

69 -```conf

69 +```text

70 role_recipients_prowl[sysadmin]="AAAAAAAA"

71 role_recipients_prowl[domainadmin]="BBBBBBBBB"

72 role_recipients_prowl[dba]="CCCCCCCCC"

src/health/notifications/prowl/metadata.yaml

+1 -1

@@ -43,7 +43,7 @@

43 All roles will default to this variable if left unconfigured.

44

45 The `DEFAULT_RECIPIENT_PROWL` can be edited in the following entries at the bottom of the same file:

46 - ```conf

46 + ```text

47 role_recipients_prowl[sysadmin]="AAAAAAAA"

48 role_recipients_prowl[domainadmin]="BBBBBBBBB"

49 role_recipients_prowl[dba]="CCCCCCCCC"

src/health/notifications/pushbullet/README.md

+1 -1

@@ -63,7 +63,7 @@ You can define multiple entries like this: user1@email.com user2@email.com.

63 All roles will default to this variable if left unconfigured.

64

65 The `DEFAULT_RECIPIENT_PUSHBULLET` can be edited in the following entries at the bottom of the same file:

66 -```conf

66 +```text

67 role_recipients_pushbullet[sysadmin]="user1@email.com"

68 role_recipients_pushbullet[domainadmin]="user2@mail.com"

69 role_recipients_pushbullet[dba]="#channel1"

src/health/notifications/pushbullet/metadata.yaml

+1 -1

@@ -47,7 +47,7 @@

47 All roles will default to this variable if left unconfigured.

48

49 The `DEFAULT_RECIPIENT_PUSHBULLET` can be edited in the following entries at the bottom of the same file:

50 - ```conf

50 + ```text

51 role_recipients_pushbullet[sysadmin]="user1@email.com"

52 role_recipients_pushbullet[domainadmin]="user2@mail.com"

53 role_recipients_pushbullet[dba]="#channel1"

src/health/notifications/pushover/README.md

+1 -1

@@ -65,7 +65,7 @@ The following options can be defined for this notification

65 All roles will default to this variable if left unconfigured.

66

67 The `DEFAULT_RECIPIENT_PUSHOVER` can be edited in the following entries at the bottom of the same file:

68 -```conf

68 +```text

69 role_recipients_pushover[sysadmin]="USERTOKEN1"

70 role_recipients_pushover[domainadmin]="USERTOKEN2"

71 role_recipients_pushover[dba]="USERTOKEN3 USERTOKEN4"

src/health/notifications/pushover/metadata.yaml

+1 -1

@@ -49,7 +49,7 @@

49 All roles will default to this variable if left unconfigured.

50

51 The `DEFAULT_RECIPIENT_PUSHOVER` can be edited in the following entries at the bottom of the same file:

52 - ```conf

52 + ```text

53 role_recipients_pushover[sysadmin]="USERTOKEN1"

54 role_recipients_pushover[domainadmin]="USERTOKEN2"

55 role_recipients_pushover[dba]="USERTOKEN3 USERTOKEN4"

src/health/notifications/rocketchat/README.md

+1 -1

@@ -62,7 +62,7 @@ The following options can be defined for this notification

62 All roles will default to this variable if left unconfigured.

63

64 The `DEFAULT_RECIPIENT_ROCKETCHAT` can be edited in the following entries at the bottom of the same file:

65 -```conf

65 +```text

66 role_recipients_rocketchat[sysadmin]="systems"

67 role_recipients_rocketchat[domainadmin]="domains"

68 role_recipients_rocketchat[dba]="databases systems"

src/health/notifications/rocketchat/metadata.yaml

+1 -1

@@ -46,7 +46,7 @@

46 All roles will default to this variable if left unconfigured.

47

48 The `DEFAULT_RECIPIENT_ROCKETCHAT` can be edited in the following entries at the bottom of the same file:

49 - ```conf

49 + ```text

50 role_recipients_rocketchat[sysadmin]="systems"

51 role_recipients_rocketchat[domainadmin]="domains"

52 role_recipients_rocketchat[dba]="databases systems"

src/health/notifications/smstools3/README.md

+1 -1

@@ -74,7 +74,7 @@ sendsms="/usr/bin/sendsms"

74 All roles will default to this variable if left unconfigured.

75

76 You can then have different phone numbers per role, by editing `DEFAULT_RECIPIENT_SMS` with the phone number you want, in the following entries at the bottom of the same file:

77 -```conf

77 +```text

78 role_recipients_sms[sysadmin]="PHONE1"

79 role_recipients_sms[domainadmin]="PHONE2"

80 role_recipients_sms[dba]="PHONE3"

src/health/notifications/smstools3/metadata.yaml

+1 -1

@@ -57,7 +57,7 @@

57 All roles will default to this variable if left unconfigured.

58

59 You can then have different phone numbers per role, by editing `DEFAULT_RECIPIENT_SMS` with the phone number you want, in the following entries at the bottom of the same file:

60 - ```conf

60 + ```text

61 role_recipients_sms[sysadmin]="PHONE1"

62 role_recipients_sms[domainadmin]="PHONE2"

63 role_recipients_sms[dba]="PHONE3"

src/health/notifications/syslog/README.md

+1 -1

@@ -78,7 +78,7 @@ All roles will default to this variable if left unconfigured.

78

79 You can then have different recipients per role, by editing DEFAULT_RECIPIENT_SYSLOG with the recipient you want, in the following entries at the bottom of the same file:

80

81 -```conf

81 +```text

82 role_recipients_syslog[sysadmin]="daemon.notice@loghost1:514/netdata"

83 role_recipients_syslog[domainadmin]="daemon.notice@loghost2:514/netdata"

84 role_recipients_syslog[dba]="daemon.notice@loghost3:514/netdata"

src/health/notifications/syslog/metadata.yaml

+1 -1

@@ -59,7 +59,7 @@

59 detailed_description: |

60 You can then have different recipients per role, by editing DEFAULT_RECIPIENT_SYSLOG with the recipient you want, in the following entries at the bottom of the same file:

61

62 - ```conf

62 + ```text

63 role_recipients_syslog[sysadmin]="daemon.notice@loghost1:514/netdata"

64 role_recipients_syslog[domainadmin]="daemon.notice@loghost2:514/netdata"

65 role_recipients_syslog[dba]="daemon.notice@loghost3:514/netdata"

src/health/notifications/telegram/README.md

+1 -1

@@ -63,7 +63,7 @@ All roles will default to this variable if left unconfigured.

63

64 The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:

65

66 -```conf

66 +```text

67 role_recipients_telegram[sysadmin]="-49999333324"

68 role_recipients_telegram[domainadmin]="-49999333389"

69 role_recipients_telegram[dba]="-10099992222"

src/health/notifications/telegram/metadata.yaml

+1 -1

@@ -47,7 +47,7 @@

47

48 The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:

49

50 - ```conf

50 + ```text

51 role_recipients_telegram[sysadmin]="-49999333324"

52 role_recipients_telegram[domainadmin]="-49999333389"

53 role_recipients_telegram[dba]="-10099992222"

src/health/notifications/twilio/README.md

+1 -1

@@ -62,7 +62,7 @@ The following options can be defined for this notification

62

63 You can then have different recipients per role, by editing DEFAULT_RECIPIENT_TWILIO with the recipient's number you want, in the following entries at the bottom of the same file:

64

65 -```conf

65 +```text

66 role_recipients_twilio[sysadmin]="+15555555555"

67 role_recipients_twilio[domainadmin]="+15555555556"

68 role_recipients_twilio[dba]="+15555555557"

src/health/notifications/twilio/metadata.yaml

+1 -1

@@ -52,7 +52,7 @@

52 detailed_description: |

53 You can then have different recipients per role, by editing DEFAULT_RECIPIENT_TWILIO with the recipient's number you want, in the following entries at the bottom of the same file:

54

55 - ```conf

55 + ```text

56 role_recipients_twilio[sysadmin]="+15555555555"

57 role_recipients_twilio[domainadmin]="+15555555556"

58 role_recipients_twilio[dba]="+15555555557"

src/health/notifications/web/README.md

-10

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Browser pop up agent alert notifications"

3 -sidebar_label: "Browser pop ups"

4 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/health/notifications/web/README.md"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Integrations/Notify/Agent alert notifications"

8 -learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"

9 --->

10 -

1 # Browser pop up agent alert notifications

2

3 The Netdata dashboard shows HTML notifications, when it is open.

src/libnetdata/adaptive_resortable_list/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Adaptive Re-sortable List (ARL)"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/adaptive_resortable_list/README.md

4 -sidebar_label: "Adaptive Re-sortable List (ARL)"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # Adaptive Re-sortable List (ARL)

2

3 This library allows Netdata to read a series of `name - value` pairs

src/libnetdata/aral/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Array Allocator"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/aral/README.md

4 -sidebar_label: "Array allocator"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # Array Allocator

2

3 Come on! Array allocators are embedded in libc! Why do we need such a thing in Netdata?

src/libnetdata/avl/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "AVL"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/avl/README.md

4 -sidebar_label: "AVL"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # AVL

2

3 AVL is a library indexing objects in B-Trees.

src/libnetdata/buffer/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "BUFFER"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/buffer/README.md

4 -sidebar_label: "BUFFER library"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # BUFFER

2

3 `BUFFER` is a convenience library for working with strings in `C`.

src/libnetdata/circular_buffer/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Circular Buffer"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/circular_buffer/README.md

4 -sidebar_label: "Circular Buffer"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # Circular Buffer

2

3 `struct circular_buffer` is an adaptive circular buffer. It will start at an initial size

src/libnetdata/config/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Netdata ini config files"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/config/README.md

4 -sidebar_label: "Netdata ini config files"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # Netdata ini config files

2

3 Configuration files `netdata.conf` and `stream.conf` are Netdata ini files.

src/libnetdata/datetime/README.md

-8

@@ -1,11 +1,3 @@

1 -<!--

2 -title: "Datetime"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/datetime/README.md

4 -sidebar_label: "Datetime"

5 -learn_topic_type: "Tasks"

6 -learn_rel_path: "Developers/libnetdata"

7 --->

8 -

1 # Datetime

2

3 Formatting dates and timestamps.

src/libnetdata/ebpf/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "eBPF"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/ebpf/README.md

4 -sidebar_label: "eBPF"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # eBPF library

2

3 Netdata's eBPF library supports the [eBPF collector](/src/collectors/ebpf.plugin/README.md).

src/libnetdata/json/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "json"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/json/README.md

4 -sidebar_label: "json"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # json

2

3 `json` contains a parser for json strings, based on `jsmn` (<https://github.com/zserge/jsmn>), but case you have installed the JSON-C library, the installation script will prefer it, you can also force its use with `--enable-jsonc` in the compilation time.

src/libnetdata/line_splitter/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Log"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/log/README.md

4 -sidebar_label: "Log"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # Log

2

3 The netdata log library supports debug, info, error and fatal error logging.

src/libnetdata/locks/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Locks"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/locks/README.md

4 -sidebar_label: "Locks"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # Locks

2

3 ## How to trace netdata locks

src/libnetdata/log/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Log"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/log/README.md

4 -sidebar_label: "Log"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # Netdata Logging

2

3 This document describes how Netdata generates its own logs, not how Netdata manages and queries logs databases.

src/libnetdata/onewayalloc/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "One Way Allocator"

3 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/libnetdata/onewayalloc/README.md"

4 -sidebar_label: "One way allocator"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # One Way Allocator

2

3 This is a very fast single-threaded-only memory allocator, that minimized system calls

src/libnetdata/procfile/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "PROCFILE"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/procfile/README.md

4 -sidebar_label: "Procfile"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # PROCFILE

2

3 procfile is a library for reading text data files (i.e `/proc` files) in the fastest possible way.

src/libnetdata/simple_pattern/README.md

-10

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Simple patterns"

3 -description: "Netdata supports simple patterns, which are less cryptic versions of regular expressions. Use familiar notation for powerful results."

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/simple_pattern/README.md

5 -sidebar_label: "Simple patterns"

6 -learn_status: "Published"

7 -learn_topic_type: "Tasks"

8 -learn_rel_path: "Developers/libnetdata"

9 --->

10 -

1 # Simple patterns

2

3 Unix prefers regular expressions. But they are just too hard, too cryptic

src/libnetdata/statistical/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Statistical functions"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/statistical/README.md

4 -sidebar_label: "Statistical functions"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # Statistical functions

2

3 A library for easy and fast calculations of statistical measurements like average, median etc.

src/libnetdata/storage_number/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Netdata storage number"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/storage_number/README.md

4 -sidebar_label: "Storage number"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # Netdata storage number

2

3 Although `netdata` does all its calculations using `long double`, it stores all values using

src/libnetdata/string/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "String"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/string/README.md

4 -sidebar_label: "String"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # STRING

2

3 STRING provides a way to allocate and free text strings, while de-duplicating them.

src/libnetdata/threads/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: Threads

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/threads/README.md

4 -sidebar_label: "Threads"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # Threads

2

3 Netdata uses a custom threads library

src/libnetdata/url/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "URL"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/url/README.md

4 -sidebar_label: "URL"

5 -learn_status: "Published"

6 -learn_topic_type: "Tasks"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # URL

2

3 The URL library contains common functions useful for URLs, like conversion from/to hex,

src/libnetdata/uuid/README.md

-8

@@ -1,11 +1,3 @@

1 -<!--

2 -title: "UUID"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/uuid/README.md

4 -sidebar_label: "UUID"

5 -learn_topic_type: "Tasks"

6 -learn_rel_path: "Developers/libnetdata"

7 --->

8 -

1 # UUID

2

3 Netdata uses libuuid for managing UUIDs.

src/libnetdata/worker_utilization/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Worker Utilization"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/worker_utilization/README.md

4 -sidebar_label: "Worker Utilization"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/libnetdata"

8 --->

9 -

1 # Worker Utilization

2

3 This library is to be used when there are 1 or more worker threads accepting requests

src/plugins.d/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "External plugins"

3 -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/plugins.d/README.md"

4 -sidebar_label: "External plugins"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/External plugins"

8 --->

9 -

1 # External plugins

2

3 `plugins.d` is the Netdata internal plugin that collects metrics

src/registry/README.md

+7 -7

@@ -85,7 +85,7 @@ We believe, it can do it...

85

86 **To turn any Netdata into a registry**, edit `/etc/netdata/netdata.conf` and set:

87

88 -```conf

88 +```text

89 [registry]

90 enabled = yes

91 registry to announce = http://your.registry:19999

@@ -96,7 +96,7 @@ Restart your Netdata to activate it.

96 Then, you need to tell **all your other Netdata servers to advertise your registry**, instead of the default. To do

97 this, on each of your Netdata servers, edit `/etc/netdata/netdata.conf` and set:

98

99 -```conf

99 +```text

100 [registry]

101 enabled = no

102 registry to announce = http://your.registry:19999

@@ -110,7 +110,7 @@ This is it. You have your registry now.

110 You may also want to give your server different names under the node menu (i.e. to have them sorted / grouped). You can

111 change its registry name, by setting on each Netdata server:

112

113 -```conf

113 +```text

114 [registry]

115 registry hostname = Group1 - Master DB

116 ```

@@ -121,7 +121,7 @@ So this server will appear in the node menu as `Group1 - Master DB`. The max nam

121

122 Netdata v1.9+ support limiting access to the registry from given IPs, like this:

123

124 -```conf

124 +```text

125 [registry]

126 allow from = *

127 ```

@@ -142,7 +142,7 @@ against the name-pattern.

142 Please note that this process can be expensive on a machine that is serving many connections. The behaviour of the

143 pattern matching can be controlled with the following setting:

144

145 -```conf

145 +```text

146 [registry]

147 allow by dns = heuristic

148 ```

@@ -175,7 +175,7 @@ Beginning with `v1.30.0`, when the Netdata Agent's web server processes a reques

175 and `Secure` cookies. If you have problems accessing the local Agent dashboard or Netdata Cloud, disable these

176 cookies by [editing `netdata.conf`](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config):

177

178 -```conf

178 +```text

179 [registry]

180 enable cookies SameSite and Secure = no

181 ```

@@ -198,7 +198,7 @@ redirecting the browser back to itself hoping that it will receive the cookie. I

198 registry will keep redirecting your web browser back to itself, which after a few redirects will fail with an error like

199 this:

200

201 -```conf

201 +```text

202 ERROR 409: Cannot ACCESS netdata registry: https://registry.my-netdata.io responded with: {"status":"redirect","registry":"https://registry.my-netdata.io"}

203 ```

204

src/streaming/README.md

+9 -9

@@ -111,7 +111,7 @@ the following format: `[PROTOCOL:]HOST[%INTERFACE][:PORT][:SSL]`.

111

112 To enable TCP streaming to a parent node at `203.0.113.0` on port `20000` and with TLS/SSL encryption:

113

114 -```conf

114 +```text

115 [stream]

116 destination = tcp:203.0.113.0:20000:SSL

117 ```

@@ -125,14 +125,14 @@ The default is a single wildcard `*`, which streams all charts.

125 To send only a few charts, list them explicitly, or list a group using a wildcard. To send _only_ the `apps.cpu` chart

126 and charts with contexts beginning with `system.`:

127

128 -```conf

128 +```text

129 [stream]

130 send charts matching = apps.cpu system.*

131 ```

132

133 To send all but a few charts, use `!` to create a negative match. To send _all_ charts _but_ `apps.cpu`:

134

135 -```conf

135 +```text

136 [stream]

137 send charts matching = !apps.cpu *

138 ```

@@ -146,14 +146,14 @@ The default is `*`, which accepts all requests including the `API_KEY`.

146

147 To allow from only a specific IP address:

148

149 -```conf

149 +```text

150 [API_KEY]

151 allow from = 203.0.113.10

152 ```

153

154 To allow all IPs starting with `10.*`, except `10.1.2.3`:

155

156 -```conf

156 +```text

157 [API_KEY]

158 allow from = !10.1.2.3 10.*

159 ```

@@ -201,7 +201,7 @@ with the `[MACHINE_GUID]` section.

201 For example, the metrics streamed from only the child node with `MACHINE_GUID` are saved in memory, not using the

202 default `dbengine` as specified by the `API_KEY`, and alerts are disabled.

203

204 -```conf

204 +```text

205 [API_KEY]

206 enabled = yes

207 db = dbengine

@@ -431,7 +431,7 @@ In the following example, the proxy receives metrics from a child node using the

431 `66666666-7777-8888-9999-000000000000`, then stores metrics using `dbengine`. It then uses the `API_KEY` of

432 `11111111-2222-3333-4444-555555555555` to proxy those same metrics on to a parent node at `203.0.113.0`.

433

434 -```conf

434 +```text

435 [stream]

436 enabled = yes

437 destination = 203.0.113.0

@@ -449,7 +449,7 @@ metrics to any number of permanently-running parent nodes.

449

450 On the parent, set the following in `stream.conf`:

451

452 -```conf

452 +```text

453 [11111111-2222-3333-4444-555555555555]

454 # enable/disable this API key

455 enabled = yes

@@ -497,7 +497,7 @@ This replication process ensures data continuity even if child nodes temporarily

497

498 Replication is enabled by default in Netdata, but you can customize the replication behavior by modifying the `[API_KEY]` section of the `stream.conf` file. Here's an example configuration:

499

500 -```conf

500 +```text

501 [11111111-2222-3333-4444-555555555555]

502 # Enable replication for all hosts using this api key. Default: yes.

503 enable replication = yes

src/web/api/exporters/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Exporters"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/exporters/README.md

4 -sidebar_label: "Exporters"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api"

8 --->

9 -

1 # Exporters

2

3 TBD

src/web/api/exporters/prometheus/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Prometheus exporter"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/exporters/prometheus/README.md

4 -sidebar_label: "Prometheus exporter"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Exporters"

8 --->

9 -

1 # Prometheus exporter

2

3 Read the Prometheus exporter documentation: [Using Netdata with Prometheus](/src/exporting/prometheus/README.md).

src/web/api/exporters/shell/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Shell exporter"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/exporters/shell/README.md

4 -sidebar_label: "Shell exporter"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Exporters"

8 --->

9 -

1 # Shell exporter

2

3 Shell scripts can now query Netdata:

src/web/api/formatters/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Query formatting"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/formatters/README.md

4 -sidebar_label: "Query formatting"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Formatters"

8 --->

9 -

1 # Query formatting

2

3 API data queries need to be formatted before returned to the caller.

src/web/api/formatters/csv/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "CSV formatter"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/formatters/csv/README.md

4 -sidebar_label: "CSV formatter"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Formatters"

8 --->

9 -

1 # CSV formatter

2

3 The CSV formatter presents [results of database queries](/src/web/api/queries/README.md) in the following formats:

src/web/api/formatters/json/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "JSON formatter"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/formatters/json/README.md

4 -sidebar_label: "JSON formatter"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Formatters"

8 --->

9 -

1 # JSON formatter

2

3 The CSV formatter presents [results of database queries](/src/web/api/queries/README.md) in the following formats:

src/web/api/formatters/ssv/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "SSV formatter"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/formatters/ssv/README.md

4 -sidebar_label: "SSV formatter"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Formatters"

8 --->

9 -

1 # SSV formatter

2

3 The SSV formatter sums all dimensions in [results of database queries](/src/web/api/queries/README.md)

src/web/api/formatters/value/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Value formatter"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/formatters/value/README.md

4 -sidebar_label: "Value formatter"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Formatters"

8 --->

9 -

1 # Value formatter

2

3 The Value formatter presents [results of database queries](/src/web/api/queries/README.md) as a single value.

src/web/api/health/README.md

-10

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Health API Calls"

3 -date: 2020-04-27

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/health/README.md

5 -sidebar_label: "Health API Calls"

6 -learn_status: "Published"

7 -learn_topic_type: "References"

8 -learn_rel_path: "Developers/Web/Api"

9 --->

10 -

1 # Health API Calls

2

3 ## Health Read API

src/web/api/queries/average/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Average or Mean"

3 -sidebar_label: "Average or Mean"

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/average/README.md

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Queries"

8 --->

9 -

1 # Average or Mean

2

3 > This query is available as `average` and `mean`.

src/web/api/queries/countif/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "CountIf"

3 -sidebar_label: "CountIf"

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/countif/README.md

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Queries"

8 --->

9 -

1 # CountIf

2

3 > This query is available as `countif`.

src/web/api/queries/des/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "double exponential smoothing"

3 -sidebar_label: "double exponential smoothing"

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/des/README.md

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Queries"

8 --->

9 -

1 # double exponential smoothing

2

3 Exponential smoothing is one of many window functions commonly applied to smooth data in signal

src/web/api/queries/incremental_sum/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Incremental Sum (`incremental_sum`)"

3 -sidebar_label: "Incremental Sum (`incremental_sum`)"

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/incremental_sum/README.md

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Queries"

8 --->

9 -

1 # Incremental Sum (`incremental_sum`)

2

3 This modules finds the incremental sum of a period, which `last value - first value`.

src/web/api/queries/max/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Max"

3 -sidebar_label: "Max"

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/max/README.md

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Queries"

8 --->

9 -

1 # Max

2

3 This module finds the max value in the time-frame given.

src/web/api/queries/median/README.md

-10

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Median"

3 -sidebar_label: "Median"

4 -description: "Use median in API queries and health entities to find the 'middle' value from a sample, eliminating any unwanted spikes in the returned metrics."

5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/median/README.md

6 -learn_status: "Published"

7 -learn_topic_type: "References"

8 -learn_rel_path: "Developers/Web/Api/Queries"

9 --->

10 -

1 # Median

2

3 The median is the value separating the higher half from the lower half of a data sample

src/web/api/queries/min/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Min"

3 -sidebar_label: "Min"

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/min/README.md

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Queries"

8 --->

9 -

1 # Min

2

3 This module finds the min value in the time-frame given.

src/web/api/queries/percentile/README.md

-10

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Percentile"

3 -sidebar_label: "Percentile"

4 -description: "Use percentile in API queries and health entities to find the 'percentile' value from a sample, eliminating any unwanted spikes in the returned metrics."

5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/percentile/README.md

6 -learn_status: "Published"

7 -learn_topic_type: "References"

8 -learn_rel_path: "Developers/Web/Api/Queries"

9 --->

10 -

1 # Percentile

2

3 The percentile is the average value of a series using only the smaller N percentile of the values.

src/web/api/queries/ses/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Single (or Simple) Exponential Smoothing (`ses`)"

3 -sidebar_label: "Single (or Simple) Exponential Smoothing (`ses`)"

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/ses/README.md

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Queries"

8 --->

9 -

1 # Single (or Simple) Exponential Smoothing (`ses`)

2

3 > This query is also available as `ema` and `ewma`.

src/web/api/queries/stddev/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "standard deviation (`stddev`)"

3 -sidebar_label: "standard deviation (`stddev`)"

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/stddev/README.md

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Queries"

8 --->

9 -

1 # standard deviation (`stddev`)

2

3 The standard deviation is a measure that is used to quantify the amount of variation or dispersion

src/web/api/queries/sum/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Sum"

3 -sidebar_label: "Sum"

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/sum/README.md

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api/Queries"

8 --->

9 -

1 # Sum

2

3 This module sums all the values in the time-frame requested.

src/web/api/queries/trimmed_mean/README.md

-10

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "Trimmed Mean"

3 -sidebar_label: "Trimmed Mean"

4 -description: "Use trimmed-mean in API queries and health entities to find the average value from a sample, eliminating any unwanted spikes in the returned metrics."

5 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/queries/trimmed_mean/README.md

6 -learn_status: "Published"

7 -learn_topic_type: "References"

8 -learn_rel_path: "Developers/Web/Api/Queries"

9 --->

10 -

1 # Trimmed Mean

2

3 The trimmed mean is the average value of a series excluding the smallest and biggest points.

src/web/api/v1/api_v1_badge/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Netdata badges"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/badges/README.md

4 -sidebar_label: "Netdata badges"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers/Web/Api"

8 --->

9 -

1 # Netdata badges

2

3 **Badges are cool!**

src/web/gui/README.md

+1 -1

@@ -147,7 +147,7 @@ customDashboard.menu = {

147 Finally, tell Netdata where you placed your customization file by replacing

148 `your_dashboard_info_file.js` below.

149

150 -```conf

150 +```text

151 [web]

152 custom dashboard_info.js = your_dashboard_info_file.js

153 ```

src/web/server/README.md

+23 -23

@@ -58,7 +58,7 @@ Scroll down to the `[web]` section to find the following settings.

58

59 Disable the web server by editing `netdata.conf` and setting:

60

61 -```txt

61 +```text

62 [web]

63 mode = none

64 ```

@@ -67,7 +67,7 @@ Disable the web server by editing `netdata.conf` and setting:

67

68 Control the number of threads and sockets with the following settings:

69

70 -```txt

70 +```text

71 [web]

72 web server threads = 4

73 web server max sockets = 512

@@ -79,7 +79,7 @@ Netdata can bind to multiple IPs and ports, offering access to different service

79

80 The ports to bind are controlled via `[web].bind to`, like this:

81

82 -```txt

82 +```text

83 [web]

84 default port = 19999

85 bind to = 127.0.0.1=dashboard^SSL=optional 10.1.1.1:19998=management|netdata.conf hostname:19997=badges [::]:19996=streaming^SSL=force localhost:19995=registry *:http=dashboard unix:/run/netdata/netdata.sock

@@ -121,10 +121,10 @@ Inbound unix socket connections are unaffected, regardless of the TLS settings.

121

122 To enable TLS, provide the path to your certificate and private key in the `[web]` section of `netdata.conf`:

123

124 -```conf

124 +```text

125 [web]

126 - ssl key = /etc/netdata/ssl/key.pem

127 - ssl certificate = /etc/netdata/ssl/cert.pem

126 + ssl key = /etc/netdata/ssl/key.pem

127 + ssl certificate = /etc/netdata/ssl/cert.pem

128 ```

129

130 Both files must be readable by the `netdata` user. If either of these files do not exist or are unreadable, Netdata will fall back to HTTP. For a parent-child connection, only the parent needs these settings.

@@ -147,7 +147,7 @@ openssl req -newkey rsa:2048 -nodes -sha512 -x509 -days 365 -keyout key.pem -out

147

148 Beginning with version `v1.21.0`, specify the TLS version and the ciphers that you want to use:

149

150 -```conf

150 +```text

151 [web]

152 tls version = 1.3

153 tls ciphers = TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

@@ -172,7 +172,7 @@ To change this behavior, you need to modify the `bind to` setting in the `[web]`

172

173 Example:

174

175 -```txt

175 +```text

176 [web]

178 ```

@@ -181,7 +181,7 @@ For information how to configure the child to use TLS, check [securing the commu

181

182 When we define the use of SSL in a Netdata agent for different ports, Netdata will apply the behavior specified on each port. For example, using the configuration line below:

183

184 -```txt

184 +```text

185 [web]

187 ```

@@ -205,14 +205,14 @@ In the near future, Netdata will allow our users to change the internal configur

205

206 Netdata supports access lists in `netdata.conf`:

207

208 -```txt

208 +```text

209 [web]

210 - allow connections from = localhost *

211 - allow dashboard from = localhost *

212 - allow badges from = *

213 - allow streaming from = *

214 - allow netdata.conf from = localhost fd* 10.* 192.168.* 172.16.* 172.17.* 172.18.* 172.19.* 172.20.* 172.21.* 172.22.* 172.23.* 172.24.* 172.25.* 172.26.* 172.27.* 172.28.* 172.29.* 172.30.* 172.31.*

215 - allow management from = localhost

210 + allow connections from = localhost *

211 + allow dashboard from = localhost *

212 + allow badges from = *

213 + allow streaming from = *

214 + allow netdata.conf from = localhost fd* 10.* 192.168.* 172.16.* 172.17.* 172.18.* 172.19.* 172.20.* 172.21.* 172.22.* 172.23.* 172.24.* 172.25.* 172.26.* 172.27.* 172.28.* 172.29.* 172.30.* 172.31.*

215 + allow management from = localhost

216 ```

217

218 `*` does string matches on the IPs or FQDNs of the clients.

@@ -242,13 +242,13 @@ a forward DNS resolution is made to validate the IP address against the name-pat

242 Please note that this process can be expensive on a machine that is serving many connections. Each access list has an

243 associated configuration option to turn off DNS-based patterns completely to avoid incurring this cost at run-time:

244

245 -```conf

246 - allow connections by dns = heuristic

247 - allow dashboard by dns = heuristic

248 - allow badges by dns = heuristic

249 - allow streaming by dns = heuristic

250 - allow netdata.conf by dns = no

251 - allow management by dns = heuristic

245 +```text

246 + allow connections by dns = heuristic

247 + allow dashboard by dns = heuristic

248 + allow badges by dns = heuristic

249 + allow streaming by dns = heuristic

250 + allow netdata.conf by dns = no

251 + allow management by dns = heuristic

252 ```

253

254 The three possible values for each of these options are `yes`, `no` and `heuristic`. The `heuristic` option disables

src/web/server/static/README.md

-10

@@ -1,13 +1,3 @@

1 -<!--

2 -title: "`static-threaded` web server"

3 -description: "The Netdata Agent's static-threaded web server spawns a fixed number of threads that listen to web requests and uses non-blocking I/O."

4 -custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/server/static/README.md

5 -sidebar_label: "`static-threaded` web server"

6 -learn_status: "Published"

7 -learn_topic_type: "Tasks"

8 -learn_rel_path: "Developers/Web"

9 --->

10 -

1 # `static-threaded` web server

2

3 The `static-threaded` web server spawns a fixed number of threads.

tests/health_mgmtapi/README.md

-9

@@ -1,12 +1,3 @@

1 -<!--

2 -title: "Health command API tester"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/tests/health_mgmtapi/README.md

4 -sidebar_label: "Health command API tester"

5 -learn_status: "Published"

6 -learn_topic_type: "References"

7 -learn_rel_path: "Developers"

8 --->

9 -

1 # Health command API tester

2

3 The directory `tests/health_cmdapi` contains the test script `health-cmdapi-test.sh` for the [health command API](/src/web/api/health/README.md).

Docs fixes (#18676)