mirror of
https://github.com/netdata/netdata.git
synced 2025-05-08 19:10:25 +00:00
Deployment Guides Improved (#20004)
* Deployment Guides Improved * Update docs/deployment-guides/README.md Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> --------- Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
This commit is contained in:
kanelatechnical
GitHub
parent
be9ac7cac9
commit
aeeead5de0
3 changed files with 98 additions and 120 deletions
docs/deployment-guides
|
|
@ -1,25 +1,42 @@
|
|||
# Deployment Guides
|
||||
# Deployment Guide
|
||||
|
||||
Netdata can be used to monitor all kinds of infrastructure, from tiny stand-alone IoT devices to complex hybrid setups combining on-premise and cloud infrastructure, mixing bare-metal servers, virtual machines and containers.
|
||||
Netdata provides real-time monitoring for various infrastructure types, from small IoT devices to complex hybrid environments that combine on-premise and cloud infrastructure. It supports bare-metal servers, virtual machines, and containers.
|
||||
|
||||
There are 3 components to structure your Netdata ecosystem:
|
||||
## Core Components of a Netdata Deployment
|
||||
|
||||
1. **Netdata Agents**
|
||||
A Netdata deployment consists of three main components:
|
||||
|
||||
To monitor the physical or virtual nodes of your infrastructure, including all applications and containers running on them.
|
||||
### 1. Netdata Agents
|
||||
|
||||
Netdata Agents are Open-Source, licensed under GPL v3+.
|
||||
Netdata Agents collect real-time metrics from your infrastructure's physical or virtual nodes, including applications and containers running on them. They are open-source and licensed under GPL v3+.
|
||||
|
||||
2. **Netdata Parents**
|
||||
### 2. Netdata Parents
|
||||
|
||||
To create [observability centralization points](/docs/observability-centralization-points/README.md) within your infrastructure, to offload Netdata Agents functions from your production systems, to provide high-availability of your data, increased data retention and isolation of your nodes.
|
||||
Netdata Parents serve as central aggregation points for monitoring data. They help reduce the resource load on individual Netdata Agents, provide high availability for collected metrics, extend data retention, and enable better isolation of monitored nodes.
|
||||
|
||||
Netdata Parents are implemented using the Netdata Agent software. Any Netdata Agent can be an Agent for a node and a Parent for other Agents, at the same time.
|
||||
- Netdata Parents are built using the same Netdata Agent software.
|
||||
- Any Netdata Agent can function as both an Agent for a node and a Parent for other Agents.
|
||||
- Deploying multiple Netdata Parents ensures redundancy and seamless integration with Netdata Cloud.
|
||||
|
||||
It is recommended to set up multiple Netdata Parents. They will all seamlessly be integrated by Netdata Cloud into one monitoring solution.
|
||||
### 3. Netdata Cloud
|
||||
|
||||
3. **Netdata Cloud**
|
||||
Netdata Cloud is a SaaS platform that unifies all Netdata Agents and Parents into a distributed, scalable monitoring solution. It provides:
|
||||
|
||||
Our SaaS, combining all your infrastructure, all your Netdata Agents and Parents, into one uniform, distributed, scalable, monitoring database, offering advanced data slicing and dicing capabilities, custom dashboards, advanced troubleshooting tools, user management, centralized management of alerts, and more.
|
||||
- Centralized infrastructure monitoring
|
||||
- Advanced data analysis and visualization tools
|
||||
- Customizable dashboards
|
||||
- User management features
|
||||
- Alerting and anomaly detection capabilities
|
||||
|
||||
The Netdata Agent is a highly modular software piece, providing data collection via numerous plugins, an in-house crafted time-series database, a query engine, health monitoring and alerts, machine learning and anomaly detection, metrics exporting to third party systems.
|
||||
## Key Features of Netdata Agents
|
||||
|
||||
Netdata Agents offer a modular monitoring solution with capabilities that include:
|
||||
|
||||
- Extensive data collection through built-in plugins
|
||||
- A high-performance time-series database optimized for real-time analytics
|
||||
- A query engine for flexible data retrieval
|
||||
- Integrated health monitoring and alerting
|
||||
- Machine learning-based anomaly detection
|
||||
- Exporting of metrics to third-party systems
|
||||
|
||||
This structured deployment allows for scalable, efficient monitoring of any infrastructure, ensuring optimal performance and proactive issue resolution.
|
||||
|
|
@ -80,14 +80,14 @@ flowchart LR
|
|||
On-Prem
|
||||
having all metrics & logs
|
||||
for all Bx nodes"]
|
||||
EMAIL{{"<b>e-mail</b>
|
||||
notifications"}}
|
||||
MOBILEAPP{{"<b>Netdata Mobile App</b>
|
||||
notifications"}}
|
||||
SLACK{{"<b>Slack</b>
|
||||
notifications"}}
|
||||
OTHER{{"Other
|
||||
notifications"}}
|
||||
EMAIL[["<b>e-mail</b>
|
||||
notifications"]]
|
||||
MOBILEAPP[["<b>Netdata Mobile App</b>
|
||||
notifications"]]
|
||||
SLACK[["<b>Slack</b>
|
||||
notifications"]]
|
||||
OTHER[["Other
|
||||
notifications"]]
|
||||
PA & PB -->|alert transitions| NC -->|notification| EMAIL & MOBILEAPP & SLACK & OTHER
|
||||
SA1 & SA2 & SAN ---|stream| PA
|
||||
SB1 & SB2 & SBN ---|stream| PB
|
||||
|
|
@ -109,7 +109,7 @@ For Metrics:
|
|||
|
||||
- Configure `stream.conf` at the Netdata Children to enable streaming to the configured Netdata Parents.
|
||||
|
||||
Check the [related section in our documentation](/docs/observability-centralization-points/metrics-centralization-points/README.md) for more info
|
||||
Check the [related section in our documentation](/docs/observability-centralization-points/metrics-centralization-points/README.md) for more info.
|
||||
|
||||
For Logs:
|
||||
|
||||
|
|
@ -119,4 +119,4 @@ For Logs:
|
|||
|
||||
- Configure `systemd-journal-upload` at the Netdata Children to enable transmission of their logs to the Netdata Parents.
|
||||
|
||||
Check the [related section in our documentation](/docs/observability-centralization-points/logs-centralization-points-with-systemd-journald/README.md) for more info
|
||||
Check the [related section in our documentation](/docs/observability-centralization-points/logs-centralization-points-with-systemd-journald/README.md) for more info.
|
||||
|
|
@ -1,141 +1,102 @@
|
|||
# Standalone Deployment
|
||||
|
||||
To help our users have a complete experience of Netdata when they install it for the first time, the Netdata Agent with default configuration is a complete monitoring solution out of the box, with features enabled and available.
|
||||
Netdata provides real-time monitoring out of the box. By default, each Netdata Agent functions as a standalone monitoring system with no additional configuration required.
|
||||
|
||||
So, each Netdata Agent acts as a standalone monitoring system by default.
|
||||
## Standalone Agents Without Netdata Cloud
|
||||
|
||||
## Standalone Agents, without Netdata Cloud
|
||||
Each Netdata Agent operates independently and provides its own monitoring dashboard and alerting system.
|
||||
|
||||
| Feature | How it works |
|
||||
|:---------------------------------------------:|:----------------------------------------------------:|
|
||||
| Unified infrastructure dashboards for metrics | No, each Netdata Agent provides its own dashboard |
|
||||
| Unified infrastructure dashboards for logs | No, each Netdata Agent exposes its own logs |
|
||||
| Centrally configured alerts | No, each Netdata has its own alerts configuration |
|
||||
| Centrally dispatched alert notifications | No, each Netdata Agent sends notifications by itself |
|
||||
| Data are exclusively on-prem | Yes |
|
||||
### Features
|
||||
|
||||
When using Standalone Netdata Agents, each of them offers an API and a dashboard, at its own unique URL, that looks like `http://agent-ip:19999`.
|
||||
| Feature | How it works |
|
||||
|---------|-------------|
|
||||
| **Infrastructure dashboards for metrics** | No, each Netdata Agent provides its own dashboard. |
|
||||
| **Infrastructure dashboards for logs** | No, logs are only accessible per individual Netdata Agent. |
|
||||
| **Centralized alert configuration** | No, each Netdata Agent has its own alert settings. |
|
||||
| **Centralized alert notifications** | No, each Netdata Agent sends notifications independently. |
|
||||
| **On-prem data retention** | Yes, all collected data remains on the monitored system. |
|
||||
|
||||
So, each of the Netdata Agents has to be accessed individually and independently of the others:
|
||||
Each Netdata Agent is accessible via a unique URL: `http://agent-ip:19999`.
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
WEB[["Multiple
|
||||
Independent
|
||||
Dashboards"]]
|
||||
S1["Standalone
|
||||
Netdata
|
||||
1"]
|
||||
S2["Standalone
|
||||
Netdata
|
||||
2"]
|
||||
SN["Standalone
|
||||
Netdata
|
||||
N"]
|
||||
WEB["Multiple Independent Dashboards"]
|
||||
S1["Standalone Netdata 1"]
|
||||
S2["Standalone Netdata 2"]
|
||||
SN["Standalone Netdata N"]
|
||||
WEB -->|URL 1| S1
|
||||
WEB -->|URL 2| S2
|
||||
WEB -->|URL N| SN
|
||||
```
|
||||
|
||||
The same is true for alert notifications. Each of the Netdata Agents runs its own alerts and sends notifications by itself, according to its configuration:
|
||||
Each agent also manages its own alert notifications:
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
S1["Standalone
|
||||
Netdata
|
||||
1"]
|
||||
S2["Standalone
|
||||
Netdata
|
||||
2"]
|
||||
SN["Standalone
|
||||
Netdata
|
||||
N"]
|
||||
EMAIL{{"<b>e-mail</b>
|
||||
notifications"}}
|
||||
SLACK{{"<b>Slack</b>
|
||||
notifications"}}
|
||||
OTHER{{"Other
|
||||
notifications"}}
|
||||
S1["Standalone Netdata 1"]
|
||||
S2["Standalone Netdata 2"]
|
||||
SN["Standalone Netdata N"]
|
||||
EMAIL["Email notifications"]
|
||||
SLACK["Slack notifications"]
|
||||
OTHER["Other notifications"]
|
||||
S1 & S2 & SN .-> SLACK
|
||||
S1 & S2 & SN ---> EMAIL
|
||||
S1 & S2 & SN ==> OTHER
|
||||
```
|
||||
|
||||
### Configuration steps for standalone Netdata Agents without Netdata Cloud
|
||||
### Configuration Steps
|
||||
|
||||
No special configuration needed.
|
||||
- Install Netdata Agents on each system.
|
||||
- Access each Agent individually via its URL (`http://agent-ip:19999`).
|
||||
|
||||
- Install Netdata Agents on all your systems, then access each of them via its own unique URL, that looks like `http://agent-ip:19999/`.
|
||||
## Standalone Agents With Netdata Cloud
|
||||
|
||||
## Standalone Agents, with Netdata Cloud
|
||||
Connecting Netdata Agents to Netdata Cloud enables centralized monitoring while keeping collected data on-premise.
|
||||
|
||||
| Feature | How it works |
|
||||
|:---------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| Unified infrastructure dashboards for metrics | Yes, via Netdata Cloud, all charts aggregate metrics from all servers. |
|
||||
| Unified infrastructure dashboards for logs | All logs are accessible via the same dashboard at Netdata Cloud, although they are not unified (ie. logs from different servers are not multiplexed into a single view) |
|
||||
| Centrally configured alerts | No, each Netdata has its own alerts configuration |
|
||||
| Centrally dispatched alert notifications | Yes, via Netdata Cloud |
|
||||
| Data are exclusively on-prem | Yes, Netdata Cloud queries Netdata Agents to satisfy dashboard queries. |
|
||||
### Features
|
||||
|
||||
By [connecting all Netdata Agents to Netdata Cloud](/src/claim/README.md), you can have a unified infrastructure view of all your nodes, with aggregated charts, without configuring [observability centralization points](/docs/observability-centralization-points/README.md).
|
||||
| Feature | Description |
|
||||
|---------|-------------|
|
||||
| **Infrastructure dashboards for metrics** | Yes, Netdata Cloud provides unified charts aggregating metrics from all systems. |
|
||||
| **Infrastructure dashboards for logs** | Logs from all agents are accessible in Netdata Cloud (though not merged into a single view). |
|
||||
| **Centralized alert configuration** | No, each Netdata Agent maintains its own alert settings. |
|
||||
| **Centralized alert notifications** | Yes, Netdata Cloud manages and dispatches notifications. |
|
||||
| **On-prem data retention** | Yes, Netdata Cloud queries Netdata Agents in real time. |
|
||||
|
||||
Connecting Netdata Agents to Netdata Cloud enables a unified monitoring view without requiring additional infrastructure setup.
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
WEB[["One unified
|
||||
dashboard
|
||||
for all nodes"]]
|
||||
NC(["<b>Netdata Cloud</b>
|
||||
decides which Agents
|
||||
need to be queried"])
|
||||
S1["Standalone
|
||||
Netdata
|
||||
1"]
|
||||
S2["Standalone
|
||||
Netdata
|
||||
2"]
|
||||
SN["Standalone
|
||||
Netdata
|
||||
N"]
|
||||
WEB["Unified Dashboard for All Nodes"]
|
||||
NC["Netdata Cloud"]
|
||||
S1["Standalone Netdata 1"]
|
||||
S2["Standalone Netdata 2"]
|
||||
SN["Standalone Netdata N"]
|
||||
WEB -->|queries| NC
|
||||
NC -->|queries| S1 & S2 & SN
|
||||
```
|
||||
|
||||
Similarly for alerts, Netdata Cloud receives all alert transitions from all Agents, decides which notifications should be sent and how, applies silencing rules, maintenance windows and based on each Netdata Cloud space and user settings, dispatches notifications:
|
||||
Alert notifications are managed centrally in Netdata Cloud:
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
EMAIL{{"<b>e-mail</b>
|
||||
notifications"}}
|
||||
MOBILEAPP{{"<b>Netdata Mobile App</b>
|
||||
notifications"}}
|
||||
SLACK{{"<b>Slack</b>
|
||||
notifications"}}
|
||||
OTHER{{"Other
|
||||
notifications"}}
|
||||
NC(["<b>Netdata Cloud</b>
|
||||
applies silencing
|
||||
& user settings"])
|
||||
S1["Standalone
|
||||
Netdata
|
||||
1"]
|
||||
S2["Standalone
|
||||
Netdata
|
||||
2"]
|
||||
SN["Standalone
|
||||
Netdata
|
||||
N"]
|
||||
EMAIL["Email notifications"]
|
||||
MOBILEAPP["Netdata Mobile App notifications"]
|
||||
SLACK["Slack notifications"]
|
||||
OTHER["Other notifications"]
|
||||
NC["Netdata Cloud"]
|
||||
S1["Standalone Netdata 1"]
|
||||
S2["Standalone Netdata 2"]
|
||||
SN["Standalone Netdata N"]
|
||||
NC -->|notification| EMAIL & MOBILEAPP & SLACK & OTHER
|
||||
S1 & S2 & SN -->|alert transition| NC
|
||||
```
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> Alerts are still triggered by Netdata Agents. Netdata Cloud only takes care of the notifications.
|
||||
> **Note:** Alerts are still triggered by Netdata Agents. Netdata Cloud manages notifications.
|
||||
|
||||
### Configuration steps for standalone Netdata Agents with Netdata Cloud
|
||||
### Configuration Steps
|
||||
|
||||
- Install Netdata Agents using the commands given by Netdata Cloud so that they will be automatically connected to your Space. Otherwise, install Netdata Agents and connect them via the command line or their dashboard.
|
||||
|
||||
- Optionally: disable their direct dashboard access to secure them.
|
||||
|
||||
- Optionally: disable their alert notifications to avoid receiving email notifications directly from them (email notifications are automatically enabled when a working MTA is found on the systems Netdata Agents are installed).
|
||||
- Install Netdata Agents using the installation commands provided by Netdata Cloud to automatically link them to your Space.
|
||||
- Alternatively, install Netdata Agents manually and connect them via the command line or dashboard.
|
||||
- **Optional:** Disable direct dashboard access for security.
|
||||
- **Optional:** Disable individual agent notifications to prevent duplicate alerts (Netdata Agents send email alerts by default if an MTA is detected).
|
||||
Loading…
Add table
Add a link
Reference in a new issue