mirror of
https://github.com/netdata/netdata.git
synced 2025-04-09 23:57:55 +00:00
Fix broken links in our documentation (#14565)
* fix broken link in ml/README.md * fix broken link across all files * fix broken link across all files * fix broken links and remove what's next sections * fix broken links and remove what's next section * Remove related links sections with broken links that link to removed files * fix broken links
This commit is contained in:
Fotis Voutsas
GitHub
parent
fe17707b06
commit
ff14cf0df6
28 changed files with 46 additions and 135 deletions
aclk
collectors
docs
category-overview-pages
cloud
alerts-notifications
manage
visualize
configure
dashboard
export
guides
monitor
visualize
exporting
health
ml
packaging/installer
|
|
@ -28,8 +28,7 @@ this is not an option in your case always verify the current domain resolution (
|
|||
|
||||
:::
|
||||
|
||||
For a guide to connecting a node using the ACLK, plus additional troubleshooting and reference information, read our [get
|
||||
started with Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/get-started.md) guide or the full [connect to Cloud
|
||||
For a guide to connecting a node using the ACLK, plus additional troubleshooting and reference information, read our [connect to Cloud
|
||||
documentation](https://github.com/netdata/netdata/blob/master/claim/README.md).
|
||||
|
||||
## Data privacy
|
||||
|
|
|
|||
|
|
@ -52,7 +52,10 @@ If you don't see the app/service you'd like to monitor in this list:
|
|||
|
||||
## Available Collectors
|
||||
|
||||
- [Service and application collectors](#service-and-application-collectors)
|
||||
- [Supported collectors list](#supported-collectors-list)
|
||||
- [Add your application to Netdata](#add-your-application-to-netdata)
|
||||
- [Available Collectors](#available-collectors)
|
||||
- [Service and application collectors](#service-and-application-collectors)
|
||||
- [Generic](#generic)
|
||||
- [APM (application performance monitoring)](#apm-application-performance-monitoring)
|
||||
- [Containers and VMs](#containers-and-vms)
|
||||
|
|
@ -68,7 +71,7 @@ If you don't see the app/service you'd like to monitor in this list:
|
|||
- [Search](#search)
|
||||
- [Storage](#storage)
|
||||
- [Web](#web)
|
||||
- [System collectors](#system-collectors)
|
||||
- [System collectors](#system-collectors)
|
||||
- [Applications](#applications)
|
||||
- [Disks and filesystems](#disks-and-filesystems)
|
||||
- [eBPF](#ebpf)
|
||||
|
|
@ -79,10 +82,10 @@ If you don't see the app/service you'd like to monitor in this list:
|
|||
- [Processes](#processes)
|
||||
- [Resources](#resources)
|
||||
- [Users](#users)
|
||||
- [Netdata collectors](#netdata-collectors)
|
||||
- [Orchestrators](#orchestrators)
|
||||
- [Third-party collectors](#third-party-collectors)
|
||||
- [Etc](#etc)
|
||||
- [Netdata collectors](#netdata-collectors)
|
||||
- [Orchestrators](#orchestrators)
|
||||
- [Third-party collectors](#third-party-collectors)
|
||||
- [Etc](#etc)
|
||||
|
||||
## Service and application collectors
|
||||
|
||||
|
|
@ -218,8 +221,7 @@ configure any of these collectors according to your setup and infrastructure.
|
|||
server log files and provide summary (client, traffic) metrics.
|
||||
- [Squid web server logs](https://github.com/netdata/go.d.plugin/blob/master/modules/squidlog/README.md): Tail Squid
|
||||
access logs to return the volume of requests, types of requests, bandwidth, and much more.
|
||||
- [Web server logs (Go version for Apache,
|
||||
NGINX)](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md/): Tail access logs and provide
|
||||
- [Web server logs (Go version for Apache, NGINX)](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md): Tail access logs and provide
|
||||
very detailed web server performance statistics. This module is able to parse 200k+ rows in less than half a second.
|
||||
- [Web server logs (Apache, NGINX)](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md): Tail
|
||||
access log
|
||||
|
|
@ -398,7 +400,7 @@ The Netdata Agent can collect these system- and hardware-level metrics using a v
|
|||
of targets (service-checks) using the XML
|
||||
stats interface.
|
||||
- [WMI (Windows Management Instrumentation)
|
||||
exporter](https://github.com/netdata/go.d.plugin/blob/master/modules/wmi/README.md): Collect CPU, memory,
|
||||
exporter](https://github.com/netdata/go.d.plugin/blob/master/modules/windows/README.md): Collect CPU, memory,
|
||||
network, disk, OS, system, and log-in metrics scraping `wmi_exporter`.
|
||||
|
||||
### Disks and filesystems
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ either centrally, via the
|
|||
|
||||
We designed Netdata with interoperability in mind. The Agent collects thousands of metrics every second, and then what
|
||||
you do with them is up to you. You can
|
||||
[store metrics in the database engine](https://github.com/netdata/netdata/blob/master/docs/guides/longer-metrics-storage.md),
|
||||
[store metrics in the database engine](https://github.com/netdata/netdata/blob/master/database/README.md),
|
||||
or send them to another time series database for long-term storage or further analysis using
|
||||
Netdata's [exporting engine](https://github.com/netdata/netdata/edit/master/exporting/README.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Centralized alert notifications from Netdata Cloud is a independent process from
|
|||
Netdata](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md). You can enable one or the other, or both, based on your needs. However,
|
||||
the alerts you see in Netdata Cloud are based on those streamed from your Netdata-monitoring nodes. If you want to tweak
|
||||
or add new alert that you see in Netdata Cloud, and receive via centralized alert notifications, you must
|
||||
[configure](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) each node's alert watchdog.
|
||||
[configure](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) each node's alert watchdog.
|
||||
|
||||
</Callout>
|
||||
|
||||
|
|
@ -130,8 +130,8 @@ Here's an example email notification for the `ram_available` chart, which is in
|
|||
## What's next?
|
||||
|
||||
Netdata Cloud's alarm notifications feature leverages the alarms configuration on each node in your infrastructure. If
|
||||
you'd like to tweak any of these alarms, or even add new ones based on your needs, read our [health
|
||||
quickstart](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
|
||||
you'd like to tweak any of these alarms, or even add new ones based on your needs, read our [Health
|
||||
configuration documentation](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md).
|
||||
|
||||
You can also [view active alarms](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/view-active-alerts.md) in Netdata Cloud for an instant
|
||||
visualization of the health of your infrastructure.
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ infrastructure based on their configuration. Every node comes with hundreds of p
|
|||
tested by Netdata's community of DevOps engineers and SREs, but you may want to customize existing alerts or create new
|
||||
ones entirely.
|
||||
|
||||
Read our doc on [health alerts](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to
|
||||
Read our documentation on [health alerts](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) to
|
||||
learn how to tweak existing alerts or create new
|
||||
health entities based on the specific needs of your infrastructure. By taking charge of alert configuration, you'll
|
||||
ensure Netdata Cloud always delivers the most relevant alerts about the well-being of your nodes.
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ To not disrupt current users space's access rights we will be keeping their curr
|
|||
keep using the legacy **Member** role with the exact same permissions as it has currently.
|
||||
|
||||
If you move from the **Early Bird** plan to a paid plan, you will not be able to return to the **Early Bird** plan again. The **Community** free plan will always be available to you, but it does not allow
|
||||
you to invite or change users using the Member role. See more details on our [roles and plans](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access-model.md#what-roles-are-available) documentation.
|
||||
you to invite or change users using the Member role. See more details on our [roles and plans](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md#what-roles-are-available) documentation.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<!--
|
||||
title: "Role-Based Access model"
|
||||
sidebar_label: "Role-Based Access model"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access-model.md"
|
||||
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md"
|
||||
sidebar_position: "1"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Concepts"
|
||||
|
|
|
|||
|
|
@ -42,8 +42,7 @@ If you want to add more metrics to your War Rooms and they don't show up when yo
|
|||
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
|
||||
on [long-term storage of historical metrics](https://github.com/netdata/netdata/blob/master/docs/guides/longer-metrics-storage.md). Also, see our
|
||||
If you want to see up to 30 days of historical metrics in Cloud (and more on individual node dashboards), read about [changing how long Netdata stores metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md). Also, see our
|
||||
[calculator](/docs/store/change-metrics-storage#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
|
||||
for finding the disk and RAM you need to store metrics for a certain period of time.
|
||||
|
||||
|
|
|
|||
|
|
@ -93,7 +93,7 @@ sudo ./edit-config health.d/example-alarm.conf
|
|||
|
||||
Or, append your new alarm to an existing file by editing a relevant existing file in the `health.d/` directory.
|
||||
|
||||
Read more about [configuring alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to
|
||||
Read more about [configuring alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) to
|
||||
get started, and see
|
||||
the [health monitoring reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) for a full listing
|
||||
of options available in health entities.
|
||||
|
|
@ -229,7 +229,7 @@ You can also take what you've learned about node configuration to tweak the Agen
|
|||
|
||||
- [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
|
||||
- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.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
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ anomaly, or change in infrastructure affects how their Agents should perform.
|
|||
## The Netdata config directory
|
||||
|
||||
On most Linux systems, using our [recommended one-line
|
||||
installation](https://github.com/netdata/netdata/blob/master/docs/get-started.md#install-on-linux-with-one-line-installer), the **Netdata config
|
||||
installation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md#install-on-linux-with-one-line-installer), the **Netdata config
|
||||
directory** is `/etc/netdata/`. The config directory contains several configuration files with the `.conf` extension, a
|
||||
few directories, and a shell script named `edit-config`.
|
||||
|
||||
|
|
@ -52,7 +52,7 @@ exist.
|
|||
- `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).
|
||||
- `health.d/` is a directory that contains [health configuration files](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
|
||||
- `health.d/` is a directory that contains [health configuration files](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md).
|
||||
- `health_alarm_notify.conf` enables and configures [alarm notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md).
|
||||
- `statsd.d/` is a directory for configuring Netdata's [statsd collector](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md).
|
||||
- `stream.conf` configures [parent-child streaming](https://github.com/netdata/netdata/blob/master/streaming/README.md) between separate nodes running the Agent.
|
||||
|
|
@ -161,7 +161,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/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.
|
||||
- [Configure existing health alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.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.
|
||||
- Change [the long-term metrics retention period](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) using the database engine.
|
||||
|
|
|
|||
|
|
@ -81,22 +81,3 @@ ps aux| grep netdata
|
|||
|
||||
The output of `ps aux` should show no `netdata` or associated processes running. You can now start the Netdata Agent
|
||||
again with `service netdata start`, or the appropriate method for your system.
|
||||
|
||||
## What's next?
|
||||
|
||||
Learn more about [securing the Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md).
|
||||
|
||||
You can also use the restart/reload methods described above to enable new features:
|
||||
|
||||
- [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.
|
||||
- Change [the long-term metrics retention period](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) using the database engine.
|
||||
|
||||
### Related reference documentation
|
||||
|
||||
- [Netdata Agent · Daemon](https://github.com/netdata/netdata/blob/master/daemon/README.md)
|
||||
- [Netdata Agent · Netdata CLI](https://github.com/netdata/netdata/blob/master/cli/README.md)
|
||||
|
||||
[](<>)
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ they have a lot of underlying complexity. To meaningfully organize charts out of
|
|||
your nodes, Netdata uses the concepts of **dimensions**, **contexts**, and **families**.
|
||||
|
||||
Understanding how these work will help you more easily navigate the dashboard, [write new
|
||||
alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md), or play around with the [API](https://github.com/netdata/netdata/blob/master/web/api/README.md).
|
||||
alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md), or play around with the [API](https://github.com/netdata/netdata/blob/master/web/api/README.md).
|
||||
|
||||
For a refresher on the anatomy of a chart, see [dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md).
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ whereas anything after the `.` is specified either by the chart's developer or b
|
|||
|
||||
By default, a chart's type affects where it fits in the menu, while its family creates submenus.
|
||||
|
||||
Netdata also relies on contexts for [alarm configuration](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) (the [`on`
|
||||
Netdata also relies on contexts for [alarm configuration](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) (the [`on`
|
||||
line](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md#alarm-line-on)).
|
||||
|
||||
## Family
|
||||
|
|
|
|||
|
|
@ -95,24 +95,5 @@ active alarm, and the **Log** tab shows a historical record of exactly when alar
|
|||
log](https://user-images.githubusercontent.com/1153921/80842482-8c289500-8bb6-11ea-9791-600cfdbe82ce.gif)
|
||||
|
||||
Learn more about [viewing active alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md), [configuring
|
||||
alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md), or [enabling a new notification
|
||||
alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md), or [enabling a new notification
|
||||
method](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md).
|
||||
|
||||
## What's next?
|
||||
|
||||
Learn more about [interacting with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md) to quickly pan through time, zoom, and
|
||||
show/hide dimensions to best understand the state of your node in any timeframe. A complete understanding of [chart
|
||||
dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md) will also help with how Netdata
|
||||
organizes its dashboard and operates [alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
|
||||
|
||||
### Further reading & related information
|
||||
|
||||
- Dashboard
|
||||
- **[How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.md)**
|
||||
- [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.md)
|
||||
- [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.md)
|
||||
- [Select timeframes to visualize](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md)
|
||||
- [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.md)
|
||||
- [Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.md)
|
||||
- [HTTP API](https://github.com/netdata/netdata/blob/master/web/api/README.md)
|
||||
- [Custom dashboards](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md)
|
||||
|
|
|
|||
|
|
@ -75,19 +75,3 @@ documentation and the [enabling a connector](https://github.com/netdata/netdata/
|
|||
Can't find your preferred external time-series database? Ask our [community](https://community.netdata.cloud/) for
|
||||
solutions, or file an [issue on
|
||||
GitHub](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml).
|
||||
|
||||
## What's next?
|
||||
|
||||
We recommend you read our document on [enabling a connector](https://github.com/netdata/netdata/blob/master/docs/export/enable-connector.md) to learn about the
|
||||
process and discover important configuration options. If you would rather skip ahead, click on any of the above links to
|
||||
connectors for their reference documentation, which outline any prerequisites to install for that connector, along with
|
||||
connector-specific configuration options.
|
||||
|
||||
Read about one possible use case for exporting metrics in our guide: [_Export and visualize Netdata metrics in
|
||||
Graphite_](https://github.com/netdata/netdata/blob/master/docs/guides/export/export-netdata-metrics-graphite.md).
|
||||
|
||||
### Related reference documentation
|
||||
|
||||
- [Exporting engine reference](https://github.com/netdata/netdata/blob/master/exporting/README.md)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -107,7 +107,7 @@ update_every: 10
|
|||
## Disable unneeded plugins or collectors
|
||||
|
||||
If you know that you don't need an [entire plugin or a specific
|
||||
collector](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md#collector-architecture-and-terminology), you can disable any of them.
|
||||
collector](https://github.com/netdata/netdata/blob/master/collectors/README.md#collector-architecture-and-terminology), you can disable any of them.
|
||||
Keep in mind that if a plugin/collector has nothing to do, it simply shuts down and does not consume system resources.
|
||||
You will only improve the Agent's performance by disabling plugins/collectors that are actively collecting metrics.
|
||||
|
||||
|
|
@ -229,19 +229,3 @@ On the child nodes you should add to `netdata.conf` the following:
|
|||
[health]
|
||||
enabled = no
|
||||
```
|
||||
|
||||
## What's next?
|
||||
|
||||
We hope this guide helped you better understand how to optimize the performance of the Netdata Agent.
|
||||
|
||||
Now that your Agent is running smoothly, we recommend you [secure your nodes](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) if you haven't
|
||||
already.
|
||||
|
||||
Next, dive into some of Netdata's more complex features, such as configuring its health watchdog or exporting metrics to
|
||||
an external time-series database.
|
||||
|
||||
- [Interact with dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/visualize/interact-dashboards-charts.md)
|
||||
- [Configure health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md)
|
||||
- [Export metrics to external time-series databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md)
|
||||
|
||||
[](<>)
|
||||
|
|
|
|||
|
|
@ -115,4 +115,4 @@ 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 documentation on [configuring health alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.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/health/REFERENCE.md).
|
||||
|
|
|
|||
|
|
@ -211,7 +211,7 @@ shows any alarms currently triggered, while the **All** tab displays a list of _
|
|||
|
||||
|
||||
[Tweak alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) based on your infrastructure monitoring needs, and to see these alarms
|
||||
[Tweak alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) based on your infrastructure monitoring needs, and to see these alarms
|
||||
in other places, like your inbox or a Slack channel, [enable a notification
|
||||
method](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -101,8 +101,7 @@ part of your system might affect another.
|
|||
|
||||
|
||||
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 documentation](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md).
|
||||
If you're completely new to Netdata, look at the [Introduction](https://github.com/netdata/netdata/blob/master/docs/getting-started/introduction.md) section for a 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
|
||||
|
||||
|
|
@ -140,7 +139,7 @@ more than 256.
|
|||
|
||||
Use our [database sizing
|
||||
calculator](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
|
||||
and [guide on storing historical metrics](https://github.com/netdata/netdata/blob/master/docs/guides/longer-metrics-storage.md) to help you determine the right
|
||||
and the [Database configuration documentation](https://github.com/netdata/netdata/blob/master/database/README.md) to help you determine the right
|
||||
setting for your Raspberry Pi.
|
||||
|
||||
## What's next?
|
||||
|
|
@ -153,7 +152,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/docs/monitor/configure-alarms.md) for either Pi-hole or the health of your Raspberry Pi.
|
||||
- [Tweak alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.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
|
||||
|
|
|
|||
|
|
@ -12,8 +12,7 @@ learn_rel_path: "Integrations/Notify"
|
|||
Netdata offers two ways to receive alert notifications on external platforms. These methods work independently _or_ in
|
||||
parallel, which means you can enable both at the same time to send alert notifications to any number of endpoints.
|
||||
|
||||
Both methods use a node's health alerts to generate the content of alert notifications. Read the doc on [configuring
|
||||
alerts](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to change the preconfigured thresholds or to create tailored alerts for your
|
||||
Both methods use a node's health alerts to generate the content of alert notifications. Read our documentation on [configuring alerts](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) to change the preconfigured thresholds or to create tailored alerts for your
|
||||
infrastructure.
|
||||
|
||||
Netdata Cloud offers [centralized alert notifications](#netdata-cloud) via email, which leverages the health status
|
||||
|
|
|
|||
|
|
@ -65,12 +65,11 @@ With the three icons beneath that and the **role** designation, you can:
|
|||
3. Copy the code to embed the badge onto another web page using an `<embed>` element.
|
||||
|
||||
The table on the right-hand side displays information about the health entity that triggered the alarm, which you can
|
||||
use as a reference to [configure alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md).
|
||||
use as a reference to [configure alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md).
|
||||
|
||||
## What's next?
|
||||
|
||||
With the information that appears on Netdata Cloud and the local dashboard about active alarms, you can [configure
|
||||
alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) to match your infrastructure's needs or your team's goals.
|
||||
With the information that appears on Netdata Cloud and the local dashboard about active alarms, you can [configure alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) to match your infrastructure's needs or your team's goals.
|
||||
|
||||
If you're happy with the pre-configured alarms, skip ahead to [enable
|
||||
notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to use Netdata Cloud's centralized alarm notifications and/or
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ faster.
|
|||
|
||||
While it's useful to see real-time metrics on flexible dashboards, you need ways to know precisely when an anomaly
|
||||
strikes. Every Netdata Agent comes with a health watchdog that
|
||||
uses [alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) and
|
||||
uses [alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) and
|
||||
[notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to notify you of
|
||||
issues seconds after they strike.
|
||||
|
||||
|
|
|
|||
|
|
@ -120,8 +120,7 @@ Netdata Cloud users can [build new dashboards](https://github.com/netdata/netdat
|
|||
aggregating relevant metrics from any number of nodes onto a single interface, you can respond faster to anomalies,
|
||||
perform more targeted troubleshooting, or keep tabs on a bird's eye view of your infrastructure.
|
||||
|
||||
If you're finished with dashboards for now, skip to Netdata's health watchdog for information on [creating or
|
||||
configuring](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) alarms, and [send notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md)
|
||||
If you're finished with dashboards for now, skip to Netdata's health watchdog for information on [creating or configuring](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) alarms, and [send notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md)
|
||||
to get informed when something goes wrong in your infrastructure.
|
||||
|
||||
### Related reference documentation
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ connector to enable and configure for your database of choice.
|
|||
- [**Graphite**](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md): A plaintext interface. Metrics are sent to the database server as
|
||||
`prefix.hostname.chart.dimension`. `prefix` is configured below, `hostname` is the hostname of the machine (can
|
||||
also be configured). Learn more in our guide to [export and visualize Netdata metrics in
|
||||
Graphite](https://github.com/netdata/netdata/blob/master/docs/guides/export/export-netdata-metrics-graphite.md).
|
||||
Graphite](https://github.com/netdata/netdata/blob/master/exporting/graphite/README.md).
|
||||
- [**JSON** document databases](https://github.com/netdata/netdata/blob/master/exporting/json/README.md)
|
||||
- [**OpenTSDB**](https://github.com/netdata/netdata/blob/master/exporting/opentsdb/README.md): Use a plaintext or HTTP interfaces. Metrics are sent to
|
||||
OpenTSDB as `prefix.chart.dimension` with tag `host=hostname`.
|
||||
|
|
|
|||
|
|
@ -21,20 +21,3 @@ your metrics.
|
|||
Ready to take the next steps with health monitoring?
|
||||
|
||||
[Configuration reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md)
|
||||
|
||||
## Guides
|
||||
|
||||
Every infrastructure is different, so we're not interested in mandating how you should configure Netdata's health
|
||||
monitoring features. Instead, these guides should give you the details you need to tweak alarms to your heart's
|
||||
content.
|
||||
|
||||
[Stopping notifications for individual alarms](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/stop-notifications-alarms.md)
|
||||
|
||||
[Use dimension templates to create dynamic alarms](https://github.com/netdata/netdata/blob/master/docs/guides/monitor/dimension-templates.md)
|
||||
|
||||
## Related features
|
||||
|
||||
**[Notifications](https://github.com/netdata/netdata/blob/master/health/notifications/README.md)**: Get notified about ongoing alarms from your Agents via your
|
||||
favorite platform(s), such as Slack, Discord, PagerDuty, email, and much more.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -63,5 +63,5 @@ sudo su -s /bin/bash netdata
|
|||
Aside from the three values set in `health_alarm_notify.conf`, there is no further configuration required to send alert
|
||||
notifications to PagerDuty.
|
||||
|
||||
To configure individual alarms, read our [alert configuration](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) doc or
|
||||
To configure individual alarms, read our [alert configuration](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) doc or
|
||||
the [health entity reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) doc.
|
||||
|
|
|
|||
|
|
@ -114,7 +114,9 @@ To enable or disable anomaly detection:
|
|||
2. In the `[ml]` section, set `enabled = yes` to enable or `enabled = no` to disable.
|
||||
3. Restart netdata (typically `sudo systemctl restart netdata`).
|
||||
|
||||
**Note**: If you would like to learn more about configuring Netdata please see [the configuration guide](https://github.com/netdata/netdata/blob/master/docs/guides/step-by-step/step-04.md).
|
||||
> 📑 Note
|
||||
>
|
||||
> If you would like to learn more about configuring Netdata please see the [Configuration section](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) of our documentation.
|
||||
|
||||
Below is a list of all the available configuration params and their default values.
|
||||
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ or read about its requirements to configure your endpoint to publish metrics in
|
|||
#### Alarms & notifications
|
||||
|
||||
Netdata comes with hundreds of preconfigured alarms, designed by our monitoring gurus in parallel with our open-source
|
||||
community, but you may want to [edit alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or
|
||||
community, but you may want to [edit alarms](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) or
|
||||
[enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to customize your Netdata experience.
|
||||
|
||||
#### Make your deployment production ready
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ aims to document some of those steps for popular cloud providers.
|
|||
|
||||
> This document is a work-in-progress! If you find new issues specific to a cloud provider, or would like to help
|
||||
> clarify the correct workaround, please [create an
|
||||
> issue](https://github.com/netdata/netdata/issues/new?labels=feature+request,+needs+triage&template=feature_request.md)
|
||||
> issue](https://github.com/netdata/netdata/issues/new?labels=feature+request,+needs+triage&template=feature_request)
|
||||
> with your process and instructions on using the provider's interface to complete the workaround.
|
||||
|
||||
- [Install Netdata on cloud providers](#install-netdata-on-cloud-providers)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue