diff options
Diffstat (limited to 'docs/category-overview-pages')
19 files changed, 4 insertions, 533 deletions
diff --git a/docs/category-overview-pages/accessing-netdata-dashboards.md b/docs/category-overview-pages/accessing-netdata-dashboards.md deleted file mode 100644 index 8d83c89351..0000000000 --- a/docs/category-overview-pages/accessing-netdata-dashboards.md +++ /dev/null @@ -1,40 +0,0 @@ -# Dashboards and Charts - -This guide covers how to access both Agent and Cloud dashboards, along with links to explore specific sections in more detail. - -When you access the Netdata dashboard through the Cloud, you'll always have the latest version available. - -By default, the Agent dashboard shows the latest version (matching Netdata Cloud). However, there are a few exceptions: - -- Without internet access, the Agent can't download the newest dashboards. In this case, it will automatically use the bundled version. -- Users have defined, e.g. through URL bookmark, that they want to see the previous version of the dashboard (accessible `http://NODE:19999/v1`, replacing `NODE` with the IP address or hostname of your Agent). - -## Main sections - -The Netdata dashboard consists of the following main sections: - -- [Home tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/home-tab.md) -- [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md) -- [Netdata charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/netdata-charts.md) -- [Metrics tab and single node tabs](https://github.com/netdata/netdata/blob/master/docs/dashboard/metrics-tab-and-single-node-tabs.md) -- [Top tab](https://github.com/netdata/netdata/blob/master/docs/cloud/runtime-troubleshooting-with-functions.md) -- [Logs tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/logs-tab.md) -- [Dashboards tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/dashboards-tab.md) -- [Alerts tab](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alerts.md) -- [Events tab](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/events-feed.md) - -> **Note** -> -> 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. - -## How to access the dashboards? - -### Netdata Cloud - -You can access the dashboard at <https://app.netdata.cloud/> and [sign-in with an account or sign-up](https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/authentication-and-authorization.md) if you don't have an account yet. - -### Netdata Agent - -To view your Netdata dashboard, open a web browser and enter the address `http://NODE:19999` - replace `NODE` with your Agent's IP address or hostname. If the Agent is on the same machine, use http://localhost:19999. - -Documentation for previous Agent dashboard can still be found [here](https://github.com/netdata/netdata/blob/master/src/web/gui/README.md). diff --git a/docs/category-overview-pages/authentication-and-authorization.md b/docs/category-overview-pages/authentication-and-authorization.md deleted file mode 100644 index 56c83fa653..0000000000 --- a/docs/category-overview-pages/authentication-and-authorization.md +++ /dev/null @@ -1,27 +0,0 @@ -# Authentication & Authorization - -This section contains documentation about how Netdata allows users to Authenticate with Netdata Cloud, as well as the Authorization flows that control the access and actions of their teammates in Netdata Cloud. - -## Authentication - -### Email - -To sign in/sign up using email, visit [Netdata Cloud](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_email_section), enter your email address, and click the **Sign in by email** button. - -Click the **Verify** button in the email you received to start using Netdata Cloud. - -### Google and GitHub OAuth - -When you use Google/GitHub OAuth, your Netdata Cloud account is associated with the email address that Netdata Cloud receives through OAuth. - -To sign in/sign up using Google or GitHub OAuth, visit [Netdata Cloud](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_google_github_section) select the method you want to use. After the verification steps, you will be signed in to Netdata Cloud. - -### Enterprise SSO Authentication - -Netdata integrates with SSO tools, allowing you to control how your team connects and authenticates to Netdata Cloud. - -For more information, see [Enterprise SSO Authentication](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md). - -## Authorization - -Once logged in, you can manage role-based access in your space to give each team member the appropriate role. For more information, see [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md). diff --git a/docs/category-overview-pages/build-the-netdata-agent-yourself.md b/docs/category-overview-pages/build-the-netdata-agent-yourself.md deleted file mode 100644 index 99166ad951..0000000000 --- a/docs/category-overview-pages/build-the-netdata-agent-yourself.md +++ /dev/null @@ -1,3 +0,0 @@ -# Build the Netdata Agent yourself - -This section contains documentation on all the ways that you can build the Netdata Agent.
\ No newline at end of file diff --git a/docs/category-overview-pages/developer-and-contributor-corner.md b/docs/category-overview-pages/developer-and-contributor-corner.md deleted file mode 100644 index d4d86382ac..0000000000 --- a/docs/category-overview-pages/developer-and-contributor-corner.md +++ /dev/null @@ -1,3 +0,0 @@ -# Developer and Contributor Corner - -In this section of our Documentation you will find more advanced information, suited for developers and contributors alike.
\ No newline at end of file diff --git a/docs/category-overview-pages/install-netdata-on-embedded-systems.md b/docs/category-overview-pages/install-netdata-on-embedded-systems.md deleted file mode 100644 index dfaa4482c2..0000000000 --- a/docs/category-overview-pages/install-netdata-on-embedded-systems.md +++ /dev/null @@ -1,3 +0,0 @@ -# Install Netdata on Embedded Systems Overview - -This section contains documentation for installation methods when it comes to Embedded Systems.
\ No newline at end of file diff --git a/docs/category-overview-pages/install-with-a-cicd-provisioning-system.md b/docs/category-overview-pages/install-with-a-cicd-provisioning-system.md deleted file mode 100644 index 30a5a706cd..0000000000 --- a/docs/category-overview-pages/install-with-a-cicd-provisioning-system.md +++ /dev/null @@ -1,3 +0,0 @@ -# Install with a CI/CD Provisioning System Overview - -This section contains documentation on all the installation methods through a CI/CD system.
\ No newline at end of file diff --git a/docs/category-overview-pages/installation-overview.md b/docs/category-overview-pages/installation-overview.md deleted file mode 100644 index 703ca26b9b..0000000000 --- a/docs/category-overview-pages/installation-overview.md +++ /dev/null @@ -1,10 +0,0 @@ -# Installation - -In this category you can find instructions on all the possible ways you can install Netdata on the -[supported platforms](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/versions-and-platforms.md). - -If this is your first time using Netdata, we recommend that you first start with the -[quick installation guide](https://github.com/netdata/netdata/edit/master/packaging/installer/README.md) and then -go into the more advanced options available to you. - - diff --git a/docs/category-overview-pages/integrations-overview.md b/docs/category-overview-pages/integrations-overview.md deleted file mode 100644 index afd4cf306d..0000000000 --- a/docs/category-overview-pages/integrations-overview.md +++ /dev/null @@ -1,31 +0,0 @@ -<!-- -title: "Integrations" -sidebar_label: "Integrations" -custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/category-overview-pages/integrations-overview.md" -description: "Available integrations in Netdata" -learn_status: "Published" -learn_rel_path: "Integrations" -sidebar_position: 60 ---> - -# Integrations - -Netdata's ability to monitor out of the box every potentially useful aspect of a node's operation is unparalleled. -But Netdata also provides out of the box, meaningful charts and alerts for hundreds of applications, with the ability -to be easily extended to monitor anything. See the full list of Netdata's capabilities and how you can extend them in the -[supported collectors list](https://github.com/netdata/netdata/blob/master/src/collectors/COLLECTORS.md). - -Our out of the box alerts were created by expert professionals and have been validated on the field, countless times. -Use them to trigger [alert notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) -either centrally, via the -[Cloud alert notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md) -, or by configuring individual -[agent notifications](https://github.com/netdata/netdata/blob/master/src/health/notifications/README.md). - -We designed Netdata with interoperability in mind. The Agent collects thousands of metrics every second, and then what -you do with them is up to you. You can -[store metrics in the database engine](https://github.com/netdata/netdata/blob/master/src/database/README.md), -or send them to another time series database for long-term storage or further analysis using -Netdata's [exporting engine](https://github.com/netdata/netdata/edit/master/src/exporting/README.md). - - diff --git a/docs/category-overview-pages/machine-learning-and-assisted-troubleshooting.md b/docs/category-overview-pages/machine-learning-and-assisted-troubleshooting.md index c531f0128b..a94f68fa22 100644 --- a/docs/category-overview-pages/machine-learning-and-assisted-troubleshooting.md +++ b/docs/category-overview-pages/machine-learning-and-assisted-troubleshooting.md @@ -2,6 +2,6 @@ Netdata provides a variety of Machine Learning features to help you troubleshoot certain scenarios that might come up. -- K-means clustering [Machine Learning models](https://github.com/netdata/netdata/blob/master/src/ml/README.md) are trained to power the [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/dashboard/anomaly-advisor-tab.md) on the dashboard, which allows you to identify anomalies in your infrastructure -- [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) are possible through the dashboard using the [Two-sample Kolmogorov Smirnov](https://en.wikipedia.org/wiki/Kolmogorov%E2%80%93Smirnov_test#Two-sample_Kolmogorov%E2%80%93Smirnov_test) statistical test and Volume heuristic measures -- The [Netdata Assistant](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-assistant.md) is able to answer your prompts when it comes to troubleshooting alerts and anomalies. +- K-means clustering [Machine Learning models](https://github.com/netdata/netdata/blob/master/src/ml/README.md) are trained to power the [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/dashboards-and-charts/anomaly-advisor-tab.md) on the dashboard, which allows you to identify anomalies in your infrastructure +- [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/metric-correlations.md) are possible through the dashboard using the [Two-sample Kolmogorov Smirnov](https://en.wikipedia.org/wiki/Kolmogorov%E2%80%93Smirnov_test#Two-sample_Kolmogorov%E2%80%93Smirnov_test) statistical test and Volume heuristic measures +- The [Netdata Assistant](https://github.com/netdata/netdata/blob/master/docs/netdata-assistant.md) is able to answer your prompts when it comes to troubleshooting alerts and anomalies. diff --git a/docs/category-overview-pages/metrics-streaming-and-replication.md b/docs/category-overview-pages/metrics-streaming-and-replication.md deleted file mode 100644 index f473105fdb..0000000000 --- a/docs/category-overview-pages/metrics-streaming-and-replication.md +++ /dev/null @@ -1,175 +0,0 @@ -# Netdata Parents (Streaming and Replication) - -## What are they and why do we need them? - -A “Parent” is a Netdata Agent, like the ones we install on all our systems, but is configured as a central node that receives, stores and processes metrics data from other Netdata “Child” nodes in our infrastructure. - -Netdata Parents are flexible. You can have one big active-active cluster of Netdata Parents, or you can spread a lot of independent Parents across the infrastructure. - -This “distributed still centralized” setup provides a lot of benefits. Let’s see them: - -## Infrastructure-Level Dashboards: All Nodes in One Dashboard - -A Parent node receives and aggregates metrics data from all child nodes that push metrics to it, presenting all of them on a single, centralized dashboard. - -Metrics streaming between Netdata nodes is real-time and low-latency, so that the Parent can provide the same resolution and detail its children provide. - -Each chart on the Parent’s dashboard is automatically turned into a multi-node chart, allowing instant aggregation of the data across the entire dashboard. This is transparent and automatic for all kinds of charts, even application-specific ones. For example, when you have 2 PostgreSQL servers in your infrastructure, the parent will present one set of charts for PostgreSQL and these charts will include data from both servers. - -## Increased Data Retention: Store More, Learn More - -Netdata’s database (`dbengine`), supports multiple tiers of variable resolution for storing metrics’ samples. Tier 0 is the high-resolution one and usually stores per second data. Tier 1 is the middle resolution one, downsampling data to per minute. Tier 2 is the low-resolution one, downsampling data to per hour. With this setup, a default Netdata setup is usually able to maintain 2-3 days of high resolution and up to a year of low-resolution data, all in less than 1 GB of disk space. - -In many cases, however, organizations require a lot more retention than this. A Netdata Parent can be configured to have weeks or even months of high-resolution data and several years of low-resolution data for all its Child nodes, by allowing the Netdata database to grow to hundreds of GiBs or even several TiBs. - -## Monitoring Ephemeral Nodes: No Node Left Behind - -Production systems are often ephemeral by nature. In containerized and orchestrated environments, like Kubernetes, nodes may come and go due to scaling policies, maintenance tasks, or as part of regular operations. - -Netdata Parents come to the rescue in such scenarios. They can continuously receive metrics from ephemeral nodes during their lifecycle. As these nodes are removed or replaced, the Parent retains their performance history, essentially archiving the life of each node. - -The Netdata dashboards on the Parents automatically bring into the charts data from archived nodes when users pan the dashboard to the time-window these nodes were alive. This means that no data is lost and visibility is maintained across the entire lifespan of every node, regardless of its ephemeral nature. - -## Unified Alerts Management: Silence the Noise - -Each Netdata Agent is able to run health checks, trigger alerts and send notifications on its own. However, in a large-scale infrastructure with numerous nodes, each capable of generating alerts, managing these notifications can quickly become a challenge. Duplicate alerts and non-centralized management can lead to unnecessary noise, causing alert fatigue and possibly overlooking critical warnings. - -Netdata Parents provide a solution to this problem. By configuring a Parent node to handle all alerts and health checks, and disabling health monitoring on the Child nodes, you centralize your alerts management, meaning that all alerts are now generated from a single place, reducing noise and ensuring that each unique issue only triggers a single notification. - -In addition to making alert management more straightforward, this setup also allows for more refined control over your alert configurations. Instead of managing alert settings across multiple nodes, you can handle all configurations in one place, ensuring consistency and ease of management. - -## Offloading Production Systems: Prioritize Performance - -In a production environment, every bit of system resources is crucial. Minimizing the overhead due to monitoring and observability is vital to ensure optimal system performance. Although the Netdata Agent is designed to be lightweight and efficient, using a Netdata Parent can allow the Netdata Agents on your production systems to focus on the absolutely necessary for collecting metrics and pushing them to their Parent. - -On your production systems, by configuring the Netdata Agents to use the `alloc` database mode with 5-10 minutes of retention time and disabling health monitoring and Machine Learning (ML) processing, you significantly reduce the system resources consumed by the monitoring system. - -Netdata, with the `alloc` database mode, doesn't touch the disk at all (apart from logging - which can also be disabled). This approach eliminates any potential disk I/O impact from Netdata on your production applications, which could be particularly beneficial in I/O-sensitive environments. - -## Fault Tolerance and Redundancy: Ensure Continuous Monitoring - -Netdata Agents stream metrics to one Netdata Parent at a time. But more than one Parent can be configured on each child. The first available at any given time is used. - -Similarly, Netdata Parents can be configured to stream/proxy the data they receive to another Netdata Parent. And they can support multiple Parents too, one of which will be used at any given time. - -Configuration allows setting up a circular streaming setup. Parent A streams to Parent B and Parent B streams to Parent A. Child nodes are configured to stream to any of Parents A and B and they will automatically fall back and switch parents as necessary. - -With the replication feature (enabled by default), all nodes replicate missing data on their Parent, before streaming live metrics, filling up any gap the Parent may have. - -The same setup can work for 2 or even more parents, to form an active-active multi-node cluster. Child nodes can connect to any of the parent nodes available and the parent nodes will automatically replicate and stream metrics to each other. - -The setup is optimized even for wide-area connections between child nodes and parents, or for cases where the bandwidth between child nodes and parents has a cost associated with it. At any given time each child node sends its data only once. The parents then replicate and stream this data to each other. - -## Security and Isolation: Protect Your Production Systems - -Parent nodes can be set up in your organization's Demilitarized Zone (DMZ), acting as a protective barrier or application firewall, shielding your production Netdata agents from the outside world. - -With Netdata Parents configured, the Netdata Agents running on your production systems need only one connection to these parents. They don’t need to run data queries, they will never send alert notifications, or even connect to Netdata Cloud. - -Especially for Netdata Cloud, when the Parent node is connected to Netdata Cloud, it registers its Child nodes to it and can serve all functions required by the Cloud on behalf of the Child nodes. So, although only the parent is connected to Netdata Cloud, there is no difference in the user features you enjoy on Netdata Cloud in regard to your production systems. They will all be there. - -## FAQ about Netdata Parents - -### How much can a Parent node scale? - -For about 1 million real-time metrics, with a default configuration: - -- collected and streamed to it per second, -- stored in 3 database tiers (high, mid, low resolution), -- with ML training and anomaly detection running, -- health for alerts and notifications - -And about 2 TiB of storage for metrics, you will need about 5-8 CPU cores and 32GiB of RAM. On such a setup you can have: - -- 15 days of high resolution metrics -- 3 months of mid resolution metrics -- 1 year of low resolution metrics - -For such a setup, we recommend a 16 CPU cores system so that there is spare capacity for queries. More RAM and faster disks will give faster queries. - -So, depending on the number of metrics per node you have and the size of your Parents, you may be able to aggregate 200 to 500 nodes per Parent. - -### If I set up 2 active-active parents, will I be able to have more Child nodes stream to them? - -No. When you set up an active-active cluster, even if child nodes connect randomly to one or the other, all the parent nodes receive all the metrics of all the child nodes. So, all of them do all the work. - -There is a feature we currently work on, to allow Parent nodes to detect that they receive ML information with the streamed metric data (they receive it already but they ignore it), to prevent them from training their own ML models and running anomaly detection again for the child node. But this is not ready yet. - -### How much retention do the child nodes need? - -Child nodes need to have only the retention required in order to connect to another Parent if one fails or stops for maintenance. - -- If you have an active-active cluster of parents, 5 to 10 minutes in `alloc` mode is enough. -- If you have only 1 parent, it would be better to run the child nodes with `dbengine` so that they will have enough retention to backfill the parent nodes if it stops for a few hours for maintenance. - -### Does streaming between child nodes and parents support encryption? - -Yes. You can configure your parent nodes to enable TLS and configure the child nodes to connect with TLS to it. The streaming connection is also compressed with LZ4 and this works even on top of TLS. - -### Can I have an HTTP proxy between parent and child nodes? - -No. The streaming protocol works on the same port as the internal web server of Netdata Agents, but the protocol is not HTTP-friendly and cannot be understood by HTTP proxy servers. - -### Should I load balance the parents with a TCP load balancer? - -Although this can be done and for streaming between child and parent nodes it could work, we recommend not doing it. It can lead to several kinds of problems. - -It is better to configure all the parent nodes directly in the child nodes `stream.conf`. The child nodes will do everything in their power to find a parent node to connect and they will never give up. - -### When I have an active-active cluster of parents, will I receive alert notifications from both of them? - -If both are configured to run health checks and trigger alerts, yes. - -We recommend using Netdata Cloud to avoid receiving duplicate alert notifications. Netdata Cloud deduplicates alert notifications so that you will receive them only once. On top of that, you can control silencing and routing directly from the Netdata Cloud UI. - -### When I have only Parents connected to Netdata Cloud, will I be able to use the Functions feature on my child nodes? - -Yes. - -Functions is a feature of data collection plugins to expose functions that can be run from the dashboard to view more detailed information about a data collection. For example, apps.plugin exposes the processes function that returns a list of all the processes running, together with information about their CPU utilization, memory consumption, disk I/O operations, bandwidth, and a lot more. - -When a parent receives a Function request, it forwards it to the plugin that exposes it. If the plugin is available over a streaming connection, the parent will forward the request to the socket it receives metrics from. This process will be repeated even if many parents are chained in order to reach the child. - -### If I have a set of 2 active-active parents and get one out for maintenance for a few hours, will it have missing data when it returns back online? - -There are 2 reasons you may have gaps in your data after you bring it back online: - -1. Replication does not replicate metrics that are not actively collected. So, when the parent comes back, if there are samples that this parent does not have, for metrics that are not currently being collected, these samples will not be propagated to that parent. [We are working to fix this issue](https://github.com/netdata/netdata/issues/15198). -2. If the parent has been offline for a long time and the child nodes run in db mode `alloc`, you need to plan how you will bring this parent back online. Child nodes in this mode do not have enough retention to backfill the parent and if they connect to it before the other parent, you will end up with missing information on that parent. - -The simplest way to solve this is to block at the firewall all connections to port 19999 from child nodes, but allow connections from the other parent nodes. Once replication finishes for all nodes, you can unblock the connections from child nodes to it. - -### I got a parent out of maintenance but it replicates (backfills) missing data slowly. Can I speed it up? - -Yes, there is a setting on `netdata.conf` under section `[db]` called `replication threads`. The default value is 1. - -Usually, each thread is able to replicate about 2-5 million samples per second. We suggest setting this to 5 threads for all parents. Generally do not use too many threads because you are risking congesting the disks and/or the CPU cores available. Keep in mind that the sending parent needs this setting. - -There is no need to increase this number on child nodes. Each node has one replication sender, so when hundreds of nodes are replicating to a parent, there are already a lot of senders pushing metrics to it. - -### I have multiple active-active parents. Which one is used by Netdata Cloud for queries? - -When you have multiple parents available, the one that is further away from the child node is used by Netdata Cloud, unless it does not have the data required. - -This works like this: The child has `hops = 0`. Each parent receiving metrics for this child increases the `hops` by 1. So the first parent will have `hops = 1`, the second parent will have `hops = 2` and so on. - -Netdata Cloud knows the retention of each parent. So, when it needs data from this child, it first checks the available retention each parent has for it and then it uses the parent with the higher `hops`. If no parent is available and the child node is directly connected to Netdata Cloud, it uses the child. - -### Is there a way to balance child nodes to the parent nodes of an active-active cluster? - -If you have 2 parent nodes A and B, you can configure them on half the child nodes as A, B, and the other half as B, A. The child nodes will connect to the first available (left to right). If both A and B are online, half of the child nodes will connect to A and the other half to B. - -Keep in mind, however, that if you restart a parent, all the child nodes that were connected to it will automatically reconnect to the other parent. Once this happens, the child nodes will stay connected to it. - -### Is there a way to get notified when a child gets disconnected? - -There are 2 kinds of production nodes: -1. **Permanent nodes** - These are nodes that should be available permanently and if they disconnect an alert should be triggered to notify you. - By default, all nodes are considered permanent (not ephemeral). -2. **Ephemeral nodes** - These are nodes that are ephemeral by nature and they may shutdown at any point in time without any impact on the services you run. - -To set the ephemeral flag on a node, edit its `netdata.conf` and in the `[health]` section set is `ephemeral = yes`. This setting is propagated to parent nodes and Netdata Cloud. - -When using Netdata Cloud (via a parent or directly) and a permanent node gets disconnected, Netdata Cloud sends node disconnection notifications. diff --git a/docs/category-overview-pages/misc-overview.md b/docs/category-overview-pages/misc-overview.md deleted file mode 100644 index dbb11e9bc8..0000000000 --- a/docs/category-overview-pages/misc-overview.md +++ /dev/null @@ -1,3 +0,0 @@ -# Miscellaneous material - -This section contains material that will be moved to new locations as we see fit. We keep it here to make it accessible while we make these changes.
\ No newline at end of file diff --git a/docs/category-overview-pages/netdata-apis.md b/docs/category-overview-pages/netdata-apis.md deleted file mode 100644 index 82d1c1752e..0000000000 --- a/docs/category-overview-pages/netdata-apis.md +++ /dev/null @@ -1,5 +0,0 @@ -# Netdata APIs Overview - -This section contains information about Netdata's APIs. - -You can access the Netdata Agent's API through swagger UI [here](/api).
\ No newline at end of file diff --git a/docs/category-overview-pages/netdata-architecture.md b/docs/category-overview-pages/netdata-architecture.md deleted file mode 100644 index 70f1265977..0000000000 --- a/docs/category-overview-pages/netdata-architecture.md +++ /dev/null @@ -1,3 +0,0 @@ -# Netdata Architecture Overview - -This section's purpose is to explain the architecture of Netdata, the role of the Agent and the Cloud, and more.
\ No newline at end of file diff --git a/docs/category-overview-pages/optimizing-metrics-database.md b/docs/category-overview-pages/optimizing-metrics-database.md deleted file mode 100644 index fdbd3b690c..0000000000 --- a/docs/category-overview-pages/optimizing-metrics-database.md +++ /dev/null @@ -1,3 +0,0 @@ -# Optimizing Metrics Database Overview - -This section contains documentation to help you understand how the metrics DB works, understand the key features and configure them to suit your needs.
\ No newline at end of file diff --git a/docs/category-overview-pages/reverse-proxies.md b/docs/category-overview-pages/reverse-proxies.md deleted file mode 100644 index 1b4d935a30..0000000000 --- a/docs/category-overview-pages/reverse-proxies.md +++ /dev/null @@ -1,34 +0,0 @@ -# Running Netdata behind a reverse proxy - -If you need to access a Netdata agent's user interface or API in a production environment we recommend you put Netdata behind -another web server and secure access to the dashboard via SSL, user authentication and firewall rules. - -A dedicated web server also provides more robustness and capabilities than the Agent's [internal web server](https://github.com/netdata/netdata/blob/master/src/web/README.md). - -We have documented running behind -[nginx](https://github.com/netdata/netdata/blob/master/docs/Running-behind-nginx.md), -[Apache](https://github.com/netdata/netdata/blob/master/docs/Running-behind-apache.md), -[HAProxy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-haproxy.md), -[Lighttpd](https://github.com/netdata/netdata/blob/master/docs/Running-behind-lighttpd.md), -[Caddy](https://github.com/netdata/netdata/blob/master/docs/Running-behind-caddy.md), -and [H2O](https://github.com/netdata/netdata/blob/master/docs/Running-behind-h2o.md). -If you prefer a different web server, we suggest you follow the documentation for nginx and tell us how you did it - by adding your own "Running behind webserverX" document. - -When you run Netdata behind a reverse proxy, we recommend you firewall protect all your Netdata servers, so that only the web server IP will be allowed to directly access Netdata. To do this, run this on each of your servers (or use your firewall manager): - -```sh -PROXY_IP="1.2.3.4" -iptables -t filter -I INPUT -p tcp --dport 19999 \! -s ${PROXY_IP} -m conntrack --ctstate NEW -j DROP -``` - -The above will prevent anyone except your web server to access a Netdata dashboard running on the host. - -You can also use `netdata.conf`: - -``` -[web] - allow connections from = localhost 1.2.3.4 -``` - -Of course, you can add more IPs. diff --git a/docs/category-overview-pages/secure-nodes.md b/docs/category-overview-pages/secure-nodes.md deleted file mode 100644 index 99e2739208..0000000000 --- a/docs/category-overview-pages/secure-nodes.md +++ /dev/null @@ -1,177 +0,0 @@ -# Secure your nodes
-
-Netdata is a monitoring system. It should be protected, the same way you protect all your admin apps. We assume Netdata
-will be installed privately, for your eyes only.
-
-Upon installation, the Netdata Agent serves the **local dashboard** at port `19999`. If the node is accessible to the
-internet at large, anyone can access the dashboard and your node's metrics at `http://NODE:19999`. We made this decision
-so that the local dashboard was immediately accessible to users, and so that we don't dictate how professionals set up
-and secure their infrastructures.
-
-Viewers will be able to get some information about the system Netdata is running. This information is everything the dashboard
-provides. The dashboard includes a list of the services each system runs (the legends of the charts under the `Systemd Services`
-section), the applications running (the legends of the charts under the `Applications` section), the disks of the system and
-their names, the user accounts of the system that are running processes (the `Users` and `User Groups` section of the dashboard),
-the network interfaces and their names (not the IPs) and detailed information about the performance of the system and its applications.
-
-This information is not sensitive (meaning that it is not your business data), but **it is important for possible attackers**.
-It will give them clues on what to check, what to try and in the case of DDoS against your applications, they will know if they
-are doing it right or not.
-
-Also, viewers could use Netdata itself to stress your servers. Although the Netdata daemon runs unprivileged, with the minimum
-process priority (scheduling priority `idle` - lower than nice 19) and adjusts its OutOfMemory (OOM) score to 1000 (so that it
-will be first to be killed by the kernel if the system starves for memory), some pressure can be applied on your systems if
-someone attempts a DDoS against Netdata.
-
-Instead of dictating how to secure your infrastructure, we give you many options to establish security best practices
-that align with your goals and your organization's standards.
-
-- [Disable the local dashboard](#disable-the-local-dashboard): **Simplest and recommended method** for those who have
- added nodes to Netdata Cloud and view dashboards and metrics there.
-
-- [Expose Netdata only in a private LAN](#expose-netdata-only-in-a-private-lan). Simplest and recommended method for those who do not use Netdata Cloud.
-
-- [Fine-grained access control](#fine-grained-access-control): Allow local dashboard access from
- only certain IP addresses, such as a trusted static IP or connections from behind a management LAN. Full support for Netdata Cloud.
-
-- [Use a reverse proxy (authenticating web server in proxy mode)](#use-an-authenticating-web-server-in-proxy-mode): Password-protect
- a local dashboard and enable TLS to secure it. Full support for Netdata Cloud.
-
-- [Use Netdata parents as Web Application Firewalls](#use-netdata-parents-a |