webfutureiorepo · pull · Nov 25, 2024 · Nov 25, 2024 · Nov 25, 2024 · Nov 25, 2024
diff --git a/docs/DICTIONARY.md b/docs/DICTIONARY.md
@@ -0,0 +1,36 @@
+# Terminology Dictionary
+
+This guide standardizes terminology for Netdata's documentation and communications. When referring to Netdata mechanisms or concepts, use these terms and definitions to ensure clarity and consistency.
+
+When the context is clear, we can omit the "Netdata" prefix for brevity.
+
+## Core Components
+
+| Term                   | Definition                                                               |
+|------------------------|--------------------------------------------------------------------------|
+| **Agent** (**Agents**) | The core monitoring software that collects, processes and stores metrics |
+| **Cloud**              | The centralized platform for managing and visualizing Netdata metrics    |
+
+## Database
+
+| Term                 | Definition                                         |
+|----------------------|----------------------------------------------------|
+| **Tier** (**Tiers**) | Database storage layers with different granularity |
+| **Mode(s)**          | The different Modes of the Database                |
+
+## Streaming
+
+| Term                     | Definition                                                  |
+|--------------------------|-------------------------------------------------------------|
+| **Parent** (**Parents**) | An Agent that receives metrics from other Agents (Children) |
+| **Child** (**Children**) | An Agent that streams metrics to another Agent (Parent)     |
+
+## Machine Learning
+
+| Term                    | Abbreviation | Definition                                                                                      |
+|-------------------------|:------------:|-------------------------------------------------------------------------------------------------|
+| **Machine Learning**    |      ML      | An umbrella term for Netdata's ML-powered features                                              |
+| **Model(s)**            |              | Uppercase when referring to the ML Models Netdata uses                                          |
+| **Anomaly Detection**   |              | The capability to identify unusual patterns in metrics                                          |
+| **Metric Correlations** |              | Filters dashboard to show metrics with the most significant changes in the selected time window |
+| **Anomaly Advisor**     |              | The interface and tooling for analyzing detected anomalies                                      |
diff --git a/docs/dashboards-and-charts/visualization-date-and-time-controls.md b/docs/dashboards-and-charts/visualization-date-and-time-controls.md
@@ -81,7 +81,7 @@ beyond stored historical metrics, you'll see this message:
 
 ![image](https://user-images.githubusercontent.com/70198089/225851033-43b95164-a651-48f2-8915-6aac9739ed93.png)
 
-At any time, [configure the internal TSDB's storage capacity](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md) to expand your
+At any time, [configure the internal TSDB's storage capacity](/src/database/README.md) to expand your
 depth of historical metrics.
 
 ### Timezone selector

diff --git a/docs/deployment-guides/deployment-strategies.md b/docs/deployment-guides/deployment-strategies.md
@@ -2,7 +2,7 @@
 
 ## Deployment Options Overview
 
-This section provides a quick overview for a few common deployment options for Netdata.
+This section provides a quick overview of a few common deployment options for Netdata.
 
 You can read about [Standalone Deployment](/docs/deployment-guides/standalone-deployment.md) and [Deployment with Centralization Points](/docs/deployment-guides/deployment-with-centralization-points.md) in the documentation inside this section.
 
@@ -24,24 +24,24 @@ An API key is a key created with `uuidgen` and is used for authentication and/or
 
 #### Child config
 
-As mentioned above, we do not recommend to connect the Child to Cloud directly during your setup.
+As mentioned above, we do not recommend connecting the Child to Cloud directly during your setup.
 
-This is done in order to reduce the footprint of the Netdata Agent on your production system, as some capabilities can be switched OFF for the Child and kept ON for the Parent.
+This is done to reduce the footprint of the Netdata Agent on your production system, as some capabilities can be switched OFF for the Child and kept ON for the Parent.
 
 In this example, Machine Learning and Alerting are disabled for the Child, so that the Parent can take the load. We also use RAM instead of disk to store metrics with limited retention, covering temporary network issues.
 
 ##### netdata.conf
 
 On the child node, edit `netdata.conf` by using the [edit-config](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script and set the following parameters:
 
-```yaml
+```text
 [db]
     # https://github.com/netdata/netdata/blob/master/src/database/README.md
     # none = no retention, ram = some retention in ram
     mode = ram
     # The retention in seconds.
-    # This provides some tolerance to the time the child has to find a parent in
-    # order to transfer the data. For IoT this can be lowered to 120.
+    # This provides some tolerance to the time the child has to find a parent 
+    # to transfer the data. For IoT, this can be lowered to 120.
     retention = 1200
     # The granularity of metrics, in seconds.
     # You may increase this to lower CPU resources.
@@ -56,16 +56,15 @@ On the child node, edit `netdata.conf` by using the [edit-config](/docs/netdata-
     # Disable remote access to the local dashboard
     bind to = lo
 [plugins]
-    # Uncomment the following line to disable all external plugins on extreme
-    # IoT cases by default.
+    # Uncomment the following line to disable all external plugins on extreme IoT cases by default.
     # enable running new plugins = no
 ```
 
 ##### stream.conf
 
 To edit `stream.conf`, use again the [edit-config](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script and set the following parameters:
 
-```yaml
+```text
 [stream]
     # Stream metrics to another Netdata
     enabled = yes
@@ -77,7 +76,7 @@ To edit `stream.conf`, use again the [edit-config](/docs/netdata-agent/configura
 
 #### Parent config
 
-For the Parent, besides setting up streaming, this example also provides configuration for multiple [tiers of metrics storage](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md), for 10 Children, with about 2k metrics each. This allows for:
+For the Parent, besides setting up streaming, this example also provides configuration for multiple [tiers of metrics storage](/src/database/README.md#tiers), for 10 Children, with about 2k metrics each. This allows for:
 
 - 1s granularity at tier 0 for 1 week
 - 1m granularity at tier 1 for 1 month
@@ -92,7 +91,7 @@ Requiring:
 
 On the Parent, edit `netdata.conf` by using the [edit-config](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script and set the following parameters:
 
-```yaml
+```text
 [db]
     mode = dbengine
     dbengine tier backfill = new
@@ -124,19 +123,19 @@ On the Parent node, edit `stream.conf` by using the [edit-config](/docs/netdata-
 
 ```yaml
 [API_KEY]
-    # Accept metrics streaming from other Agents with the specified API key
-    enabled = yes
+  # Accept metrics streaming from other Agents with the specified API key
+  enabled = yes
 ```
 
 ### Active–Active Parents
 
-In order to setup active–active streaming between Parent 1 and Parent 2, Parent 1 needs to be instructed to stream data to Parent 2 and Parent 2 to stream data to Parent 1. The Child Agents need to be configured with the addresses of both Parent Agents. An Agent will only connect to one Parent at a time, falling back to the next upon failure. These examples use the same API key between Parent Agents and for connections for Child Agents.
+To set up active–active streaming between Parent 1 and Parent 2, Parent 1 needs to be instructed to stream data to Parent 2 and Parent 2 to stream data to Parent 1. The Child Agents need to be configured with the addresses of both Parent Agents. An Agent will only connect to one Parent at a time, falling back to the next upon failure. These examples use the same API key between Parent Agents and for connections for Child Agents.
 
 On both Netdata Parent and all Child Agents, edit `stream.conf` by using the [edit-config](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script:
 
 #### stream.conf on Parent 1
 
-```yaml
+```text
 [stream]
     # Stream metrics to another Netdata
     enabled = yes
@@ -147,11 +146,12 @@ On both Netdata Parent and all Child Agents, edit `stream.conf` by using the [ed
 [API_KEY]
     # Accept metrics streams from Parent 2 and Child Agents
     enabled = yes
+
 ```
 
 #### stream.conf on Parent 2
 
-```yaml
+```text
 [stream]
     # Stream metrics to another Netdata
     enabled = yes
@@ -165,7 +165,7 @@ On both Netdata Parent and all Child Agents, edit `stream.conf` by using the [ed
 
 #### stream.conf on Child Agents
 
-```yaml
+```text
 [stream]
     # Stream metrics to another Netdata
     enabled = yes
@@ -193,7 +193,7 @@ We also suggest that you:
 
    For increased security, user management and access to our latest features, tools and troubleshooting solutions.
 
-2. [Change how long Netdata stores metrics](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md)
+2. [Change how long Netdata stores metrics](/src/database/README.md#modes)
 
    To control Netdata's memory use, when you have a lot of ephemeral metrics.
 

diff --git a/docs/exporting-metrics/enable-an-exporting-connector.md b/docs/exporting-metrics/enable-an-exporting-connector.md
@@ -9,7 +9,7 @@ the OpenTSDB and Graphite connectors.
 >
 > When you enable the exporting engine and a connector, the Netdata Agent exports metrics _beginning from the time you
 > restart its process_, not the entire
-> [database of long-term metrics](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md).
+> [database of long-term metrics](/src/database/README.md).
 
 Once you understand how to enable a connector, you can apply that knowledge to any other connector.
 

diff --git a/docs/glossary.md b/docs/glossary.md
@@ -35,7 +35,7 @@ Use the alphabetized list below to find the answer to your single-term questions
 
 - [**Cloud** or **Netdata Cloud**](/docs/netdata-cloud/README.md): Netdata Cloud is a web application that gives you real-time visibility for your entire infrastructure. With Netdata Cloud, you can view key metrics, insightful charts, and active alerts from all your nodes in a single web interface.
 
-- [**Collector**](/src/collectors/README.md#collector-architecture-and-terminology): A catch-all term for any Netdata process that gathers metrics from an endpoint.
+- [**Collector**](/src/collectors/README.md): A catch-all term for any Netdata process that gathers metrics from an endpoint.
 
 - [**Community**](https://community.netdata.cloud/): As a company with a passion and genesis in open-source, we are not just very proud of our community, but we consider our users, fans, and chatters to be an imperative part of the Netdata experience and culture.
 
@@ -75,7 +75,7 @@ Use the alphabetized list below to find the answer to your single-term questions
 
 ## I
 
-- [**Internal plugins**](/src/collectors/README.md#collector-architecture-and-terminology): These gather metrics from `/proc`, `/sys`, and other Linux kernel sources. They are written in `C` and run as threads within the Netdata daemon.
+- [**Internal plugins**](/src/collectors/README.md): These gather metrics from `/proc`, `/sys`, and other Linux kernel sources. They are written in `C` and run as threads within the Netdata daemon.
 
 ## K
 
@@ -91,11 +91,10 @@ Use the alphabetized list below to find the answer to your single-term questions
 
 - [**Metrics Exporting**](/docs/exporting-metrics/README.md): Netdata allows you to export metrics to external time-series databases with the exporting engine. This system uses a number of connectors to initiate connections to more than thirty supported databases, including InfluxDB, Prometheus, Graphite, ElasticSearch, and much more.
 
-- [**Metrics Storage**](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md): Upon collection the collected metrics need to be either forwarded, exported or just stored for further treatment. The Agent is capable to store metrics both short and long-term, with or without the usage of non-volatile storage.
+- [**Metrics Storage**](/src/database/README.md#modes): Upon collection the collected metrics need to be either forwarded, exported or just stored for further treatment. The Agent is capable to store metrics both short and long-term, with or without the usage of non-volatile storage.
 
 - [**Metrics Streaming Replication**](/docs/observability-centralization-points/README.md): Each node running Netdata can stream the metrics it collects, in real time, to another node. Metric streaming allows you to replicate metrics data across multiple nodes, or centralize all your metrics data into a single time-series database (TSDB).
 
-- [**Module**](/src/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module): A type of collector.
 
 ## N
 
@@ -112,7 +111,7 @@ metrics, troubleshoot complex performance problems, and make data interoperable
 
 - [**Obsoletion**(of nodes)](/docs/dashboards-and-charts/nodes-tab.md): Removing nodes from a space.
 
-- [**Orchestrators**](/src/collectors/README.md#collector-architecture-and-terminology): External plugins that run and manage one or more modules. They run as independent processes.
+- [**Orchestrators**](/src/collectors/README.md): External plugins that run and manage one or more modules. They run as independent processes.
 
 ## P
 

diff --git a/docs/netdata-agent/configuration/common-configuration-changes.md b/docs/netdata-agent/configuration/common-configuration-changes.md
@@ -19,36 +19,7 @@ changes reflected in those visualizations due to the way Netdata Cloud proxies m
 
 ### Increase the long-term metrics retention period
 
-Read our doc on [increasing long-term metrics storage](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md) for details.
-
-### Reduce the data collection frequency
-
-Change `update every` in
-the [`[global]` section](/src/daemon/config/README.md#global-section-options)
-of `netdata.conf` so
-that it is greater than `1`. An `update every` of `5` means the Netdata Agent enforces a _minimum_ collection frequency
-of 5 seconds.
-
-```text
-[global]
-    update every = 5
-```
-
-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](/src/collectors/REFERENCE.md#enable-and-disable-a-specific-collection-module)
-doc for details.
-
-### Disable a collector or plugin
-
-Turn off entire plugins in
-the [`[plugins]` section](/src/daemon/config/README.md#plugins-section-options)
-of
-`netdata.conf`.
-
-To disable specific collectors, open `go.d.conf`, `python.d.conf` or `charts.d.conf` and find the line
-for that specific module. Uncomment the line and change its value to `no`.
+Read our doc on [increasing long-term metrics storage](/src/database/README.md#tiers) for details.
 
 ## Modify alerts and notifications