mirror of
https://github.com/netdata/netdata.git
synced 2025-04-16 18:37:50 +00:00
Fix broken links in markdown files (#14513)
* fix broken links in claim/README.md * delete broken link in docs/guidelines.md * fix broken links * fix broken link * fix broken links * fix broken links * fix broken links * fix broken links * fix broken links * remove broken link * fix broken link * fix broken links * fix broken links * fix broken links * fix broken link * fix linking phrasing * fix broken links batch * fix broken links second batch * fix broken links * fix broken links * fix broken links * Update COLLECTORS.md * fix broken links * fix broken links
This commit is contained in:
Fotis Voutsas
GitHub
parent
639ca97330
commit
32baa46cb1
46 changed files with 89 additions and 128 deletions
claim
collectors
docs
cloud
alerts-notifications
insights
manage
visualize
collect
configure
contributing
dashboard
export
guidelines.mdguides
configure
export
monitor-cockroachdb.mdmonitor
anomaly-detection-python.mdlamp-stack.mdpi-hole-raspberry-pi.mdprocess.mdraspberry-pi-anomaly-detection.mdstatsd.mdstop-notifications-alarms.md
python-collector.mdstep-by-step
troubleshoot
monitor
quickstart
visualize
health
packaging/installer
web/gui
|
|
@ -14,9 +14,7 @@ You can securely connect a Netdata Agent, running on a distributed node, to Netd
|
|||
administrator creates a **claiming token**, which is used to add an Agent to their Space via the [Agent-Cloud link
|
||||
(ACLK)](https://github.com/netdata/netdata/blob/master/aclk/README.md).
|
||||
|
||||
Are you just starting out with Netdata Cloud? See our [get started with
|
||||
Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx) guide for a walkthrough of the process and simplified
|
||||
instructions.
|
||||
Are you just getting started with Netdata Cloud? You can find simplified instructions in the [Install Netdata documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#get-started)
|
||||
|
||||
When connecting an agent (also referred to as a node) to Netdata Cloud, you must complete a verification process that proves you have some level of authorization to manage the node itself. This verification is a security feature that helps prevent unauthorized users from seeing the data on your node.
|
||||
|
||||
|
|
@ -32,7 +30,7 @@ identity of the Netdata Agent when it connects to the Cloud. While the data does
|
|||
from Agents to the browser, we do not store or log it.
|
||||
|
||||
You can connect a node during the Netdata Cloud onboarding process, or after you created a Space by clicking on **Connect
|
||||
Nodes** in the [Spaces management area](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx#manage-spaces).
|
||||
Nodes** in the [Spaces management area](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md#manage-spaces).
|
||||
|
||||
There are two important notes regarding connecting nodes:
|
||||
|
||||
|
|
@ -373,7 +371,7 @@ If you run the kickstart script and get the following error `Existing install ap
|
|||
|
||||
If you are using an unsupported package, such as a third-party `.deb`/`.rpm` package provided by your distribution,
|
||||
please remove that package and reinstall using our [recommended kickstart
|
||||
script](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx#install-on-linux-with-one-line-installer).
|
||||
script](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#install-on-linux-with-one-line-installer).
|
||||
|
||||
#### kickstart: Failed to write new machine GUID
|
||||
|
||||
|
|
@ -393,7 +391,7 @@ if you installed Netdata to `/opt/netdata`, use `/opt/netdata/bin/netdata-claim.
|
|||
|
||||
If you are using an unsupported package, such as a third-party `.deb`/`.rpm` package provided by your distribution,
|
||||
please remove that package and reinstall using our [recommended kickstart
|
||||
script](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx#install-on-linux-with-one-line-installer).
|
||||
script](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#install-on-linux-with-one-line-installer).
|
||||
|
||||
#### Connecting on older distributions (Ubuntu 14.04, Debian 8, CentOS 6)
|
||||
|
||||
|
|
@ -510,7 +508,7 @@ tool, and details about the files found in `cloud.d`.
|
|||
|
||||
### The `cloud.conf` file
|
||||
|
||||
This section defines how and whether your Agent connects to [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx)
|
||||
This section defines how and whether your Agent connects to Netdata Cloud
|
||||
using the [ACLK](https://github.com/netdata/netdata/blob/master/aclk/README.md).
|
||||
|
||||
| setting | default | info |
|
||||
|
|
|
|||
|
|
@ -14,16 +14,16 @@ real-time, interactive charts. The following list includes collectors for both e
|
|||
internal system metrics.
|
||||
|
||||
Learn more
|
||||
about [how collectors work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md), and
|
||||
about [how collectors work](https://github.com/netdata/netdata/blob/master/collectors/README.md), and
|
||||
then learn how to [enable or
|
||||
configure](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) any of the below collectors using the same process.
|
||||
configure](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module) any of the below collectors using the same process.
|
||||
|
||||
Some collectors have both Go and Python versions as we continue our effort to migrate all collectors to Go. In these
|
||||
cases, _Netdata always prioritizes the Go version_, and we highly recommend you use the Go versions for the best
|
||||
experience.
|
||||
|
||||
If you want to use a Python version of a collector, you need to
|
||||
explicitly [disable the Go version](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md),
|
||||
explicitly [disable the Go version](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module),
|
||||
and enable the Python version. Netdata then skips the Go version and attempts to load the Python version and its
|
||||
accompanying configuration file.
|
||||
|
||||
|
|
|
|||
|
|
@ -62,13 +62,13 @@ To manage user specific notification settings, you will need the following:
|
|||
- A Cloud account
|
||||
- Have access to, at least, a space
|
||||
|
||||
Note: If an administrator has disabled a Personal [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#service-level) notification method this will override any user specific setting.
|
||||
Note: If an administrator has disabled a Personal [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx#service-level) notification method this will override any user specific setting.
|
||||
|
||||
#### Steps
|
||||
|
||||
1. Click on the **User notification settings** shortcut on top of the help button
|
||||
1. You are presented with:
|
||||
- The Personal [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#service-level) notification methods you can manage
|
||||
- The Personal [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx#service-level) notification methods you can manage
|
||||
- The list spaces and rooms inside those where you have access to
|
||||
- If you're an administrator, Manager or Troubleshooter you'll also see the Rooms from a space you don't have access to on **All Rooms** tab and you can activate notifications for them by joining the room
|
||||
1. On this modal you will be able to:
|
||||
|
|
@ -83,6 +83,6 @@ Note: If an administrator has disabled a Personal [service level](https://github
|
|||
- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
|
||||
- [Alerts Configuration](https://github.com/netdata/netdata/blob/master/health/README.md)
|
||||
- [Add webhook notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-webhook-notification-configuration.md)
|
||||
- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification-configuration.md)
|
||||
- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification.md)
|
||||
- [Add Slack notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-slack-notification-configuration.md)
|
||||
- [Add PagerDuty notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md)
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ Having this information centralized helps you:
|
|||
* Have a clear view of the health across your infrastructure, [seeing all a alerts in one place](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx)
|
||||
* Easily [setup your alert notification process](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md):
|
||||
methods to use and where to use them, filtering rules, etc.
|
||||
* Quickly troubleshoot using [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metrics-correlations.md)
|
||||
* Quickly troubleshoot using [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
|
||||
or [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx)
|
||||
|
||||
If a node is getting disconnected often or has many alerts, we protect you and your team from alert fatigue by sending
|
||||
|
|
@ -143,13 +143,13 @@ visualization of the health of your infrastructure.
|
|||
|
||||
#### **Related Concepts**
|
||||
- [Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md)
|
||||
- [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metrics-correlations.md)
|
||||
- [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
|
||||
- [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.mdx)
|
||||
|
||||
#### Related Tasks
|
||||
- [View Active alarms](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.mdx)
|
||||
- [Manage notification methods](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md)
|
||||
- [Add webhook notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-webhook-notification-configuration.md)
|
||||
- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification-configuration.md)
|
||||
- [Add Discord notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-discord-notification.md)
|
||||
- [Add Slack notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-slack-notification-configuration.md)
|
||||
- [Add PagerDuty notification configuration](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/add-pagerduty-notification-configuration.md)
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ At a high-level view, these are the domains from which the Events feed will prov
|
|||
|
||||
## Who can access the events?
|
||||
|
||||
All users will be able to see events from the Topology and Alerts domain but Auditing events, once these are added, only be accessible to administrators. For more details checkout [Netdata Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access-model.md).
|
||||
All users will be able to see events from the Topology and Alerts domain but Auditing events, once these are added, only be accessible to administrators. For more details checkout [Netdata Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md).
|
||||
|
||||
## How to use the events feed
|
||||
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ Depending on the plan associated to your space you will have different roles ava
|
|||
| **Observers**<p>This role is for read-only access with restricted access to explicit War Rooms and only the Nodes that appear in those War Rooms.</p>💡 Ideal for restricting your customer's access to their own dedicated rooms.<p></p> | - | - | :heavy_check_mark: |
|
||||
| **Billing**<p>This role is for users that need to manage billing options and see invoices, with no further access to the system.</p> | - | - | :heavy_check_mark: |
|
||||
|
||||
For more details check the documentation under [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access-model.md).
|
||||
For more details check the documentation under [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md).
|
||||
|
||||
##### Events feed
|
||||
|
||||
|
|
@ -104,8 +104,8 @@ For mode details check the documentation under [Alert Notifications](https://git
|
|||
#### **Related Concepts**
|
||||
- [Spaces](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md)
|
||||
- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.mdx)
|
||||
- [Events feed](https://github.com/netdata/netdata/blob/master/docs/cloud/events-feed.md)
|
||||
- [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access-model.md)
|
||||
- [Events feed](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/events-feed.md)
|
||||
- [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md)
|
||||
|
||||
|
||||
#### Related Tasks
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ If you don't have a Netdata Cloud account yet you won't need to worry about it.
|
|||
After your account is created and you sign in to Netdata, you first are asked to agree to Netdata Cloud's [Privacy
|
||||
Policy](https://www.netdata.cloud/privacy/) and [Terms of Use](https://www.netdata.cloud/terms/). Once you agree with these you are directed
|
||||
through the Netdata Cloud onboarding process, which is explained in the [Netdata Cloud
|
||||
quickstart](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx).
|
||||
quickstart](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
|
|
@ -85,4 +85,4 @@ It is not currently possible to link an account created with `user@example.com`
|
|||
## What's next?
|
||||
|
||||
If you haven't already onboarded to Netdata Cloud and connected your first nodes, visit
|
||||
the [get started guide](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx).
|
||||
the [Get Started section of our documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ These customizations appear for anyone else with access to that War Room.
|
|||
## See more metrics in Netdata Cloud
|
||||
|
||||
If you want to add more metrics to your War Rooms and they don't show up when you add new metrics to Nodes, you likely
|
||||
need to configure those nodes to collect from additional data sources. See our [collectors doc](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
|
||||
need to configure those nodes to collect from additional data sources. See our [collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md)
|
||||
to learn how to use dozens of pre-installed collectors that can instantly collect from your favorite services and applications.
|
||||
|
||||
If you want to see up to 30 days of historical metrics in Cloud (and more on individual node dashboards), read our guide
|
||||
|
|
|
|||
|
|
@ -51,11 +51,10 @@ application metrics collectors, including those for containers/k8s clusters.
|
|||
## Collect metrics from applications running on Windows
|
||||
|
||||
Netdata is fully capable of collecting and visualizing metrics from applications running on Windows systems. The only
|
||||
caveat is that you must [install Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) on a separate system or a compatible VM because there
|
||||
caveat is that you must [install Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) on a separate system or a compatible VM because there
|
||||
is no native Windows version of the Netdata Agent.
|
||||
|
||||
Once you have Netdata running on that separate system, you can follow the [enable and configure
|
||||
doc](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) to tell the collector to look for exposed metrics on the Windows system's IP
|
||||
Once you have Netdata running on that separate system, you can follow the [collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) documentation to tell the collector to look for exposed metrics on the Windows system's IP
|
||||
address or hostname, plus the applicable port.
|
||||
|
||||
For example, you have a MySQL database with a root password of `my-secret-pw` running on a Windows system with the IP
|
||||
|
|
|
|||
|
|
@ -55,8 +55,7 @@ metrics](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README
|
|||
|
||||
### Collect metrics from applications running in Docker containers
|
||||
|
||||
You could use this technique to monitor an entire infrastructure of Docker containers. The same [enable and
|
||||
configure](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) procedures apply whether an application runs on the host system or inside
|
||||
You could use this technique to monitor an entire infrastructure of Docker containers. The same [enable and configure](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) procedures apply whether an application runs on the host system or inside
|
||||
a container. You may need to configure the target endpoint if it's not the application's default.
|
||||
|
||||
Netdata can even [run in a Docker container](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md) itself, and then collect metrics about the
|
||||
|
|
|
|||
|
|
@ -38,13 +38,13 @@ can find all system collectors in our [supported collectors list](https://github
|
|||
## Collect Windows system metrics
|
||||
|
||||
Netdata is also capable of monitoring Windows systems. The [WMI
|
||||
collector](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md) integrates with
|
||||
collector](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/README.md) integrates with
|
||||
[windows_exporter](https://github.com/prometheus-community/windows_exporter), a small Go-based binary that you can run
|
||||
on Windows systems. The WMI collector then gathers metrics from an endpoint created by windows_exporter, for more
|
||||
details see [the requirements](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md#requirements).
|
||||
details see [the requirements](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/README.md#requirements).
|
||||
|
||||
Next, [configure the WMI
|
||||
collector](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md#configuration) to point to the URL
|
||||
collector](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/README.md#configuration) to point to the URL
|
||||
and port of your exposed endpoint. Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
|
||||
method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system. You'll start seeing Windows system metrics, such as CPU
|
||||
utilization, memory, bandwidth per NIC, number of processes, and much more.
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ of 5 seconds.
|
|||
Every collector and plugin has its own `update every` setting, which you can also change in the `go.d.conf`,
|
||||
`python.d.conf` or `charts.d.conf` files, or in individual collector configuration files. If the `update
|
||||
every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See
|
||||
the [enable or configure a collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
|
||||
the [enable or configure a collector](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module)
|
||||
doc for details.
|
||||
|
||||
### Disable a collector or plugin
|
||||
|
|
@ -227,7 +227,7 @@ As mentioned at the top, there are plenty of other
|
|||
|
||||
You can also take what you've learned about node configuration to tweak the Agent's behavior or enable new features:
|
||||
|
||||
- [Enable new collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) or tweak
|
||||
- [Enable new collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module) or tweak
|
||||
their behavior.
|
||||
- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or
|
||||
create new ones.
|
||||
|
|
|
|||
|
|
@ -45,10 +45,10 @@ exist.
|
|||
for each in the [daemon config](https://github.com/netdata/netdata/blob/master/daemon/config/README.md) doc.
|
||||
- `edit-config` is a shell script used for [editing configuration files](#use-edit-config-to-edit-configuration-files).
|
||||
- Various configuration files ending in `.conf` for [configuring plugins or
|
||||
collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md#enable-a-collector-or-its-orchestrator) behave. Examples: `go.d.conf`,
|
||||
collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) behave. Examples: `go.d.conf`,
|
||||
`python.d.conf`, and `ebpf.d.conf`.
|
||||
- Various directories ending in `.d`, which contain other configuration files, each ending in `.conf`, for [configuring
|
||||
specific collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md#configure-a-collector).
|
||||
specific collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md).
|
||||
- `apps_groups.conf` is a configuration file for changing how applications/processes are grouped when viewing the
|
||||
**Application** charts from [`apps.plugin`](https://github.com/netdata/netdata/blob/master/collectors/apps.plugin/README.md) or
|
||||
[`ebpf.plugin`](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md).
|
||||
|
|
@ -160,7 +160,7 @@ and `edit-config`. We put together a few security best practices based on how yo
|
|||
|
||||
You can also take what you've learned about node configuration to enable or enhance features:
|
||||
|
||||
- [Enable new collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) or tweak their behavior.
|
||||
- [Enable new collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) or tweak their behavior.
|
||||
- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or create new ones.
|
||||
- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to receive updates about the health of your
|
||||
infrastructure.
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@ Read about [Netdata's security design](https://github.com/netdata/netdata/blob/m
|
|||
post](https://www.netdata.cloud/blog/netdata-agent-dashboard/) about why the local Agent dashboard is both open and
|
||||
secure by design.
|
||||
|
||||
Next up, learn about [collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) to ensure you're gathering every essential
|
||||
Next up, learn about [collectors](https://github.com/netdata/netdata/blob/master/collectors/README.md) to ensure you're gathering every essential
|
||||
metric about your node, its applications, and your infrastructure at large.
|
||||
|
||||
[](<>)
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ Learn more about [securing the Netdata Agent](https://github.com/netdata/netdata
|
|||
|
||||
You can also use the restart/reload methods described above to enable new features:
|
||||
|
||||
- [Enable new collectors](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) or tweak their behavior.
|
||||
- [Enable new collectors](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) or tweak their behavior.
|
||||
- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or create new ones.
|
||||
- [Enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to receive updates about the health of your
|
||||
infrastructure.
|
||||
|
|
|
|||
|
|
@ -469,7 +469,6 @@ The following tables describe the standard spelling, capitalization, and usage o
|
|||
| **Netdata** | The company behind the open-source Netdata Agent and the Netdata Cloud web application. Never use _netdata_ or _NetData_. <br /><br />In general, focus on the user's goals, actions, and solutions rather than what the company provides. For example, write _Learn more about enabling alarm notifications on your preferred platforms_ instead of _Netdata sends alarm notifications to your preferred platforms_. |
|
||||
| **Netdata Agent** | The free and open source [monitoring agent](https://github.com/netdata/netdata) that you can install on all of your distributed systems, whether they're physical, virtual, containerized, ephemeral, and more. The Agent monitors systems running Linux, Docker, Kubernetes, macOS, FreeBSD, and more, and collects metrics from hundreds of popular services and applications. |
|
||||
| **Netdata Cloud** | The web application hosted at [https://app.netdata.cloud](https://app.netdata.cloud) that helps you monitor an entire infrastructure of distributed systems in real time. <br /><br />Never use _Cloud_ without the preceding _Netdata_ to avoid ambiguity. |
|
||||
| **Netdata community** | Contributors to any of Netdata's [open-source projects](https://github.com/netdata/learn/blob/master/contribute/projects.mdx), members of the [community forum](https://community.netdata.cloud/). |
|
||||
| **Netdata community forum** | The Discourse-powered forum for feature requests, Netdata Cloud technical support, and conversations about Netdata's monitoring and troubleshooting products. |
|
||||
| **node** | A system on which the Netdata Agent is installed. The system can be physical, virtual, in a Docker container, and more. Depending on your infrastructure, you may have one, dozens, or hundreds of nodes. Some nodes are _ephemeral_, in that they're created/destroyed automatically by an orchestrator service. |
|
||||
| **Space** | The highest level container within Netdata Cloud for a user to organize their team members and nodes within their infrastructure. A Space likely represents an entire organization or a large team. <br /><br />_Space_ is always capitalized. |
|
||||
|
|
@ -482,7 +481,7 @@ The following tables describe the standard spelling, capitalization, and usage o
|
|||
| Term | Definition |
|
||||
|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **filesystem** | Use instead of _file system_. |
|
||||
| **preconfigured** | The concept that many of Netdata's features come with sane defaults that users don't need to configure to find [immediate value](https://github.com/netdata/netdata/blob/master/docs/overview/why-netdata.md#simple-to-deploy). |
|
||||
| **preconfigured** | The concept that many of Netdata's features come with sane defaults that users don't need to configure to find immediate value. |
|
||||
| **real time**/**real-time** | Use _real time_ as a noun phrase, most often with _in_: _Netdata collects metrics in real time_. Use _real-time_ as an adjective: _Netdata collects real-time metrics from hundreds of supported applications and services. |
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ learn_rel_path: "Concepts"
|
|||
Because Netdata is a monitoring and _troubleshooting_ platform, a dashboard with real-time, meaningful, and
|
||||
context-aware charts is essential.
|
||||
|
||||
As soon as you [install Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx), it autodetects hardware, OS, containers, services, and
|
||||
As soon as you [install Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md), it autodetects hardware, OS, containers, services, and
|
||||
applications running on your node and builds a dashboard on a single, scrollable webpage. This page features hundreds of
|
||||
charts, which are preconfigured to save you time from learning a query language, all stacked on top of one another. This
|
||||
vertical rhythm is designed to encourage exploration and help you visually identify connections between the metrics
|
||||
|
|
@ -59,7 +59,7 @@ synchronizes your interactions to help you understand exactly how a node behaved
|
|||
seconds or days.
|
||||
|
||||
A chart is an individual, interactive, always-updating graphic displaying one or more collected/calculated metrics,
|
||||
which are generated by [collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md).
|
||||
which are generated by [collectors](https://github.com/netdata/netdata/blob/master/collectors/README.md).
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ Based on your needs and resources you allocated to your external time-series dat
|
|||
that metrics are exported or export only certain charts with filtering. You can also choose whether metrics are exported
|
||||
as-collected, a normalized average, or the sum/volume of metrics values over the configured interval.
|
||||
|
||||
Exporting is an important part of Netdata's effort to be [interoperable](https://github.com/netdata/netdata/blob/master/docs/overview/netdata-monitoring-stack.md)
|
||||
Exporting is an important part of Netdata's effort to be interoperable
|
||||
with other monitoring software. You can use an external time-series database for long-term metrics retention, further
|
||||
analysis, or correlation with other tools, such as application tracing.
|
||||
|
||||
|
|
|
|||
|
|
@ -303,8 +303,7 @@ button to initiate your pull request (PR).
|
|||
Jump down to our instructions on [PRs](#making-a-pull-request) for your next steps.
|
||||
|
||||
**Note**: If you wish to contribute documentation that is more tailored from your specific infrastructure
|
||||
monitoring/troubleshooting experience, please consider submitting a blog post about your experience. Check
|
||||
the [README](https://github.com/netdata/blog/blob/master/README.md) in our blog repo! Any blog submissions that have
|
||||
monitoring/troubleshooting experience, please consider submitting a blog post about your experience. Check out our [blog](https://github.com/netdata/blog#readme) repo! Any blog submissions that have
|
||||
widespread or universal application will be integrated into our permanent documentation.
|
||||
|
||||
### Edit locally
|
||||
|
|
@ -765,7 +764,3 @@ TODO: Update this section after implemeting a _docker-compose_ for builting and
|
|||
|
||||
The Netdata team aggregates and publishes all documentation at [learn.netdata.cloud](/) using
|
||||
[Docusaurus](https://v2.docusaurus.io/) over at the [`netdata/learn` repository](https://github.com/netdata/learn).
|
||||
|
||||
## Netdata-specific terms
|
||||
|
||||
Consult the [Netdata Glossary](https://github.com/netdata/netdata/blob/master/docs/glossary.md) Netdata specific terms
|
||||
|
|
|
|||
|
|
@ -83,11 +83,10 @@ seconds, respectively.
|
|||
|
||||
Every collector and plugin has its own `update every` setting, which you can also change in the `go.d.conf`,
|
||||
`python.d.conf`, or `charts.d.conf` files, or in individual collector configuration files. If the `update
|
||||
every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See the [enable
|
||||
or configure a collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) doc for details.
|
||||
every` for an individual collector is less than the global, the Netdata Agent uses the global setting. See the [collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) for details.
|
||||
|
||||
To reduce the frequency of an [internal
|
||||
plugin/collector](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md#collector-architecture-and-terminology), open `netdata.conf` and
|
||||
plugin/collector](https://github.com/netdata/netdata/blob/master/collectors/README.md#collector-architecture-and-terminology), open `netdata.conf` and
|
||||
find the appropriate section. For example, to reduce the frequency of the `apps` plugin, which collects and visualizes
|
||||
metrics on application resource utilization:
|
||||
|
||||
|
|
@ -96,7 +95,7 @@ metrics on application resource utilization:
|
|||
update every = 5
|
||||
```
|
||||
|
||||
To [configure an individual collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md), open its specific configuration file with
|
||||
To [configure an individual collector](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md#configure-a-collector), open its specific configuration file with
|
||||
`edit-config` and look for the `update_every` setting. For example, to reduce the frequency of the `nginx` collector,
|
||||
run `sudo ./edit-config go.d/nginx.conf`:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<!--
|
||||
title: "Export and visualize Netdata metrics in Graphite"
|
||||
sidebar_label: "Export and visualize Netdata metrics in Graphite"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/guides/export/export-netdata-metrics-graphite.md"
|
||||
description: "Use Netdata to collect and export thousands of metrics to Graphite for long-term storage or further analysis."
|
||||
image: /img/seo/guides/export/export-netdata-metrics-graphite.png
|
||||
learn_status: "Published"
|
||||
|
|
@ -164,8 +165,7 @@ exporting charts to your Graphite dashboard!
|
|||
### Add exporting charts to Netdata Cloud
|
||||
|
||||
You can also show these exporting engine metrics on Netdata Cloud. If you don't have an account already,
|
||||
go [sign in](https://app.netdata.cloud) and get started for free. If you need some help along the way, read
|
||||
the [get started with Cloud guide](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx).
|
||||
go [sign in](https://app.netdata.cloud) and get started for free.
|
||||
|
||||
Add more metrics to a War Room's Nodes view by clicking on the **Add metric** button, then typing `exporting` into the
|
||||
context field. Choose the exporting contexts you want to add, then click **Add**. You'll see these charts alongside any
|
||||
|
|
|
|||
|
|
@ -116,8 +116,7 @@ cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /et
|
|||
./edit-config health.d/cockroachdb.conf # You may need to use `sudo` for write privileges
|
||||
```
|
||||
|
||||
For more information about editing the defaults or writing new alarm entities, see our health monitoring [quickstart
|
||||
guide](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md).
|
||||
For more information about editing the defaults or writing new alarm entities, see our documentation on [configuring health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
|
||||
|
||||
## What's next?
|
||||
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ server](https://user-images.githubusercontent.com/1153921/103586700-da5b0a00-4ea
|
|||
|
||||
## Prerequisites
|
||||
|
||||
- A node running the Netdata Agent. If you don't yet have that, [get Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
|
||||
- A node running the Netdata Agent. If you don't yet have that, [install Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
|
||||
- A Netdata Cloud account. [Sign up](https://app.netdata.cloud) if you don't have one already.
|
||||
- Familiarity with configuring the Netdata Agent with [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
|
||||
- _Optional_: An Nginx web server running on the same node to follow the example configuration steps.
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ To follow this tutorial, you need:
|
|||
## Install the Netdata Agent
|
||||
|
||||
If you don't have the free, open-source Netdata monitoring agent installed on your node yet, get started with a [single
|
||||
kickstart command](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx):
|
||||
kickstart command](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md):
|
||||
|
||||
<OneLineInstallWget/>
|
||||
|
||||
|
|
@ -242,7 +242,7 @@ source of issues faster with [Metric Correlations](https://github.com/netdata/ne
|
|||
|
||||
### Related reference documentation
|
||||
|
||||
- [Netdata Agent · Get started](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx)
|
||||
- [Netdata Agent · Get started](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md)
|
||||
- [Netdata Agent · Apache data collector](https://github.com/netdata/go.d.plugin/blob/master/modules/apache/README.md)
|
||||
- [Netdata Agent · Web log collector](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md)
|
||||
- [Netdata Agent · MySQL data collector](https://github.com/netdata/go.d.plugin/blob/master/modules/mysql/README.md)
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ part of your system might affect another.
|
|||
action](https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98-11ea-8f60-0d7824667cd3.gif)
|
||||
|
||||
If you're completely new to Netdata, look at our [step-by-step guide](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-00.md) for a
|
||||
walkthrough of all its features. For a more expedited tour, see the [get started guide](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
|
||||
walkthrough of all its features. For a more expedited tour, see the [get started documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
|
||||
|
||||
### Enable temperature sensor monitoring
|
||||
|
||||
|
|
@ -154,7 +154,7 @@ Most importantly, you can always install additional services and instantly colle
|
|||
|
||||
- [Optimize performance](https://github.com/netdata/netdata/blob/master/docs/guides/configure/performance.md) using tweaks developed for IoT devices.
|
||||
- [Stream Raspberry Pi metrics](https://github.com/netdata/netdata/blob/master/streaming/README.md) to a parent host for easy access or longer-term storage.
|
||||
- [Tweak alarms](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md) for either Pi-hole or the health of your Raspberry Pi.
|
||||
- [Tweak alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) for either Pi-hole or the health of your Raspberry Pi.
|
||||
- [Export metrics to external databases](https://github.com/netdata/netdata/blob/master/exporting/README.md) with the exporting engine.
|
||||
|
||||
Or, head over to [our guides](https://learn.netdata.cloud/guides/) for even more experiments and insights into
|
||||
|
|
|
|||
|
|
@ -38,11 +38,7 @@ With Netdata's process monitoring, you can:
|
|||
|
||||
## Prerequisites
|
||||
|
||||
- One or more Linux nodes running [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx). If you
|
||||
need more time to understand Netdata before
|
||||
following this guide, see
|
||||
the [infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) or
|
||||
[single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) monitoring quickstarts.
|
||||
- One or more Linux nodes running [Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md)
|
||||
- A general understanding of how
|
||||
to [configure the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md)
|
||||
using `edit-config`.
|
||||
|
|
@ -286,7 +282,7 @@ a [supported collector](https://github.com/netdata/netdata/blob/master/collector
|
|||
set
|
||||
that up if it wasn't autodetected. With both process utilization and application-specific metrics, you should have every
|
||||
piece of data needed to discover the root cause of an incident. See
|
||||
our [collector setup](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) doc for details.
|
||||
the [collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) documentation for details.
|
||||
|
||||
[Create new dashboards](https://github.com/netdata/netdata/blob/master/docs/visualize/create-dashboards.md) in Netdata
|
||||
Cloud using charts from `apps.plugin`,
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ Read on to learn all the steps and enable unsupervised anomaly detection on your
|
|||
|
||||
- A Raspberry Pi running Raspbian, which we'll call a _node_.
|
||||
- The [open-source Netdata](https://github.com/netdata/netdata) monitoring agent. If you don't have it installed on your
|
||||
node yet, [get started now](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
|
||||
node yet, [get started now](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
|
||||
|
||||
## Install dependencies
|
||||
|
||||
|
|
@ -123,7 +123,7 @@ feedback on our [community forum](https://community.netdata.cloud/t/anomalies-co
|
|||
|
||||
### Related reference documentation
|
||||
|
||||
- [Netdata Agent · Get Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx)
|
||||
- [Netdata Agent · Get Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md)
|
||||
- [Netdata Agent · Anomalies collector](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/anomalies/README.md)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Now, let's see the above process in detail.
|
|||
|
||||
## Prerequisites
|
||||
|
||||
- A node with the [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) installed.
|
||||
- A node with the [Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) installed.
|
||||
- An application to instrument. For this guide, that will be [k6](https://k6.io/docs/getting-started/installation).
|
||||
|
||||
## Understanding the metrics
|
||||
|
|
|
|||
|
|
@ -37,8 +37,7 @@ In the `source` row, you see that this chart is getting its configuration from
|
|||
`4@/usr/lib/netdata/conf.d/health.d/cpu.conf`. The relevant part of begins at `health.d`: `health.d/cpu.conf`. That's
|
||||
the file you need to edit if you want to silence this alarm.
|
||||
|
||||
For more information about editing or referencing health configuration files on your system, see the [health
|
||||
quickstart](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md#edit-health-configuration-files).
|
||||
For more information about editing or referencing health configuration files on your system, see the [Configure health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md#edit-health-configuration-files) and the [Health configuration reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) sections of our documentation.
|
||||
|
||||
## Edit the file to enable silencing
|
||||
|
||||
|
|
@ -74,8 +73,7 @@ To silence this alarm, change `sysadmin` to `silent`.
|
|||
to: silent
|
||||
```
|
||||
|
||||
Use one of the available [methods](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md#reload-health-configuration) to reload your health configuration
|
||||
and ensure you get no more notifications about that alarm**.
|
||||
Use one of the available [methods](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md#reload-health-configuration) to reload your health configuration and ensure you get no more notifications about that alarm.
|
||||
|
||||
You can add `to: silent` to any alarm you'd rather not bother you with notifications.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ learn_rel_path: "Guides"
|
|||
|
||||
# Develop a custom data collector in Python
|
||||
|
||||
The Netdata Agent uses [data collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) to fetch metrics from hundreds of system,
|
||||
The Netdata Agent uses [data collectors](https://github.com/netdata/netdata/blob/master/collectors/README.md) to fetch metrics from hundreds of system,
|
||||
container, and service endpoints. While the Netdata team and community has built [powerful
|
||||
collectors](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) for most system, container, and service/application endpoints, there are plenty
|
||||
of custom applications that can't be monitored by default.
|
||||
|
|
@ -33,7 +33,7 @@ covered here, or use the included examples for collecting and organizing either
|
|||
## What you need to get started
|
||||
|
||||
- A physical or virtual Linux system, which we'll call a _node_.
|
||||
- A working installation of the free and open-source [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) monitoring agent.
|
||||
- A working installation of the free and open-source [Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) monitoring agent.
|
||||
|
||||
## Jobs and elements of a Python collector
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ completely new to Netdata, or have never tried health monitoring/performance tro
|
|||
guide is perfect for you.
|
||||
|
||||
If you have monitoring experience, or would rather get straight into configuring Netdata to your needs, you can jump
|
||||
straight into code and configurations with our [getting started guide](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx).
|
||||
straight into code and configurations with our [getting started guide](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
|
||||
|
||||
> This guide contains instructions for Netdata installed on a Linux system. Many of the instructions will work on
|
||||
> other supported operating systems, like FreeBSD and macOS, but we can't make any guarantees.
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ You might be thinking, "So, now I have to remember all these IP addresses, and t
|
|||
manually, to move from one system to another? Maybe I should just make a bunch of bookmarks. What's a few more tabs
|
||||
on top of the hundred I have already?"
|
||||
|
||||
We get it. That's why we built [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx), which connects many distributed
|
||||
We get it. That's why we built [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), which connects many distributed
|
||||
agents for a seamless experience when monitoring an entire infrastructure of Netdata-monitored nodes.
|
||||
|
||||
 does a good job (we think!) of explaining why Cloud
|
||||
gives you a ton of value at no cost:
|
||||
Our documentation on [monitoring your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) does a good job (we think!) of explaining why Cloud gives you a ton of value at no cost:
|
||||
|
||||
> Netdata Cloud gives you real-time visibility for your entire infrastructure. With Netdata Cloud, you can run all your
|
||||
> distributed Agents in headless mode _and_ access the real-time metrics and insightful charts from their dashboards.
|
||||
|
|
@ -50,8 +49,7 @@ features, new collectors for more applications, and improved UI, so will Cloud.
|
|||
|
||||
## Get started with Netdata Cloud
|
||||
|
||||
Signing in, onboarding, and connecting your first nodes only takes a few minutes, and we have a [Get started with
|
||||
Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx) guide to help you walk through every step.
|
||||
Signing in, onboarding, and connecting your first nodes only takes a few minutes, and we have a [Monitor your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) section to help you walk through every step.
|
||||
|
||||
Or, if you're feeling confident, dive right in.
|
||||
|
||||
|
|
|
|||
|
|
@ -79,7 +79,7 @@ the `warn` and `crit` lines to the values of your choosing. For example:
|
|||
```
|
||||
|
||||
You _can_ restart Netdata with `sudo systemctl restart netdata`, to enable your tune, but you can also reload _only_ the
|
||||
health monitoring component using one of the available [methods](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md#reload-health-configuration).
|
||||
health monitoring component using one of the available [methods](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md#reload-health-configuration).
|
||||
|
||||
You can also tune any other aspect of the default alarms. To better understand how each line in a health entity works,
|
||||
read our [health documentation](https://github.com/netdata/netdata/blob/master/health/README.md).
|
||||
|
|
|
|||
|
|
@ -240,8 +240,7 @@ same application on multiple systems and want to correlate how it performs on ea
|
|||
findings with someone else on your team.
|
||||
|
||||
If you don't already have a Netdata Cloud account, go [sign in](https://app.netdata.cloud) and get started for free.
|
||||
Read the [get started with Cloud guide](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.mdx) for a walkthrough of
|
||||
connecting nodes to and other fundamentals.
|
||||
You can also read how to [monitor your infrastructure with Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) to understand the key features that it has to offer.
|
||||
|
||||
Once you've added one or more nodes to a Space in Netdata Cloud, you can see aggregated eBPF metrics in the [Overview
|
||||
dashboard](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) under the same **Applications** or **eBPF** sections that you
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Netdata's health watchdog is highly configurable, with support for dynamic thres
|
|||
more. You can tweak any of the existing alarms based on your infrastructure's topology or specific monitoring needs, or
|
||||
create new entities.
|
||||
|
||||
You can use health alarms in conjunction with any of Netdata's [collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) (see
|
||||
You can use health alarms in conjunction with any of Netdata's [collectors](https://github.com/netdata/netdata/blob/master/collectors/README.md) (see
|
||||
the [supported collector list](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md)) to monitor the health of your systems, containers, and
|
||||
applications in real time.
|
||||
|
||||
|
|
|
|||
|
|
@ -143,9 +143,7 @@ Netdata has [300+ pre-installed collectors](https://github.com/netdata/netdata/b
|
|||
configuration. Collectors search each of your nodes in default locations and ports to find running applications and
|
||||
gather as many metrics as they can without you having to configure them individually.
|
||||
|
||||
Most collectors work without configuration, but you should read up on [how collectors
|
||||
work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) and [how to enable/configure](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md) them so
|
||||
that you can see metrics from those applications in Netdata Cloud.
|
||||
Most collectors work without configuration, should you want more info, you can read more on [how Netdata's metrics collectors work](https://github.com/netdata/netdata/blob/master/collectors/README.md) and the [Collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md) documentation.
|
||||
|
||||
In addition, find detailed information about which [system](https://github.com/netdata/netdata/blob/master/docs/collect/system-metrics.md),
|
||||
[container](https://github.com/netdata/netdata/blob/master/docs/collect/container-metrics.md), and [application](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md) metrics you can
|
||||
|
|
|
|||
|
|
@ -17,14 +17,15 @@ You can find Netdata's dashboards in two places: locally served at `http://NODE:
|
|||
Netdata Cloud. While you access these dashboards differently, they have similar interfaces, identical charts and
|
||||
metrics, and you interact with both of them the same way.
|
||||
|
||||
> If you're not sure which option is best for you, see our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) and
|
||||
> [infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) quickstart guides.
|
||||
> 📑 Note
|
||||
>
|
||||
> For a quickstart on how to get started, check the [install Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) documentation.
|
||||
|
||||
Netdata dashboards are single, scrollable pages with many charts stacked on top of one another. As you scroll up or
|
||||
down, charts appearing in your browser's viewport automatically load and update every second.
|
||||
|
||||
The dashboard is broken up into multiple **sections**, such as **System Overview**, **CPU**, **Disk**, which are
|
||||
automatically generated based on which [collectors](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md) begin collecting metrics when
|
||||
automatically generated based on which [collectors](https://github.com/netdata/netdata/blob/master/collectors/README.md) begin collecting metrics when
|
||||
Netdata starts up. Sections also appear in the right-hand **menu**, along with submenus based on the contexts and
|
||||
families Netdata creates for your node.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,8 +14,7 @@ Welcome to the health configuration reference.
|
|||
This guide contains information about editing health configuration files to tweak existing alarms or create new health
|
||||
entities that are customized to the needs of your infrastructure.
|
||||
|
||||
To learn the basics of locating and editing health configuration files, see the [health
|
||||
quickstart](https://github.com/netdata/netdata/blob/master/health/QUICKSTART.md).
|
||||
To learn the basics of locating and editing health configuration files, see the [Configure health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) documentation.
|
||||
|
||||
## Health configuration files
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ resolution times.
|
|||
|
||||
## What you need to get started
|
||||
|
||||
- An installation of the open-source [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) monitoring agent.
|
||||
- An installation of the open-source [Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md) monitoring agent.
|
||||
- An installation of the [PagerDuty agent](https://www.pagerduty.com/docs/guides/agent-install-guide/) on the node
|
||||
running Netdata.
|
||||
- A PagerDuty `Generic API` service using either the `Events API v2` or `Events API v1`.
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ import TabItem from '@theme/TabItem';
|
|||
Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from
|
||||
any physical or virtual system (we call them _nodes_). These metrics are organized in an easy-to-use and -navigate interface.
|
||||
|
||||
Together with [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx), you can monitor your entire infrastructure in
|
||||
Together with [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), you can monitor your entire infrastructure in
|
||||
real time and troubleshoot problems that threaten the health of your nodes.
|
||||
|
||||
Netdata runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices. It
|
||||
|
|
@ -32,7 +32,7 @@ To install Netdata in minutes on your platform:
|
|||
2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform
|
||||
3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it
|
||||
|
||||
Upon installation completing successfully, you should be able to see the node live in your Netdata Space and live charts in the Overview tab. [Read more about the cloud features](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx).
|
||||
Upon installation completing successfully, you should be able to see the node live in your Netdata Space and live charts in the Overview tab. [Read more about the cloud features](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md).
|
||||
|
||||
Where you go from here is based on your use case, immediate needs, and experience with monitoring and troubleshooting,
|
||||
but we have some hints on what you might want to do next.
|
||||
|
|
@ -56,8 +56,8 @@ metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metric
|
|||
#### Data collection
|
||||
|
||||
If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should
|
||||
learn more about [how data collectors work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md). If there's a [supported
|
||||
collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) for metrics you need, [configure the collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
|
||||
learn more about [how data collectors work](https://github.com/netdata/netdata/blob/master/collectors/README.md). If there's a [supported
|
||||
collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) for metrics you need, [configure the collector](https://github.com/netdata/netdata/blob/master/collectors/REFERENCE.md)
|
||||
or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.
|
||||
|
||||
#### Alarms & notifications
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ learn_rel_path: "Installation"
|
|||
|
||||
# Deploy Netdata with Ansible
|
||||
|
||||
Netdata's [one-line kickstart](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) is zero-configuration, highly adaptable, and compatible with tons
|
||||
Netdata's [one-line kickstart](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#install-on-linux-with-one-line-installer) is zero-configuration, highly adaptable, and compatible with tons
|
||||
of different operating systems and Linux distributions. You can use it on bare metal, VMs, containers, and everything
|
||||
in-between.
|
||||
|
||||
|
|
@ -166,7 +166,7 @@ want to do with Netdata, so use those categories to dive in.
|
|||
|
||||
Some of the best places to start:
|
||||
|
||||
- [Enable or configure a collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)
|
||||
- [Collectors configuration reference](https://github.com/netdata/netdata/blob/master/collectors/README.md)
|
||||
- [Supported collectors list](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md)
|
||||
- [See an overview of your infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md)
|
||||
- [Interact with dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md)
|
||||
|
|
|
|||
|
|
@ -164,11 +164,8 @@ If the script is valid, this command will return `OK, VALID`.
|
|||
|
||||
## What's next?
|
||||
|
||||
When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
|
||||
[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
|
||||
When you're finished with installation, check out [how to monitor your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), or skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
|
||||
|
||||
Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
|
||||
|
||||
Read through Netdata's [documentation](https://learn.netdata.cloud/), which is structured based on actions and
|
||||
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
|
||||
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
|
||||
external databases, and more.
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ The Netdata Agent is installed under `/usr/local/netdata`. Dependencies are hand
|
|||
The `kickstart.sh` script accepts additional parameters to automatically [connect](https://github.com/netdata/netdata/blob/master/claim/README.md) your node to Netdata
|
||||
Cloud immediately after installation. Find the `token` and `rooms` strings by [signing in to Netdata
|
||||
Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Connect Nodes** in the [Spaces management
|
||||
area](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx#manage-spaces).
|
||||
area](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md).
|
||||
|
||||
- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
|
||||
after the install.
|
||||
|
|
@ -81,7 +81,7 @@ We don't recommend installing Netdata from source on macOS, as it can be difficu
|
|||
```
|
||||
|
||||
2. Click **Install** on the Software Update popup window that appears.
|
||||
3. Use the same terminal session to install some of Netdata's prerequisites using Homebrew. If you don't want to use [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx), you can omit `cmake`.
|
||||
3. Use the same terminal session to install some of Netdata's prerequisites using Homebrew. If you don't want to use [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), you can omit `cmake`.
|
||||
|
||||
```bash
|
||||
brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl libtool cmake
|
||||
|
|
@ -106,10 +106,8 @@ We don't recommend installing Netdata from source on macOS, as it can be difficu
|
|||
|
||||
## What's next?
|
||||
|
||||
When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
|
||||
[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
|
||||
|
||||
Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
|
||||
|
||||
|
||||
When you're finished with installation, check out [how to monitor your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), or skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
|
||||
|
||||
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
|
||||
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
|
||||
external databases, and more.
|
||||
|
|
|
|||
|
|
@ -229,13 +229,8 @@ In most cases, you can do this by running `CC=gcc ./netdata-installer.sh`.
|
|||
|
||||
## What's next?
|
||||
|
||||
When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
|
||||
[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
|
||||
|
||||
Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
|
||||
When you're finished with installation, check out [how to monitor your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), or skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
|
||||
|
||||
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
|
||||
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
|
||||
external databases, and more.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -60,10 +60,7 @@ supported on offline installs).
|
|||
|
||||
## What's next?
|
||||
|
||||
When you're finished with installation, check out our [single-node](https://github.com/netdata/netdata/blob/master/docs/quickstart/single-node.md) or
|
||||
[infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
|
||||
|
||||
Or, skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
|
||||
When you're finished with installation, check out [how to monitor your infrastructure](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md), or skip straight to [configuring the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md).
|
||||
|
||||
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
|
||||
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
|
||||
|
|
|
|||
|
|
@ -107,9 +107,6 @@ a War Room's name to jump to the Netdata Cloud web interface.
|
|||
|
||||
|
||||
If you want to know more about how Cloud populates this menu, and the Agent-Cloud integration at a high level, see our
|
||||
document on [using the Agent with Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/agent-cloud.md).
|
||||
|
||||
## Customizing the local dashboard
|
||||
|
||||
Netdata stores information about individual charts in the `dashboard_info.js`
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue