summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorFotis Voutsas <fotis@netdata.cloud>2023-03-21 16:41:38 +0200
committerGitHub <noreply@github.com>2023-03-21 07:41:38 -0700
commit9385b062f649fd197e7ba411120516fb5f9f46d7 (patch)
tree63861f1cdff85ae530ca08ddd192643e2dc3358a /docs
parent2d50a119413fc5e0f6116bc851a317ff6ffa5e6c (diff)
Replace hardcoded links pointing to "learn.netdata.cloud" with github absolute links (#14779)
* Update REFERENCE.md * replace redirected links * format the files * fix redirected link * format the file * replace hardcoded links
Diffstat (limited to 'docs')
-rw-r--r--docs/cloud/cheatsheet.md4
-rw-r--r--docs/cloud/insights/anomaly-advisor.md9
-rw-r--r--docs/cloud/insights/metric-correlations.md2
-rw-r--r--docs/cloud/manage/view-plan-billing.md2
-rw-r--r--docs/cloud/visualize/dashboards.md3
-rw-r--r--docs/guides/monitor/anomaly-detection.md8
-rw-r--r--docs/guides/monitor/kubernetes-k8s-netdata.md2
-rw-r--r--docs/guides/monitor/pi-hole-raspberry-pi.md25
-rw-r--r--docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md2
-rw-r--r--docs/store/distributed-data-architecture.md2
10 files changed, 18 insertions, 41 deletions
diff --git a/docs/cloud/cheatsheet.md b/docs/cloud/cheatsheet.md
index 531f65f4f2..4dea807274 100644
--- a/docs/cloud/cheatsheet.md
+++ b/docs/cloud/cheatsheet.md
@@ -25,7 +25,7 @@ To do so, sign in to Netdata Cloud, click the `Claim Nodes` button, choose the `
## Metrics collection & retention
You can tweak your settings in the netdata.conf file.
-πŸ“„ [Find your netdata.conf file](https://learn.netdata.cloud/guides/step-by-step/step-04#find-your-netdataconf-file)
+πŸ“„ [Find your netdata.conf file](https://github.com/netdata/netdata/blob/master/daemon/config/README.md)
Open a new terminal and navigate to the netdata.conf file. Use the edit-config script to make changes: `sudo ./edit-config netdata.conf`
@@ -93,7 +93,7 @@ $ sudo ./edit-config python.d/anomalies.conf
#### The Netdata config directory: `/etc/netdata`
> If you don't have such a directory:
-> πŸ“„ [Find your netdata.conf file](https://learn.netdata.cloud/guides/step-by-step/step-04#find-your-netdataconf-file)
+> πŸ“„ [Find your netdata.conf file](https://github.com/netdata/netdata/blob/master/daemon/config/README.md)
> The cheatsheet assumes you’re running all commands from within the Netdata config directory!
#### Edit Netdata's main config file: `$ sudo ./edit-config netdata.conf`
diff --git a/docs/cloud/insights/anomaly-advisor.md b/docs/cloud/insights/anomaly-advisor.md
index ff5cce1455..4804dbc161 100644
--- a/docs/cloud/insights/anomaly-advisor.md
+++ b/docs/cloud/insights/anomaly-advisor.md
@@ -21,7 +21,7 @@ interest.
If you are running a Netdata version higher than `v1.35.0-29-nightly` you will be able to use the Anomaly Advisor out of the box with zero configuration. If you are on an earlier Netdata version you will need to first enable ML on your nodes by following the steps below.
-To enable the Anomaly Advisor you must first enable ML on your nodes via a small config change in `netdata.conf`. Once the anomaly detection models have trained on the Agent (with default settings this takes a couple of hours until enough data has been seen to train the models) you will then be able to enable the Anomaly Advisor feature in Netdata Cloud.
+To enable the Anomaly Advisor you must first enable ML on your nodes via a small config change in `netdata.conf`. Once the anomaly detection models have trained on the Agent (with default settings this takes a couple of hours until enough data has been seen to train the models) you will then be able to enable the Anomaly Advisor feature in Netdata Cloud.
### Enable ML on Netdata Agent
@@ -32,7 +32,7 @@ To enable ML on your Netdata Agent, you need to edit the `[ml]` section in your
enabled = yes
```
-At a minimum you just need to set `enabled = yes` to enable ML with default params. More details about configuration can be found in the [Netdata Agent ML docs](https://learn.netdata.cloud/docs/agent/ml#configuration).
+At a minimum you just need to set `enabled = yes` to enable ML with default params. More details about configuration can be found in the [Netdata Agent ML docs](https://github.com/netdata/netdata/blob/master/ml/README.md#configuration).
When you have finished your configuration, restart Netdata with a command like `sudo systemctl restart netdata` for the config changes to take effect. You can find more info on restarting Netdata [here](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md).
@@ -44,7 +44,7 @@ Once this line flattens out all configured metrics should have models trained an
## Using Anomaly Advisor
-To use the Anomaly Advisor, go to the "anomalies" tab. Once you highlight a particular timeframe of interest, a selection of the most anomalous dimensions will appear below.
+To use the Anomaly Advisor, go to the "anomalies" tab. Once you highlight a particular timeframe of interest, a selection of the most anomalous dimensions will appear below.
The aim here is to surface the most anomalous metrics in the space or room for the highlighted window to try and cut down on the amount of manual searching required to get to the root cause of your issues.
@@ -68,7 +68,7 @@ You can expand any sparkline chart to see the underlying raw data to see how it
![image](https://user-images.githubusercontent.com/2178292/164430105-f747d1e0-f3cb-4495-a5f7-b7bbb71039ae.png)
-On the upper right hand side of the page you can select which nodes to filter on if you wish to do so. The ML training status of each node is also displayed.
+On the upper right hand side of the page you can select which nodes to filter on if you wish to do so. The ML training status of each node is also displayed.
On the lower right hand side of the page an index of anomaly rates is displayed for the highlighted timeline of interest. The index is sorted from most anomalous metric (highest anomaly rate) to least (lowest anomaly rate). Clicking on an entry in the index will scroll the rest of the page to the corresponding anomaly rate sparkline for that metric.
@@ -80,6 +80,7 @@ On the lower right hand side of the page an index of anomaly rates is displayed
You can read more detail on how anomaly detection in the Netdata Agent works in our [Agent docs](https://github.com/netdata/netdata/blob/master/ml/README.md).
🚧 **Note**: This functionality is still **under active development** and considered experimental. We dogfood it internally and among early adopters within the Netdata community to build the feature. If you would like to get involved and help us with feedback, you can reach us through any of the following channels:
+
- Email us at analytics-ml-team@netdata.cloud
- Comment on the [beta launch post](https://community.netdata.cloud/t/anomaly-advisor-beta-launch/2717) in the Netdata community
- Join us in the [πŸ€–-ml-powered-monitoring](https://discord.gg/4eRSEUpJnc) channel of the Netdata discord.
diff --git a/docs/cloud/insights/metric-correlations.md b/docs/cloud/insights/metric-correlations.md
index 7eb7d17bc5..1ba15c0f5b 100644
--- a/docs/cloud/insights/metric-correlations.md
+++ b/docs/cloud/insights/metric-correlations.md
@@ -74,7 +74,7 @@ Should you still want to, disabling nodes for Metric Correlation on the agent is
## Usage tips!
-- When running Metric Correlations from the [Overview tab](https://learn.netdata.cloud/docs/cloud/visualize/overview#overview) across multiple nodes, you might find better results if you iterate on the initial results by grouping by node to then filter to nodes of interest and run the Metric Correlations again. So a typical workflow in this case would be to:
+- When running Metric Correlations from the [Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#overview-and-single-node-view) across multiple nodes, you might find better results if you iterate on the initial results by grouping by node to then filter to nodes of interest and run the Metric Correlations again. So a typical workflow in this case would be to:
- If unsure which nodes you are interested in then run MC on all nodes.
- Within the initial results returned group the most interesting chart by node to see if the changes are across all nodes or a subset of nodes.
- If you see a subset of nodes clearly jump out when you group by node, then filter for just those nodes of interest and run the MC again. This will result in less aggregation needing to be done by Netdata and so should help give clearer results as you interact with the slider.
diff --git a/docs/cloud/manage/view-plan-billing.md b/docs/cloud/manage/view-plan-billing.md
index 8fd3c4380c..5d4c50a7e1 100644
--- a/docs/cloud/manage/view-plan-billing.md
+++ b/docs/cloud/manage/view-plan-billing.md
@@ -55,7 +55,7 @@ After an initial failed payment, we will attempt to process your payment every w
For the next 24 hours, you will be able to use all your current notification method configurations. After 24 hours, any of the notification method configurations that aren't available on your space's plan will be automatically disabled.
-Cancellation might affect users in your Space. Please check what roles are available on the [Community plan](https://learn.netdata.cloud/docs/nightly/concepts/netdata-plans#areas-impacted-by-plans). Users with unavailable roles on the Community plan will immediately have restricted access to the Space.
+Cancellation might affect users in your Space. Please check what roles are available on the [Community plan](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md#areas-impacted-by-plans). Users with unavailable roles on the Community plan will immediately have restricted access to the Space.
#### 3. Which currencies do you support?
diff --git a/docs/cloud/visualize/dashboards.md b/docs/cloud/visualize/dashboards.md
index 70fe4d20bc..b5a6120edf 100644
--- a/docs/cloud/visualize/dashboards.md
+++ b/docs/cloud/visualize/dashboards.md
@@ -50,8 +50,7 @@ node. If you select **All Nodes**, you will add a [composite chart](/docs/cloud/
your new dashboard. Next, select the context. You'll see a preview of the chart before you finish adding it.
The charts you add to any dashboard are fully interactive, just like the charts in an Agent dashboard or a single node's
-dashboard in Cloud. Zoom in and out, highlight timeframes, and more. See our
-[Agent dashboard docs](https://learn.netdata.cloud/docs/agent/web#using-charts) for all the shortcuts.
+dashboard in Cloud. Zoom in and out, highlight timeframes, and more.
Charts also synchronize as you interact with them, even across contexts _or_ nodes.
diff --git a/docs/guides/monitor/anomaly-detection.md b/docs/guides/monitor/anomaly-detection.md
index 9c4d74997c..4552e7a723 100644
--- a/docs/guides/monitor/anomaly-detection.md
+++ b/docs/guides/monitor/anomaly-detection.md
@@ -53,13 +53,13 @@ Pressing the anomalies icon (next to the information icon in the chart header) w
## Anomaly Rate Based Alerts
-It is possible to use the `anomaly-bit` when defining traditional Alerts within netdata. The `anomaly-bit` is just another `options` parameter that can be passed as part of an [alarm line lookup](https://learn.netdata.cloud/docs/agent/health/reference#alarm-line-lookup).
+It is possible to use the `anomaly-bit` when defining traditional Alerts within netdata. The `anomaly-bit` is just another `options` parameter that can be passed as part of an [alarm line lookup](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md#alarm-line-lookup).
You can see some example ML based alert configurations below:
-- [Anomaly rate based CPU dimensions alarm](https://learn.netdata.cloud/docs/agent/health/reference#example-8---anomaly-rate-based-cpu-dimensions-alarm)
-- [Anomaly rate based CPU chart alarm](https://learn.netdata.cloud/docs/agent/health/reference#example-9---anomaly-rate-based-cpu-chart-alarm)
-- [Anomaly rate based node level alarm](https://learn.netdata.cloud/docs/agent/health/reference#example-10---anomaly-rate-based-node-level-alarm)
+- [Anomaly rate based CPU dimensions alarm](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md#example-8---anomaly-rate-based-cpu-dimensions-alarm)
+- [Anomaly rate based CPU chart alarm](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md#example-9---anomaly-rate-based-cpu-chart-alarm)
+- [Anomaly rate based node level alarm](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md#example-10---anomaly-rate-based-node-level-alarm)
- More examples in the [`/health/health.d/ml.conf`](https://github.com/netdata/netdata/blob/master/health/health.d/ml.conf) file that ships with the agent.
## Learn More
diff --git a/docs/guides/monitor/kubernetes-k8s-netdata.md b/docs/guides/monitor/kubernetes-k8s-netdata.md
index 1d9ec2782a..cdf482ce11 100644
--- a/docs/guides/monitor/kubernetes-k8s-netdata.md
+++ b/docs/guides/monitor/kubernetes-k8s-netdata.md
@@ -140,7 +140,7 @@ visualizations](https://user-images.githubusercontent.com/1153921/109049195-349f
### Health map
-The first visualization is the [health map](https://learn.netdata.cloud/docs/cloud/visualize/kubernetes#health-map),
+The first visualization is the [health map](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md#health-map),
which places each container into its own box, then varies the intensity of their color to visualize the resource
utilization. By default, the health map shows the **average CPU utilization as a percentage of the configured limit**
for every container in your cluster.
diff --git a/docs/guides/monitor/pi-hole-raspberry-pi.md b/docs/guides/monitor/pi-hole-raspberry-pi.md
index 45af1eac94..4f0ff4cd6d 100644
--- a/docs/guides/monitor/pi-hole-raspberry-pi.md
+++ b/docs/guides/monitor/pi-hole-raspberry-pi.md
@@ -65,9 +65,7 @@ populates its dashboard with more than 250 charts.
Open your browser of choice and navigate to `http://NODE:19999/`, replacing `NODE` with the IP address of your Raspberry
Pi. Not sure what that IP is? Try running `hostname -I | awk '{print $1}'` from the Pi itself.
-You'll see Netdata's dashboard and a few hundred real-time,
-[interactive](https://learn.netdata.cloud/guides/step-by-step/step-02#interact-with-charts) charts. Feel free to
-explore, but let's turn our attention to installing Pi-hole.
+You'll see Netdata's dashboard and a few hundred real-time, interactive charts. Feel free to explore, but let's turn our attention to installing Pi-hole.
## Install Pi-Hole
@@ -142,24 +140,3 @@ 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 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?
-
-Now that you're monitoring Pi-hole and your Raspberry Pi with Netdata, you can extend its capabilities even further, or
-configure Netdata to more specific goals.
-
-Most importantly, you can always install additional services and instantly collect metrics from many of them with our
-[300+ integrations](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
-
-- [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/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
-troubleshooting the health of your systems and services.
-
-If you have any questions about using Netdata to monitor your Raspberry Pi, Pi-hole, or any other applications, head on
-over to our [community forum](https://community.netdata.cloud/).
-
-
diff --git a/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md b/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md
index 472772a4c4..1e1a2bad84 100644
--- a/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md
+++ b/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md
@@ -65,7 +65,7 @@ Read more about [Starting, Stopping and Restarting the Agent](https://github.com
## Claiming on an older, deprecated version of the Agent
-Make sure that you are using the latest version of Netdata if you are using the [Claiming script](https://learn.netdata.cloud/docs/agent/claim#claiming-script).
+Make sure that you are using the latest version of Netdata if you are using the [Claiming script](https://github.com/netdata/netdata/blob/master/claim/README.md#claiming-script).
With the introduction of our new architecture, Agents running versions lower than `v1.32.0` can face claiming problems, so we recommend you [update the Netdata Agent](https://github.com/netdata/netdata/blob/master/packaging/installer/UPDATE.md) to the latest stable version.
diff --git a/docs/store/distributed-data-architecture.md b/docs/store/distributed-data-architecture.md
index fffedd8ce8..bfd7803426 100644
--- a/docs/store/distributed-data-architecture.md
+++ b/docs/store/distributed-data-architecture.md
@@ -67,7 +67,7 @@ When you use the database engine to store your metrics, you can always perform a
Netdata Cloud does not store metric values.
To enable certain features, such as [viewing active alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md)
-or [filtering by hostname/service](https://learn.netdata.cloud/docs/cloud/war-rooms#node-filter), Netdata Cloud does
+or [filtering by hostname/service](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md), Netdata Cloud does
store configured alarms, their status, and a list of active collectors.
Netdata does not and never will sell your personal data or data about your deployment.