Deleted an EOL file (#12000)
Tina Luedtke committed
Jan 19, 2022 at 13:15 UTC
51ebd46ba014729156b1f5ff9daf43f65a4a019f
1 file changed
-125
collectors/QUICKSTART.md
deleted
-125
@@ -1,125 +0,0 @@
1
-<!--
2
-title: "Collectors quickstart"
3
-custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/QUICKSTART.md
4
--->
5
-
6
-# Collectors quickstart
7
-
8
-In this quickstart guide, you'll learn how to enable collectors so you can get metrics from your favorite applications
9
-and services.
10
-
11
-This guide will not cover advanced collector features, such as enabling/disabling entire plugins,
12
-
13
-## What's in this quickstart guide
14
-
15
-- [Find the collector for your application or service](#find-the-collector-for-your-application-or-service)
16
-- [Configure your application or service for monitoring](#configure-your-application-or-service-for-monitoring)
17
-- [Edit the collector's configuration file](#edit-the-collectors-configuration-file)
18
-- [Enable the collector](#enable-the-collector)
19
-
20
-## Find the collector for your application or service
21
-
22
-Netdata has _pre-installed_ collectors for hundreds of popular applications and services. You don't need to install
23
-anything to collect metrics from many popular services, like Nginx web servers, MySQL/MariaDB databases, and much more.
24
-
25
-To find whether Netdata has a pre-installed collector for your favorite app/service, check out our [collector support
26
-list](COLLECTORS.md). The only exception is the [third-party collectors](COLLECTORS.md#third-party-collectors), which
27
-you do need to install yourself. However, this quickstart guide will focus on pre-installed collectors.
28
-
29
-When you find a collector you're interested in, take note of its orchestrator. These are in the headings above each
30
-table, and there are four: Bash, Go, Node, and Python. They go by their respective names: `charts.d`, `go.d`, `node.d`,
31
-and `python.d`.
32
-
33
-> If there is a collector written in both Go and Python, it's better to choose the Go-based version, as we will
34
-> eventually deprecate most Python-based collectors.
35
-
36
-From here on out, this quickstart guide will use the [Nginx
37
-collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx) as an example to showcase the
38
-process of configuring and enabling one of Netdata's pre-installed collectors.
39
-
40
-## Configure your application or service for monitoring
41
-
42
-Every collector's documentation comes with instructions on how to configure your app/service to make it available to
43
-Netdata's collector. Our [collector support list](COLLECTORS.md) contains links to each collector's documentation page
44
-so you can learn more.
45
-
46
-For example, the [Nginx collector
47
-documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx) states that your Nginx
48
-installation must have the `stub_status` module configured correctly, in addition to an active `stub_status/` page, for
49
-Netdata to monitor it. You can confirm whether you have the module enabled with the following command:
50
-
51
-```bash
52
-nginx -V 2>&1 | grep -o with-http_stub_status_module
53
-```
54
-
55
-If this command returns nothing, you'll need to [enable the `stub_status`
56
-module](https://www.nginx.com/blog/monitoring-nginx/).
57
-
58
-Next, edit your `/etc/nginx/sites-enabled/default` file to include a `location` block with the following, which enables
59
-the `stub_status` page:
60
-
61
-```conf
62
-server {
63
- ...
64
-
65
- location /nginx_status {
66
- stub_status;
67
- }
68
-}
69
-```
70
-
71
-At this point, your Nginx installation is fully configured and ready for Netdata to monitor it. Next, you'll configure
72
-your collector.
73
-
74
-## Edit the collector's configuration file
75
-
76
-This step may not be required based on how you configured your app/service, as each collector comes with a few
77
-pre-configured jobs that look for the app/service in common and expected locations. For example, the Nginx collector
78
-looks for a `stub_status` page at `http://localhost/stub_status` and `http://127.0.0.1/stub_status`, which allows it to
79
-auto-detect almost all local Nginx web servers.
80
-
81
-Despite Netdata's auto-detection capabilities, it's important to know how to edit collector configuration files.
82
-
83
-You should always edit configuration files with the `edit-config` script that comes with every installation of Netdata.
84
-To edit a collector configuration file, navigate to your [Netdata configuration directory](/docs/configure/nodes.md).
85
-Launch `edit-config` with the path to the collector's configuration file.
86
-
87
-How do you find that path to the collector's configuration file? Look under the **Configuration** heading in the
88
-collector's documentation. Each file contains a short code block with the relevant command.
89
-
90
-For example, the [Nginx collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/nginx) has its
91
-configuration file at `go.d/nginx.conf`.
92
-
93
-```bash
94
-cd /etc/netdata # Replace this path with your Netdata config directory
95
-sudo ./edit-config go.d/nginx.conf
96
-```
97
-
98
-This file contains all of the possible job parameters to help you monitor Nginx in all sorts of complex deployments. At
99
-the bottom of the file is a `[JOB]` section, which contains the two default jobs. Configure these as needed, using those
100
-parameters as a reference, to configure the collector.
101
-
102
-## Enable the collector
103
-
104
-Most collectors are enabled and will auto-detect their app/service without manual configuration. However, you need to
105
-restart Netdata to trigger the auto-detection process.
106
-
107
-To restart Netdata on most systems, use `sudo systemctl restart netdata`, or the [appropriate
108
-method](/docs/configure/start-stop-restart.md) for your system.
109
-
110
-Open Netdata's dashboard in your browser, or refresh the page if you already have it open. You should now see a new
111
-entry in the menu and new interactive charts!
112
-
113
-## What's next?
114
-
115
-Collector not working? Learn about collector troubleshooting in our [collector
116
-reference](REFERENCE.md#troubleshoot-a-collector).
117
-
118
-View our [collectors guides](/collectors/README.md#guides) to get specific instructions on enabling new and
119
-popular collectors.
120
-
121
-Finally, learn more advanced collector features, such as disabling plugins or developing a custom collector, in our
122
-[internal plugin API](/collectors/REFERENCE.md#internal-plugins-api) or our [external plugin
123
-docs](/collectors/plugins.d/README.md).
124
-
125
-[]()