32a6cd38e · cryptotaxi247/netdata-1

README.md

+5 -5

@@ -233,7 +233,7 @@ By default, Netdata will send e-mail notifications if there is a configured MTA

233

234 ### 4. **Configure Netdata Parents** :family:

235

236 -Optionally, configure one or more Netdata Parents. A Netdata Parent is a Netdata Agent that has been configured to accept [streaming connections](https://learn.netdata.cloud/docs/streaming/streaming-configuration-reference) from other Netdata agents.

236 +Optionally, configure one or more Netdata Parents. A Netdata Parent is a Netdata Agent that has been configured to accept [streaming connections](https://learn.netdata.cloud/docs/streaming/streaming-configuration-reference) from other Netdata Agents.

237

238 Netdata Parents provide:

239

@@ -264,8 +264,8 @@ If you connect your Netdata Parents, there is no need to connect your Netdata Ag

264

265 When your Netdata nodes are connected to Netdata Cloud, you can (on top of the above):

266

267 -- Access your Netdata agents from anywhere

268 -- Access sensitive Netdata agent features (like "Netdata Functions": processes, systemd-journal)

267 +- Access your Netdata Agents from anywhere

268 +- Access sensitive Netdata Agent features (like "Netdata Functions": processes, systemd-journal)

269 - Organize your infra in spaces and Rooms

270 - Create, manage, and share **custom dashboards**

271 - Invite your team and assign roles to them (Role-Based Access Control)

@@ -573,7 +573,7 @@ Here are some suggestions on how to manage and navigate this wealth of informati

573 If you're looking for specific information, you can use the search feature to find the relevant metrics or charts. This can help you avoid scrolling through all the data.

574

575 3. **Customize your Dashboards**

576 - Netdata allows you to create custom dashboards, which can help you focus on the metrics that are most important to you. Sign-in to Netdata and there you can have your custom dashboards. (coming soon to the agent dashboard too)

576 + Netdata allows you to create custom dashboards, which can help you focus on the metrics that are most important to you. Sign-in to Netdata and there you can have your custom dashboards. (coming soon to the Agent dashboard too)

577

578 4. **Leverage Netdata's Anomaly Detection**

579 Netdata uses machine learning to detect anomalies in your metrics. This can help you identify potential issues before they become major problems. We have added an `AR` button above the dashboard table of contents to reveal the anomaly rate per section so that you can spot what could need your attention.

@@ -633,7 +633,7 @@ We are aware that for privacy or regulatory reasons, not all environments can al

633

634 These steps will disable the anonymous telemetry for your Netdata installation.

635

636 -Please note, even with telemetry disabled, Netdata still requires a [Netdata Registry](https://learn.netdata.cloud/docs/configuring/securing-netdata-agents/registry) for alert notifications' Call To Action (CTA) functionality. When you click an alert notification, it redirects you to the Netdata Registry, which then directs your web browser to the specific Netdata Agent that issued the alert for further troubleshooting. The Netdata Registry learns the URLs of your agents when you visit their dashboards.

636 +Please note, even with telemetry disabled, Netdata still requires a [Netdata Registry](https://learn.netdata.cloud/docs/configuring/securing-netdata-agents/registry) for alert notifications' Call To Action (CTA) functionality. When you click an alert notification, it redirects you to the Netdata Registry, which then directs your web browser to the specific Netdata Agent that issued the alert for further troubleshooting. The Netdata Registry learns the URLs of your Agents when you visit their dashboards.

637

638 Any Netdata Agent can act as a Netdata Registry. Designate one Netdata Agent as your registry, and our global Netdata Registry will no longer be in use. For further information on this, please refer to [this guide](https://learn.netdata.cloud/docs/configuring/securing-netdata-agents/registry).

639

docs/alerts-and-notifications/notifications/README.md

+1 -1

@@ -6,4 +6,4 @@ This section includes the documentation of the integrations for both of Netdata'

6

7 - Netdata Cloud provides centralized alert notifications, utilizing the health status data already sent to Netdata Cloud from connected nodes to send alerts to configured integrations. [Supported integrations](/docs/alerts-&-notifications/notifications/centralized-cloud-notifications) include Amazon SNS, Discord, Slack, Splunk, and others.

8

9 -- The Netdata Agent offers a [wider range of notification options](/docs/alerts-&-notifications/notifications/agent-dispatched-notifications) directly from the agent itself. You can choose from over a dozen services, including email, Slack, PagerDuty, Twilio, and others, for more granular control over notifications on each node.

9 +- The Netdata Agent offers a [wider range of notification options](/docs/alerts-&-notifications/notifications/agent-dispatched-notifications) directly from the Agent itself. You can choose from over a dozen services, including email, Slack, PagerDuty, Twilio, and others, for more granular control over notifications on each node.

docs/dashboards-and-charts/README.md

+1 -1

@@ -25,7 +25,7 @@ The Netdata dashboard consists of the following main sections:

25

26 > **Note**

27 >

28 -> Some sections of the dashboard, when accessed through the agent, may require the user to be signed in to Netdata Cloud or have the Agent claimed to Netdata Cloud for their full functionality. Examples include saving visualization settings on charts or custom dashboards, claiming the node to Netdata Cloud, or executing functions on an Agent.

28 +> Some sections of the dashboard, when accessed through the Agent, may require the user to be signed in to Netdata Cloud or have the Agent claimed to Netdata Cloud for their full functionality. Examples include saving visualization settings on charts or custom dashboards, claiming the node to Netdata Cloud, or executing functions on an Agent.

29

30 ## How to access the dashboards?

31

docs/dashboards-and-charts/events-feed.md

+2 -2

@@ -49,8 +49,8 @@ At a high-level view, these are the domains from which the Events feed will prov

49 | Node Removed | The node was removed from the Space, for example by using the `Delete` action on the node. This is a soft delete in that the node gets marked as deleted, but retains the association with this space. If it becomes live again, it will be restored (see `Node Restored` below) and reappear in this space as before. | Node `ip-xyz.ec2.internal` was **deleted (soft)** |

50 | Node Restored | The node was restored. See `Node Removed` above. | Node `ip-xyz.ec2.internal` was **restored** |

51 | Node Deleted | The node was deleted from the Space. This is a hard delete and no information on the node is retained. | Node `ip-xyz.ec2.internal` was **deleted (hard)** |

52 -| Agent Connected | The agent connected to the Cloud MQTT server (Agent-Cloud Link established). These events can only be seen on _All nodes_ Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has connected to Cloud. |

53 -| Agent Disconnected | The agent disconnected from the Cloud MQTT server (Agent-Cloud Link severed). These events can only be seen on _All nodes_ Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has disconnected from Cloud: **Connection Timeout**. |

52 +| Agent Connected | The Agent connected to the Cloud MQTT server (Agent-Cloud Link established). These events can only be seen on _All nodes_ Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has connected to Cloud. |

53 +| Agent Disconnected | The Agent disconnected from the Cloud MQTT server (Agent-Cloud Link severed). These events can only be seen on _All nodes_ Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has disconnected from Cloud: **Connection Timeout**. |

54 | Space Statistics | Daily snapshot of space node statistics. These events can only be seen on _All nodes_ Room. | Space statistics. Nodes: **22 live**, **21 stale**, **18 removed**, **61 total**. |

55

56 ### Alert events

docs/dashboards-and-charts/netdata-charts.md

+1 -1

@@ -274,7 +274,7 @@ Finally, you can reset everything to its defaults by clicking the green "Reset"

274

275 ## Anomaly Rate ribbon

276

277 -Netdata's unsupervised machine learning algorithm creates a unique model for each metric collected by your agents, using exclusively the metric's past data.

277 +Netdata's unsupervised machine learning algorithm creates a unique model for each metric collected by your Agents, using exclusively the metric's past data.

278 It then uses these unique models during data collection to predict the value that should be collected and check if the collected value is within the range of acceptable values based on past patterns and behavior.

279

280 If the value collected is an outlier, it is marked as anomalous.

docs/developer-and-contributor-corner/style-guide.md

+1 -2

@@ -160,8 +160,7 @@ capitalization. In summary:

160 Docker, Apache, NGINX)

161 - Avoid camel case (NetData) or all caps (NETDATA).

162

163 -Whenever you refer to the company Netdata, Inc., or the open-source monitoring agent the company develops, capitalize

164 -**Netdata**.

163 +Whenever you refer to the company Netdata, Inc., or the open-source monitoring Agent the company develops, capitalize both words.

164

165 However, if you are referring to a process, user, or group on a Linux system, use lowercase and fence the word in an

166 inline code block: `` `netdata` ``.

docs/glossary.md

+1 -1

@@ -128,7 +128,7 @@ metrics, troubleshoot complex performance problems, and make data interoperable

128

129 ## S

130

131 -- [**Single Node Dashboard**](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md): A dashboard pre-configured with every installation of the Netdata agent, with thousand of metrics and hundreds of interactive charts that requires no set up.

131 +- [**Single Node Dashboard**](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md): A dashboard pre-configured with every installation of the Netdata Agent, with thousand of metrics and hundreds of interactive charts that requires no set up.

132

133 - [**Space**](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-spaces): A high-level container and virtual collaboration area where you can organize team members, access levels,and the nodes you want to monitor.

134

docs/netdata-agent/README.md

+4 -4

@@ -59,7 +59,7 @@ stateDiagram-v2

59 6. **Check**: a health engine, triggering alerts and sending notifications. Netdata comes with hundreds of alert configurations that are automatically attached to metrics when they get collected, detecting errors, common configuration errors and performance issues.

60 7. **Query**: a query engine for querying time-series data.

61 8. **Score**: a scoring engine for comparing and correlating metrics.

62 -9. **Stream**: a mechanism to connect Netdata agents and build Metrics Centralization Points (Netdata Parents).

62 +9. **Stream**: a mechanism to connect Netdata Agents and build Metrics Centralization Points (Netdata Parents).

63 10. **Visualize**: Netdata's fully automated dashboards for all metrics.

64 11. **Export**: export metric samples to 3rd party time-series databases, enabling the use of 3rd party tools for visualization, like Grafana.

65

@@ -77,8 +77,8 @@ stateDiagram-v2

77

78 ## Dashboard Versions

79

80 -The Netdata agents (Standalone, Children and Parents) **share the dashboard** of Netdata Cloud. However, when the user is logged in and the Netdata agent is connected to Netdata Cloud, the following are enabled (which are otherwise disabled):

80 +The Netdata Agents (Standalone, Children and Parents) **share the dashboard** of Netdata Cloud. However, when the user is logged in and the Agent is connected to the Cloud, the following are enabled (which are otherwise disabled):

81

82 -1. **Access to Sensitive Data**: Some data, like systemd-journal logs and several [Top Monitoring](/docs/top-monitoring-netdata-functions.md) features expose sensitive data, like IPs, ports, process command lines and more. To access all these when the dashboard is served directly from a Netdata agent, Netdata Cloud is required to verify that the user accessing the dashboard has the required permissions.

82 +1. **Access to Sensitive Data**: Some data, like systemd-journal logs and several [Top Monitoring](/docs/top-monitoring-netdata-functions.md) features expose sensitive data, like IPs, ports, process command lines and more. To access all these when the dashboard is served directly from an Agent, Netdata Cloud is required to verify that the user accessing the dashboard has the required permissions.

83

84 -2. **Dynamic Configuration**: Netdata agents are configured via configuration files, manually or through some provisioning system. The latest Netdata includes a feature to allow users to change some configurations (collectors, alerts) via the dashboard. This feature is only available to users of paid Netdata Cloud plan.

84 +2. **Dynamic Configuration**: Netdata Agents are configured via configuration files, manually or through some provisioning system. The latest Netdata includes a feature to allow users to change some configurations (collectors, alerts) via the dashboard. This feature is only available to users of paid Netdata Cloud plan.

docs/netdata-agent/backup-and-restore-an-agent.md

+4 -4

@@ -34,18 +34,18 @@ In this standard scenario, you’re backing up your Netdata Agent in case of a n

34 sudo tar -cvpzf netdata_backup.tar.gz /etc/netdata/ /var/cache/netdata /var/lib/netdata

35 ```

36

37 - Stopping the Netdata agent is typically necessary to back up the database files of the Netdata Agent.

37 + Stopping the Netdata Agent is typically necessary to back up the database files of the Netdata Agent.

38

39 If you want to minimize the gap in metrics caused by stopping the Netdata Agent, consider implementing a backup job or script that follows this sequence:

40

41 - Backup the Agent configuration Identity directories

42 - Stop the Netdata service

43 - Backup up the database files

44 -- Restart the netdata agent.

44 +- Restart the Netdata Agent.

45

46 ### Restoring Netdata

47

48 -1. Ensure that the Netdata agent is installed and is [stopped](/docs/netdata-agent/start-stop-restart.md)

48 +1. Ensure that the Netdata Agent is installed and is [stopped](/docs/netdata-agent/start-stop-restart.md)

49

50 If you plan to deploy the Agent and restore a backup on top of it, then you might find it helpful to use the [`--dont-start-it`](/packaging/installer/methods/kickstart.md#other-options) option upon installation.

51

@@ -66,4 +66,4 @@ If you want to minimize the gap in metrics caused by stopping the Netdata Agent,

66 sudo tar -xvpzf /path/to/netdata_backup.tar.gz -C /

67 ```

68

69 -3. [Start the Netdata agent](/docs/netdata-agent/start-stop-restart.md)

69 +3. [Start the Netdata Agent](/docs/netdata-agent/start-stop-restart.md)

docs/netdata-agent/configuration/anonymous-telemetry-events.md

+3 -4

@@ -1,7 +1,6 @@

1 # Anonymous telemetry events

2

3 -By default, Netdata collects anonymous usage information from the open-source monitoring agent. For agent events like start, stop, crash, etc. we use our own cloud function in GCP. For frontend telemetry (page views etc.) on the agent dashboard itself, we use the open-source

4 -product analytics platform [PostHog](https://github.com/PostHog/posthog).

3 +By default, Netdata collects anonymous usage information from the open-source monitoring Agent. For events like start, stop, crash, etc. we use our own cloud function in GCP. For frontend telemetry (page views etc.) on the dashboard itself, we use the open-source product analytics platform [PostHog](https://github.com/PostHog/posthog).

4

5 We are strongly committed to your [data privacy](https://netdata.cloud/privacy/).

6

@@ -10,7 +9,7 @@ We use the statistics gathered from this information for two purposes:

9 1. **Quality assurance**, to help us understand if Netdata behaves as expected, and to help us classify repeated

10 issues with certain distributions or environments.

11

13 -2. **Usage statistics**, to help us interpret how people use the Netdata agent in real-world environments, and to help

12 +2. **Usage statistics**, to help us interpret how people use the Netdata Agent in real-world environments, and to help

13 us identify how our development/design decisions influence the community.

14

15 Netdata collects usage information via two different channels:

@@ -59,7 +58,7 @@ filename and source code line number of the fatal error.

58 Starting with v1.21, we additionally collect information about:

59

60 - Failures to build the dependencies required to use Cloud features.

62 -- Unavailability of Cloud features in an agent.

61 +- Unavailability of Cloud features in an Agent.

62 - Failures to connect to the Cloud in case the [connection process](/src/claim/README.md) has been completed. This includes error codes

63 to inform the Netdata team about the reason why the connection failed.

64

docs/netdata-agent/configuration/optimize-the-netdata-agents-performance.md

+3 -3

@@ -26,7 +26,7 @@ The following table summarizes the effect of each optimization on the CPU, RAM a

29 -| [Disable/lower gzip compression for the agent dashboard](#disablelower-gzip-compression-for-the-dashboard) | :heavy_check_mark: | | |

29 +| [Disable/lower gzip compression for the Agent dashboard](#disablelower-gzip-compression-for-the-dashboard) | :heavy_check_mark: | | |

30

31 ## Resources required by a default Netdata installation

32

@@ -62,7 +62,7 @@ To reduce CPU usage, you can (either one or a combination of the following actio

62 3. [Reduce the data collection frequency](#reduce-collection-frequency)

63 4. [Disable unneeded plugins or collectors](#disable-unneeded-plugins-or-collectors)

64 5. [Use a reverse proxy](#run-netdata-behind-a-proxy),

65 -6. [Disable/lower gzip compression for the agent dashboard](#disablelower-gzip-compression-for-the-dashboard).

65 +6. [Disable/lower gzip compression for the Agent dashboard](#disablelower-gzip-compression-for-the-dashboard).

66

67 ### Memory consumption

68

@@ -111,7 +111,7 @@ using [streaming and replication](/docs/observability-centralization-points/READ

111 ### Disable health checks on the child nodes

112

113 When you set up streaming, we recommend you run your health checks on the parent. This saves resources on the children

114 -and makes it easier to configure or disable alerts and agent notifications.

114 +and makes it easier to configure or disable alerts and Agent notifications.

115

116 The parents by default run health checks for each child, as long as the child is connected (the details are

117 in `stream.conf`). On the child nodes you should add to `netdata.conf` the following:

docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md

+1 -2

@@ -17,8 +17,7 @@ With these defaults, Netdata requires approximately 4 GiB of storage space (incl

17

18 ## Retention Settings

19

20 -> **In a parent-child setup**, these settings manage the shared storage space used by the Netdata parent agent for

21 -> storing metrics collected by both the parent and its child nodes.

20 +> **In a parent-child setup**, these settings manage the shared storage space used by the Netdata parent Agent for storing metrics collected by both the parent and its child nodes.

21

22 You can fine-tune retention for each tier by setting a time limit or size limit. Setting a limit to 0 disables it,

23 allowing for no time-based deletion for that tier or using all available space, respectively. This enables various

docs/netdata-agent/configuration/organize-systems-metrics-and-alerts.md

+2 -3

@@ -104,8 +104,7 @@ can reload labels using the helpful `netdatacli` tool:

104 netdatacli reload-labels

105 ```

106

107 -Your host labels will now be enabled. You can double-check these by using `curl http://HOST-IP:19999/api/v1/info` to

108 -read the status of your agent. For example, from a VPS system running Debian 10:

107 +Your host labels will now be enabled. You can double-check these by using `curl http://HOST-IP:19999/api/v1/info` to read the status of your Agent. For example, from a VPS system running Debian 10:

108

109 ```json

110 {

@@ -232,7 +231,7 @@ All go.d plugin collectors support the specification of labels at the "collectio

231 labels (e.g. generic Prometheus collector, Kubernetes, Docker and more). But you can also add your own custom labels by configuring

232 the data collection jobs.

233

235 -For example, suppose we have a single Netdata agent, collecting data from two remote Apache web servers, located in different data centers.

234 +For example, suppose we have a single Netdata Agent, collecting data from two remote Apache web servers, located in different data centers.

235 The web servers are load balanced and provide access to the service "Payments".

236

237 You can define the following in `go.d.conf`, to be able to group the web requests by service or location:

docs/netdata-agent/configuration/running-the-netdata-agent-behind-a-reverse-proxy/README.md

+1 -1

@@ -1,6 +1,6 @@

1 # Running the Netdata Agent behind a reverse proxy

2

3 -If you need to access a Netdata agent's user interface or API in a production environment we recommend you put Netdata behind

3 +If you need to access a Netdata Agent's user interface or API in a production environment we recommend you put Netdata behind

4 another web server and secure access to the dashboard via SSL, user authentication and firewall rules.

5

6 A dedicated web server also provides more robustness and capabilities than the Agent's [internal web server](/src/web/README.md).

docs/netdata-agent/sizing-netdata-agents/bandwidth-requirements.md

+1 -1

@@ -44,4 +44,4 @@ The information transferred to Netdata Cloud is:

44

45 This is not a constant stream of information. Netdata Agents update Netdata Cloud only about status changes on all the above (e.g., an alert being triggered, or a metric stopped being collected). So, there is an initial handshake and exchange of information when Netdata starts, and then there only updates when required.

46

47 -Of course, when you view Netdata Cloud dashboards that need to query the database a Netdata agent maintains, this query is forwarded to an agent that can satisfy it. This means that Netdata Cloud receives metric samples only when a user is accessing a dashboard and the samples transferred are usually aggregations to allow rendering the dashboards.

47 +Of course, when you view Netdata Cloud dashboards that need to query the database a Netdata Agent maintains, this query is forwarded to an Agent that can satisfy it. This means that Netdata Cloud receives metric samples only when a user is accessing a dashboard and the samples transferred are usually aggregations to allow rendering the dashboards.

docs/netdata-cloud/README.md

+19 -19

@@ -37,7 +37,7 @@ flowchart TB

37 NC <-->|secure connection| Agents

38 ```

39

40 -Netdata Cloud provides the following features, on top of what the Netdata agents already provide:

40 +Netdata Cloud provides the following features, on top of what the Netdata Agents already provide:

41

42 1. **Horizontal scalability**: Netdata Cloud allows scaling the observability infrastructure horizontally, by adding more independent Netdata Parents and Children. It can aggregate such, otherwise independent, observability islands into one uniform and integrated infrastructure.

43

@@ -45,11 +45,11 @@ Netdata Cloud provides the following features, on top of what the Netdata agents

45

46 2. **Role Based Access Control (RBAC)**: Netdata Cloud has all the mechanisms for user-management and access control. It allows assigning all users a role, segmenting the infrastructure into rooms, and associating Rooms with roles and users.

47

48 -3. **Access from anywhere**: Netdata agents are installed on-prem and this is where all your data are always stored. Netdata Cloud allows querying all the Netdata agents (Standalone, Children and Parents) in real-time when dashboards are accessed via Netdata Cloud.

48 +3. **Access from anywhere**: Netdata Agents are installed on-prem and this is where all your data are always stored. Netdata Cloud allows querying all the Netdata Agents (Standalone, Children and Parents) in real-time when dashboards are accessed via Netdata Cloud.

49

50 This enables a much simpler access control, eliminating the complexities of setting up VPNs to access observability, and the bandwidth costs for centralizing all metrics to one place.

51

52 -4. **Central dispatch of alert notifications**: Netdata Cloud allows controlling the dispatch of alert notifications centrally. By default, all Netdata agents (Standalone, Children and Parents) send their own notifications. This becomes increasingly complex as the infrastructure grows. So, Netdata Cloud steps in to simplify this process and provide central control of all notifications.

52 +4. **Central dispatch of alert notifications**: Netdata Cloud allows controlling the dispatch of alert notifications centrally. By default, all Netdata Agents (Standalone, Children and Parents) send their own notifications. This becomes increasingly complex as the infrastructure grows. So, Netdata Cloud steps in to simplify this process and provide central control of all notifications.

53

54 Netdata Cloud also enables the use of the **Netdata Mobile App** offering mobile push notifications for all users in commercial plans.

55

@@ -61,18 +61,18 @@ Netdata Cloud provides the following features, on top of what the Netdata agents

61

62 ## Data Exposed to Netdata Cloud

63

64 -Netdata is thin layer of top of Netdata agents. It does not receive the samples collected, or the logs Netdata agents maintain.

64 +Netdata is thin layer of top of Netdata Agents. It does not receive the samples collected, or the logs Netdata Agents maintain.

65

66 This is a key design decision for Netdata. If we were centralizing metric samples and logs, Netdata would have the same constrains and cost structure other observability solutions have, and we would be forced to lower metrics resolution, filter out metrics and eventually increase significantly the cost of observability.

67

68 Instead, Netdata Cloud receives and stores only metadata related to the metrics collected, such as the nodes collecting metrics and their labels, the metric names, their labels and their retention, the data collection plugins and modules running, the configured alerts and their transitions.

69

70 -This information is a small fraction of the total information maintained by Netdata agents, allowing Netdata Cloud to remain high-resolution, high-fidelity and real-time, while being able to:

70 +This information is a small fraction of the total information maintained by Netdata Agents, allowing Netdata Cloud to remain high-resolution, high-fidelity and real-time, while being able to:

71

72 - dispatch alerts centrally for all alert transitions.

73 -- know which Netdata agents to query when users view the dashboards.

73 +- know which Netdata Agents to query when users view the dashboards.

74

75 -Metric samples and logs are transferred via Netdata Cloud to your Web Browser, only when you view them via Netdata Cloud. And even then, Netdata Cloud does not store this information. It only aggregates the responses of multiple Netdata agents to a single response for your web browser to visualize.

75 +Metric samples and logs are transferred via Netdata Cloud to your Web Browser, only when you view them via Netdata Cloud. And even then, Netdata Cloud does not store this information. It only aggregates the responses of multiple Netdata Agents to a single response for your web browser to visualize.

76

77 ## High-Availability

78

@@ -80,38 +80,38 @@ You can subscribe to Netdata Cloud updates at the [Netdata Cloud Status](https:/

80

81 Netdata Cloud is a highly available, auto-scalable solution, however being a monitoring solution, we need to ensure dashboards are accessible during crisis.

82

83 -Netdata agents provide the same dashboard Netdata Cloud provides, with the following limitations:

83 +Netdata Agents provide the same dashboard Netdata Cloud provides, with the following limitations:

84

85 -1. Netdata agents (Children and Parents) dashboards are limited to their databases, while on Netdata Cloud the dashboard presents the entire infrastructure, from all Netdata agents connected to it.

85 +1. Netdata Agents (Children and Parents) dashboards are limited to their databases, while on Netdata Cloud the dashboard presents the entire infrastructure, from all Netdata Agents connected to it.

86

87 -2. When you are not logged-in or the agent is not connected to Netdata Cloud, certain features of the Netdata agent dashboard will not be available.

87 +2. When you are not logged-in or the Agent is not connected to Netdata Cloud, certain features of the Netdata Agent dashboard will not be available.

88

89 - When you are logged-in and the agent is connected to Netdata Cloud, the agent dashboard has the same functionality as Netdata Cloud.

89 + When you are logged-in and the Agent is connected to Netdata Cloud, the dashboard has the same functionality as Netdata Cloud.

90

91 -To ensure dashboard high availability, Netdata agent dashboards are available by directly accessing them, even when the connectivity between Children and Parents or Netdata Cloud faces issues. This allows the use of the individual Netdata agents' dashboards during crisis, at different levels of aggregation.

91 +To ensure dashboard high availability, Netdata Agent dashboards are available by directly accessing them, even when the connectivity between Children and Parents or Netdata Cloud faces issues. This allows the use of the individual Netdata Agents' dashboards during crisis, at different levels of aggregation.

92

93 ## Fidelity and Insights

94

95 -Netdata Cloud queries Netdata agents, so it provides exactly the same fidelity and insights Netdata agents provide. Dashboards have the same resolution, the same number of metrics, exactly the same data.

95 +Netdata Cloud queries Netdata Agents, so it provides exactly the same fidelity and insights Netdata Agents provide. Dashboards have the same resolution, the same number of metrics, exactly the same data.

96

97 ## Performance

98

99 -The Netdata agent and Netdata Cloud have similar query performance, but there are additional network latencies involved when the dashboards are viewed via Netdata Cloud.

99 +The Netdata Agent and Netdata Cloud have similar query performance, but there are additional network latencies involved when the dashboards are viewed via Netdata Cloud.

100

101 -Accessing Netdata agents on the same LAN has marginal network latency and their response time is only affected by the queries. However, accessing the same Netdata agents via Netdata Cloud has a bigger network round-trip time, that looks like this:

101 +Accessing Netdata Agents on the same LAN has marginal network latency and their response time is only affected by the queries. However, accessing the same Netdata Agents via Netdata Cloud has a bigger network round-trip time, that looks like this:

102

103 1. Your web browser makes a request to Netdata Cloud.

104 -2. Netdata Cloud sends the request to your Netdata agents. If multiple Netdata agents are involved, they are queried in parallel.

104 +2. Netdata Cloud sends the request to your Netdata Agents. If multiple Netdata Agents are involved, they are queried in parallel.

105 3. Netdata Cloud receives their responses and aggregates them into a single response.

106 4. Netdata Cloud replies to your web browser.

107

108 -If you are sitting on the same LAN as the Netdata agents, the latency will be 2 times the round-trip network latency between this LAN and Netdata Cloud.

108 +If you are sitting on the same LAN as the Netdata Agents, the latency will be 2 times the round-trip network latency between this LAN and Netdata Cloud.

109

110 -However, when there are multiple Netdata agents involved, the queries will be faster compared to a monitoring solution that has one centralization point. Netdata Cloud splits each query into multiple parts and each of the Netdata agents involved will only perform a small part of the original query. So, when querying a large infrastructure, you enjoy the performance of the combined power of all your Netdata agents, which is usually quite higher than any single-centralization-point monitoring solution.

110 +However, when there are multiple Netdata Agents involved, the queries will be faster compared to a monitoring solution that has one centralization point. Netdata Cloud splits each query into multiple parts and each of the Netdata Agents involved will only perform a small part of the original query. So, when querying a large infrastructure, you enjoy the performance of the combined power of all your Netdata Agents, which is usually quite higher than any single-centralization-point monitoring solution.

111

112 ## Does Netdata Cloud require Observability Centralization Points?

113

114 -No. Any or all Netdata agents can be connected to Netdata Cloud.

114 +No. Any or all Netdata Agents can be connected to Netdata Cloud.

115

116 We recommend to create [observability centralization points](/docs/observability-centralization-points/README.md), as required for operational efficiency (ephemeral nodes, teams or services isolation, central control of alerts, production systems performance), security policies (internet isolation), or cost optimization (use existing capacities before allocating new ones).

117

docs/netdata-cloud/authentication-and-authorization/api-tokens.md

+1 -1

@@ -14,7 +14,7 @@ The API Tokens are not going to expire and can be limited to a few scopes:

14

15 * `scope:agent-ui`

16

17 - this token is mainly used by the local Netdata agent accessing the Cloud UI

17 + this token is mainly used by the local Netdata Agent accessing the Cloud UI

18

19 * `scope:grafana-plugin`

20

docs/netdata-cloud/netdata-cloud-on-prem/README.md

+2 -2

@@ -6,7 +6,7 @@ The overall architecture looks like this:

6

7 ```mermaid

8 flowchart TD

9 - agents("🌍 Netdata Agents Users' infrastructure Netdata Children & Parents")

9 + Agents("🌍 Netdata Agents Users' infrastructure Netdata Children & Parents")

10 users[["🔥 Unified Dashboards Integrated Infrastructure Dashboards"]]

11 ingress("🛡️ Ingress Gateway TLS termination")

12 traefik((("🔒 Traefik Authentication & Authorization")))

@@ -15,7 +15,7 @@ flowchart TD

15 frontend("🌐 Front-End Static Web Files")

16 auth("👨‍💼 Users & Agents Authorization Microservices")

17 spaceroom("🏡 Spaces, Rooms, Nodes, Settings Microservices for managing Spaces, Rooms, Nodes and related settings")

18 - charts("📈 Metrics & Queries Microservices for dispatching queries to Netdata agents")

18 + charts("📈 Metrics & Queries Microservices for dispatching queries to Netdata Agents")

19 alerts("🔔 Alerts & Notifications Microservices for tracking alert transitions and deduplicating alerts")

20 sql[("✨ PostgreSQL Users, Spaces, Rooms, Agents, Nodes, Metric Names, Metrics Retention, Custom Dashboards, Settings")]

21 redis[("🗒️ Redis Caches needed by Microservices")]

docs/netdata-cloud/netdata-cloud-on-prem/installation.md

+21 -21

@@ -123,36 +123,36 @@ Responsible for user registration & authentication. Manages user account informa

123

124 ### cloud-agent-data-ctrl-service

125

126 -Forwards request from the Cloud to the relevant agents.

126 +Forwards request from the Cloud to the relevant Agents.

127 The requests include:

128

129 -- Fetching chart metadata from the agent

130 -- Fetching chart data from the agent

131 -- Fetching function data from the agent

129 +- Fetching chart metadata from the Agent

130 +- Fetching chart data from the Agent

131 +- Fetching function data from the Agent

132

133 ### cloud-agent-mqtt-input-service

134

135 -Forwards MQTT messages emitted by the agent related to the agent entities to the internal Pulsar broker. These include agent connection state updates.

135 +Forwards MQTT messages emitted by the Agent related to the Agent entities to the internal Pulsar broker. These include Agent connection state updates.

136

137 ### cloud-agent-mqtt-output-service

138

139 -Forwards Pulsar messages emitted in the Cloud related to the agent entities to the MQTT broker. From there, the messages reach the relevant agent.

139 +Forwards Pulsar messages emitted in the Cloud related to the Agent entities to the MQTT broker. From there, the messages reach the relevant Agent.

140

141 ### cloud-alarm-config-mqtt-input-service

142

143 -Forwards MQTT messages emitted by the agent related to the alarm-config entities to the internal Pulsar broker. These include the data for the alarm configuration as seen by the agent.

143 +Forwards MQTT messages emitted by the Agent related to the alarm-config entities to the internal Pulsar broker. These include the data for the alarm configuration as seen by the Agent.

144

145 ### cloud-alarm-log-mqtt-input-service

146

147 -Forwards MQTT messages emitted by the agent related to the alarm-log entities to the internal Pulsar broker. These contain data about the alarm transitions that occurred in an agent.

147 +Forwards MQTT messages emitted by the Agent related to the alarm-log entities to the internal Pulsar broker. These contain data about the alarm transitions that occurred in an Agent.

148

149 ### cloud-alarm-mqtt-output-service

150

151 -Forwards Pulsar messages emitted in the Cloud related to the alarm entities to the MQTT broker. From there, the messages reach the relevant agent.

151 +Forwards Pulsar messages emitted in the Cloud related to the alarm entities to the MQTT broker. From there, the messages reach the relevant Agent.

152

153 ### cloud-alarm-processor-service

154

155 -Persists latest alert statuses received from the agent in the Cloud.

155 +Persists latest alert statuses received from the Agent in the Cloud.

156 Aggregates alert statuses from relevant node instances.

157 Exposes API endpoints to fetch alert data for visualization on the Cloud.

158 Determines if notifications need to be sent when alert statuses change and emits relevant messages to Pulsar.

@@ -160,22 +160,22 @@ Exposes API endpoints to store and return notification-silencing data.

160

161 ### cloud-alarm-streaming-service

162

163 -Responsible for starting the alert stream between the agent and the Cloud.

163 +Responsible for starting the alert stream between the Agent and the Cloud.

164 Ensures that messages are processed in the correct order, and starts a reconciliation process between the Cloud and the Agent if out-of-order processing occurs.

165

166 ### cloud-charts-mqtt-input-service

167

168 -Forwards MQTT messages emitted by the agent related to the chart entities to the internal Pulsar broker. These include the chart metadata that is used to display relevant charts on the Cloud.

168 +Forwards MQTT messages emitted by the Agent related to the chart entities to the internal Pulsar broker. These include the chart metadata that is used to display relevant charts on the Cloud.

169

170 ### cloud-charts-mqtt-output-service

171

172 -Forwards Pulsar messages emitted in the Cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant agent.

172 +Forwards Pulsar messages emitted in the Cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant Agent.

173

174 ### cloud-charts-service

175

176 Exposes API endpoints to fetch the chart metadata.

177 -Forwards data requests via the `cloud-agent-data-ctrl-service` to the relevant agents to fetch chart data points.

178 -Exposes API endpoints to call various other endpoints on the agent, for instance, functions.

177 +Forwards data requests via the `cloud-agent-data-ctrl-service` to the relevant Agents to fetch chart data points.

178 +Exposes API endpoints to call various other endpoints on the Agent, for instance, functions.

179

180 ### cloud-custom-dashboard-service

181

@@ -183,8 +183,8 @@ Exposes API endpoints to fetch and store custom dashboard data.

183

184 ### cloud-environment-service

185

186 -Serves as the first contact point between the agent and the Cloud.

187 -Returns authentication and MQTT endpoints to connecting agents.

186 +Serves as the first contact point between the Agent and the Cloud.

187 +Returns authentication and MQTT endpoints to connecting Agents.

188

189 ### cloud-feed-service

190

@@ -209,11 +209,11 @@ Exposes API endpoints to fetch a human-friendly explanation of various netdata c

209

210 ### cloud-node-mqtt-input-service

211

212 -Forwards MQTT messages emitted by the agent related to the node entities to the internal Pulsar broker. These include the node metadata as well as their connectivity state, either direct or via parents.

212 +Forwards MQTT messages emitted by the Agent related to the node entities to the internal Pulsar broker. These include the node metadata as well as their connectivity state, either direct or via parents.

213

214 ### cloud-node-mqtt-output-service

215

216 -Forwards Pulsar messages emitted in the Cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant agent.

216 +Forwards Pulsar messages emitted in the Cloud related to the charts entities to the MQTT broker. From there, the messages reach the relevant Agent.

217

218 ### cloud-notifications-dispatcher-service

219

@@ -222,6 +222,6 @@ Handles incoming notification messages and uses the relevant channels(email, sla

222

223 ### cloud-spaceroom-service

224

225 -Exposes API endpoints to fetch and store relations between agents, nodes, spaces, users, and rooms.

225 +Exposes API endpoints to fetch and store relations between Agents, nodes, spaces, users, and rooms.

226 Acts as a provider of authorization for other Cloud endpoints.

227 -Exposes API endpoints to authenticate agents connecting to the Cloud.

227 +Exposes API endpoints to authenticate Agents connecting to the Cloud.

docs/netdata-cloud/netdata-cloud-on-prem/troubleshooting.md

+4 -4

@@ -8,19 +8,19 @@ The following are questions that are usually asked by Netdata Cloud On-Prem oper

8

9 ## Loading charts takes a long time or ends with an error

10

11 -The charts service is trying to collect data from the agents involved in the query. In most of the cases, this microservice queries many agents (depending on the Room), and all of them have to reply for the query to be satisfied.

11 +The charts service is trying to collect data from the Agents involved in the query. In most of the cases, this microservice queries many Agents (depending on the Room), and all of them have to reply for the query to be satisfied.

12

13 One or more of the following may be the cause:

14

15 1. **Slow Netdata Agent or Netdata Agents with unreliable connections**

16

17 - If any of the Netdata agents queried is slow or has an unreliable network connection, the query will stall and Netdata Cloud will have timeout before responding.

17 + If any of the Netdata Agents queried is slow or has an unreliable network connection, the query will stall and Netdata Cloud will have timeout before responding.

18

19 - When agents are overloaded or have unreliable connections, we suggest to install more Netdata Parents for providing reliable backends to Netdata Cloud. They will automatically be preferred for all queries, when available.

19 + When Agents are overloaded or have unreliable connections, we suggest to install more Netdata Parents for providing reliable backends to Netdata Cloud. They will automatically be preferred for all queries, when available.

20

21 2. **Poor Kubernetes cluster management**

22

23 - Another common issue is poor management of the Kubernetes cluster. When a node of a Kubernetes cluster is saturated, or the limits set to its containers are small, Netdata Cloud microservices get throttled by Kubernetes and does not get the resources required to process the responses of Netdata agents and aggregate the results for the dashboard.

23 + Another common issue is poor management of the Kubernetes cluster. When a node of a Kubernetes cluster is saturated, or the limits set to its containers are small, Netdata Cloud microservices get throttled by Kubernetes and does not get the resources required to process the responses of Netdata Agents and aggregate the results for the dashboard.

24

25 We recommend to review the throttling of the containers and increase the limits if required.

26

docs/netdata-cloud/versions.md

+1 -1

@@ -12,7 +12,7 @@ For more information check our [Pricing](https://www.netdata.cloud/pricing/) pag

12

13 ## SaaS Version

14

15 -[Sign-up to Netdata Cloud](https://app.netdata.cloud) and start connecting your Netdata agents. The commands provided once you have signed up, include all the information to install and automatically connect (claim) Netdata agents to your Netdata Cloud space.

15 +[Sign-up to Netdata Cloud](https://app.netdata.cloud) and start connecting your Netdata Agents. The commands provided once you have signed up, include all the information to install and automatically connect (claim) Netdata Agents to your Netdata Cloud space.

16

17 ## On-Prem Version

18

docs/observability-centralization-points/best-practices.md

+2 -2

@@ -32,8 +32,8 @@ Compared to other observability solutions, the design of Netdata offers:

32

33 - **Optimized Cost and Performance**: By distributing the load across multiple centralization points, Netdata can optimize both performance and cost. This distribution allows for the efficient use of resources and help mitigate the bottlenecks associated with a single centralization point.

34

35 -- **Simplicity**: Netdata agents (Children and Parents) require minimal configuration and maintenance, usually less than the configuration and maintenance required for the agents and exporters of other monitoring solutions. This provides an observability pipeline that has less moving parts and is easier to manage and maintain.

35 +- **Simplicity**: Netdata Agents (Children and Parents) require minimal configuration and maintenance, usually less than the configuration and maintenance required for the Agents and exporters of other monitoring solutions. This provides an observability pipeline that has less moving parts and is easier to manage and maintain.

36

37 -- **Always On-Prem**: Netdata centralization points are always on-prem. Even when Netdata Cloud is used, Netdata agents and parents are queried to provide the data required for the dashboards.

37 +- **Always On-Prem**: Netdata centralization points are always on-prem. Even when Netdata Cloud is used, Netdata Agents and parents are queried to provide the data required for the dashboards.

38

39 - **Bottom-Up Observability**: Netdata is designed to monitor systems, containers and applications bottom-up, aiming to provide the maximum resolution, visibility, depth and insights possible. Its ability to segment the infrastructure into multiple independent observability centralization points with customized retention, machine learning and alerts on each of them, while providing unified infrastructure level dashboards at Netdata Cloud, provides a flexible environment that can be tailored per service or team, while still being one unified infrastructure.

docs/observability-centralization-points/metrics-centralization-points/configuration.md

+1 -1

@@ -2,7 +2,7 @@

2

3 Metrics streaming configuration for both Netdata Children and Parents is done via `stream.conf`.

4

5 -`netdata.conf` and `stream.conf` have the same `ini` format, but `netdata.conf` is considered a non-sensitive file, while `stream.conf` contains API keys, IPs and other sensitive information that enable communication between Netdata agents.

5 +`netdata.conf` and `stream.conf` have the same `ini` format, but `netdata.conf` is considered a non-sensitive file, while `stream.conf` contains API keys, IPs and other sensitive information that enable communication between Netdata Agents.

6

7 `stream.conf` has 2 main sections:

8

docs/observability-centralization-points/metrics-centralization-points/faq.md

+4 -4

@@ -49,9 +49,9 @@ Check [Restoring a Netdata Parent after maintenance](/docs/observability-central

49

50 When there are multiple data sources for the same node, Netdata Cloud follows this strategy:

51

52 -1. Netdata Cloud prefers Netdata agents having `live` data.

53 -2. For time-series queries, when multiple Netdata agents have the retention required to answer the query, Netdata Cloud prefers the one that is further away from production systems.

54 -3. For Functions, Netdata Cloud prefers Netdata agents that are closer to the production systems.

52 +1. Netdata Cloud prefers Netdata Agents having `live` data.

53 +2. For time-series queries, when multiple Netdata Agents have the retention required to answer the query, Netdata Cloud prefers the one that is further away from production systems.

54 +3. For Functions, Netdata Cloud prefers Netdata Agents that are closer to the production systems.

55

56 ## Is there a way to balance child nodes to the parent nodes of a cluster?

57

@@ -69,7 +69,7 @@ To set the ephemeral flag on a node, edit its netdata.conf and in the `[global]`

69

70 A parent node tracks connections and disconnections. When a node is marked as ephemeral and stops connecting for more than 24 hours, the parent will delete it from its memory and local administration, and tell Cloud that it is no longer live nor stale. Data for the node can no longer be accessed, but if the node connects again later, the node will be "revived", and previous data becomes available again.

71

72 -A node can be forced into this "forgotten" state with the Netdata CLI tool on the parent the node is connected to (if still connected) or one of the parent agents it was previously connected to. The state will be propagated _upwards_ and _sideways_ in case of an HA setup.

72 +A node can be forced into this "forgotten" state with the Netdata CLI tool on the parent the node is connected to (if still connected) or one of the parent Agents it was previously connected to. The state will be propagated _upwards_ and _sideways_ in case of an HA setup.

73

74 ```

75 netdatacli remove-stale-node <node_id | machine_guid | hostname | ALL_NODES>

docs/observability-centralization-points/metrics-centralization-points/sizing-netdata-parents.md

+1 -1

@@ -1,3 +1,3 @@

1 # Sizing Netdata Parents

2

3 -To estimate CPU, RAM, and disk requirements for your Netdata Parents, check [sizing Netdata agents](/docs/netdata-agent/sizing-netdata-agents/README.md).

3 +To estimate CPU, RAM, and disk requirements for your Netdata Parents, check [sizing Netdata Agents](/docs/netdata-agent/sizing-netdata-agents/README.md).

docs/security-and-privacy-design/README.md

+3 -3

@@ -28,7 +28,7 @@ Netdata is committed to adhering to the best practices laid out by the Open Sour

28 Currently, the Netdata Agent follows the OSSF best practices at the passing level. Feel free to audit our approach to

29 the [OSSF guidelines](https://bestpractices.coreinfrastructure.org/en/projects/2231)

30

31 -Netdata Cloud boasts of comprehensive end-to-end automated testing, encompassing the UI, back-end, and agents, where

31 +Netdata Cloud boasts of comprehensive end-to-end automated testing, encompassing the UI, back-end, and Agents, where

32 involved. In addition, the Netdata Agent uses an array of third-party services for static code analysis,

33 security analysis, and CI/CD integrations to ensure code quality on a per pull request basis. Tools like Github's

34 CodeQL, Github's Dependabot, our own unit tests, various types of linters,

@@ -124,10 +124,10 @@ Netdata also collects anonymous telemetry events, which provide information on t

124 and performance metrics. This data is used to understand how the software is being used and to identify areas for

125 improvement.

126

127 -The purpose of collecting these statistics and telemetry data is to guide the development of the open-source agent,

127 +The purpose of collecting these statistics and telemetry data is to guide the development of the open-source Agent,

128 focusing on areas that are most beneficial to users.

129

130 -Users have the option to opt out of this data collection during the installation of the agent, or at any time by

130 +Users have the option to opt out of this data collection during the installation of the Agent, or at any time by

131 removing a specific file from their system.

132

133 Netdata retains this data indefinitely in order to track changes and trends within the community over time.

docs/security-and-privacy-design/netdata-agent-security.md

+11 -14

@@ -27,25 +27,25 @@ neither do most of the data collecting plugins.

27 Data collection plugins communicate with the main Netdata process via ephemeral, in-memory, pipes that are inaccessible

28 to any other process.

29

30 -Streaming of metrics between Netdata agents requires an API key and can also be encrypted with TLS if the user

30 +Streaming of metrics between Netdata Agents requires an API key and can also be encrypted with TLS if the user

31 configures it.

32

33 -The Netdata agent's web API can also use TLS if configured.

33 +The Netdata Agent's web API can also use TLS if configured.

34

35 -When Netdata agents are claimed to Netdata Cloud, the communication happens via MQTT over Web Sockets over TLS, and

35 +When Netdata Agents are claimed to Netdata Cloud, the communication happens via MQTT over Web Sockets over TLS, and

36 public/private keys are used for authorizing access. These keys are exchanged during the claiming process (usually

37 -during the provisioning of each agent).

37 +during the provisioning of each Agent).

38

39 ## Authentication

40

41 -Direct user access to the agent is not authenticated, considering that users should either use Netdata Cloud, or they

42 -are already on the same LAN, or they have configured proper firewall policies. However, Netdata agents can be hidden

41 +Direct user access to the Agent is not authenticated, considering that users should either use Netdata Cloud, or they

42 +are already on the same LAN, or they have configured proper firewall policies. However, Netdata Agents can be hidden

43 behind an authenticating web proxy if required.

44

45 -For other Netdata agents streaming metrics to an agent, authentication via API keys is required and TLS can be used if

45 +For other Netdata Agents streaming metrics to an Agent, authentication via API keys is required and TLS can be used if

46 configured.

47

48 -For Netdata Cloud accessing Netdata agents, public/private key cryptography is used and TLS is mandatory.

48 +For Netdata Cloud accessing Netdata Agents, public/private key cryptography is used and TLS is mandatory.

49

50 ## Security Vulnerability Response

51

@@ -57,12 +57,11 @@ information can be found [here](https://github.com/netdata/netdata/security/poli

57

58 ## Protection Against Common Security Threats

59

60 -The Netdata agent is resilient against common security threats such as DDoS attacks and SQL injections. For DDoS,

61 -Netdata agent uses a fixed number of threads for processing requests, providing a cap on the resources that can be

60 +The Netdata Agent is resilient against common security threats such as DDoS attacks and SQL injections. For DDoS, the Agent uses a fixed number of threads for processing requests, providing a cap on the resources that can be

61 consumed. It also automatically manages its memory to prevent over-utilization. SQL injections are prevented as nothing

62 from the UI is passed back to the data collection plugins accessing databases.

63

65 -Additionally, the Netdata agent is running as a normal, unprivileged, operating system user (a few data collections

64 +Additionally, the Agent is running as a normal, unprivileged, operating system user (a few data collections

65 require escalated privileges, but these privileges are isolated to just them), every netdata process runs by default

66 with a nice priority to protect production applications in case the system is starving for CPU resources, and Netdata

67 agents are configured by default to be the first processes to be killed by the operating system in case the operating

@@ -70,6 +69,4 @@ system starves for memory resources (OS-OOM - Operating System Out Of Memory eve

69

70 ## User Customizable Security Settings

71

73 -Netdata provides users with the flexibility to customize agent security settings. Users can configure TLS across the

74 -system, and the agent provides extensive access control lists on all its interfaces to limit access to its endpoints

75 -based on IP. Additionally, users can configure the CPU and Memory priority of Netdata agents.

72 +Netdata provides users with the flexibility to customize the Agent's security settings. Users can configure TLS across the system, and the Agent provides extensive access control lists on all its interfaces to limit access to its endpoints based on IP. Additionally, users can configure the CPU and Memory priority of Netdata Agents.

docs/security-and-privacy-design/netdata-cloud-security.md

+1 -1

@@ -4,7 +4,7 @@ Netdata Cloud is designed with a security-first approach to ensure the highest l

4 using Netdata Cloud in environments that require compliance with standards like PCI DSS, SOC 2, or HIPAA, users can be

5 confident that all collected data is stored within their infrastructure. Data viewed on dashboards and alert

6 notifications travel over Netdata Cloud, but are not stored—instead, they're transformed in transit, aggregated from

7 -multiple agents and parents (centralization points), to appear as one data source in the user's browser.

7 +multiple Agents and parents (centralization points), to appear as one data source in the user's browser.

8

9 ## User Identification and Authorization

10

docs/top-monitoring-netdata-functions.md

+1 -1

@@ -13,7 +13,7 @@ For more details please check out documentation on how we use our internal colle

13

14 The following is required to be able to run Functions from Netdata Cloud.

15

16 -- At least one of the nodes claimed to your Space should be on a Netdata agent version higher than `v1.37.1`

16 +- At least one of the nodes claimed to your Space should be on a Netdata Agent version higher than `v1.37.1`

17 - Ensure that the node has the collector that exposes the function you want enabled

18

19 ## What functions are currently available?

integrations/README.md

+2 -2

@@ -10,7 +10,7 @@ To generate a copy of `integrations.js` locally, you will need:

10 - A local checkout of https://github.com/netdata/netdata

11 - A local checkout of https://github.com/netdata/go.d.plugin. The script

12 expects this to be checked out in a directory called `go.d.plugin`

13 - in the root directory of the agent repo, though a symlink with that

13 + in the root directory of the Agent repo, though a symlink with that

14 name pointing at the actual location of the repo will work as well.

15

16 The first two parts can be easily covered in a Linux environment, such

@@ -21,6 +21,6 @@ as a VM or Docker container:

21 - On Fedora or RHEL (EPEL is required on RHEL systems): `dnf install python3-jsonschema python3-referencing python3-jinja2 python3-ruamel-yaml`

22

23 Once the environment is set up, simply run

24 -`integrations/gen_integrations.py` from the agent repo. Note that the

24 +`integrations/gen_integrations.py` from the Agent repo. Note that the

25 script must be run _from this specific location_, as it uses it’s own

26 path to figure out where all the files it needs are.

packaging/PLATFORM_SUPPORT.md

+1 -1

@@ -28,7 +28,7 @@ The following table shows a general outline of the various support tiers and cat

29

30 - ‘Bug Support’: How we handle of platform-specific bugs.

31 -- ‘Guaranteed Configurations’: Which runtime configurations for the agent we try to guarantee will work with minimal

31 +- ‘Guaranteed Configurations’: Which runtime configurations for the Agent we try to guarantee will work with minimal

32 effort from users.

33 - ‘CI Coverage’: What level of coverage we provide for the platform in CI.

34 - ‘Native Packages’: Whether we provide native packages for the system package manager for the platform.

packaging/VERSIONING_AND_PUBLIC_API.md

+2 -2

@@ -59,7 +59,7 @@ Netdata Agent git repository.

59

60 ## Public API

61

62 -The remainder of the document outlines the public API of the Netdata agent.

62 +The remainder of the document outlines the public API of the Netdata Agent.

63

64 We define two categories of components within the public API:

65

@@ -89,7 +89,7 @@ notes at least one minor release prior to being merged:

89 - The protocol used for communicating with external data collection plugins.

90 - The APIs provided by the `python.d.plugin` and `charts.d.plugin` data collection frameworks.

91 - The set of optional features supported by the Agent which are provided by default in our pre-built packages. If

92 - support for an optional feature is being completely removed from the agent, that is instead covered by what

92 + support for an optional feature is being completely removed from the Agent, that is instead covered by what

93 component that feature is part of.

94

95 ### Loosely Defined Public API Components

packaging/docker/README.md

+4 -4

@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';

7

8 We do not officially support running our Docker images with the Docker CLI `--user` option or the Docker Compose

9 `user:` parameter. Such usage will usually still work, but some features will not be available when run this

10 -way. Note that the agent will drop privileges appropriately inside the container during startup, meaning that even

10 +way. Note that the Agent will drop privileges appropriately inside the container during startup, meaning that even

11 when run without these options almost nothing in the container will actually run with an effective UID of 0.

12

13 Our POWER8+ Docker images do not support our FreeIPMI collector. This is a technical limitation in FreeIPMI itself,

@@ -620,12 +620,12 @@ Our Docker image provides integrated support for health checks through the stand

620

621 You can control how the health checks run by using the environment variable `NETDATA_HEALTHCHECK_TARGET` as follows:

622

623 -- If left unset, the health check will attempt to access the `/api/v1/info` endpoint of the agent.

624 -- If set to the exact value 'cli', the health check script will use `netdatacli ping` to determine if the agent is

623 +- If left unset, the health check will attempt to access the `/api/v1/info` endpoint of the Agent.

624 +- If set to the exact value 'cli', the health check script will use `netdatacli ping` to determine if the Agent is

625 running correctly or not. This is sufficient to ensure that Netdata did not hang during startup, but does not provide

626 a rigorous verification that the daemon is collecting data or is otherwise usable.

627 - If set to anything else, the health check will treat the value as a URL to check for a 200 status code on. In most

628 - cases, this should start with `http://localhost:19999/` to check the agent running in the container.

628 + cases, this should start with `http://localhost:19999/` to check the Agent running in the container.

629

630 In most cases, the default behavior of checking the `/api/v1/info` endpoint will be sufficient. If you are using a

631 configuration which disables the web server or restricts access to certain APIs, you will need to use a non-default

packaging/installer/methods/ansible.md

+1 -1

@@ -11,7 +11,7 @@ code?

11

12 Enter [Ansible](https://ansible.com), a popular system provisioning, configuration management, and infrastructure as

13 code (IaC) tool. Ansible uses **playbooks** to glue many standardized operations together with a simple syntax, then run

14 -those operations over standard and secure SSH connections. There's no agent to install on the remote system, so all you

14 +those operations over standard and secure SSH connections. There's no Agent to install on the remote system, so all you

15 have to worry about is your application and your monitoring software.

16

17 Ansible has some competition from the likes of [Puppet](https://puppet.com/) or [Chef](https://www.chef.io/), but the

packaging/installer/methods/freebsd.md

+1 -1

@@ -120,7 +120,7 @@ The following options are mutually exclusive and specify special operations othe

120 - `--uninstall`: Uninstall an existing installation of Netdata. Fails if there is no existing install.

121 - `--claim-only`: If there is an existing install, only try to claim it without attempting to update it. If there is no existing install, install and claim Netdata normally.

122 - `--repositories-only`: Only install repository configuration packages instead of doing a full install of Netdata. Automatically sets --native-only.

123 -- `--prepare-offline-install-source`: Instead of installing the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.

123 +- `--prepare-offline-install-source`: Instead of installing the Agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.

124

125 Additionally, the following environment variables may be used to further customize how the script runs (most users

126 should not need to use special values for any of these):

packaging/installer/methods/kickstart.md

+4 -4

@@ -65,7 +65,7 @@ The `kickstart.sh` script accepts a number of optional parameters to control how

65 The script automatically detects if it is running interactively, on a user's terminal, or headless in a CI/CD environment. These are options related to overriding this behavior.

66

67 - `--non-interactive` or `--dont-wait`

68 - Don’t prompt for anything and assume yes whenever possible, overriding any automatic detection of an interactive run. Use this option when installing Netdata agent with a provisioning tool or in CI/CD.

68 + Don’t prompt for anything and assume yes whenever possible, overriding any automatic detection of an interactive run. Use this option when installing Netdata Agent with a provisioning tool or in CI/CD.

69 - `--interactive`

70 Act as if running interactively, even if automatic detection indicates a run is non-interactive.

71

@@ -109,7 +109,7 @@ By default, the script installs a cron job to automatically update Netdata to th

109

110 ### Netdata Cloud related options

111

112 -By default, the kickstart script will provide a Netdata agent installation that can potentially communicate with Netdata Cloud if the Netdata agent is further configured to do so.

112 +By default, the kickstart script will provide a Netdata Agent installation that can potentially communicate with Netdata Cloud if the Netdata Agent is further configured to do so.

113

114 - `--claim-token`

115 Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node after the installation. This will connect and claim the Netdata Agent to Netdata Cloud.

@@ -124,7 +124,7 @@ By default, the kickstart script will provide a Netdata agent installation that

124

125 ### anonymous telemetry

126

127 -By default, the agent is sending anonymous telemetry data to help us take identify the most common operating systems and the configurations Netdata agents run. We use this information to prioritize our efforts towards what is most commonly used by our community.

127 +By default, the Agent is sending anonymous telemetry data to help us take identify the most common operating systems and the configurations Netdata Agents run. We use this information to prioritize our efforts towards what is most commonly used by our community.

128

129 - `--disable-telemetry`

130 Disable anonymous statistics.

@@ -157,7 +157,7 @@ The following options are mutually exclusive and specify special operations othe

157 - `--repositories-only`

158 Only install repository configuration packages instead of doing a full install of Netdata. Automatically sets --native-only.

159 - `--prepare-offline-install-source`

160 - Instead of installing the agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.

160 + Instead of installing the Agent, prepare a directory that can be used to install on another system without needing to download anything. See our [offline installation documentation](/packaging/installer/methods/offline.md) for more info.

161

162 ### environment variables

163

packaging/installer/methods/source.md

+1 -1

@@ -93,7 +93,7 @@ On Linux systems, Netdata has support for using the kernel's eBPF

93 interface to monitor performance-related VFS, network, and process events,

94 allowing for insights into process lifetimes and file access

95 patterns. Using this functionality requires additional code managed in

96 -a separate repository from the core Netdata agent. You can either install

96 +a separate repository from the core Netdata Agent. You can either install

97 a pre-built copy of the required code, or build it locally.

98

99 #### Installing the pre-built eBPF code

src/claim/README.md

+4 -4

@@ -1,7 +1,7 @@

1 # Connect Agent to Cloud

2

3 This section guides you through installing and securely connecting a new Netdata Agent to Netdata Cloud via the

4 -encrypted Agent-Cloud Link ([ACLK](/src/aclk/README.md)). Connecting your agent to Netdata Cloud unlocks additional

4 +encrypted Agent-Cloud Link ([ACLK](/src/aclk/README.md)). Connecting your Agent to Netdata Cloud unlocks additional

5 features like centralized monitoring and easier collaboration.

6

7 ## Connect

@@ -70,8 +70,8 @@ example:

70 insecure = no

71 ```

72

73 -If the agent is already running, you can either run `netdatacli reload-claiming-state` or restart the agent.

74 -Otherwise, the agent will be claimed when it starts.

73 +If the Agent is already running, you can either run `netdatacli reload-claiming-state` or restart the Agent.

74 +Otherwise, the Agent will be claimed when it starts.

75

76 If the claiming process fails, the reason will be logged in daemon.log (search for "CLAIM") and the `cloud` section of `http://ip:19999/api/v2/info`.

77

@@ -102,7 +102,7 @@ sudo rm -rf cloud.d/

102

103 > **IMPORTANT**

104 >

105 -> Keep in mind that the Agent will be **re-claimed automatically** if the environment variables or `claim.conf` exist when the agent is restarted.

105 +> Keep in mind that the Agent will be **re-claimed automatically** if the environment variables or `claim.conf` exist when the Agent is restarted.

106

107 This node no longer has access to the credentials it was used when connecting to Netdata Cloud via the ACLK. You will

108 still be able to see this node in your Rooms in an **unreachable** state.

src/collectors/ebpf.plugin/README.md

+1 -1

@@ -957,7 +957,7 @@ Then compile your `netdata_ebpf.te` file with the following commands to create a

957 # semodule_package -o netdata_ebpf.pp -m netdata_ebpf.mod

958 ```

959

960 -Finally, you can load the new policy and start the Netdata agent again:

960 +Finally, you can load the new policy and start the Netdata Agent again:

961

962 ```bash

963 # semodule -i netdata_ebpf.pp

src/collectors/proc.plugin/README.md

+1 -1

@@ -581,7 +581,7 @@ Default configuration will monitor only enabled infiniband ports, and refresh ne

581

582 ## AMD GPUs

583

584 -This module monitors every AMD GPU card discovered at agent startup.

584 +This module monitors every AMD GPU card discovered at Agent startup.

585

586 ### Monitored GPU metrics

587

src/collectors/profile.plugin/README.md

+1 -1

@@ -1,6 +1,6 @@

1 # profile.plugin

2

3 -This plugin allows someone to backfill an agent with random data.

3 +This plugin allows someone to backfill an Agent with random data.

4

5 A user can specify:

6

src/collectors/systemd-journal.plugin/README.md

+3 -3

@@ -396,15 +396,15 @@ free Netdata Cloud account.

396

397 ### Is any of my data exposed to Netdata Cloud from this plugin?

398

399 -No. When you access the agent directly, none of your data passes through Netdata Cloud.

399 +No. When you access the Agent directly, none of your data passes through Netdata Cloud.

400 You need a free Netdata Cloud account only to verify your identity and enable the use of

401 -Netdata Functions. Once this is done, all the data flow directly from your Netdata agent

401 +Netdata Functions. Once this is done, all the data flow directly from your Netdata Agent

402 to your web browser.

403

404 Also check [this discussion](https://github.com/netdata/netdata/discussions/16136).

405

406 When you access Netdata via `https://app.netdata.cloud`, your data travel via Netdata Cloud,

407 -but they are not stored in Netdata Cloud. This is to allow you access your Netdata agents from

407 +but they are not stored in Netdata Cloud. This is to allow you access your Netdata Agents from

408 anywhere. All communication from/to Netdata Cloud is encrypted.

409

410 ### What are `volatile` and `persistent` journals?

src/collectors/windows-events.plugin/README.md

+3 -3

@@ -216,12 +216,12 @@ account.

216

217 ### Is any of my data exposed to Netdata Cloud from this plugin?

218

219 -No. When you access the agent directly, none of your data passes through Netdata Cloud. You need a free Netdata

219 +No. When you access the Agent directly, none of your data passes through Netdata Cloud. You need a free Netdata

220 Cloud account only to verify your identity and enable the use of Netdata Functions. Once this is done, all the

221 -data flow directly from your Netdata agent to your web browser.

221 +data flow directly from your Netdata Agent to your web browser.

222

223 When you access Netdata via https://app.netdata.cloud, your data travel via Netdata Cloud, but they are not stored

224 -in Netdata Cloud. This is to allow you access your Netdata agents from anywhere. All communication from/to

224 +in Netdata Cloud. This is to allow you access your Netdata Agents from anywhere. All communication from/to

225 Netdata Cloud is encrypted.

226

227 ### What are the different types of event logs supported by this plugin?

src/daemon/config/README.md

+1 -1

@@ -167,7 +167,7 @@ monitoring](/src/health/README.md).

167 | script to execute on alarm | `/usr/libexec/netdata/plugins.d/alarm-notify.sh` | The script that sends alert notifications. Note that in versions before 1.16, the plugins.d directory may be installed in a different location in certain OSs (e.g. under `/usr/lib/netdata`). |

168 | run at least every | `10s` | Controls how often all alert conditions should be evaluated. |

169 | postpone alarms during hibernation for | `1m` | Prevents false alerts. May need to be increased if you get alerts during hibernation. |

170 -| health log retention | `5d` | Specifies the history of alert events (in seconds) kept in the agent's sqlite database. |

170 +| health log retention | `5d` | Specifies the history of alert events (in seconds) kept in the Agent's sqlite database. |

171 | enabled alarms | * | Defines which alerts to load from both user and stock directories. This is a [simple pattern](/src/libnetdata/simple_pattern/README.md) list of alert or template names. Can be used to disable specific alerts. For example, `enabled alarms = !oom_kill *` will load all alerts except `oom_kill`. |

172

173 ### [web] section options

src/database/README.md

+1 -1

@@ -45,7 +45,7 @@ You can select the database mode by editing `netdata.conf` and setting:

45 ## Netdata Longer Metrics Retention

46

47 Metrics retention is controlled only by the disk space allocated to storing metrics. But it also affects the memory and

48 -CPU required by the agent to query longer timeframes.

48 +CPU required by the Agent to query longer timeframes.

49

50 Since Netdata Agents usually run on the edge, on production systems, Netdata Agent **parents** should be considered.

51 When having a [**parent - child**](/docs/observability-centralization-points/README.md) setup, the child (the

src/database/engine/README.md

+1 -1

@@ -122,7 +122,7 @@ Until **hot pages** and **dirty pages** are **flushed** to disk they are at risk

122 power failure), as they are stored only in memory.

123

124 The supported way of ensuring high data availability is the use of Netdata Parents to stream the data in real-time to

125 -multiple other Netdata agents.

125 +multiple other Netdata Agents.

126

127 ## Memory requirements and retention

128

src/exporting/json/integrations/json.md

+1 -1

@@ -13,7 +13,7 @@ endmeta-->

13 <img src="https://netdata.cloud/img/json.svg" width="150"/>

14

15

16 -Use the JSON connector for the exporting engine to archive your agent's metrics to JSON document databases for long-term storage,

16 +Use the JSON connector for the exporting engine to archive your Agent's metrics to JSON document databases for long-term storage,

17 further analysis, or correlation with data from other sources

18

19

src/exporting/json/metadata.yaml

+1 -1

@@ -12,7 +12,7 @@ keywords:

12 - json

13 overview:

14 exporter_description: |

15 - Use the JSON connector for the exporting engine to archive your agent's metrics to JSON document databases for long-term storage,

15 + Use the JSON connector for the exporting engine to archive your Agent's metrics to JSON document databases for long-term storage,

16 further analysis, or correlation with data from other sources

17 exporter_limitations: ''

18 setup:

src/exporting/mongodb/integrations/mongodb.md

+1 -1

@@ -13,7 +13,7 @@ endmeta-->

13 <img src="https://netdata.cloud/img/mongodb.svg" width="150"/>

14

15

16 -Use the MongoDB connector for the exporting engine to archive your agent's metrics to a MongoDB database

16 +Use the MongoDB connector for the exporting engine to archive your Agent's metrics to a MongoDB database

17 for long-term storage, further analysis, or correlation with data from other sources.

18

19

src/exporting/mongodb/metadata.yaml

+1 -1

@@ -12,7 +12,7 @@ keywords:

12 - MongoDB

13 overview:

14 exporter_description: |

15 - Use the MongoDB connector for the exporting engine to archive your agent's metrics to a MongoDB database

15 + Use the MongoDB connector for the exporting engine to archive your Agent's metrics to a MongoDB database

16 for long-term storage, further analysis, or correlation with data from other sources.

17 exporter_limitations: ''

18 setup:

src/go/plugin/go.d/modules/consul/integrations/consul.md

+1 -1

@@ -180,7 +180,7 @@ The following alerts are available:

180

181 #### Enable Prometheus telemetry

182

183 -[Enable](https://developer.hashicorp.com/consul/docs/agent/config/config-files#telemetry-prometheus_retention_time) telemetry on your Consul agent, by increasing the value of `prometheus_retention_time` from `0`.

183 +[Enable](https://developer.hashicorp.com/consul/docs/agent/config/config-files#telemetry-prometheus_retention_time) telemetry on your Consul Agent, by increasing the value of `prometheus_retention_time` from `0`.

184

185

186 #### Add required ACLs to Token

src/go/plugin/go.d/modules/consul/metadata.yaml

+1 -1

@@ -58,7 +58,7 @@ modules:

58 list:

59 - title: Enable Prometheus telemetry

60 description: |

61 - [Enable](https://developer.hashicorp.com/consul/docs/agent/config/config-files#telemetry-prometheus_retention_time) telemetry on your Consul agent, by increasing the value of `prometheus_retention_time` from `0`.

61 + [Enable](https://developer.hashicorp.com/consul/docs/agent/config/config-files#telemetry-prometheus_retention_time) telemetry on your Consul Agent, by increasing the value of `prometheus_retention_time` from `0`.

62 - title: Add required ACLs to Token

63 description: |

64 Required **only if authentication is enabled**.

src/go/plugin/go.d/modules/postgres/integrations/postgresql.md

+1 -1

@@ -266,7 +266,7 @@ CREATE USER netdata;

266 GRANT pg_monitor TO netdata;

267 ```

268

269 -After creating the new user, restart the Netdata agent with `sudo systemctl restart netdata`, or

269 +After creating the new user, restart the Netdata Agent with `sudo systemctl restart netdata`, or

270 the [appropriate method](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/start-stop-restart.md) for your

271 system.

272

src/go/plugin/go.d/modules/postgres/metadata.yaml

+1 -1

@@ -68,7 +68,7 @@ modules:

68 GRANT pg_monitor TO netdata;

69 ```

70

71 - After creating the new user, restart the Netdata agent with `sudo systemctl restart netdata`, or

71 + After creating the new user, restart the Netdata Agent with `sudo systemctl restart netdata`, or

72 the [appropriate method](/docs/netdata-agent/start-stop-restart.md) for your

73 system.

74 configuration:

src/go/plugin/go.d/modules/tomcat/integrations/tomcat.md

+2 -2

@@ -38,7 +38,7 @@ By default, this Tomcat collector cannot access the server's status page. To ena

38

39 #### Auto-Detection

40

41 -If the Netdata agent and Tomcat are on the same host, the collector will attempt to connect to the Tomcat server's status page at `http://localhost:8080/manager/status?XML=true`.

41 +If the Netdata Agent and Tomcat are on the same host, the collector will attempt to connect to the Tomcat server's status page at `http://localhost:8080/manager/status?XML=true`.

42

43

44 #### Limits

@@ -120,7 +120,7 @@ There are no alerts configured by default for this integration.

120

121 #### Access to Tomcat Status Endpoint

122

123 -The Netdata agent needs read-only access to its status endpoint to collect data from the Tomcat server.

123 +The Netdata Agent needs read-only access to its status endpoint to collect data from the Tomcat server.

124

125 You can achieve this by creating a dedicated user named `netdata` with read-only permissions specifically for accessing the [Server Status](https://tomcat.apache.org/tomcat-10.0-doc/manager-howto.html#Server_Status) endpoint.

126

src/go/plugin/go.d/modules/tomcat/metadata.yaml

+2 -2

@@ -39,7 +39,7 @@ modules:

39 default_behavior:

40 auto_detection:

41 description: >

42 - If the Netdata agent and Tomcat are on the same host, the collector will attempt to connect to the Tomcat server's status page at `http://localhost:8080/manager/status?XML=true`.

42 + If the Netdata Agent and Tomcat are on the same host, the collector will attempt to connect to the Tomcat server's status page at `http://localhost:8080/manager/status?XML=true`.

43 limits:

44 description: ""

45 performance_impact:

@@ -49,7 +49,7 @@ modules:

49 list:

50 - title: Access to Tomcat Status Endpoint

51 description: |

52 - The Netdata agent needs read-only access to its status endpoint to collect data from the Tomcat server.

52 + The Netdata Agent needs read-only access to its status endpoint to collect data from the Tomcat server.

53

54 You can achieve this by creating a dedicated user named `netdata` with read-only permissions specifically for accessing the [Server Status](https://tomcat.apache.org/tomcat-10.0-doc/manager-howto.html#Server_Status) endpoint.

55

src/go/plugin/go.d/modules/windows/integrations/active_directory.md

+1 -1

@@ -32,7 +32,7 @@ To get started with Netdata on Windows, see the [Netdata Windows Installer](http

32 This collector monitors the performance of Windows machines, collects both host metrics and metrics from various Windows applications (e.g. Active Directory, MSSQL).

33

34

35 -It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows agent running on each host.

35 +It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows Agent running on each host.

36

37

38 This collector is supported on all platforms.

src/go/plugin/go.d/modules/windows/integrations/hyperv.md

+1 -1

@@ -32,7 +32,7 @@ To get started with Netdata on Windows, see the [Netdata Windows Installer](http

32 This collector monitors the performance of Windows machines, collects both host metrics and metrics from various Windows applications (e.g. Active Directory, MSSQL).

33

34

35 -It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows agent running on each host.

35 +It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows Agent running on each host.

36

37

38 This collector is supported on all platforms.

src/go/plugin/go.d/modules/windows/integrations/ms_exchange.md

+1 -1

@@ -32,7 +32,7 @@ To get started with Netdata on Windows, see the [Netdata Windows Installer](http

32 This collector monitors the performance of Windows machines, collects both host metrics and metrics from various Windows applications (e.g. Active Directory, MSSQL).

33

34

35 -It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows agent running on each host.

35 +It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows Agent running on each host.

36

37

38 This collector is supported on all platforms.

src/go/plugin/go.d/modules/windows/integrations/ms_sql_server.md

+1 -1

@@ -32,7 +32,7 @@ To get started with Netdata on Windows, see the [Netdata Windows Installer](http

32 This collector monitors the performance of Windows machines, collects both host metrics and metrics from various Windows applications (e.g. Active Directory, MSSQL).

33

34

35 -It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows agent running on each host.

35 +It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows Agent running on each host.

36

37

38 This collector is supported on all platforms.

src/go/plugin/go.d/modules/windows/integrations/net_framework.md

+1 -1

@@ -32,7 +32,7 @@ To get started with Netdata on Windows, see the [Netdata Windows Installer](http

32 This collector monitors the performance of Windows machines, collects both host metrics and metrics from various Windows applications (e.g. Active Directory, MSSQL).

33

34

35 -It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows agent running on each host.

35 +It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows Agent running on each host.

36

37

38 This collector is supported on all platforms.

src/go/plugin/go.d/modules/windows/integrations/windows.md

+1 -1

@@ -32,7 +32,7 @@ To get started with Netdata on Windows, see the [Netdata Windows Installer](http

32 This collector monitors the performance of Windows machines, collects both host metrics and metrics from various Windows applications (e.g. Active Directory, MSSQL).

33

34

35 -It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows agent running on each host.

35 +It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows Agent running on each host.

36

37

38 This collector is supported on all platforms.

src/go/plugin/go.d/modules/windows/metadata.yaml

+1 -1

@@ -33,7 +33,7 @@ modules:

33

34 This collector monitors the performance of Windows machines, collects both host metrics and metrics from various Windows applications (e.g. Active Directory, MSSQL).

35 method_description: |

36 - It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows agent running on each host.

36 + It collect metrics by periodically sending HTTP requests to [Prometheus exporter for Windows machines](https://github.com/prometheus-community/windows_exporter), a native Windows Agent running on each host.

37 default_behavior:

38 auto_detection:

39 description: ""

src/health/README.md

+1 -1

@@ -10,7 +10,7 @@ Read our documentation on [configuring alerts](/src/health/REFERENCE.md) to chan

10

11 - Netdata Cloud provides centralized alert notifications, utilizing the health status data already sent to Netdata Cloud from connected nodes to send alerts to configured integrations. [Supported integrations](/docs/alerts-&-notifications/notifications/centralized-cloud-notifications) include Amazon SNS, Discord, Slack, Splunk, and others.

12

13 -- The Netdata Agent offers a [wider range of notification options](/docs/alerts-&-notifications/notifications/agent-dispatched-notifications) directly from the agent itself. You can choose from over a dozen services, including email, Slack, PagerDuty, Twilio, and others, for more granular control over notifications on each node.

13 +- The Netdata Agent offers a [wider range of notification options](/docs/alerts-&-notifications/notifications/agent-dispatched-notifications) directly from the Agent itself. You can choose from over a dozen services, including email, Slack, PagerDuty, Twilio, and others, for more granular control over notifications on each node.

14

15 The Netdata Agent is a health watchdog for the health and performance of your systems, services, and applications. We've worked closely with our community of DevOps engineers, SREs, and developers to define hundreds of production-ready alerts that work without any configuration.

16

src/health/REFERENCE.md

+3 -3

@@ -89,7 +89,7 @@ available options are described below.

89

90 ### Disable all alerts

91

92 -In the `netdata.conf` `[health]` section, set `enabled` to `no`, and restart the agent.

92 +In the `netdata.conf` `[health]` section, set `enabled` to `no`, and restart the Agent.

93

94 ### Disable some alerts

95

@@ -116,7 +116,7 @@ When you need to frequently disable all or some alerts from triggering during ce

116 when running backups) you can use the

117 [health management API](/src/web/api/health/README.md).

118 The API allows you to issue commands to control the health engine's behavior without changing configuration,

119 -or restarting the agent.

119 +or restarting the Agent.

120

121 ### Temporarily silence notifications at runtime

122

@@ -124,7 +124,7 @@ If you want health checks to keep running and alerts to keep getting triggered,

124 suppressed temporarily, you can use the

125 [health management API](/src/web/api/health/README.md).

126 The API allows you to issue commands to control the health engine's behavior without changing configuration,

127 -or restarting the agent.

127 +or restarting the Agent.

128

129 ## Write a new health entity

130

src/health/guides/anomalies/anomalies_anomaly_probabilities.md

+1 -1

@@ -1,6 +1,6 @@

1 ### Understand the alert

2

3 -This alert, `anomalies_anomaly_probabilities`, is generated by the Netdata agent when the average anomaly probability over the last 2 minutes is 50. An anomaly probability is a value calculated by the machine learning (ML) component in Netdata, aiming to detect unusual events or behavior in system metrics.

3 +This alert, `anomalies_anomaly_probabilities`, is generated by the Netdata Agent when the average anomaly probability over the last 2 minutes is 50. An anomaly probability is a value calculated by the machine learning (ML) component in Netdata, aiming to detect unusual events or behavior in system metrics.

4

5 ### What is anomaly probability?

6

src/health/guides/dbengine/10min_dbengine_global_fs_errors.md

+1 -1

@@ -2,7 +2,7 @@

2

3 The Database Engine works like a traditional database. It dedicates a certain amount of RAM to data caching and indexing, while the rest of the data resides compressed on disk. Unlike other memory modes, the amount of historical metrics stored is based on the amount of disk space you allocate and the effective compression ratio, not a fixed number of metrics collected.

4

5 -By using both RAM and disk space, the database engine allows for long-term storage of per-second metrics inside of the Netdata agent itself.

5 +By using both RAM and disk space, the database engine allows for long-term storage of per-second metrics inside of the Netdata Agent itself.

6

7 Netdata monitors the number of filesystem errors in the last 10 minutes. The Dbengine is experiencing filesystem errors (too many open files, wrong permissions, etc.)

8

src/health/guides/exporting/exporting_last_buffering.md

+1 -1

@@ -16,7 +16,7 @@ This alert is related to the Netdata Exporting engine, which calculates the numb

16 ```

17 Replace `new_value` with the desired number that matches your system requirements.

18

19 -4. Restart the Netdata Agent: After modifying the `exporting.conf` file, don't forget to restart the Netdata Agent for changes to take effect. Use the following command to restart the agent:

19 +4. Restart the Netdata Agent: After modifying the `exporting.conf` file, don't forget to restart the Netdata Agent for changes to take effect. Use the following command to restart the Agent:

20

21 ```

22 sudo systemctl restart netdata

src/health/guides/httpcheck/httpcheck_web_service_bad_content.md

+1 -1

@@ -1,6 +1,6 @@

1 ### Understand the alert

2

3 -The Netdata Agent monitors your HTTP endpoints. You can specify endpoints that the agent will monitor in Agent's Go module under `go.d/httpcheck.conf`. You can also specify the expected response pattern. This HTTP endpoint will send in the `response_match` option. If the endpoint's response does not match the `response_match` pattern, then the Agent marks the response as unexpected.

3 +The Netdata Agent monitors your HTTP endpoints. You can specify endpoints that the Agent will monitor in Agent's Go module under `go.d/httpcheck.conf`. You can also specify the expected response pattern. This HTTP endpoint will send in the `response_match` option. If the endpoint's response does not match the `response_match` pattern, then the Agent marks the response as unexpected.

4

5 The Netdata Agent calculates the average ratio of HTTP responses with unexpected content over the last 5 minutes.

6

src/health/guides/httpcheck/httpcheck_web_service_unreachable.md

+1 -1

@@ -1,6 +1,6 @@

1 ### Understand the alert

2

3 -The Netdata agent monitors your HTTP endpoints. You can specify endpoints the Agent will monitor in the Agent's Go module under `go.d/httpcheck.conf`.

3 +The Netdata Agent monitors your HTTP endpoints. You can specify endpoints the Agent will monitor in the Agent's Go module under `go.d/httpcheck.conf`.

4

5 If your system fails to connect to your endpoint, or if the request to that endpoint times out, then the Agent will mark the requests and log them as "unreachable".

6

src/health/guides/httpcheck/httpcheck_web_service_up.md

+2 -2

@@ -30,9 +30,9 @@ An HTTP endpoint is like a door where clients make requests to access web servic

30 curl -I http://example.com/some/endpoint

31 ```

32

33 -4. Check for network issues between the monitoring agent and the HTTP endpoint.

33 +4. Check for network issues between the monitoring Agent and the HTTP endpoint.

34

35 - Use tools like `ping`, `traceroute`, or `mtr` to check for network latency or packet loss between the monitoring agent and the HTTP endpoint.

35 + Use tools like `ping`, `traceroute`, or `mtr` to check for network latency or packet loss between the monitoring Agent and the HTTP endpoint.

36

37 5. Review the web server or application configuration.

38

src/health/guides/ml/ml_1min_node_ar.md

+1 -1

@@ -6,7 +6,7 @@ For example, with the default of `warn: $this > 1`, this means that 1% or more o

6

7 ### Troubleshoot the alert

8

9 -This alert is a signal that some significant percentage of metrics within your infrastructure have been flagged as anomalous accoring to the ML based anomaly detection models the Netdata agent continually trains and re-trains for each metric. This tells us something somewhere might look strange in some way. THe next step is to try drill in and see what metrics are actually driving this.

9 +This alert is a signal that some significant percentage of metrics within your infrastructure have been flagged as anomalous accoring to the ML based anomaly detection models the Netdata Agent continually trains and re-trains for each metric. This tells us something somewhere might look strange in some way. THe next step is to try drill in and see what metrics are actually driving this.

10

11 1. **Filter for the node or nodes relevant**: First we need to reduce as much noise as possible by filtering for just those nodes that have the elevated node anomaly rate. Look at the `anomaly_detection.anomaly_rate` chart and group by `node` to see which nodes have an elevated anomaly rate. Filter for just those nodes since this will reduce any noise as much as possible.

12

src/health/guides/net/1m_received_traffic_overflow.md

+1 -1

@@ -1,6 +1,6 @@

1 ### Understand the alert

2

3 -Network interfaces are categorized primarily on the bandwidth they can operate (1 Gbps, 10 Gbps, etc). High network utilization occurs when the volume of data on a network link approaches the capacity of the link. Netdata agent

3 +Network interfaces are categorized primarily on the bandwidth they can operate (1 Gbps, 10 Gbps, etc). High network utilization occurs when the volume of data on a network link approaches the capacity of the link. Netdata Agent

4 calculates the average outbound utilization for a specific network interface over the last minute. High outbound utilization increases latency and packet loss because packet bursts are buffered

5

6 This alarm may indicate either network congestion or malicious activity.

src/health/guides/net/1m_sent_traffic_overflow.md

+1 -1

@@ -1,6 +1,6 @@

1 ### Understand the alert

2

3 -Network interfaces are categorized primarily on the bandwidth rate at which they can operate (1 Gbps, 10 Gbps, etc). High network utilization occurs when the volume of data on a network link approaches the capacity of the link. Netdata agent calculates the average outbound utilization for a specific network interface over the last minute. High outbound utilization increases latency and packet loss because packet bursts are buffered.

3 +Network interfaces are categorized primarily on the bandwidth rate at which they can operate (1 Gbps, 10 Gbps, etc). High network utilization occurs when the volume of data on a network link approaches the capacity of the link. Netdata Agent calculates the average outbound utilization for a specific network interface over the last minute. High outbound utilization increases latency and packet loss because packet bursts are buffered.

4

5 This alarm may indicate either a network congestion or malicious activity.

6

src/health/guides/netdev/1min_netdev_budget_ran_outs.md

+1 -1

@@ -2,7 +2,7 @@

2

3 Your system communicates with the devices attached to it through interrupt requests. In a nutshell, when an interrupt occurs, the operating system stops what it was doing and starts addressing that interrupt.

4

5 -Network interfaces can receive thousands of packets per second. To avoid burying the system with thousands of interrupts, the Linux kernel uses the NAPI polling framework. In this way, we can replace hundreds of hardware interrupts with one poll by managing them with a few Soft Interrupt ReQuests (Soft IRQs). Ksoftirqd is a per-CPU kernel thread responsible for handling those unserved Soft Interrupt ReQuests (Soft IRQs). The Netdata agent inspects the average number of times Ksoftirqd ran out of netdev_budget or CPU time when there was still work to be done. This abnormality may cause packet overflow on the intermediate buffers and, as a result, drop packet on your network interfaces.

5 +Network interfaces can receive thousands of packets per second. To avoid burying the system with thousands of interrupts, the Linux kernel uses the NAPI polling framework. In this way, we can replace hundreds of hardware interrupts with one poll by managing them with a few Soft Interrupt ReQuests (Soft IRQs). Ksoftirqd is a per-CPU kernel thread responsible for handling those unserved Soft Interrupt ReQuests (Soft IRQs). The Netdata Agent inspects the average number of times Ksoftirqd ran out of netdev_budget or CPU time when there was still work to be done. This abnormality may cause packet overflow on the intermediate buffers and, as a result, drop packet on your network interfaces.

6

7 The default value of the netdev_budget is 300. However, this may not be enough in some cases, such as:

8

src/health/guides/portcheck/portcheck_connection_timeouts.md

+1 -1

@@ -32,7 +32,7 @@ This alert triggers a warning state when the ratio of timeouts is between 10-40%

32

33 5. Check the Netdata configuration

34 - Review the Netdata configuration file `/etc/netdata/netdata.conf` to ensure the `portcheck` plugin settings are correctly configured for monitoring the TCP endpoint.

35 - - If necessary, update and restart the Netdata agent.

35 + - If necessary, update and restart the Netdata Agent.

36

37 ### Useful resources

38

src/health/guides/vernemq/vernemq_cluster_dropped.md

+1 -1

@@ -1,6 +1,6 @@

1 ### Understand the alert

2

3 -This alert indicates that VerneMQ, an MQTT broker, is experiencing issues with inter-node message delivery within a clustered environment. The Netdata agent calculates the amount of traffic dropped during communication with cluster nodes in the last minute. If you receive this alert, it means that the outgoing cluster buffer is full and some messages cannot be delivered.

3 +This alert indicates that VerneMQ, an MQTT broker, is experiencing issues with inter-node message delivery within a clustered environment. The Netdata Agent calculates the amount of traffic dropped during communication with cluster nodes in the last minute. If you receive this alert, it means that the outgoing cluster buffer is full and some messages cannot be delivered.

4

5 ### What does dropped messages mean?

6

src/health/guides/web_log/web_log_1m_redirects.md

+1 -1

@@ -2,7 +2,7 @@

2

3 HTTP response status codes indicate whether a specific HTTP request has been successfully completed or not.

4

5 -The 3XX class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request. The action required may be carried out by the user agent without interaction with the user if and only if the method used in the second request is GET or HEAD. A client SHOULD detect infinite redirection loops, since such loops generate network traffic for each redirection.

5 +The 3XX class of status code indicates that further action needs to be taken by the user Agent in order to fulfill the request. The action required may be carried out by the user Agent without interaction with the user if and only if the method used in the second request is GET or HEAD. A client SHOULD detect infinite redirection loops, since such loops generate network traffic for each redirection.

6

7 The Netdata Agent calculates the ratio of redirection HTTP requests over the last minute. This metric does not include the "304 Not modified" message.

8

src/health/guides/web_log/web_log_1m_total_requests.md

+1 -1

@@ -10,7 +10,7 @@ An increase in workload means that your web server is handling more traffic than

10

11 1. Analyze web traffic logs

12

13 - To understand the reason behind the increased workload, the first step is to analyze the web server traffic logs. Look for any patterns, specific time intervals, or specific user agents that are contributing to the high number of requests.

13 + To understand the reason behind the increased workload, the first step is to analyze the web server traffic logs. Look for any patterns, specific time intervals, or specific user Agents that are contributing to the high number of requests.

14

15 2. Check the web server performance

16

src/health/guides/web_log/web_log_5m_successful.md

+1 -1

@@ -22,7 +22,7 @@ A successful HTTP request is one that receives a response with an HTTP status co

22

23 4. Verify client connections

24

25 - Investigate the IP addresses and user agents that are making a significant number of requests during the alert period. If there's a spike in requests from a single or a few IPs, it could be a sign of a coordinated attack, excessive crawling, or other unexpected behavior.

25 + Investigate the IP addresses and user Agents that are making a significant number of requests during the alert period. If there's a spike in requests from a single or a few IPs, it could be a sign of a coordinated attack, excessive crawling, or other unexpected behavior.

26

27 5. Check your web application

28

src/health/notifications/pagerduty/metadata.yaml

+1 -1

@@ -19,7 +19,7 @@

19 list:

20 - title: ''

21 description: |

22 - - An installation of the [PagerDuty](https://www.pagerduty.com/docs/guides/agent-install-guide/) agent on the node running the Netdata Agent

22 + - An installation of the [PagerDuty](https://www.pagerduty.com/docs/guides/agent-install-guide/) Agent on the node running the Netdata Agent

23 - A PagerDuty Generic API service using either the `Events API v2` or `Events API v1`

24 - [Add a new service](https://support.pagerduty.com/docs/services-and-integrations#section-configuring-services-and-integrations) to PagerDuty. Click Use our API directly and select either `Events API v2` or `Events API v1`. Once you finish creating the service, click on the Integrations tab to find your Integration Key.

25 - Access to the terminal where Netdata Agent is running

src/health/notifications/web/README.md

+1 -1

@@ -1,4 +1,4 @@

1 -# Browser pop up agent alert notifications

1 +# Browser pop up Agent alert notifications

2

3 The Netdata dashboard shows HTML notifications, when it is open.

4

src/ml/notebooks/README.md

+1 -1

@@ -2,4 +2,4 @@

2

3 This folder is a home for any documentation supporting machine learning related notebooks.

4

5 -- [Netdata anomaly detection deepdive](netdata_anomaly_detection_deepdive.ipynb): This is a starter notebook to help users understand how anomaly detection works in the Netdata agent and go a little deeper if they want.

\ No newline at end of file

5 +- [Netdata anomaly detection deepdive](netdata_anomaly_detection_deepdive.ipynb): This is a starter notebook to help users understand how anomaly detection works in the Netdata Agent and go a little deeper if they want.

\ No newline at end of file

src/registry/README.md

+1 -1

@@ -135,7 +135,7 @@ Keep in mind that connections to Netdata API ports are filtered by `[web].allow

135 `[registry].allow from` should also be allowed by `[web].allow connection from`.

136

137 The patterns can be matches over IP addresses or FQDN of the host. In order to check the FQDN of the connection without

138 -opening the Netdata agent to DNS-spoofing, a reverse-dns record must be setup for the connecting host. At connection

138 +opening the Netdata Agent to DNS-spoofing, a reverse-dns record must be setup for the connecting host. At connection

139 time the reverse-dns of the peer IP address is resolved, and a forward DNS resolution is made to validate the IP address

140 against the name-pattern.

141

src/streaming/README.md

+7 -7

@@ -50,7 +50,7 @@ This section is used by the sending Netdata.

50

51 ### `[API_KEY]` sections

52

53 -This section defines an API key for other agents to connect to this Netdata.

53 +This section defines an API key for other Agents to connect to this Netdata.

54

55 | Setting | Default | Description |

56 |------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

@@ -75,12 +75,12 @@ This section defines an API key for other agents to connect to this Netdata.

75

76 ### `[MACHINE_GUID]` sections

77

78 -This section is about customizing configuration for specific agents. It allows many agents to share the same API key, while providing customizability per remote agent.

78 +This section is about customizing configuration for specific Agents. It allows many Agents to share the same API key, while providing customizability per remote Agent.

79

80 | Setting | Default | Description |

81 |------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

82 | `enabled` | `no` | Whether this MACHINE_GUID enabled or disabled. |

83 -| `type` | `machine` | This section defines the configuration for a specific agent. |

83 +| `type` | `machine` | This section defines the configuration for a specific Agent. |

84 | [`allow from`](#allow-from) | `*` | A space-separated list of [Netdata simple patterns](/src/libnetdata/simple_pattern/README.md) matching the IPs of nodes that will stream metrics using this API key. [Read more →](#allow-from) |

85 | `retention` | `3600` | The default amount of child metrics history to retain when using the `ram` db. |

86 | [`db`](#default-memory-mode) | `dbengine` | The [database](/src/database/README.md) to use for all nodes using this `API_KEY`. Valid settings are `dbengine`, `ram`, or `none`. [Read more →](#default-memory-mode) |

@@ -221,7 +221,7 @@ default `dbengine` as specified by the `API_KEY`, and alerts are disabled.

221 [![Supported version Netdata Agent release](https://img.shields.io/badge/Supported%20Netdata%20stream%20version-v5%2B-blue)](https://github.com/netdata/netdata/releases/latest)

222

223 #### OS dependencies

224 -* Streaming compression is based on [lz4 v1.9.0+](https://github.com/lz4/lz4). The [lz4 v1.9.0+](https://github.com/lz4/lz4) library must be installed in your OS in order to enable streaming compression. Any lower version will disable Netdata streaming compression for compatibility purposes between the older versions of Netdata agents.

224 +* Streaming compression is based on [lz4 v1.9.0+](https://github.com/lz4/lz4). The [lz4 v1.9.0+](https://github.com/lz4/lz4) library must be installed in your OS in order to enable streaming compression. Any lower version will disable Netdata streaming compression for compatibility purposes between the older versions of Netdata Agents.

225

226 To check if your Netdata Agent supports stream compression run the following GET request in your browser or terminal:

227

@@ -251,7 +251,7 @@ A compressed data packet is determined and decompressed on the fly.

251 #### Limitations

252 This limitation will be withdrawn asap and is work-in-progress.

253

254 -The current implementation of streaming data compression can support only a few number of dimensions in a chart with names that cannot exceed the size of 16384 bytes. In case your instance hit this limitation, the agent will deactivate compression during runtime to avoid stream corruption. This limitation can be seen in the error.log file with the sequence of the following messages:

254 +The current implementation of streaming data compression can support only a few number of dimensions in a chart with names that cannot exceed the size of 16384 bytes. In case your instance hit this limitation, the Agent will deactivate compression during runtime to avoid stream corruption. This limitation can be seen in the error.log file with the sequence of the following messages:

255 ```

256 netdata INFO : STREAM_SENDER[child01] : STREAM child01 [send to my.parent.IP]: connecting...

257 netdata INFO : STREAM_SENDER[child01] : STREAM child01 [send to my.parent.IP]: initializing communication...

@@ -266,7 +266,7 @@ netdata ERROR : PLUGINSD[go.d] : STREAM_COMPRESSION child01 [send to my.parent.I

266 netdata INFO : STREAM_SENDER[child01] : STREAM child01 [send to my.parent.IP]: connecting...

267 netdata INFO : STREAM_SENDER[child01] : STREAM child01 [send to my.parent.IP]: initializing communication...

268 netdata INFO : STREAM_SENDER[child01] : STREAM child01 [send to my.parent.IP]: waiting response from remote netdata...

269 -netdata INFO : STREAM_SENDER[child01] : Stream is uncompressed! One of the agents (my.parent.IP <-> child01) does not support compression OR compression is disabled.

269 +netdata INFO : STREAM_SENDER[child01] : Stream is uncompressed! One of the Agents (my.parent.IP <-> child01) does not support compression OR compression is disabled.

270 netdata INFO : STREAM_SENDER[child01] : STREAM child01 [send to my.parent.IP]: established communication with a parent using protocol version 4 - ready to send metrics...

271 netdata INFO : WEB_SERVER[static4] : STREAM child01 [send]: sending metrics...

272 ```

@@ -283,7 +283,7 @@ To enable stream compression:

283

284 2. In the `[stream]` section, set `enable compression` to `yes`.

285 ```

286 -# This is the default stream compression flag for an agent.

286 +# This is the default stream compression flag for an Agent.

287

288 [stream]

289 enable compression = yes | no

src/web/README.md

+1 -1

@@ -6,7 +6,7 @@ we put a lot of emphasis on real-time, meaningful, and context-aware charts.

6 We bundle Netdata with a dashboard and hundreds of charts, designed by both our

7 team and the community, but you can also customize them yourself.

8

9 -There are two primary ways to view Netdata's dashboards on the agent:

9 +There are two primary ways to view Netdata's dashboards on the Agent:

10

11 1. The [local Agent dashboard](/src/web/gui/README.md) that comes pre-configured with every Netdata installation. You can

12 see it at `http://NODE:19999`, replacing `NODE` with `localhost`, the hostname of your node, or its IP address. You

src/web/api/README.md

+2 -2

@@ -1,8 +1,8 @@

1 # API

2

3 -## Netdata agent REST API

3 +## Netdata Agent REST API

4

5 -The complete documentation of the Netdata agent's REST API is documented in the OpenAPI format [in our GitHub repository](https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml).

5 +The complete documentation of the Netdata Agent's REST API is documented in the OpenAPI format [in our GitHub repository](https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml).

6

7 You can explore it using the **[Swagger UI](https://learn.netdata.cloud/api)**, or the **[Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml)**.

8

src/web/api/netdata-swagger.json

+29 -29

@@ -60,7 +60,7 @@

60 },

61 {

62 "name": "management",

63 - "description": "Everything related to managing netdata agents"

63 + "description": "Everything related to managing netdata Agents"

64 }

65 ],

66 "paths": {

@@ -71,7 +71,7 @@

71 "nodes"

72 ],

73 "summary": "Nodes Info v2",

74 - "description": "Get a list of all nodes hosted by this Netdata agent.\n",

74 + "description": "Get a list of all nodes hosted by this Netdata Agent.\n",

75 "parameters": [

76 {

77 "$ref": "#/components/parameters/scopeNodes"

@@ -92,7 +92,7 @@

92 "content": {

93 "application/json": {

94 "schema": {

95 - "description": "`/api/v2/nodes` response for all nodes hosted by a Netdata agent.\n",

95 + "description": "`/api/v2/nodes` response for all nodes hosted by a Netdata Agent.\n",

96 "type": "object",

97 "properties": {

98 "api": {

@@ -125,7 +125,7 @@

125 "contexts"

126 ],

127 "summary": "Contexts Info v2",

128 - "description": "Get a list of all contexts, across all nodes, hosted by this Netdata agent.\n",

128 + "description": "Get a list of all contexts, across all nodes, hosted by this Netdata Agent.\n",

129 "parameters": [

130 {

131 "$ref": "#/components/parameters/scopeNodes"

@@ -161,7 +161,7 @@

161 "contexts"

162 ],

163 "summary": "Full Text Search v2",

164 - "description": "Get a list of contexts, across all nodes, hosted by this Netdata agent, matching a string expression\n",

164 + "description": "Get a list of contexts, across all nodes, hosted by this Netdata Agent, matching a string expression\n",

165 "parameters": [

166 {

167 "name": "q",

@@ -1853,7 +1853,7 @@

1853 "scopeNodes": {

1854 "name": "scope_nodes",

1855 "in": "query",

1856 - "description": "A simple pattern limiting the nodes scope of the query. The scope controls both data and metadata response. The simple pattern is checked against the nodes' machine guid, node id and hostname. The default nodes scope is all nodes for which this agent has data for. Usually the nodes scope is used to slice the entire dashboard (e.g. the Global Nodes Selector at the Netdata Cloud overview dashboard). Both positive and negative simple pattern expressions are supported.\n",

1856 + "description": "A simple pattern limiting the nodes scope of the query. The scope controls both data and metadata response. The simple pattern is checked against the nodes' machine guid, node id and hostname. The default nodes scope is all nodes for which this Agent has data for. Usually the nodes scope is used to slice the entire dashboard (e.g. the Global Nodes Selector at the Netdata Cloud overview dashboard). Both positive and negative simple pattern expressions are supported.\n",

1857 "required": false,

1858 "schema": {

1859 "type": "string",

@@ -1864,7 +1864,7 @@

1864 "scopeContexts": {

1865 "name": "scope_contexts",

1866 "in": "query",

1867 - "description": "A simple pattern limiting the contexts scope of the query. The scope controls both data and metadata response. The default contexts scope is all contexts for which this agent has data for. Usually the contexts scope is used to slice data on the dashboard (e.g. each context based chart has its own contexts scope, limiting the chart to all the instances of the selected context). Both positive and negative simple pattern expressions are supported.\n",

1867 + "description": "A simple pattern limiting the contexts scope of the query. The scope controls both data and metadata response. The default contexts scope is all contexts for which this Agent has data for. Usually the contexts scope is used to slice data on the dashboard (e.g. each context based chart has its own contexts scope, limiting the chart to all the instances of the selected context). Both positive and negative simple pattern expressions are supported.\n",

1868 "required": false,

1869 "schema": {

1870 "type": "string",

@@ -1992,7 +1992,7 @@

1992 "dataQueryOptions": {

1993 "name": "options",

1994 "in": "query",

1995 - "description": "Options that affect data generation.\n* `jsonwrap` - Wrap the output in a JSON object with metadata about the query.\n* `raw` - change the output so that it is aggregatable across multiple such queries. Supported by `/api/v2` data queries and `json2` format.\n* `minify` - Remove unnecessary spaces and newlines from the output.\n* `debug` - Provide additional information in `jsonwrap` output to help tracing issues.\n* `nonzero` - Do not return dimensions that all their values are zero, to improve the visual appearance of charts. They will still be returned if all the dimensions are entirely zero.\n* `null2zero` - Replace `null` values with `0`.\n* `absolute` or `abs` - Traditionally Netdata returns select dimensions negative to improve visual appearance. This option turns this feature off.\n* `display-absolute` - Only used by badges, to do color calculation using the signed value, but render the value without a sign.\n* `flip` or `reversed` - Order the timestamps array in reverse order (newest to oldest).\n* `min2max` - When flattening multi-dimensional data into a single metric format, use `max - min` instead of `sum`. This is EOL - use `/api/v2` to control aggregation across dimensions.\n* `percentage` - Convert all values into a percentage vs the row total. When enabled, Netdata will query all dimensions, even the ones that have not been selected or are hidden, to find the row total, in order to calculate the percentage of each dimension selected.\n* `seconds` - Output timestamps in seconds instead of dates.\n* `milliseconds` or `ms` - Output timestamps in milliseconds instead of dates.\n* `unaligned` - by default queries are aligned to the the view, so that as time passes past data returned do not change. When a data query will not be used for visualization, `unaligned` can be given to avoid aligning the query time-frame for visual precision.\n* `match-ids`, `match-names`. By default filters match both IDs and names when they are available. Setting either of the two options will disable the other.\n* `anomaly-bit` - query the anomaly information instead of metric values. This is EOL, use `/api/v2` and `json2` format which always returns this information and many more.\n* `jw-anomaly-rates` - return anomaly rates as a separate result set in the same `json` format response. This is EOL, use `/api/v2` and `json2` format which always returns information and many more. \n* `details` - `/api/v2/data` returns in `jsonwrap` the full tree of dimensions that have been matched by the query.\n* `group-by-labels` - `/api/v2/data` returns in `jsonwrap` flattened labels per output dimension. These are used to identify the instances that have been aggregated into each dimension, making it possible to provide a map, like Netdata does for Kubernetes.\n* `natural-points` - return timestamps as found in the database. The result is again fixed-step, but the query engine attempts to align them with the timestamps found in the database.\n* `virtual-points` - return timestamps independent of the database alignment. This is needed aggregating data across multiple Netdata agents, to ensure that their outputs do not need to be interpolated to be merged.\n* `selected-tier` - use data exclusively from the selected tier given with the `tier` parameter. This option is set automatically when the `tier` parameter is set.\n* `all-dimensions` - In `/api/v1` `jsonwrap` include metadata for all candidate metrics examined. In `/api/v2` this is standard behavior and no option is needed.\n* `label-quotes` - In `csv` output format, enclose each header label in quotes.\n* `objectrows` - Each row of value should be an object, not an array (only for `json` format).\n* `google_json` - Comply with google JSON/JSONP specs (only for `json` format).\n",

1995 + "description": "Options that affect data generation.\n* `jsonwrap` - Wrap the output in a JSON object with metadata about the query.\n* `raw` - change the output so that it is aggregatable across multiple such queries. Supported by `/api/v2` data queries and `json2` format.\n* `minify` - Remove unnecessary spaces and newlines from the output.\n* `debug` - Provide additional information in `jsonwrap` output to help tracing issues.\n* `nonzero` - Do not return dimensions that all their values are zero, to improve the visual appearance of charts. They will still be returned if all the dimensions are entirely zero.\n* `null2zero` - Replace `null` values with `0`.\n* `absolute` or `abs` - Traditionally Netdata returns select dimensions negative to improve visual appearance. This option turns this feature off.\n* `display-absolute` - Only used by badges, to do color calculation using the signed value, but render the value without a sign.\n* `flip` or `reversed` - Order the timestamps array in reverse order (newest to oldest).\n* `min2max` - When flattening multi-dimensional data into a single metric format, use `max - min` instead of `sum`. This is EOL - use `/api/v2` to control aggregation across dimensions.\n* `percentage` - Convert all values into a percentage vs the row total. When enabled, Netdata will query all dimensions, even the ones that have not been selected or are hidden, to find the row total, in order to calculate the percentage of each dimension selected.\n* `seconds` - Output timestamps in seconds instead of dates.\n* `milliseconds` or `ms` - Output timestamps in milliseconds instead of dates.\n* `unaligned` - by default queries are aligned to the the view, so that as time passes past data returned do not change. When a data query will not be used for visualization, `unaligned` can be given to avoid aligning the query time-frame for visual precision.\n* `match-ids`, `match-names`. By default filters match both IDs and names when they are available. Setting either of the two options will disable the other.\n* `anomaly-bit` - query the anomaly information instead of metric values. This is EOL, use `/api/v2` and `json2` format which always returns this information and many more.\n* `jw-anomaly-rates` - return anomaly rates as a separate result set in the same `json` format response. This is EOL, use `/api/v2` and `json2` format which always returns information and many more. \n* `details` - `/api/v2/data` returns in `jsonwrap` the full tree of dimensions that have been matched by the query.\n* `group-by-labels` - `/api/v2/data` returns in `jsonwrap` flattened labels per output dimension. These are used to identify the instances that have been aggregated into each dimension, making it possible to provide a map, like Netdata does for Kubernetes.\n* `natural-points` - return timestamps as found in the database. The result is again fixed-step, but the query engine attempts to align them with the timestamps found in the database.\n* `virtual-points` - return timestamps independent of the database alignment. This is needed aggregating data across multiple Netdata Agents, to ensure that their outputs do not need to be interpolated to be merged.\n* `selected-tier` - use data exclusively from the selected tier given with the `tier` parameter. This option is set automatically when the `tier` parameter is set.\n* `all-dimensions` - In `/api/v1` `jsonwrap` include metadata for all candidate metrics examined. In `/api/v2` this is standard behavior and no option is needed.\n* `label-quotes` - In `csv` output format, enclose each header label in quotes.\n* `objectrows` - Each row of value should be an object, not an array (only for `json` format).\n* `google_json` - Comply with google JSON/JSONP specs (only for `json` format).\n",

1996 "required": false,

1997 "allowEmptyValue": false,

1998 "schema": {

@@ -2186,7 +2186,7 @@

2186 "timeoutMS": {

2187 "name": "timeout",

2188 "in": "query",

2189 - "description": "Specify a timeout value in milliseconds after which the agent will abort the query and return a 503 error. A value of 0 indicates no timeout.\n",

2189 + "description": "Specify a timeout value in milliseconds after which the Agent will abort the query and return a 503 error. A value of 0 indicates no timeout.\n",

2190 "required": false,

2191 "schema": {

2192 "type": "number",

@@ -2197,7 +2197,7 @@

2197 "timeoutSecs": {

2198 "name": "timeout",

2199 "in": "query",

2200 - "description": "Specify a timeout value in seconds after which the agent will abort the query and return a 504 error. A value of 0 indicates no timeout, but some endpoints, like `weights`, do not accept infinite timeouts (they have a predefined default), so to disable the timeout it must be set to a really high value.\n",

2200 + "description": "Specify a timeout value in seconds after which the Agent will abort the query and return a 504 error. A value of 0 indicates no timeout, but some endpoints, like `weights`, do not accept infinite timeouts (they have a predefined default), so to disable the timeout it must be set to a really high value.\n",

2201 "required": false,

2202 "schema": {

2203 "type": "number",

@@ -3490,38 +3490,38 @@

3490 "type": "integer"

3491 },

3492 "agents": {

3493 - "description": "An array of agent definitions consulted to compose this response.\n",

3493 + "description": "An array of Agent definitions consulted to compose this response.\n",

3494 "type": "array",

3495 "items": {

3496 "type": "object",

3497 "properties": {

3498 "mg": {

3499 - "description": "The agent machine GUID.",

3499 + "description": "The Agent machine GUID.",

3500 "type": "string",

3501 "format": "uuid"

3502 },

3503 "nd": {

3504 - "description": "The agent cloud node ID.",

3504 + "description": "The Agent cloud node ID.",

3505 "type": "string",

3506 "format": "uuid"

3507 },

3508 "nm": {

3509 - "description": "The agent hostname.",

3509 + "description": "The Agent hostname.",

3510 "type": "string"

3511 },

3512 "ai": {

3513 - "description": "The agent index ID for this agent, in this response.",

3513 + "description": "The Agent index ID for this Agent, in this response.",

3514 "type": "integer"

3515 },

3516 "now": {

3517 - "description": "The current unix epoch timestamp of this agent.",

3517 + "description": "The current unix epoch timestamp of this Agent.",

3518 "type": "integer"

3519 }

3520 }

3521 }

3522 },

3523 "versions": {

3524 - "description": "Hashes that allow the caller to detect important database changes of Netdata agents.\n",

3524 + "description": "Hashes that allow the caller to detect important database changes of Netdata Agents.\n",

3525 "type": "object",

3526 "properties": {

3527 "nodes_hard_hash": {

@@ -3577,11 +3577,11 @@

3577 "type": "object",

3578 "properties": {

3579 "ai": {

3580 - "description": "The agent index id that has been contacted for this node.",

3580 + "description": "The Agent index id that has been contacted for this node.",

3581 "type": "integer"

3582 },

3583 "code": {

3584 - "description": "The HTTP response code of the response for this node. When working directly with an agent, this is always 200. If the `code` is missing, it should be assumed to be 200.",

3584 + "description": "The HTTP response code of the response for this node. When working directly with an Agent, this is always 200. If the `code` is missing, it should be assumed to be 200.",

3585 "type": "integer"

3586 },

3587 "msg": {

@@ -3589,7 +3589,7 @@

3589 "type": "string"

3590 },

3591 "ms": {

3592 - "description": "The time in milliseconds this node took to respond, or if the local agent responded for this node, the time it needed to execute the query. If `ms` is missing, the time that was required to query this node is unknown.",

3592 + "description": "The time in milliseconds this node took to respond, or if the local Agent responded for this node, the time it needed to execute the query. If `ms` is missing, the time that was required to query this node is unknown.",

3593 "type": "number"

3594 }

3595 }

@@ -3641,11 +3641,11 @@

3641 "type": "string"

3642 },

3643 "hops": {

3644 - "description": "How many hops away from the origin node, the queried one is. 0 means the agent itself is the origin node.",

3644 + "description": "How many hops away from the origin node, the queried one is. 0 means the Agent itself is the origin node.",

3645 "type": "integer"

3646 },

3647 "state": {

3648 - "description": "The current state of the node on this agent.",

3648 + "description": "The current state of the node on this Agent.",

3649 "type": "string",

3650 "enum": [

3651 "reachable",

@@ -3678,7 +3678,7 @@

3678 }

3679 },

3680 "contexts2": {

3681 - "description": "`/api/v2/contexts` and `/api/v2/q` response about multi-node contexts hosted by a Netdata agent.\n",

3681 + "description": "`/api/v2/contexts` and `/api/v2/q` response about multi-node contexts hosted by a Netdata Agent.\n",

3682 "type": "object",

3683 "properties": {

3684 "api": {

@@ -4310,7 +4310,7 @@

4310 "properties": {

4311 "aclk-available": {

4312 "type": "string",

4313 - "description": "Describes whether this agent is capable of connection to the Cloud. False means agent has been built without ACLK component either on purpose (user choice) or due to missing dependency.\n"

4313 + "description": "Describes whether this Agent is capable of connection to the Cloud. False means Agent has been built without ACLK component either on purpose (user choice) or due to missing dependency.\n"

4314 },

4315 "aclk-version": {

4316 "type": "integer",

@@ -4323,18 +4323,18 @@

4323 "type": "string"

4324 }

4325 },

4326 - "agent-claimed": {

4326 + "Agent-claimed": {

4327 "type": "boolean",

4328 - "description": "Informs whether this agent has been added to a space in the cloud (User has to perform claiming). If false (user didn't perform claiming) agent will never attempt any cloud connection."

4328 + "description": "Informs whether this Agent has been added to a space in the cloud (User has to perform claiming). If false (user didn't perform claiming) Agent will never attempt any cloud connection."

4329 },

4330 "claimed_id": {

4331 "type": "string",

4332 "format": "uuid",

4333 - "description": "Unique ID this agent uses to identify when connecting to cloud"

4333 + "description": "Unique ID this Agent uses to identify when connecting to cloud"

4334 },

4335 "online": {

4336 "type": "boolean",

4337 - "description": "Informs if this agent was connected to the cloud at the time this request has been processed."

4337 + "description": "Informs if this Agent was connected to the cloud at the time this request has been processed."

4338 },

4339 "used-cloud-protocol": {

4340 "type": "string",

@@ -4605,7 +4605,7 @@

4605 "properties": {

4606 "version": {

4607 "type": "integer",

4608 - "description": "The version of dynamic configuration supported by the Netdata agent."

4608 + "description": "The version of dynamic configuration supported by the Netdata Agent."

4609 },

4610 "tree": {

4611 "type": "object",

src/web/api/netdata-swagger.yaml

+30 -30

@@ -32,7 +32,7 @@ tags:

32 - name: alerts

33 description: Everything related to alerts

34 - name: management

35 - description: Everything related to managing netdata agents

35 + description: Everything related to managing netdata Agents

36 paths:

37 /api/v2/nodes:

38 get:

@@ -41,7 +41,7 @@ paths:

41 - nodes

42 summary: Nodes Info v2

43 description: |

44 - Get a list of all nodes hosted by this Netdata agent.

44 + Get a list of all nodes hosted by this Netdata Agent.

45 parameters:

46 - $ref: '#/components/parameters/scopeNodes'

47 - $ref: '#/components/parameters/scopeContexts'

@@ -54,7 +54,7 @@ paths:

54 application/json:

55 schema:

56 description: |

57 - `/api/v2/nodes` response for all nodes hosted by a Netdata agent.

57 + `/api/v2/nodes` response for all nodes hosted by a Netdata Agent.

58 type: object

59 properties:

60 api:

@@ -74,7 +74,7 @@ paths:

74 - contexts

75 summary: Contexts Info v2

76 description: |

77 - Get a list of all contexts, across all nodes, hosted by this Netdata agent.

77 + Get a list of all contexts, across all nodes, hosted by this Netdata Agent.

78 parameters:

79 - $ref: '#/components/parameters/scopeNodes'

80 - $ref: '#/components/parameters/scopeContexts'

@@ -94,7 +94,7 @@ paths:

94 - contexts

95 summary: Full Text Search v2

96 description: |

97 - Get a list of contexts, across all nodes, hosted by this Netdata agent, matching a string expression

97 + Get a list of contexts, across all nodes, hosted by this Netdata Agent, matching a string expression

98 parameters:

99 - name: q

100 in: query

@@ -1186,7 +1186,7 @@ components:

1186 name: scope_nodes

1187 in: query

1188 description: |

1189 - A simple pattern limiting the nodes scope of the query. The scope controls both data and metadata response. The simple pattern is checked against the nodes' machine guid, node id and hostname. The default nodes scope is all nodes for which this agent has data for. Usually the nodes scope is used to slice the entire dashboard (e.g. the Global Nodes Selector at the Netdata Cloud overview dashboard). Both positive and negative simple pattern expressions are supported.

1189 + A simple pattern limiting the nodes scope of the query. The scope controls both data and metadata response. The simple pattern is checked against the nodes' machine guid, node id and hostname. The default nodes scope is all nodes for which this Agent has data for. Usually the nodes scope is used to slice the entire dashboard (e.g. the Global Nodes Selector at the Netdata Cloud overview dashboard). Both positive and negative simple pattern expressions are supported.

1190 required: false

1191 schema:

1192 type: string

@@ -1196,7 +1196,7 @@ components:

1196 name: scope_contexts

1197 in: query

1198 description: |

1199 - A simple pattern limiting the contexts scope of the query. The scope controls both data and metadata response. The default contexts scope is all contexts for which this agent has data for. Usually the contexts scope is used to slice data on the dashboard (e.g. each context based chart has its own contexts scope, limiting the chart to all the instances of the selected context). Both positive and negative simple pattern expressions are supported.

1199 + A simple pattern limiting the contexts scope of the query. The scope controls both data and metadata response. The default contexts scope is all contexts for which this Agent has data for. Usually the contexts scope is used to slice data on the dashboard (e.g. each context based chart has its own contexts scope, limiting the chart to all the instances of the selected context). Both positive and negative simple pattern expressions are supported.

1200 required: false

1201 schema:

1202 type: string

@@ -1333,7 +1333,7 @@ components:

1333 * `details` - `/api/v2/data` returns in `jsonwrap` the full tree of dimensions that have been matched by the query.

1334 * `group-by-labels` - `/api/v2/data` returns in `jsonwrap` flattened labels per output dimension. These are used to identify the instances that have been aggregated into each dimension, making it possible to provide a map, like Netdata does for Kubernetes.

1335 * `natural-points` - return timestamps as found in the database. The result is again fixed-step, but the query engine attempts to align them with the timestamps found in the database.

1336 - * `virtual-points` - return timestamps independent of the database alignment. This is needed aggregating data across multiple Netdata agents, to ensure that their outputs do not need to be interpolated to be merged.

1336 + * `virtual-points` - return timestamps independent of the database alignment. This is needed aggregating data across multiple Netdata Agents, to ensure that their outputs do not need to be interpolated to be merged.

1337 * `selected-tier` - use data exclusively from the selected tier given with the `tier` parameter. This option is set automatically when the `tier` parameter is set.

1338 * `all-dimensions` - In `/api/v1` `jsonwrap` include metadata for all candidate metrics examined. In `/api/v2` this is standard behavior and no option is needed.

1339 * `label-quotes` - In `csv` output format, enclose each header label in quotes.

@@ -1520,7 +1520,7 @@ components:

1520 name: timeout

1521 in: query

1522 description: |

1523 - Specify a timeout value in milliseconds after which the agent will abort the query and return a 503 error. A value of 0 indicates no timeout.

1523 + Specify a timeout value in milliseconds after which the Agent will abort the query and return a 503 error. A value of 0 indicates no timeout.

1524 required: false

1525 schema:

1526 type: number

@@ -1530,7 +1530,7 @@ components:

1530 name: timeout

1531 in: query

1532 description: |

1533 - Specify a timeout value in seconds after which the agent will abort the query and return a 504 error. A value of 0 indicates no timeout, but some endpoints, like `weights`, do not accept infinite timeouts (they have a predefined default), so to disable the timeout it must be set to a really high value.

1533 + Specify a timeout value in seconds after which the Agent will abort the query and return a 504 error. A value of 0 indicates no timeout, but some endpoints, like `weights`, do not accept infinite timeouts (they have a predefined default), so to disable the timeout it must be set to a really high value.

1534 required: false

1535 schema:

1536 type: number

@@ -2563,31 +2563,31 @@ components:

2563 type: integer

2564 agents:

2565 description: |

2566 - An array of agent definitions consulted to compose this response.

2566 + An array of Agent definitions consulted to compose this response.

2567 type: array

2568 items:

2569 type: object

2570 properties:

2571 mg:

2572 - description: The agent machine GUID.

2572 + description: The Agent machine GUID.

2573 type: string

2574 format: uuid

2575 nd:

2576 - description: The agent cloud node ID.

2576 + description: The Agent cloud node ID.

2577 type: string

2578 format: uuid

2579 nm:

2580 - description: The agent hostname.

2580 + description: The Agent hostname.

2581 type: string

2582 ai:

2583 - description: The agent index ID for this agent, in this response.

2583 + description: The Agent index ID for this Agent, in this response.

2584 type: integer

2585 now:

2586 - description: The current unix epoch timestamp of this agent.

2586 + description: The current unix epoch timestamp of this Agent.

2587 type: integer

2588 versions:

2589 description: |

2590 - Hashes that allow the caller to detect important database changes of Netdata agents.

2590 + Hashes that allow the caller to detect important database changes of Netdata Agents.

2591 type: object

2592 properties:

2593 nodes_hard_hash:

@@ -2636,16 +2636,16 @@ components:

2636 type: object

2637 properties:

2638 ai:

2639 - description: The agent index id that has been contacted for this node.

2639 + description: The Agent index id that has been contacted for this node.

2640 type: integer

2641 code:

2642 - description: The HTTP response code of the response for this node. When working directly with an agent, this is always 200. If the `code` is missing, it should be assumed to be 200.

2642 + description: The HTTP response code of the response for this node. When working directly with an Agent, this is always 200. If the `code` is missing, it should be assumed to be 200.

2643 type: integer

2644 msg:

2645 description: A human readable description of the error, if any. If `msg` is missing, or is the empty string `""` or is `null`, there is no description associated with the current status.

2646 type: string

2647 ms:

2648 - description: The time in milliseconds this node took to respond, or if the local agent responded for this node, the time it needed to execute the query. If `ms` is missing, the time that was required to query this node is unknown.

2648 + description: The time in milliseconds this node took to respond, or if the local Agent responded for this node, the time it needed to execute the query. If `ms` is missing, the time that was required to query this node is unknown.

2649 type: number

2650 nodeWithDataStatistics:

2651 allOf:

@@ -2673,10 +2673,10 @@ components:

2673 description: The version of the Netdata Agent the node runs.

2674 type: string

2675 hops:

2676 - description: How many hops away from the origin node, the queried one is. 0 means the agent itself is the origin node.

2676 + description: How many hops away from the origin node, the queried one is. 0 means the Agent itself is the origin node.

2677 type: integer

2678 state:

2679 - description: The current state of the node on this agent.

2679 + description: The current state of the node on this Agent.

2680 type: string

2681 enum:

2682 - reachable

@@ -2697,7 +2697,7 @@ components:

2697 type: boolean

2698 contexts2:

2699 description: |

2700 - `/api/v2/contexts` and `/api/v2/q` response about multi-node contexts hosted by a Netdata agent.

2700 + `/api/v2/contexts` and `/api/v2/q` response about multi-node contexts hosted by a Netdata Agent.

2701 type: object

2702 properties:

2703 api:

@@ -3167,7 +3167,7 @@ components:

3167 aclk-available:

3168 type: string

3169 description: |

3170 - Describes whether this agent is capable of connection to the Cloud. False means agent has been built without ACLK component either on purpose (user choice) or due to missing dependency.

3170 + Describes whether this Agent is capable of connection to the Cloud. False means Agent has been built without ACLK component either on purpose (user choice) or due to missing dependency.

3171 aclk-version:

3172 type: integer

3173 description: Describes which ACLK version is currently used.

@@ -3176,17 +3176,17 @@ components:

3176 description: List of supported protocols for communication with Cloud.

3177 items:

3178 type: string

3179 - agent-claimed:

3179 + Agent-claimed:

3180 type: boolean

3181 - description: Informs whether this agent has been added to a space in the cloud (User has to perform claiming).

3182 - If false (user didn't perform claiming) agent will never attempt any cloud connection.

3181 + description: Informs whether this Agent has been added to a space in the cloud (User has to perform claiming).

3182 + If false (user didn't perform claiming) Agent will never attempt any cloud connection.

3183 claimed_id:

3184 type: string

3185 format: uuid

3186 - description: Unique ID this agent uses to identify when connecting to cloud

3186 + description: Unique ID this Agent uses to identify when connecting to cloud

3187 online:

3188 type: boolean

3189 - description: Informs if this agent was connected to the cloud at the time this request has been processed.

3189 + description: Informs if this Agent was connected to the cloud at the time this request has been processed.

3190 used-cloud-protocol:

3191 type: string

3192 description: Informs which protocol is used to communicate with cloud

@@ -3374,7 +3374,7 @@ components:

3374 properties:

3375 version:

3376 type: integer

3377 - description: The version of dynamic configuration supported by the Netdata agent.

3377 + description: The version of dynamic configuration supported by the Netdata Agent.

3378 tree:

3379 type: object

3380 description: A map of configuration entity paths, each containing one or more configurable entities.

src/web/server/README.md

+3 -3

@@ -90,7 +90,7 @@ Using the above, Netdata will bind to:

90 - IPv4 127.0.0.1 at port 19999 (port was used from `default port`). Only the UI (dashboard) and the read API will be accessible on this port. Both HTTP and HTTPS requests will be accepted.

91 - IPv4 10.1.1.1 at port 19998. The management API and `netdata.conf` will be accessible on this port.

92 - All the IPs `hostname` resolves to (both IPv4 and IPv6 depending on the resolved IPs) at port 19997. Only badges will be accessible on this port.

93 -- All IPv6 IPs at port 19996. Only metric streaming requests from other Netdata agents will be accepted on this port. Only encrypted streams will be allowed (i.e. child nodes also need to be [configured for TLS](/src/streaming/README.md).

93 +- All IPv6 IPs at port 19996. Only metric streaming requests from other Netdata Agents will be accepted on this port. Only encrypted streams will be allowed (i.e. child nodes also need to be [configured for TLS](/src/streaming/README.md).

94 - All the IPs `localhost` resolves to (both IPv4 and IPv6 depending the resolved IPs) at port 19996. This port will only accept registry API requests.

95 - All IPv4 and IPv6 IPs at port `http` as set in `/etc/services`. Only the UI (dashboard) and the read API will be accessible on this port.

96 - Unix domain socket `/run/netdata/netdata.sock`. All requests are serviceable on this socket. Note that in some OSs like Fedora, every service sees a different `/tmp`, so don't create a Unix socket under `/tmp`. `/run` or `/var/run` is suggested.

@@ -179,7 +179,7 @@ Example:

179

180 For information how to configure the child to use TLS, check [securing the communication](/src/streaming/README.md#securing-streaming-with-tlsssl) in the streaming documentation. There you will find additional details on the expected behavior for client and server nodes, when their respective TLS options are enabled.

181

182 -When we define the use of SSL in a Netdata agent for different ports, Netdata will apply the behavior specified on each port. For example, using the configuration line below:

182 +When we define the use of SSL in a Netdata Agent for different ports, Netdata will apply the behavior specified on each port. For example, using the configuration line below:

183

184 ```text

185 [web]

@@ -235,7 +235,7 @@ Netdata supports access lists in `netdata.conf`:

235

236 - `allow management from` checks the IPs to allow API management calls. Management via the API is currently supported for [health](/src/web/api/health/README.md#health-management-api)

237

238 -In order to check the FQDN of the connection without opening the Netdata agent to DNS-spoofing, a reverse-dns record

238 +In order to check the FQDN of the connection without opening the Netdata Agent to DNS-spoofing, a reverse-dns record

239 must be setup for the connecting host. At connection time the reverse-dns of the peer IP address is resolved, and

240 a forward DNS resolution is made to validate the IP address against the name-pattern.

241

Capitalize the word "Agent" (#19044)