Fixes for SEO changes (#10468)
Joel Hans committed
Jan 8, 2021 at 14:54 UTC
1f321de3cb11536a30fd92ce19dd90009bbc448e
3 files changed
+1
-217
docs/configuration-guide.md
deleted
-211
@@ -1,211 +0,0 @@
1
-<!--
2
-title: "Configuration guide"
3
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configuration-guide.md
4
--->
5
-
6
-# Configuration guide
7
-
8
-No configuration is required to run Netdata, but you will find plenty of options to tweak, so that you can adapt it to
9
-your particular needs.
10
-
11
-<details markdown="1"><summary>Configuration files are placed in `/etc/netdata`.</summary>
12
-Depending on your installation method, Netdata will have been installed either directly under `/`, or under `/opt/netdata`. The paths mentioned here and in the documentation in general assume that your installation is under `/`. If it is not, you will find the exact same paths under `/opt/netdata` as well. (i.e. `/etc/netdata` will be `/opt/netdata/etc/netdata`).</details>
13
-
14
-Under that directory you will see the following:
15
-
16
-- `netdata.conf` is [the main configuration file](/daemon/config/README.md#daemon-configuration)
17
-- `edit-config` is an sh script that you can use to easily and safely edit the configuration. Just run it to see its
18
- usage.
19
-- Other directories, initially empty, where your custom configurations for alarms and collector plugins/modules will
20
- be copied from the stock configuration, if and when you customize them using `edit-config`.
21
-- `orig` is a symbolic link to the directory `/usr/lib/netdata/conf.d`, which contains the stock configurations for
22
- everything not included in `netdata.conf`:
23
- - `health_alarm_notify.conf` is where you configure how and to who Netdata will send [alarm
24
- notifications](/health/notifications/README.md#netdata-alarm-notifications).
25
- - `health.d` is the directory that contains the alarm triggers for [health
26
- monitoring](/health/README.md#health-monitoring). It contains one .conf file per collector.
27
- - The [modular plugin orchestrators](/collectors/plugins.d/README.md#external-plugins-overview) have:
28
- - One config file each, mainly to turn their modules on and off: `python.d.conf` for
29
- [python](/collectors/python.d.plugin/README.md#pythondplugin), `node.d.conf` for
30
- [nodejs](/collectors/node.d.plugin/README.md#nodedplugin) and `charts.d.conf` for
31
- [bash](/collectors/charts.d.plugin/README.md#chartsdplugin) modules.
32
- - One directory each, where the module-specific configuration files can be found.
33
- - `stream.conf` is where you configure [streaming and
34
- replication](/streaming/README.md#streaming-and-replication)
35
- - `stats.d` is a directory under which you can add .conf files to add [synthetic
36
- charts](/collectors/statsd.plugin/README.md#synthetic-statsd-charts).
37
- - Individual collector plugin config files, such as `fping.conf` for the [fping
38
- plugin](/collectors/fping.plugin/) and `apps_groups.conf` for the [apps plugin](/collectors/apps.plugin/)
39
-
40
-So there are many configuration files to control every aspect of Netdata's behavior. It can be overwhelming at first,
41
-but you won't have to deal with any of them, unless you have specific things you need to change. The following HOWTO
42
-will guide you on how to customize your Netdata, based on what you want to do.
43
-
44
-## How to
45
-
46
-### Persist my configuration
47
-
48
-In `http://localhost:19999/netdata.conf`, you will see the following two parameters:
49
-
50
-```bash
51
- # config directory = /etc/netdata
52
- # stock config directory = /usr/lib/netdata/conf.d
53
-```
54
-
55
-To persist your configurations, don't edit the files under the `stock config directory` directly. Use the `sudo [config
56
-directory]/edit-config` command, or copy the stock config file to its proper place under the `config directory` and edit
57
-it there.
58
-
59
-### Change what I see
60
-
61
-#### Increase the long-term metrics retention period
62
-
63
-Increase the values for the `page cache size` and `dbengine disk space` settings in the [`[global]`
64
-section](/daemon/config/README.md#global-section-options) of `netdata.conf`. Read our guide on [increasing
65
-long-term metrics storage](/docs/guides/longer-metrics-storage.md) and the [memory requirements for the database
66
-engine](/database/engine/README.md#memory-requirements).
67
-
68
-#### Reduce the data collection frequency
69
-
70
-Increase `update every` in [netdata.conf \[global\]](/daemon/config/README.md#global-section-options). This is another
71
-way to increase your metrics retention period, but at a lower resolution than the default 1s.
72
-
73
-#### Modify how a chart is displayed
74
-
75
-In `netdata.conf` under `# Per chart configuration` you will find several [\[CHART_NAME\]
76
-sections](/daemon/config/README.md#per-chart-configuration), where you can control all aspects of a specific chart.
77
-
78
-#### Disable a collector
79
-
80
-Entire plugins can be turned off from the [netdata.conf \[plugins\]](/daemon/config/README.md#plugins-section-options)
81
-section. To disable specific modules of a plugin orchestrator, you need to edit one of the following:
82
-
83
-- `python.d.conf` for [python](/collectors/python.d.plugin/README.md)
84
-- `node.d.conf` for [nodejs](/collectors/node.d.plugin/README.md)
85
-- `charts.d.conf` for [bash](/collectors/charts.d.plugin/README.md)
86
-
87
-#### Show charts with zero metrics
88
-
89
-By default, Netdata will enable monitoring metrics for disks, memory, and network only when they are not zero. If they
90
-are constantly zero they are ignored. Metrics that will start having values, after Netdata is started, will be detected
91
-and charts will be automatically added to the dashboard (a refresh of the dashboard is needed for them to appear
92
-though). Use `yes` instead of `auto` in plugin configuration sections to enable these charts permanently. You can also
93
-set the `enable zero metrics` option to `yes` in the `[global]` section which enables charts with zero metrics for all
94
-internal Netdata plugins.
95
-
96
-### Modify alarms and notifications
97
-
98
-#### Add a new alarm
99
-
100
-You can add a new alarm definition either by editing an existing stock alarm config file under `health.d` (e.g.
101
-`/etc/netdata/edit-config health.d/load.conf`), or by adding a new `.conf` file under `/etc/netdata/health.d`. The
102
-documentation on how to define an alarm is in [health monitoring](/health/README.md). It is
103
-suggested to look at some of the stock alarm definitions, so you can ensure you understand how the various options work.
104
-
105
-#### Turn off all alarms and notifications
106
-
107
-Just set `enabled = no` in the [netdata.conf \[health\]](/daemon/config/README.md#health-section-options) section
108
-
109
-#### Modify or disable a specific alarm
110
-
111
-The `health.d` directory that contains the alarm triggers for [health monitoring](/health/README.md). It has
112
-one .conf file per collector. You can easily find the .conf file you will need to modify, by looking for the "source"
113
-line on the table that appears on the right side of an alarm on the Netdata gui.
114
-
115
-For example, if you click on Alarms and go to the tab 'All', the default Netdata installation will show you at the top
116
-the configured alarm for `10 min cpu usage` (it's the name of the badge). Looking at the table on the right side, you
117
-will see a row that says: `source 4@/usr/lib/netdata/conf.d/health.d/cpu.conf`. This way, you know that you will need
118
-to run `/etc/netdata/edit-config health.d/cpu.conf` and look for alarm at line 4 of the conf file.
119
-
120
-As stated at the top of the .conf file, **you can disable an alarm notification by setting the 'to' line to: silent**.
121
-To modify how the alarm gets triggered, we suggest that you go through the guide on [health
122
-monitoring](/health/README.md#health-monitoring).
123
-
124
-#### Receive notifications using my preferred method
125
-
126
-You only need to configure `health_alarm_notify.conf`. To learn how to do it, read first [alarm
127
-notifications](/health/notifications/README.md#netdata-alarm-notifications) and then open the submenu `Supported
128
-Notifications` under `Alarm notifications` in the documentation to find the specific page on your preferred notification
129
-method.
130
-
131
-### Make security-related customizations
132
-
133
-#### Change the Netdata web server access lists
134
-
135
-You have several options under the [netdata.conf \[web\]](/web/server/README.md#access-lists) section.
136
-
137
-#### Stop sending info to registry.my-netdata.io
138
-
139
-You will need to configure the `[registry]` section in `netdata.conf`. First read the [registry
140
-documentation](/registry/). In it, are instructions on how to [run your own
141
-registry](/registry/README.md#run-your-own-registry).
142
-
143
-#### Change the IP address/port Netdata listens to
144
-
145
-The settings are under the `[web]` section. Look at the [web server
146
-documentation](/web/server/README.md#binding-netdata-to-multiple-ports) for more info.
147
-
148
-### System resource usage
149
-
150
-#### Reduce the resources Netdata uses
151
-
152
-The [Netdata performance guide](/docs/guides/configure/performance.md) outlines many ways to reduce the Netdata
153
-CPU/disk/RAM utilization to levels suitable even for the weakest [IoT devices](/docs/netdata-for-IoT.md).
154
-
155
-#### Change when Netdata saves metrics to disk
156
-
157
-[netdata.conf \[global\]](/daemon/config/README.md#global-section-options): `memory mode`
158
-
159
-#### Prevent Netdata from getting immediately killed when my server runs out of memory
160
-
161
-You can change the Netdata [OOM score](/daemon/README.md#oom-score) in `[global]`.
162
-
163
-### Other
164
-
165
-#### Move Netdata directories
166
-
167
-The various directory paths are in [netdata.conf \[global\]](/daemon/config/README.md#global-section-options).
168
-
169
-## How Netdata configuration works
170
-
171
-The configuration files are `name = value` dictionaries with `[sections]`. Write whatever you like there as long as it
172
-follows this simple format.
173
-
174
-Netdata loads this dictionary and then when the code needs a value from it, it just looks up the `name` in the
175
-dictionary at the proper `section`. In all places, in the code, there are both the `names` and their `default values`,
176
-so if something is not found in the configuration file, the default is used. The lookup is made using B-Trees and hashes
177
-(no string comparisons), so they are super fast. Also the `names` of the settings can be `my super duper setting that
178
-once set to yes, will turn the world upside down = no` - so goodbye to most of the documentation involved.
179
-
180
-Next, Netdata can generate a valid configuration for the user to edit. No need to remember anything. Just get the
181
-configuration from the server (`/netdata.conf` on your Netdata server), edit it and save it.
182
-
183
-Last, what about options you believe you have set, but you misspelled?When you get the configuration file from the
184
-server, there will be a comment above all `name = value` pairs the server does not use. So you know that whatever you
185
-wrote there, is not used.
186
-
187
-## Netdata simple patterns
188
-
189
-Unix prefers regular expressions. But they are just too hard, too cryptic to use, write and understand.
190
-
191
-So, Netdata supports [simple patterns](/libnetdata/simple_pattern/README.md).
192
-
193
-## Netdata labels
194
-
195
-Beginning with 1.20, Netdata accepts user-defined **host labels**. These labels are defined in the section `[host
196
-labels]`.
197
-
198
-Read more about how these labels work and why they're an effective way to organize complex infrasturctures in our
199
-guide: [Use host labels to organize systems, metrics, and alarms](/docs/guides/using-host-labels.md).
200
-
201
-To define a label inside this section, some rules needs to be followed, or Netdata will reject the label. The following
202
-restrictions are applied for label names:
203
-
204
-- Names cannot start with `_`, but it can be present in other parts of the name.
205
-- Names only accept alphabet letters, numbers, dots, and dashes.
206
-
207
-The policy for values is more flexible, but you can not use exclamation marks (`!`), whitespaces (` `), single quotes
208
-(`'`), double quotes (`"`), or asterisks (`*`), because they are used to compare label values in health alarms and
209
-templates.
210
-
211
-[](<>)
packaging/installer/methods/offline.md
-5
@@ -78,7 +78,6 @@ bash kickstart-static64.sh --local-files /tmp/netdata-(version-number-here).gz.r
78
79
## What's next?
80
81
-<<<<<<< HEAD
81
When you're finished with installation, check out our [single-node](/docs/quickstart/single-node.md) or
82
[infrastructure](/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
83
@@ -87,9 +86,5 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
86
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
87
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
88
external databases, and more.
90
-=======
91
-Or, get the full guided tour of Netdata's capabilities with our [step-by-step
92
-guide](/docs/guides/step-by-step/step-00.md)!
89
90
[]()
95
->>>>>>> dda27d9c (First pass to get the script working right)
web/api/queries/median/README.md
+1
-1
@@ -1,6 +1,6 @@
1
<!--
2
title: "Median"
3
-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."
3
+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."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/median/README.md
5
-->
6