Deleted duplicate getting started doc (#11978)
* Deleted duplicate getting started doc We have three different Getting started docs and a Step-by-step guide which all have the same goal: to get the user started. This page will be deleted for the following reasons: - It isn't linked in the docs navigation - The structure isn't very user friendly - All information in the doc is documented elsewhere, too. - There is almost no traffic on the page (25 views in the last 30 days). The general load of the netdata docs runs in the thousands. * Amended links to point to real get started page
Tina Luedtke committed
Jan 18, 2022 at 14:38 UTC
bca7c55d8735cf152ae676ee0c854da0b1e245d2
3 files changed
+2
-238
docs/getting-started.md
deleted
-236
@@ -1,236 +0,0 @@
1
-<!--
2
-title: "Get started guide"
3
-date: 2020-05-04
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/getting-started.md
5
--->
6
-
7
-# Get started guide
8
-
9
-Thanks for trying the Netdata Agent! In this getting started guide, we'll quickly walk you through the first steps you
10
-should take after installing the Agent.
11
-
12
-The Agent can collect thousands of metrics in real-time and use its database for long-term metrics storage without any
13
-configuration, but there are some valuable things to know to get the most out of Netdata based on your needs.
14
-
15
-We'll skip right into some technical details, so if you're brand-new to monitoring the health and performance of systems
16
-and applications, our [**step-by-step guide**](/docs/guides/step-by-step/step-00.md) might be a better fit.
17
-
18
-> If you haven't installed Netdata yet, visit the [installation instructions](/packaging/installer/README.md) for
19
-> details, including our one-liner script, which automatically installs Netdata on almost all Linux distributions.
20
-
21
-## Access the dashboard
22
-
23
-Open up your web browser of choice and navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname
24
-of your Agent. Hit **Enter**. Welcome to Netdata!
25
-
26
-
28
-
29
-**What's next?**:
30
-
31
-- Read more about the [standard Netdata dashboard](/web/gui/README.md).
32
-- Learn all the specifics of [using charts](/web/README.md#using-charts) or the differences between [charts,
33
- context, and families](/web/README.md#charts-contexts-families).
34
-
35
-## Configuration basics
36
-
37
-Netdata primarily uses the `netdata.conf` file for custom configurations.
38
-
39
-On most systems, you can find that file at `/etc/netdata/netdata.conf`.
40
-
41
-> Some operating systems will place your `netdata.conf` at `/opt/netdata/etc/netdata/netdata.conf`, so check there if
42
-> you find nothing at `/etc/netdata/netdata.conf`.
43
-
44
-The `netdata.conf` file is broken up into various sections, such as `[global]`, `[web]`, `[registry]`, and more. By
45
-default, most options are commented, so you'll have to uncomment them (remove the `#`) for Netdata to recognize your
46
-change.
47
-
48
-Once you save your changes, [restart Netdata](#start-stop-and-restart-netdata) to load your new configuration.
49
-
50
-**What's next?**:
51
-
52
-- [Change how long Netdata stores metrics](#change-how-long-netdata-stores-metrics) by changing the `page cache size`
53
- and `dbengine disk space` settings in `netdata.conf`.
54
-- Move Netdata's dashboard to a [different port](/web/server/README.md) or enable TLS/HTTPS
55
- encryption.
56
-- See all the `netdata.conf` options in our [daemon configuration documentation](/daemon/config/README.md).
57
-- Run your own [registry](/registry/README.md#run-your-own-registry).
58
-
59
-## Change how long Netdata stores metrics
60
-
61
-Netdata can store long-term, historical metrics out of the box. A custom database uses RAM to store recent metrics,
62
-ensuring dashboards and API queries are extremely responsive, while "spilling" historical metrics to disk. This
63
-configuration keeps RAM usage low while allowing for long-term, on-disk metrics storage.
64
-
65
-You can tweak this custom _database engine_ to store a much larger dataset than your system's available RAM,
66
-particularly if you allow Netdata to use slightly more RAM and disk space than the default configuration.
67
-
68
-Read our guide on [changing how long Netdata stores metrics](/docs/store/change-metrics-storage.md) to learn more and
69
-use our the embedded database engine to figure out the exact settings you'll need to store historical metrics right in
70
-the Agent's database.
71
-
72
-**What's next?**:
73
-
74
-- Learn more about the [memory requirements for the database
75
- engine](/database/engine/README.md#memory-requirements) to understand how much RAM/disk space you should commit
76
- to storing historical metrics.
77
-
78
-## Collect data from more sources
79
-
80
-When Netdata _starts_, it auto-detects dozens of **data sources**, such as database servers, web servers, and more. To
81
-auto-detect and collect metrics from a service or application you just installed, you need to [restart
82
-Netdata](#start-stop-and-restart-netdata).
83
-
84
-> There is one exception: When Netdata is running on the host (as in not in a container itself), it will always
85
-> auto-detect containers and VMs.
86
-
87
-However, auto-detection only works if you installed the source using its standard installation procedure. If Netdata
88
-isn't collecting metrics after a restart, your source probably isn't configured correctly. Look at the [external plugin
89
-documentation](/collectors/plugins.d/README.md) to find the appropriate module for your source. Those pages will contain
90
-more information about how to configure your source for auto-detection.
91
-
92
-Some modules, like `chrony`, are disabled by default and must be enabled manually for auto-detection to work.
93
-
94
-Once Netdata detects a valid source of data, it will continue trying to collect data from it. For example, if
95
-Netdata is collecting data from an Nginx web server, and you shut Nginx down, Netdata will collect new data as soon as
96
-you start the web server back up—no restart necessary.
97
-
98
-### Configure plugins
99
-
100
-Even if Netdata auto-detects your service/application, you might want to configure what, or how often, Netdata is
101
-collecting data.
102
-
103
-Netdata uses **internal** and **external** plugins to collect data. Internal plugins run within the Netdata dæmon, while
104
-external plugins are independent processes that send metrics to Netdata over pipes. There are also plugin
105
-**orchestrators**, which are external plugins with one or more data collection **modules**.
106
-
107
-You can configure both internal and external plugins, along with the individual modules. There are many ways to do so:
108
-
109
-- In `netdata.conf`, `[plugins]` section: Enable or disable internal or external plugins with `yes` or `no`.
110
-- In `netdata.conf`, `[plugin:XXX]` sections: Each plugin has a section for changing collection frequency or passing
111
- options to the plugin.
112
-- In `.conf` files for each external plugin: For example, at `/etc/netdata/python.d.conf`.
113
-- In `.conf` files for each module : For example, at `/etc/netdata/python.d/nginx.conf`.
114
-
115
-It's complex, so let's walk through an example of the various `.conf` files responsible for collecting data from an
116
-Nginx web server using the `nginx` module and the `python.d` plugin orchestrator.
117
-
118
-First, you can enable or disable the `python.d` plugin entirely in `netdata.conf`.
119
-
120
-```conf
121
-[plugins]
122
- # Enabled
123
- python.d = yes
124
- # Disabled
125
- python.d = no
126
-```
127
-
128
-You can also configure the entire `python.d` external plugin via the `[plugin:python.d]` section in `netdata.conf`.
129
-Here, you can change how often Netdata uses `python.d` to collect metrics or pass other command options:
130
-
131
-```conf
132
-[plugin:python.d]
133
- update every = 1
134
- command options =
135
-```
136
-
137
-The `python.d` plugin has a separate configuration file at `/etc/netdata/python.d.conf` for enabling and disabling
138
-modules. You can use the `edit-config` script to edit the file, or open it with your text editor of choice:
139
-
140
-```bash
141
-sudo /etc/netdata/edit-config python.d.conf
142
-```
143
-
144
-Finally, the `nginx` module has a configuration file called `nginx.conf` in the `python.d` folder. Again, use
145
-`edit-config` or your editor of choice:
146
-
147
-```bash
148
-sudo /etc/netdata/edit-config python.d/nginx.conf
149
-```
150
-
151
-In the `nginx.conf` file, you'll find additional options. The default works in most situations, but you may need to make
152
-changes based on your particular Nginx setup.
153
-
154
-**What's next?**:
155
-
156
-- Look at the [full list of data collection modules](/collectors/COLLECTORS.md)
157
- to configure your sources for auto-detection and monitoring.
158
-- Improve the [performance](/docs/guides/configure/performance.md) of Netdata on low-memory systems.
159
-- Configure `systemd` to expose [systemd services
160
- utilization](/collectors/cgroups.plugin/README.md#monitoring-systemd-services) metrics automatically.
161
-- [Reconfigure individual charts](/daemon/config/README.md#per-chart-configuration) in `netdata.conf`.
162
-
163
-## Health monitoring and alarms
164
-
165
-Netdata comes with hundreds of health monitoring alarms for detecting anomalies on production servers. If you're running
166
-Netdata on a workstation, you might want to disable Netdata's alarms.
167
-
168
-Edit your `/etc/netdata/netdata.conf` file and set the following:
169
-
170
-```conf
171
-[health]
172
- enabled = no
173
-```
174
-
175
-If you want to keep health monitoring enabled, but turn email notifications off, edit your `health_alarm_notify.conf`
176
-file with `edit-config`, or with the text editor of your choice:
177
-
178
-```bash
179
-sudo /etc/netdata/edit-config health_alarm_notify.conf
180
-```
181
-
182
-Find the `SEND_EMAIL="YES"` line and change it to `SEND_EMAIL="NO"`.
183
-
184
-**What's next?**:
185
-
186
-- Follow the [health quickstart](/health/QUICKSTART.md) to locate and edit existing health entities, and then
187
- create your own.
188
-- See all the alarm options via the [health configuration reference](/health/REFERENCE.md).
189
-- Add a new notification method, like [Slack](/health/notifications/slack/README.md).
190
-
191
-## Monitor multiple systems with Netdata Cloud
192
-
193
-If you have the Agent installed on multiple nodes, you can use Netdata Cloud in two ways: Monitor the health and
194
-performance of an entire infrastructure via the Netdata Cloud web application, or use the Visited Nodes menu that's
195
-built into every dashboard.
196
-
197
-
199
-
200
-You can use these features together or separately—the decision is up to you and the needs of your infrastructure.
201
-
202
-**What's next?**:
203
-
204
-- Sign up for [Netdata Cloud](https://app.netdata.cloud).
205
-- Read the [infrastructure monitoring quickstart](/docs/quickstart/infrastructure.md).
206
-- Better understand how the Netdata Agent connects securely to Netdata Cloud with [connection process](/claim/README.md) and
207
- [Agent-Cloud link](/aclk/README.md) documentation.
208
-
209
-## Start, stop, and restart Netdata
210
-
211
-When you install Netdata, it's configured to start at boot, and stop and restart/shutdown. You shouldn't need to start
212
-or stop Netdata manually, but you will probably need to restart Netdata at some point.
213
-
214
-- To **start** Netdata, open a terminal and run `sudo systemctl start netdata`.
215
-- To **stop** Netdata, run `sudo systemctl stop netdata`.
216
-- To **restart** Netdata, run `sudo systemctl restart netdata`.
217
-
218
-See our doc on [starting, stopping, and restarting](/docs/configure/start-stop-restart.md) the Netdata Agent for
219
-details.
220
-
221
-## What's next?
222
-
223
-Even after you've configured `netdata.conf`, tweaked alarms, learned the basics of performance troubleshooting, and
224
-connected all your systems in Netdata Cloud or added them to the Visited nodes menu, you've just gotten started with
225
-Netdata.
226
-
227
-Take a look at some more advanced features and configurations:
228
-
229
-- Centralize Netdata metrics from many systems with [streaming](/streaming/README.md)
230
-- Enable long-term archiving of Netdata metrics via [exporting engine](/exporting/README.md) to time-series databases.
231
-- Improve security by putting Netdata behind an [Nginx proxy with SSL](/docs/Running-behind-nginx.md).
232
-
233
-Or, learn more about how you can contribute to [Netdata core](/README.md#contribute) or our
234
-[documentation](/docs/contributing/contributing-documentation.md)!
235
-
236
-[](<>)
docs/guides/monitor/pi-hole-raspberry-pi.md
+1
-1
@@ -100,7 +100,7 @@ part of your system might affect another.
100
action](https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98-11ea-8f60-0d7824667cd3.gif)
101
102
If you're completely new to Netdata, look at our [step-by-step guide](/docs/guides/step-by-step/step-00.md) for a
103
-walkthrough of all its features. For a more expedited tour, see the [get started guide](/docs/getting-started.md).
103
+walkthrough of all its features. For a more expedited tour, see the [get started guide](/docs/get-started.md).
104
105
### Enable temperature sensor monitoring
106
docs/guides/step-by-step/step-00.md
+1
-1
@@ -17,7 +17,7 @@ completely new to Netdata, or have never tried health monitoring/performance tro
17
guide is perfect for you.
18
19
If you have monitoring experience, or would rather get straight into configuring Netdata to your needs, you can jump
20
-straight into code and configurations with our [getting started guide](/docs/getting-started.md).
20
+straight into code and configurations with our [getting started guide](/docs/get-started.md).
21
22
> This guide contains instructions for Netdata installed on a Linux system. Many of the instructions will work on
23
> other supported operating systems, like FreeBSD and macOS, but we can't make any guarantees.