@cryptotaxi247 / netdata-1 / commits / 5d0395ece

Netdata Cloud docs section edits (#17768)

Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>

Fotis Voutsas committed May 29, 2024 at 16:04 UTC 5d0395ece2bb82fe0cb75ee28e35e1eaa0948bb6

3 files changed +45 -264

docs/netdata-cloud/monitor-your-infrastructure.md deleted

-216

@@ -1,216 +0,0 @@

1 -import { Grid, Box, BoxList, BoxListItemRegexLink } from '@site/src/components/Grid/'

2 -import { RiExternalLinkLine } from 'react-icons/ri'

3 -

4 -# Monitor your infrastructure

5 -

6 -Learn how to view key metrics, insightful charts, and active alerts from all your nodes, with Netdata Cloud's real-time infrastructure monitoring.

7 -

8 -[Netdata Cloud](https://app.netdata.cloud) provides scalable infrastructure monitoring for any number of distributed

9 -nodes running the Netdata Agent. A node is any system in your infrastructure that you want to monitor, whether it's a

10 -physical or virtual machine (VM), container, cloud deployment, or edge/IoT device.

11 -

12 -The Netdata Agent uses zero-configuration collectors to gather metrics from every application and container instantly,

13 -and uses Netdata's distributed data architecture to store metrics

14 -locally. Without a slow and troublesome centralized data lake for your infrastructure's metrics, you reduce the

15 -resources you need to invest in, and the complexity of, monitoring your infrastructure.

16 -

17 -Netdata Cloud unifies infrastructure monitoring by _centralizing the interface_ you use to query and visualize your

18 -nodes' metrics, not the data. By streaming metrics values to your browser, with Netdata Cloud acting as the secure proxy

19 -between them, you can monitor your infrastructure using customizable, interactive, and real-time visualizations from any

20 -number of distributed nodes.

21 -

22 -In this quickstart guide, you'll learn the basics of using Netdata Cloud to monitor an infrastructure with dashboards,

23 -composite charts, and alert viewing. You'll then learn about the most critical ways to configure the Agent on each of

24 -your nodes to maximize the value you get from Netdata.

25 -

26 -This quickstart assumes you've [installed Netdata](https://github.com/netdata/netdata/edit/master/packaging/installer/README.md)

27 -on more than one node in your infrastructure, and connected those nodes to your Space in Netdata Cloud.

28 -

29 -## Set up your Netdata Cloud experience

30 -

31 -Start your infrastructure monitoring experience by setting up your Netdata Cloud account.

32 -

33 -### Organize Spaces and War Rooms

34 -

35 -Spaces are high-level containers to help you organize your team members and the nodes they can view in each War Room.

36 -You already have at least one Space in your Netdata Cloud account.

37 -

38 -A single Space puts all your metrics in one easily-accessible place, while multiple Spaces creates logical division

39 -between different users and different pieces of a large infrastructure. For example, a large organization might have one

40 -SRE team for the user-facing SaaS application, and a second IT team for managing employees' hardware. Since these teams

41 -don't monitor the same nodes, they can work in separate Spaces and then further organize their nodes into War Rooms.

42 -

43 -Next, set up War Rooms. Netdata Cloud creates dashboards and visualizations based on the nodes added to a given War

44 -Room. You can [organize War Rooms](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#war-room-organization) in any way

45 -you want, such as by the application type, for end-to-end application monitoring, or as an incident response tool.

46 -

47 -Learn more about [Spaces](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-spaces) and [War

48 -Rooms](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-war-rooms), including how to manage each, in their respective reference

49 -documentation.

50 -

51 -### Invite your team

52 -

53 -Netdata Cloud makes an infrastructure's real-time metrics available and actionable to all organization members. By

54 -inviting others, you can better synchronize with your team or colleagues to understand your infrastructure's heartbeat.

55 -When something goes wrong, you'll be ready to collaboratively troubleshoot complex performance problems from a single

56 -pane of glass.

57 -

58 -To [invite new users](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#invite-your-team), click on **Invite Users** in the

59 -Space management Area. Choose which War Rooms to add this user to, then click **Send**.

60 -

61 -### See an overview of your infrastructure

62 -

63 -Netdata Cloud utilizes "tabs" in order to provide you with informative sections based on your infrastructure.

64 -These tabs can be separated into "static", meaning they are by default presented, and "non-static" which are tabs that get presented by user action (e.g clicking on a custom dashboard)

65 -

66 -#### Static tabs

67 -

68 -- The default tab for any War Room is the [Home tab](/docs/dashboards-and-charts/home-tab.md), which gives you an overview of this Space.

69 - Here you can see the number of Nodes claimed, data retention statics, users by role, alerts and more.

70 -

71 -- The [Nodes tab](/docs/dashboards-and-charts/nodes-tab.md) gives you the ability to see the status (offline or online), host details, alert status and also a short overview of some key metrics from all your nodes at a glance.

72 -

73 -- The third and most important tab is the [Metrics tab](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md) which uses composite charts to display real-time metrics from every available node in a given War Room.

74 -

75 -- [Kubernetes tab](/docs/dashboards-and-charts/kubernetes-tab.md) is a logical grouping of charts regarding your Kubernetes clusters. It contains a subset of the charts available in the **Overview tab**.

76 -

77 -- The [Dashboards tab](/docs/dashboards-and-charts/dashboards-tab.md) gives you the ability to have tailored made views of specific/targeted interfaces for your infrastructure using any number of charts from any number of nodes.

78 -

79 -- The [Alerts tab](/docs/dashboards-and-charts/alerts-tab.md) provides you with an overview for all the active alerts you receive for the nodes in this War Room, you can also see all the alerts that are configured to be triggered in any given moment.

80 -

81 -- The [Anomalies tab](/docs/dashboards-and-charts/anomaly-advisor-tab.md) is dedicated to the Anomaly Advisor tool.

82 -

83 -- The [Functions tab](/docs/top-monitoring-netdata-functions.md) gives you the ability to visualize functions that the Netdata Agent collectors are able to expose.

84 -

85 -- The [Feed & events](/docs/dashboards-and-charts/events-feed.md) tab lets you investigate events that occurred in the past, which is invaluable for troubleshooting.

86 -

87 -#### Dynamic tabs

88 -

89 -If you open a [new dashboard](/docs/dashboards-and-charts/dashboards-tab.md), jump to a single-node dashboard, or navigate to a dedicated alert page, a new tab will open in War Room bar.

90 -

91 -Tabs can be rearranged with drag-and-drop or closed with the **X** button. Open tabs persist between sessions, so you can always come right back to your preferred setup.

92 -

93 -### Drill down to specific nodes

94 -

95 -Both the Overview and the Nodes tab offer easy access to **single-node dashboards** for targeted analysis. You can use

96 -single-node dashboards in Netdata Cloud to drill down on specific issues, scrub backward in time to investigate

97 -historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.

98 -

99 -Learn more about [interacting with

100 -dashboards and charts](/docs/dashboards-and-charts/netdata-charts.md) to get the most from all of Netdata's real-time

101 -metrics.

102 -

103 -### Create new dashboards

104 -

105 -You can use Netdata Cloud to create new dashboards that match your infrastructure's topology or help you diagnose

106 -complex issues by aggregating correlated charts from any number of nodes. For example, you could monitor the system CPU

107 -from every node in your infrastructure on a single dashboard.

108 -

109 -![An example system CPU

110 -dashboard](https://user-images.githubusercontent.com/1153921/108732974-4b09c480-74eb-11eb-87a2-c67e569c08b6.png)

111 -

112 -Read more about [creating new dashboards](/docs/dashboards-and-charts/dashboards-tab.md) for more details about the process and

113 -additional tips on best leveraging the feature to help you troubleshoot complex performance problems.

114 -

115 -## Set up your nodes

116 -

117 -You get the most value out of Netdata Cloud's infrastructure monitoring capabilities if each node collects every

118 -possible metric. For example, if a node in your infrastructure is responsible for serving a MySQL database, you should

119 -ensure that the Netdata Agent on that node is properly collecting and streaming all MySQL-related metrics.

120 -

121 -In most cases, collectors autodetect their data source and require no configuration, but you may need to configure

122 -certain behaviors based on your infrastructure. Or, you may want to enable/configure advanced functionality, such as

123 -longer metrics retention or streaming.

124 -

125 -### Configure the Netdata Agent on your nodes

126 -

127 -You can configure any node in your infrastructure if you need to, although most users will find the default settings

128 -work extremely well for monitoring their infrastructures.

129 -

130 -Each node has a configuration file called `netdata.conf`, which is typically at `/etc/netdata/netdata.conf`. The best

131 -way to edit this file is using the `edit-config` script, which ensures updates to the Netdata Agent do not overwrite

132 -your changes. For example:

133 -

134 -```bash

135 -cd /etc/netdata

136 -sudo ./edit-config netdata.conf

137 -```

138 -

139 -Our [configuration basics doc](/docs/netdata-agent/configuration/README.md) contains more information about `netdata.conf`, `edit-config`,

140 -along with simple examples to get you familiar with editing your node's configuration.

141 -

142 -After you've learned the basics, you should [secure your infrastructure's nodes](/docs/security-and-privacy-design/README.md) using

143 -one of our recommended methods. These security best practices ensure no untrusted parties gain access to the metrics

144 -collected on any of your nodes.

145 -

146 -### Collect metrics from anywhere

147 -

148 -Netdata has [300+ pre-installed collectors](/src/collectors/COLLECTORS.md) that gather thousands of metrics with zero configuration. Collectors search each of your nodes in default locations and ports to find running applications and gather as many metrics as they can without you having to configure them individually.

149 -

150 -Check our [comprehensive integrations section](/src/collectors/COLLECTORS.md), to find information about whatever you want to monitor with Netdata

151 -

152 -## Netdata Cloud features

153 -

154 -<Grid columns="2">

155 - <Box

156 - title="Spaces and War Rooms">

157 - <BoxList>

158 - <BoxListItemRegexLink to="[](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-spaces)" title="Spaces" />

159 - <BoxListItemRegexLink to="[](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-war-rooms)" title="War Rooms" />

160 - </BoxList>

161 - </Box>

162 - <Box

163 - title="Dashboards">

164 - <BoxList>

165 - <BoxListItemRegexLink to="[](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md)" title="Metrics tab" />

166 - <BoxListItemRegexLink to="[](/docs/dashboards-and-charts/nodes-tab.md)" title="Nodes tab" />

167 - <BoxListItemRegexLink to="[](/docs/dashboards-and-charts/kubernetes-tab.md)" title="Kubernetes" />

168 - <BoxListItemRegexLink to="[](/docs/dashboards-and-charts/dashboards-tab.md)" title="Create new dashboards" />

169 - </BoxList>

170 - </Box>

171 - <Box

172 - title="Alerts and notifications">

173 - <BoxList>

174 - <BoxListItemRegexLink to="[](/docs/dashboards-and-charts/alerts-tab.md#netdata-cloud)" title="View active alerts" />

175 - <BoxListItemRegexLink to="[](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md)" title="Alert notifications" />

176 - </BoxList>

177 - </Box>

178 - <Box

179 - title="Troubleshooting with Netdata Cloud">

180 - <BoxListItemRegexLink to="[](/docs/metric-correlations.md)" title="Metric Correlations" />

181 - <BoxListItemRegexLink to="[](/docs/dashboards-and-charts/anomaly-advisor-tab.md)" title="Anomaly Advisor" />

182 - <BoxListItemRegexLink to="[](/docs/dashboards-and-charts/events-feed.md)" title="Events Feed" />

183 - </Box>

184 - <Box

185 - title="Management and settings">

186 - <BoxList>

187 - <BoxListItemRegexLink to="[](/docs/netdata-cloud/authentication-and-authorization/README.md)" title="Sign in with email, Google, GitHub or with an SSO tool" />

188 - <BoxListItemRegexLink to="[](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#invite-your-team)" title="Invite your team" />

189 - <BoxListItemRegexLink to="[](/docs/dashboards-and-charts/themes.md)" title="Choose your Netdata Cloud theme" />

190 - <BoxListItemRegexLink to="[](/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md)" title="Role-Based Access" />

191 - <BoxListItemRegexLink to="[](/docs/netdata-cloud/netdata-subscription-plans.md)" title="Paid Plans" />

192 - </BoxList>

193 - </Box>

194 -</Grid>

195 -

196 -- Spaces and War Rooms

197 - - [Spaces](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-spaces)

198 - - [War Rooms](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-war-rooms)

199 -- Dashboards

200 - - [Metrics tab](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md)

201 - - [Nodes tab](/docs/dashboards-and-charts/nodes-tab.md)

202 - - [Kubernetes](/docs/dashboards-and-charts/kubernetes-tab.md)

203 - - [Create new dashboards](/docs/dashboards-and-charts/dashboards-tab.md)

204 -- Alerts and notifications

205 - - [View active alerts](/docs/dashboards-and-charts/alerts-tab.md#netdata-cloud)

206 - - [Alert notifications](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md)

207 -- Troubleshooting with Netdata Cloud

208 - - [Metric Correlations](/docs/metric-correlations.md)

209 - - [Anomaly Advisor](/docs/dashboards-and-charts/anomaly-advisor-tab.md)

210 - - [Events Feed](/docs/dashboards-and-charts/events-feed.md)

211 -- Management and settings

212 - - [Sign in with email, Google, GitHub or with an SSO tool](/docs/netdata-cloud/authentication-and-authorization/README.md)

213 - - [Invite your team](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#invite-your-team)

214 - - [Choose your Netdata Cloud theme](/docs/dashboards-and-charts/themes.md)

215 - - [Role-Based Access](/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md)

216 - - [Paid Plans](/docs/netdata-cloud/netdata-subscription-plans.md)

docs/netdata-cloud/netdata-subscription-plans.md deleted

-42

@@ -1,42 +0,0 @@

1 -# Netdata Subscription Plans

2 -

3 -This page explains the Netdata subscription plan structure.

4 -

5 -## Overview

6 -

7 -Netdata offers a **Community plan**, a free SaaS and Open Source Agent, while also it offers paid subscriptions — **Homelab**, **Business**, and **Enterprise On-Premise** — providing key business features and unlimited access to your dashboards.

8 -

9 -For more info visit the [Netdata Cloud Pricing](https://netdata.cloud/pricing) page.

10 -

11 -### Plans

12 -

13 -Each plan is linked to a Space, defining the capabilities and customizations available. Different Spaces can have different plans, offering flexibility based on your needs.

14 -

15 -Netdata Cloud plans (excluding Community) involve:

16 -

17 -- A yearly flat fee for [committed nodes](#committed-nodes)

18 -- An on-demand metered component based on the [number of running nodes](#running-nodes-and-billing)

19 -

20 -Billing options include monthly (pay-as-you-go) and yearly (annual prepayment). For more details, visit [Netdata Cloud Pricing](https://netdata.cloud/pricing).

21 -

22 -## Running Nodes and Billing

23 -

24 -Billing is based on the number of active nodes. We do not charge for offline or stale nodes. We calculate daily and running P90 figures to ensure fair billing by smoothing out sporadic spikes in node activity.

25 -

26 -## Committed Nodes

27 -

28 -Yearly plans require specifying a number of committed nodes, which receive a discounted rate. Usage above these committed nodes incurs charges at the standard rate.

29 -

30 -## Plan Changes and Credit Balance

31 -

32 -You can change your plan, billing frequency, or committed nodes at any time. For guidance, see [updating your plan](/docs/netdata-cloud/view-plan-and-billing.md#update-a-subscription-plan).

33 -

34 -> **Note**

35 ->

36 -> - Changes like downgrades or cancellations keep notification configurations active for 24 hours. After that, any methods not supported by the new plan are disabled.

37 -> - Changes may restrict user access in your Space. Review role availability under [each plan](#areas-that-change-upon-subscription).

38 -> - Any credits are valid until the end of the following year.

39 -

40 -## Areas That Change Upon Subscription

41 -

42 -Please refer to the [Netdata Cloud Pricing](https://netdata.cloud/pricing) page for more information on what each plan provides.

docs/netdata-cloud/view-plan-and-billing.md

+45 -6

@@ -1,15 +1,54 @@

1 -# View Plan & Billing

1 +# Netdata Plans & Billing

3 -This section outlines how to view and manage your Space's plan, billing settings, and usage from the Netdata Cloud interface.

3 +Netdata offers a **Community plan**, a free SaaS and Open Source Agent, and paid subscriptions — **Homelab**, **Business**, and **Enterprise On-Premise** — providing key business features and unlimited access to your dashboards.

5 -## Prerequisites

5 +For more info visit the [Netdata Cloud Pricing](https://netdata.cloud/pricing) page.

6 +

7 +## Plans

8 +

9 +Plans define the features and customization options available within a Space. Different Spaces can have different plans, giving you flexibility based on your needs.

10 +

11 +Netdata Cloud plans (excluding Community) involve:

12 +

13 +- A yearly flat fee for [committed nodes](#committed-nodes)

14 +- An on-demand metered component based on the [number of running nodes](#running-nodes-and-billing)

15 +

16 +Billing options include monthly (pay-as-you-go) and yearly (annual prepayment).

17 +

18 +### Technical Details

19 +

20 +#### Running Nodes and Billing

21 +

22 +Billing is based solely on active nodes, excluding offline or stale instances. Daily and P90 metrics ensure fair pricing by mitigating transient increases in node activity.

23 +

24 +#### Committed Nodes

25 +

26 +Yearly plans offer a discounted rate for a pre-defined number of committed nodes. Any usage exceeding this commitment will be billed at the standard rate.

27 +

28 +#### Plan Changes and Credit Balance

29 +

30 +You can change your plan, billing frequency, or committed nodes at any time. For guidance, see [updating your plan](#update-a-subscription-plan).

31 +

32 +> **Note**

33 +>

34 +> - Changes like downgrades or cancellations keep notification configurations active for 24 hours. After that, any methods not supported by the new plan are disabled.

35 +> - Changes may restrict user access in your Space. Review role availability under [each plan](https://netdata.cloud/pricing).

36 +> - Any credits are valid until the end of the following year.

37 +

38 +#### Areas That Change Upon Subscription

39 +

40 +Please refer to the [Netdata Cloud Pricing](https://netdata.cloud/pricing) page for more information on what each plan provides.

41 +

42 +## View Plan and Billing Information

43 +

44 +### Prerequisites

46 - A Netdata Cloud account

47 - Admin or Billing user access to the Space

10 -## Steps

49 +### Steps

12 -### View Current Plan, Billing Options, and Invoices

51 +#### View Current Plan, Billing Options, and Invoices

53 1. Navigate to **Space settings** (the cog above your profile icon).

54 2. Select the **Plan & Billing** tab.

@@ -23,7 +62,7 @@ This section outlines how to view and manage your Space's plan, billing settings

62 - The **Change plan** button, showing details of your current plan with options to upgrade or cancel.

63 - Your **Usage chart**, displaying daily and period counts of live nodes and how they relate to your billing.

26 -### Update a Subscription Plan

65 +#### Update a Subscription Plan

67 1. In the **Plan & Billing** tab, click **Change plan** to see:

68 - Billing frequency and committed nodes (if applicable).