diff --git a/README.md b/README.md index d1c697c49fa4dc..b518c3e8f352ca 100644 --- a/README.md +++ b/README.md @@ -319,7 +319,7 @@ navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostnam - Access your Netdata agents from anywhere - Access sensitive Netdata agent features (like "Netdata Functions": processes, systemd-journal) - - Organize your infra in spaces and rooms + - Organize your infra in spaces and Rooms - Create, manage, and share **custom dashboards** - Invite your team and assign roles to them (Role Based Access Control - RBAC) - Get infinite horizontal scalability (multiple independent Netdata Agents are viewed as one infra) diff --git a/docs/Demo-Sites.md b/docs/Demo-Sites.md index 177a37d16d0cc7..291e3a5e3c375b 100644 --- a/docs/Demo-Sites.md +++ b/docs/Demo-Sites.md @@ -11,7 +11,7 @@ sidebar_position: "90" # Live demos -See the live Netdata Cloud demo with rooms (listed below) for specific use cases at **https://app.netdata.cloud/spaces/netdata-demo** +See the live Netdata Cloud demo with Rooms (listed below) for specific use cases at **https://app.netdata.cloud/spaces/netdata-demo** | Location | Netdata Demo URL | 60 mins reqs | VM donated by | | :------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| :------------------------------------------------- | diff --git a/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-alert-notification-silencing-rules.md b/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-alert-notification-silencing-rules.md index dca474931233b7..d537ef7ea0fae7 100644 --- a/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-alert-notification-silencing-rules.md +++ b/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-alert-notification-silencing-rules.md @@ -47,11 +47,11 @@ To manage your **personal Alert notification silencing rule settings**, you will ## Silencing Rules Examples -| Rule name | War Rooms | Nodes | Host Label | Alert name | Alert context | Alert instance | Alert role | Description | +| Rule name | Rooms | Nodes | Host Label | Alert name | Alert context | Alert instance | Alert role | Description | |:---------------------------------|:-------------------|:---------|:-------------------------|:-------------------------------------------------|:--------------|:-------------------------|:------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Space silencing | All Rooms | * | * | * | * | * | * | This rule silences the entire space, targets all nodes, and for all users. E.g. infrastructure-wide maintenance window. | -| DB Servers Rooms | PostgreSQL Servers | * | * | * | * | * | * | This rule silences the nodes in the room named PostgreSQL Servers, for example, it doesn't silence the `All Nodes` room. E.g. My team with membership to this room doesn't want to receive notifications for these nodes. | -| Node child1 | All Rooms | `child1` | * | * | * | * | * | This rule silences all Alert state transitions for node `child1` in all rooms and for all users. E.g. node could be going under maintenance. | +| DB Servers Rooms | PostgreSQL Servers | * | * | * | * | * | * | This rule silences the nodes in the Room named PostgreSQL Servers, for example, it doesn't silence the `All Nodes` Room. E.g. My team with membership to this Room doesn't want to receive notifications for these nodes. | +| Node child1 | All Rooms | `child1` | * | * | * | * | * | This rule silences all Alert state transitions for node `child1` in all Rooms and for all users. E.g. node could be going under maintenance. | | Production nodes | All Rooms | * | `environment:production` | * | * | * | * | This rule silences all Alert state transitions for nodes with the host label key-value pair `environment:production`. E.g. Maintenance window on nodes with specific host labels. | | Third party maintenance | All Rooms | * | * | `httpcheck_posthog_netdata_cloud.request_status` | * | * | * | This rule silences this specific Alert since the third-party partner will be undergoing maintenance. | | Intended stress usage on CPU | All Rooms | * | * | * | `system.cpu` | * | * | This rule silences specific Alerts across all nodes and their CPU cores. | diff --git a/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md b/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md index 47709c0393b219..6a432ded3565ef 100644 --- a/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md +++ b/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md @@ -67,6 +67,6 @@ Note: If an administrator has disabled a Personal [service level](/docs/alerts-a 3. On this modal you will be able to: 1. **Enable/Disable** the notification method for you; this applies across all Spaces and Rooms. - Use the toggle to enable or disable the notification method. - 2. **Define what notifications you want** per Space/room: All Alerts and unreachable, All Alerts, Critical only, or No notifications. + 2. **Define what notifications you want** per Space/Room: All Alerts and unreachable, All Alerts, Critical only, or No notifications. 3. **Activate notifications** for a Room you aren't a member of. - From the **All Rooms** tab, click on the Join button for the Room(s) you want. diff --git a/docs/dashboards-and-charts/alerts-tab.md b/docs/dashboards-and-charts/alerts-tab.md index 2827f5e4b10ed3..00d3efcb7f0756 100644 --- a/docs/dashboards-and-charts/alerts-tab.md +++ b/docs/dashboards-and-charts/alerts-tab.md @@ -4,7 +4,7 @@ Netdata comes with hundreds of pre-configured health alerts designed to notify y ## Active tab -From the Active tab you can see all the active alerts in your War Room. You will be presented with a table having information about each alert that is in warning or critical state. +From the Active tab you can see all the active alerts in your Room. You will be presented with a table having information about each alert that is in warning or critical state. You can always sort the table by a certain column by clicking on the name of that column, and using the gear icon on the top right to control which columns are visible at any given time. @@ -21,13 +21,13 @@ From this tab, you can also filter alerts with the right hand bar. More specific - Alert role - Filter by the role that the alert is set to notify (e.g. Sysadmin, Webmaster etc.) - Host labels - - Filter based on the host labels that are configured for the nodes across the War Room (e.g. `_cloud_instance_region` to match `us-east-1`) + - Filter based on the host labels that are configured for the nodes across the Room (e.g. `_cloud_instance_region` to match `us-east-1`) - Node status - Filter by node availability status (e.g. Live or Offline) - Netdata version - Filter by Netdata version (e.g. `v1.45.3`) - Nodes - - Filter the alerts based on the nodes of your War Room. + - Filter the alerts based on the nodes of your Room. ### View alert details @@ -49,7 +49,7 @@ From this tab, the "Silencing" column shows if there is any rule present for eac ## Alert Configurations tab -From this tab you can view all the configurations for all running alerts in your War Room. Each row concerns one alert, and it provides information about it in the rest of the table columns. +From this tab you can view all the configurations for all running alerts in your Room. Each row concerns one alert, and it provides information about it in the rest of the table columns. By running alerts we mean alerts that are related to some metric that is or was collected. Netdata may have more alerts pre-configured that aren't applicable to your monitoring use-cases. diff --git a/docs/dashboards-and-charts/dashboards-tab.md b/docs/dashboards-and-charts/dashboards-tab.md index 128819c011aa13..4d7bbc84f66837 100644 --- a/docs/dashboards-and-charts/dashboards-tab.md +++ b/docs/dashboards-and-charts/dashboards-tab.md @@ -2,7 +2,7 @@ With Netdata Cloud, you can build **custom dashboards** that target your infrastructure's unique needs. Put key metrics from any number of distributed systems in one place for a bird's eye view of your infrastructure. -Click on the **Dashboards** tab in any War Room to get started. +Click on the **Dashboards** tab in any Room to get started. ## Create your first dashboard @@ -41,7 +41,7 @@ Charts also synchronize as you interact with them, even across contexts _or_ nod ### Text cards -You can use text cards as notes to explain to other members of the [War Room](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-war-rooms) the purpose of the dashboard's arrangement. +You can use text cards as notes to explain to other members of the [Room](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-rooms) the purpose of the dashboard's arrangement. By clicking the `T` icon on the text box, you can switch between font sizes. @@ -71,13 +71,13 @@ Click on the 3-dot icon in the corner of any card to open a menu. Click the **Re ## Managing your dashboard -To see dashboards associated with the current War Room, click the **Dashboards** tab in any War Room. You can select dashboards and delete them using the 🗑️ icon. +To see dashboards associated with the current Room, click the **Dashboards** tab in any Room. You can select dashboards and delete them using the 🗑️ icon. ### Update/save a dashboard If you've made changes to a dashboard, such as adding or moving elements, the **Save** button is enabled. Click it to save your most recent changes. -Any other members of the War Room will be able to see these changes the next time they load this dashboard. +Any other members of the Room will be able to see these changes the next time they load this dashboard. If multiple users attempt to make concurrent changes to the same dashboard, the second user who hits Save will be prompted to either overwrite the dashboard or reload to see the most recent changes. @@ -85,7 +85,7 @@ prompted to either overwrite the dashboard or reload to see the most recent chan ### Delete a dashboard Delete any dashboard by navigating to it and clicking the **Delete** button. This will remove this entry from the -dropdown for every member of this War Room. +dropdown for every member of this Room. ### Minimum browser viewport @@ -93,4 +93,4 @@ Because of the visual complexity of individual charts, dashboards require a mini ## What's next? -Once you've designed a dashboard or two, make sure to [invite your team](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#invite-your-team) if you haven't already. You can add these new users to the same War Room to let them see the same dashboards without any effort. +Once you've designed a dashboard or two, make sure to [invite your team](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#invite-your-team) if you haven't already. You can add these new users to the same Room to let them see the same dashboards without any effort. diff --git a/docs/dashboards-and-charts/events-feed.md b/docs/dashboards-and-charts/events-feed.md index 67678419120c43..a5386e80e7e527 100644 --- a/docs/dashboards-and-charts/events-feed.md +++ b/docs/dashboards-and-charts/events-feed.md @@ -21,20 +21,20 @@ At a high-level view, these are the domains from which the Events feed will prov | **Event name** | **Description** | **Example** | |:------------------------------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------| | Space Created | The space was created. | Space `Acme Space` was **created** | -| Room Created | A room was created on the Space. | Room `DB Servers` was **created** by `John Doe` | -| Room Deleted | A room was deleted from the Space. | Room `DB servers` was **deleted** by `John Doe` | +| Room Created | A Room was created on the Space. | Room `DB Servers` was **created** by `John Doe` | +| Room Deleted | A Room was deleted from the Space. | Room `DB servers` was **deleted** by `John Doe` | | User Invited to Space | A user was invited to join the Space. | User `John Smith` was **invited** to this space by `Alan Doe` | | User Uninvited from Space | An invitation for a user to join the space was revoked. | User `John Smith` was **uninvited** from this space | | User Added to Space | A user was added to the Space from an invitation (user accepted the invitation). | User `John Smith` was **added** to this space by invite of `Alan Doe` | | User Removed from Space | A user was added to the Space from an invitation. | User `John Smith` was **removed** from this space by `Alan Doe` | -| User Added to Room | A user was added to a room on the Space. | User `John Smith` was **added** to room `DB servers` | -| User Removed from Room | A user was removed from a room on the Space. | User `John Smith` was **removed** from room `DB Servers` by `Alan Doe` | +| User Added to Room | A user was added to a Room on the Space. | User `John Smith` was **added** to Room `DB servers` | +| User Removed from Room | A user was removed from a Room on the Space. | User `John Smith` was **removed** from Room `DB Servers` by `Alan Doe` | | User Space Properties Changed | The properties of a user on the Space have changed, e.g. change user role | User role for `John Smith` was **changed** to `troubleshooter` by `Alan Doe` | -| Node Added To Room | The node was added to a room on the Space. | Node `ip-xyz.ec2.internal` was **added** to room `DB Servers` by `John Doe` | -| Node Removed To Room | The node was removed from a room on the Space. | Node `ip-xyz.ec2.internal` was **removed** from room `DB Servers` by `John Doe` | -| Silencing Rule Created | A new alert notification silencing rule was created on the Space. | Silencing rule `DB Servers schedule silencing` on rooms `All nodes` and `DB Servers` was **created** by `John Smith` | -| Silencing Rule Changed | An existing alert notification silencing rule was modified on the Space. | Silencing rule `DB Servers schedule silencing` on rooms `All nodes` and `DB Servers` was **changed** by `John Doe` | -| Silencing Rule Deleted | An existing alert notifications silencing rule was removed from the Space. | Silencing rule `DB Servers schedule silencing` on rooms `All nodes` and `DB Servers` was **changed** by `Alan Smith` | +| Node Added To Room | The node was added to a Room on the Space. | Node `ip-xyz.ec2.internal` was **added** to Room `DB Servers` by `John Doe` | +| Node Removed To Room | The node was removed from a Room on the Space. | Node `ip-xyz.ec2.internal` was **removed** from Room `DB Servers` by `John Doe` | +| Silencing Rule Created | A new alert notification silencing rule was created on the Space. | Silencing rule `DB Servers schedule silencing` on Rooms `All nodes` and `DB Servers` was **created** by `John Smith` | +| Silencing Rule Changed | An existing alert notification silencing rule was modified on the Space. | Silencing rule `DB Servers schedule silencing` on Rooms `All nodes` and `DB Servers` was **changed** by `John Doe` | +| Silencing Rule Deleted | An existing alert notifications silencing rule was removed from the Space. | Silencing rule `DB Servers schedule silencing` on Rooms `All nodes` and `DB Servers` was **changed** by `Alan Smith` | | Space Claiming Token Created | A Space Claiming Token was created. | Claiming Token was created by user `John Doe` | | Space Claiming Token Revoked | A Space Claiming Token was revoked. | Claiming Token `_OtF2ssjrv` was revoked by user `John Doe` | @@ -49,9 +49,9 @@ At a high-level view, these are the domains from which the Events feed will prov | 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)** | | Node Restored | The node was restored. See `Node Removed` above. | Node `ip-xyz.ec2.internal` was **restored** | | 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)** | -| Agent Connected | The agent connected to the Cloud MQTT server (Agent-Cloud Link established).
These events can only be seen on _All nodes_ War Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has connected to Cloud. | -| Agent Disconnected | The agent disconnected from the Cloud MQTT server (Agent-Cloud Link severed).
These events can only be seen on _All nodes_ War Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has disconnected from Cloud: **Connection Timeout**. | -| Space Statistics | Daily snapshot of space node statistics.
These events can only be seen on _All nodes_ War Room. | Space statistics. Nodes: **22 live**, **21 stale**, **18 removed**, **61 total**. | +| 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. | +| 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**. | +| 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**. | ### Alert events diff --git a/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md b/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md index 8cc1f556679636..bf31b8a714b818 100644 --- a/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md +++ b/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md @@ -1,6 +1,6 @@ # Metrics tab and single node tabs -The Metrics tab is where all the time series [charts](/docs/dashboards-and-charts/netdata-charts.md) for all the nodes of a War Room are located. +The Metrics tab is where all the time series [charts](/docs/dashboards-and-charts/netdata-charts.md) for all the nodes of a Room are located. You can also see single-node dashboards, essentially the same dashboard the Metrics tab offers but only for one node. They are reached from most places in the UI, often by clicking the name of a node. @@ -20,6 +20,6 @@ On the right-hand side, there is a bar that: - Node status - Netdata version - Individual nodes -- Presents the active alerts for the War Room +- Presents the active alerts for the Room From this bar you can also view the maximum chart anomaly rate on each menu section by clicking the `AR%` button. diff --git a/docs/dashboards-and-charts/netdata-charts.md b/docs/dashboards-and-charts/netdata-charts.md index 9a15ea9a7ca9a3..b2a37e18bec591 100644 --- a/docs/dashboards-and-charts/netdata-charts.md +++ b/docs/dashboards-and-charts/netdata-charts.md @@ -172,7 +172,7 @@ It supports: 1. **Group by Node**, to summarize the data of each node, and provide one dimension on the chart for each of the nodes involved. Filtering nodes is supported at the same time, using the nodes dropdown menu. 2. **Group by Instance**, to summarize the data of each instance and provide one dimension on the chart for each of the instances involved. Filtering instances is supported at the same time, using the instances dropdown menu. -3. **Group by Dimension**, so that each metric in the visualization is the aggregation of a single dimension. This provides a per dimension view of the data from all the nodes in the War Room, taking into account filtering criteria if defined. +3. **Group by Dimension**, so that each metric in the visualization is the aggregation of a single dimension. This provides a per dimension view of the data from all the nodes in the Room, taking into account filtering criteria if defined. 4. **Group by Label**, to summarize the data for each label value. Multiple label keys can be selected at the same time. Using this menu, you can slice and dice the data in any possible way, to quickly get different views of it, without the need to edit a query string and without any need to better understand the format of the underlying data. diff --git a/docs/dashboards-and-charts/node-filter.md b/docs/dashboards-and-charts/node-filter.md index 9c7ea2685d988c..9f5371fff78ab0 100644 --- a/docs/dashboards-and-charts/node-filter.md +++ b/docs/dashboards-and-charts/node-filter.md @@ -1,6 +1,6 @@ # Node filter -The node filter allows you to quickly filter the nodes visualized in a War Room's views. It appears on all views, except on single-node dashboards. +The node filter allows you to quickly filter the nodes visualized in a Room's views. It appears on all views, except on single-node dashboards. Inside the filter, the nodes get categorized into three groups: diff --git a/docs/dashboards-and-charts/nodes-tab.md b/docs/dashboards-and-charts/nodes-tab.md index 36d8e00e4aad0a..70d2bca89ac6a5 100644 --- a/docs/dashboards-and-charts/nodes-tab.md +++ b/docs/dashboards-and-charts/nodes-tab.md @@ -1,6 +1,6 @@ # Nodes tab -The nodes tab provides a summarized view of your [War Room](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-war-rooms), allowing you to view quick information per node. +The nodes tab provides a summarized view of your [Room](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-rooms), allowing you to view quick information per node. > **Tip** > @@ -33,7 +33,7 @@ Each node row allows you to: ## Right bar -The bar on the right-hand side provides additional information about the nodes in the War Room and allows you to filter what is displayed in the [center information view](#center-information-view). +The bar on the right-hand side provides additional information about the nodes in the Room and allows you to filter what is displayed in the [center information view](#center-information-view). ### Node hierarchy @@ -50,7 +50,7 @@ The second tab allows you to filter which nodes are displayed, you can filter by ### Alerts sub-tab -The third tab displays room alerts and allows you to see additional information about each alert. +The third tab displays Room alerts and allows you to see additional information about each alert. ### Info sub-tab diff --git a/docs/developer-and-contributor-corner/collect-unbound-metrics.md b/docs/developer-and-contributor-corner/collect-unbound-metrics.md index d80e8151a0c058..0f80395fbc7064 100644 --- a/docs/developer-and-contributor-corner/collect-unbound-metrics.md +++ b/docs/developer-and-contributor-corner/collect-unbound-metrics.md @@ -136,7 +136,7 @@ file](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plug ## What's next? -Now that you're collecting metrics from your Unbound servers, let us know how it's working for you! There's always room +Now that you're collecting metrics from your Unbound servers, let us know how it's working for you! There's always Room for improvement or refinement based on real-world use cases. Feel free to [file an issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml) with your thoughts. diff --git a/docs/developer-and-contributor-corner/kubernetes-k8s-netdata.md b/docs/developer-and-contributor-corner/kubernetes-k8s-netdata.md index 92f4d2f0854d38..11982a5b4cfe35 100644 --- a/docs/developer-and-contributor-corner/kubernetes-k8s-netdata.md +++ b/docs/developer-and-contributor-corner/kubernetes-k8s-netdata.md @@ -93,7 +93,7 @@ The Netdata Helm chart deploys and enables everything you need for monitoring Ku Netdata and connect your cluster's nodes, you're ready to check out the visualizations **with zero configuration**. To get started, [sign in](https://app.netdata.cloud/sign-in?cloudRoute=/spaces) to your Netdata Cloud account. Head over -to the War Room you connected your cluster to, if not **General**. +to the Room you connected your cluster to, if not **General**. Let's walk through monitoring each layer of a Kubernetes cluster using the Overview as our framework. diff --git a/docs/developer-and-contributor-corner/style-guide.md b/docs/developer-and-contributor-corner/style-guide.md index db7ed985ff3990..94656bd7688168 100644 --- a/docs/developer-and-contributor-corner/style-guide.md +++ b/docs/developer-and-contributor-corner/style-guide.md @@ -450,7 +450,7 @@ The following tables describe the standard spelling, capitalization, and usage o | Term | Definition | |-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **claimed node** | A node that you've proved ownership of by completing the [connecting to Cloud process](/src/claim/README.md). The claimed node will then appear in your Space and any War Rooms you added it to. | +| **claimed node** | A node that you've proved ownership of by completing the [connecting to Cloud process](/src/claim/README.md). The claimed node will then appear in your Space and any Rooms you added it to. | | **Netdata** | The company behind the open-source Netdata Agent and the Netdata Cloud web application. Never use _netdata_ or _NetData_.

In general, focus on the user's goals, actions, and solutions rather than what the company provides. For example, write _Learn more about enabling alert notifications on your preferred platforms_ instead of _Netdata sends alert notifications to your preferred platforms_. | | **Netdata Agent** | The free and open source [monitoring agent](https://github.com/netdata/netdata) that you can install on all of your distributed systems, whether they're physical, virtual, containerized, ephemeral, and more. The Agent monitors systems running Linux, Docker, Kubernetes, macOS, FreeBSD, and more, and collects metrics from hundreds of popular services and applications. | | **Netdata Cloud** | The web application hosted at [https://app.netdata.cloud](https://app.netdata.cloud) that helps you monitor an entire infrastructure of distributed systems in real time.

Never use _Cloud_ without the preceding _Netdata_ to avoid ambiguity. | @@ -459,7 +459,7 @@ The following tables describe the standard spelling, capitalization, and usage o | **Space** | The highest level container within Netdata Cloud for a user to organize their team members and nodes within their infrastructure. A Space likely represents an entire organization or a large team.

_Space_ is always capitalized. | | **unreachable node** | A connected node with a disrupted [Agent-Cloud link](/src/aclk/README.md). Unreachable could mean the node no longer exists or is experiencing network connectivity issues with Cloud. | | **visited node** | A node which has had its Agent dashboard directly visited by a user. A list of these is maintained on a per-user basis. | -| **War Room** | A smaller grouping of nodes where users can view key metrics in real-time and monitor the health of many nodes with their alert status. War Rooms can be used to organize nodes in any way that makes sense for your infrastructure, such as by a service, purpose, physical location, and more.

_War Room_ is always capitalized. | +| **Room** | A smaller grouping of nodes where users can view key metrics in real-time and monitor the health of many nodes with their alert status. Rooms can be used to organize nodes in any way that makes sense for your infrastructure, such as by a service, purpose, physical location, and more.

_Room_ is always capitalized. | ### Other technical terms diff --git a/docs/glossary.md b/docs/glossary.md index 18162a06351b9d..bcada6030fd173 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -27,7 +27,7 @@ Use the alphabatized list below to find the answer to your single-term questions ## B -- [**Bookmarks**](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#manage-spaces): Netdata Cloud's bookmarks put your tools in one accessible place. Bookmarks are shared between all War Rooms in a Space, so any users in your Space will be able to see and use them. +- [**Bookmarks**](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#manage-spaces): Netdata Cloud's bookmarks put your tools in one accessible place. Bookmarks are shared between all Rooms in a Space, so any users in your Space will be able to see and use them. ## C @@ -71,7 +71,7 @@ Use the alphabatized list below to find the answer to your single-term questions - [**Health Entity Reference**](/src/health/REFERENCE.md#health-entity-reference): -- [**Home** tab](/docs/dashboards-and-charts/home-tab.md): Tab in Netdata Cloud that provides a predefined dashboard of relevant information about entities in the War Room. +- [**Home** tab](/docs/dashboards-and-charts/home-tab.md): Tab in Netdata Cloud that provides a predefined dashboard of relevant information about entities in the Room. ## I @@ -124,7 +124,7 @@ metrics, troubleshoot complex performance problems, and make data interoperable - [**Replication Streaming**](/src/streaming/README.md): Streaming configuration where child `A`, _with_ a database and web dashboard, streams metrics to parent `B`. -- [**Room** or **War Room**](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-war-rooms): War Rooms organize your connected nodes and provide infrastructure-wide dashboards using real-time metrics and visualizations. +- [**Room**](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-rooms): Rooms organize your connected nodes and provide infrastructure-wide dashboards using real-time metrics and visualizations. ## S @@ -147,10 +147,6 @@ even thousands of nodes. There are no actual bottlenecks especially if you retai - [**Visualizations**](/docs/category-overview-pages/visualizations-overview.md): Netdata uses dimensions, contexts, and families to sort your metric data into graphs, charts, and alerts that maximize your understand of your infrastructure and your ability to troubleshoot it, along or on a team. -## W - -- [**War Room** or **Room**](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-war-rooms): War Rooms organize your connected nodes and provide infrastructure-wide dashboards using real-time metrics and visualizations. - ## Z - **Zero Configuration**: Netdata is preconfigured and capable to autodetect and monitor any well known application that runs on your system. You just deploy and claim Netdata Agents in your Netdata space, and monitor them in seconds. diff --git a/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts.md b/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts.md index e94e8fece0a39c..b0094a60ff93fc 100644 --- a/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts.md +++ b/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts.md @@ -1,15 +1,15 @@ # Organize systems, metrics, and alerts When you use Netdata to monitor and troubleshoot an entire infrastructure, you need sophisticated ways of keeping everything organized. -Netdata allows to organize your observability infrastructure with spaces, war rooms, virtual nodes, host labels, and metric labels. +Netdata allows to organize your observability infrastructure with Spaces, Rooms, virtual nodes, host labels, and metric labels. -## Spaces and war rooms +## Spaces and Rooms [Spaces](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-spaces) are used for organization-level or infrastructure-level grouping of nodes and people. A node can only appear in a single space, while people can have access to multiple spaces. -The [war rooms](https://github.com/netdata/netdata/edit/master/docs/cloud/war-rooms.md) in a space bring together nodes and people in -collaboration areas. War rooms can also be used for fine-tuned +The [Rooms](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netdata-cloud-rooms) in a space bring together nodes and people in +collaboration areas. Rooms can also be used for fine-tuned [role based access control](/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md). ## Virtual nodes diff --git a/docs/netdata-agent/securing-netdata-agents.md b/docs/netdata-agent/securing-netdata-agents.md index 2a201296747505..4f6ff4094a0e2d 100644 --- a/docs/netdata-agent/securing-netdata-agents.md +++ b/docs/netdata-agent/securing-netdata-agents.md @@ -44,7 +44,7 @@ that align with your goals and your organization's standards. ## Disable the local dashboard This is the _recommended method for those who have connected their nodes to Netdata Cloud_ and prefer viewing real-time -metrics using the War Room Overview, Nodes tab, and Cloud dashboards. +metrics using the Room Overview, Nodes tab, and Cloud dashboards. You can disable the local dashboard (and API) but retain the encrypted Agent-Cloud link ([ACLK](/src/aclk/README.md)) that diff --git a/docs/netdata-cloud/README.md b/docs/netdata-cloud/README.md index 0e6b6741c9ac3d..6a2406aebf7100 100644 --- a/docs/netdata-cloud/README.md +++ b/docs/netdata-cloud/README.md @@ -43,7 +43,7 @@ Netdata Cloud provides the following features, on top of what the Netdata agents Netdata Cloud is a fundamental component for achieving an optimal cost structure and flexibility, in structuring observability the way that is best suited for each case. -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. +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. 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. @@ -57,7 +57,7 @@ Netdata Cloud provides the following features, on top of what the Netdata agents Custom dashboards are created directly from the UI, without the need for learning a query language. Netdata Cloud provides all the APIs to the Netdata dashboards to store, browse and retrieve custom dashboards created by all users. -6. **Advanced Customization**: Netdata Cloud provides all the APIs for the dashboard to have different default settings per space, per room and per user, allowing administrators and users to customize the Netdata dashboards and charts the way they see fit. +6. **Advanced Customization**: Netdata Cloud provides all the APIs for the dashboard to have different default settings per space, per Room and per user, allowing administrators and users to customize the Netdata dashboards and charts the way they see fit. ## Data Exposed to Netdata Cloud diff --git a/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md b/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md index 051a0c78aab496..41f12d7ea6ec3d 100644 --- a/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md +++ b/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md @@ -5,16 +5,16 @@ Netdata Cloud's role-based-access mechanism allows you to control what functiona ## What roles are available? With the advent of the paid plans we revamped the roles to cover needs expressed by Netdata users, like providing more limited access to their customers, or -being able to join any room. We also aligned the offered roles to the target audience of each plan. The end result is the following: +being able to join any Room. We also aligned the offered roles to the target audience of each plan. The end result is the following: | **Role** | **Community** | **Homelab** | **Business** | **Enterprise On-Premise** | |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:-------------------|:-------------------|:--------------------------| -| **Admins**

Users with this role can control Spaces, War Rooms, Nodes, Users and Billing.

They can also access any War Room in the Space.

| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| **Managers**

Users with this role can manage War Rooms and Users.

They can access any War Room in the Space.

| - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| **Troubleshooters**

Users with this role can use Netdata to troubleshoot, not manage entities.

They can access any War Room in the Space.

| - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| **Observers**

Users with this role can only view data in specific War Rooms.

💡 Ideal for restricting your customer's access to their own dedicated rooms.

| - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| **Admins**

Users with this role can control Spaces, Rooms, Nodes, Users and Billing.

They can also access any Room in the Space.

| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| **Managers**

Users with this role can manage Rooms and Users.

They can access any Room in the Space.

| - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| **Troubleshooters**

Users with this role can use Netdata to troubleshoot, not manage entities.

They can access any Room in the Space.

| - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| **Observers**

Users with this role can only view data in specific Rooms.

💡 Ideal for restricting your customer's access to their own dedicated rooms.

| - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | **Billing**

Users with this role can handle billing options and invoices.

| - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| **Member** ⚠️ Legacy role

Users with this role you can create War Rooms and invite other Members.

They can only see the War Rooms they belong to and all Nodes in the All Nodes room.

| - | - | - | - | +| **Member** ⚠️ Legacy role

Users with this role you can create Rooms and invite other Members.

They can only see the Rooms they belong to and all Nodes in the All Nodes Room.

| - | - | - | - | ## Which functionalities are available for each role? @@ -36,7 +36,7 @@ In more detail, you can find on the following tables which functionalities are a | **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes | |:------------------------------------------|:------------------:|:------------------:|:------------------:|:------------:|:-----------:|:------------------:|:-------------------------------------------| -| See all Nodes in Space (_All Nodes_ room) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: | Members are always on the _All Nodes_ room | +| See all Nodes in Space (_All Nodes_ Room) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: | Members are always on the _All Nodes_ Room | | Connect Node to Space | :heavy_check_mark: | - | - | - | - | - | - | | Delete Node from Space | :heavy_check_mark: | - | - | - | - | - | - | @@ -63,11 +63,11 @@ In more detail, you can find on the following tables which functionalities are a | **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes | |:-----------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|:-----------------------------------------------------------------------------------| | See all Rooms in a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | | -| Join any Room in a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | By joining a room you will be enabled to get notifications from nodes on that room | +| Join any Room in a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | By joining a Room you will be enabled to get notifications from nodes on that Room | | Leave Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | | | Create a new Room in a Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | | | Delete Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | | -| Change Room name | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | If not the _All Nodes_ room | +| Change Room name | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | If not the _All Nodes_ Room | | Change Room description | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | | | Add existing Nodes to Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | Node already connected to the Space | | Remove Nodes from Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | | diff --git a/docs/netdata-cloud/netdata-cloud-on-prem/troubleshooting.md b/docs/netdata-cloud/netdata-cloud-on-prem/troubleshooting.md index c330984aece73f..ac8bdf6f871d34 100644 --- a/docs/netdata-cloud/netdata-cloud-on-prem/troubleshooting.md +++ b/docs/netdata-cloud/netdata-cloud-on-prem/troubleshooting.md @@ -8,7 +8,7 @@ The following are questions that are usually asked by Netdata Cloud On-Prem oper ## Loading charts takes a long time or ends with an error -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. +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. One or more of the following may be the cause: diff --git a/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md b/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md index 0019d3e9c3dcb7..1ca004d9929fc2 100644 --- a/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md +++ b/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md @@ -1,169 +1,62 @@ # Organize Your Infrastructure and Invite your Team -Netdata Cloud provides you with features such as [Spaces](#netdata-cloud-spaces) and [War Rooms](#netdata-cloud-war-rooms) that allow you to better organize your infrastructure and ensure your team can also have access to it through invites. +Netdata Cloud works with [Spaces](#netdata-cloud-spaces) and [Rooms](#netdata-cloud-rooms). They allow you to better organize your infrastructure and provide the right access to your team. ## Netdata Cloud Spaces -Organize your multi-organization infrastructure monitoring on Netdata Cloud by creating Spaces to completely isolate access to your Agent-monitored nodes. +A Space is a high-level container. It's a collaboration environment where you can organize team members, access levels and the nodes you want to monitor. -A Space is a high-level container. It's a collaboration space where you can organize team members, access levels and the -nodes you want to monitor. +### How to organize your Netdata Cloud Environment -Let's talk through some strategies for creating the most intuitive Cloud experience for your team. +You can use any number of Spaces you want, but as you organize your Cloud experience, keep in mind that you can only add any given node to a **single** Space. -### How to organize your Netdata Cloud +We recommend sticking to a single Space so that you can keep all your nodes and their respective metrics in one place. You can then use multiple [Rooms](#netdata-cloud-rooms) to further organize your infrastructure monitoring. -You can use any number of Spaces you want, but as you organize your Cloud experience, keep in mind that _you can only -add any given node to a single Space_. This 1:1 relationship between node and Space may dictate whether you use one -encompassing Space for your entire team and separate them by War Rooms, or use different Spaces for teams monitoring -discrete parts of your infrastructure. +### Navigate between Spaces -If you have been invited to Netdata Cloud by another user by default you will able to see that space. If you are a new -user the first space is already created. +You can navigate through your different Spaces by using the left-most bar of the interface. From there you can also create a new Space by clicking the plus **+** icon. -The other consideration for the number of Spaces you use to organize your Netdata Cloud experience is the size and -complexity of your organization. - -For smaller teams and infrastructures, we recommend sticking to a single Space so that you can keep all your nodes and their -respective metrics in one place. You can then use -multiple [War Rooms](#netdata-cloud-war-rooms) -to further organize your infrastructure monitoring. - -Enterprises may want to create multiple Spaces for each of their larger teams, particularly if those teams have -different responsibilities or parts of the overall infrastructure to monitor. For example, you might have one SRE team -for your user-facing SaaS application and a second team for infrastructure tooling. If they don't need to monitor the -same nodes, you can create separate Spaces for each team. - -### Navigate between spaces - -Click on any of the boxes to switch between available Spaces. - -Netdata Cloud abbreviates each Space to the first letter of the name, or the first two letters if the name is two words -or more. Hover over each icon to see the full name in a tooltip. - -To add a new Space click on the green **+** button. Enter the name of the Space and click **Save**. - -![Switch between Spaces](https://github.com/netdata/netdata/assets/70198089/aa0d7a2f-02ec-4c01-a2d9-1f99642f2496) +![image](https://github.com/netdata/netdata/assets/70198089/74f622ac-07bf-40c7-81ba-f3907ed16c42) ### Manage Spaces -Manage your spaces by selecting a particular space and clicking on the small gear icon in the lower left corner. This -will open a side tab in which you can: - -1. _Configure this Space*_, in the first tab (**Space**) you can change the name, description or/and some privilege - options of this space - -2. _Edit the War Rooms*_, click on the **War rooms** tab to add or remove War Rooms. - -3. _Connect nodes*_, click on **Nodes** tab. Copy the claiming script to your node and run it. See the - [connect to Cloud doc](/src/claim/README.md) for details. - -4. _Manage the users*_, click on **Users**. - The [invitation doc](#invite-your-team) - details the invitation process. - -5. _Manage notification setting*_, click on **Notifications** tab to turn off/on notification methods. - -6. _Manage your bookmarks*_, click on the **Bookmarks** tab to add or remove bookmarks that you need. - -> #### Note -> -> \* This action requires admin rights for this space - -### Obsoleting offline nodes from a Space - -Netdata admin users now have the ability to remove obsolete nodes from a space. - -- Only admin users have the ability to obsolete nodes -- Only offline nodes can be marked obsolete (Live nodes and stale nodes cannot be obsoleted) -- Node obsoletion works across the entire space, so the obsoleted node will be removed from all rooms belonging to the - space -- If the obsoleted nodes eventually become live or online once more they will be automatically re-added to the space +Manage your spaces by selecting a particular space and clicking on the gear icon in the lower left-hand corner. This will open the Space's settings view, where you can take a multitude of actions regarding the Space's Rooms, nodes, integrations, configurations, and more. -![Obsoleting an offline node](https://user-images.githubusercontent.com/24860547/173087202-70abfd2d-f0eb-4959-bd0f-74aeee2a2a5a.gif) +## Netdata Cloud Rooms -## Netdata Cloud War rooms +Spaces use Rooms to organize your connected nodes and provide infrastructure-wide dashboards using real-time metrics and visualizations. -Netdata Cloud uses War Rooms to organize your connected nodes and provide infrastructure-wide dashboards using real-time metrics and visualizations. +**A node can be in N Rooms.** -Once you add nodes to a Space, all of your nodes will be visible in the **All nodes** War Room. This is a special War Room -which gives you an overview of all of your nodes in this particular Space. Then you can create functional separations of -your nodes into more War Rooms. Every War Room has its own dashboards, navigation, indicators, and management tools. +Once you add nodes to a Space, all of your nodes will be visible in the **All nodes** Room. It gives you an overview of all of your nodes in this particular Space. Then you can create functional separations of your nodes into more Rooms. Every Room has its own dashboards, navigation, indicators, and management tools. -![An example War Room](https://user-images.githubusercontent.com/43294513/225355998-f16730ba-06d4-4953-8fd3-f1c2751e102d.png) +### Room organization -### War Room organization - -We recommend a few strategies for organizing your War Rooms. +We recommend a few strategies for organizing your Rooms. - **Service, purpose, location, etc.** - You can group War Rooms by a service (Nginx, MySQL, Pulsar, and so on), their purpose (webserver, database, application), their physical location, whether they're "bare metal" or a Docker container, the PaaS/cloud provider it runs on, and much more. - This allows you to see entire slices of your infrastructure by moving from one War Room to another. + You can group Rooms by a service (Nginx, MySQL, Pulsar, and so on), their purpose (webserver, database, application), their physical location, whether they're "bare metal" or a Docker container, the PaaS/cloud provider it runs on, and much more. This allows you to see entire slices of your infrastructure by moving from one Room to another. - **End-to-end apps/services** - If you have a user-facing SaaS product, or an internal service that this said product relies on, you may want to monitor that entire stack in a single War Room. This might include Kubernetes clusters, Docker containers, proxies, databases, web servers, brokers, and more. - End-to-end War Rooms are valuable tools for ensuring the health and performance of your organization's essential services. + If you have a user-facing SaaS product, or an internal service that this said product relies on, you may want to monitor that entire stack in a single Room. This might include Kubernetes clusters, Docker containers, proxies, databases, web servers, brokers, and more. End-to-end Rooms are valuable tools for ensuring the health and performance of your organization's essential services. - **Incident response** - You can also create new War Rooms as one of the first steps in your incident response process. - For example, you have a user-facing web app that relies on Apache Pulsar for a message queue, and one of your nodes using the [Pulsar collector](/src/go/collectors/go.d.plugin/modules/pulsar/README.md) begins reporting a suspiciously low messages rate. - You can create a War Room called `$year-$month-$day-pulsar-rate`, add all your Pulsar nodes in addition to nodes they connect to, and begin diagnosing the root cause in a War Room optimized for getting to resolution as fast as possible. - -### Add War Rooms - -To add new War Rooms to any Space, click on the green plus icon **+** next to the **War Rooms** heading on the left (Space's) sidebar. - -In the panel, give the War Room a name and description, and choose whether it's public or private. -Anyone in your Space can join public War Rooms, but can only join private War Rooms with an invitation. - -### Manage War Rooms - -All the users and nodes involved in a particular Space can be part of a War Room. - -Any user can change simple settings of a War room, like the name or the users participating in it. -Click on the gear icon of the War Room's name in the top of the page to do that. A sidebar will open with options for this War Room: - -1. To **change a War Room's name, description, or public/private status**, click on **War Room** tab. + You can also create new Rooms as one of the first steps in your incident response process. For example, you have a user-facing web app that relies on Apache Pulsar for a message queue, and one of your nodes using the [Pulsar collector](/src/go/collectors/go.d.plugin/modules/pulsar/README.md) begins reporting a suspiciously low messages rate. You can create a Room called `$year-$month-$day-pulsar-rate`, add all your Pulsar nodes in addition to nodes they connect to, and begin diagnosing the root cause in a Room optimized for getting to resolution as fast as possible. -2. To **include an existing node** to a War Room or **connect a new node\*** click on **Nodes** tab. Choose any connected node you want to add to this War Room by clicking on the checkbox next to its hostname, then click **+ Add** at the top of the panel. +### Add Rooms -3. To **add existing users to a War Room**, click on **Add Users**. - See our [invite section](#invite-your-team) for details on inviting new users to your Space in Netdata Cloud. +To add new Rooms to any Space, click on the green plus icon **+** next to the **Rooms** heading on the Room's sidebar. -> #### Note -> ->\* This action requires **admin** rights for this Space +### Manage Rooms -#### More actions +All the users and nodes involved in a particular Space can be part of a Room. -To **view or remove nodes** in a War Room, click on the **Nodes tab**. To remove a node from the current War Room, click on -the **🗑** icon. - -> #### Info -> -> Removing a node from a War Room does not remove it from your Space. +Click on the gear icon next to the Room's name in the top of the page to do that. This will open the Rooms settings view, where you can take the same actions as with the Spaces settings, but now catered towards the specific Room. ## Invite your team -Invite your entire SRE, DevOPs, or ITOps team to Netdata Cloud, to give everyone insights into your infrastructure from a single pane of glass. - -Invite new users to your Space by clicking on **Invite Users** in -the [Space](#netdata-cloud-spaces) management area. - -![image](https://user-images.githubusercontent.com/70198089/227887469-e46bad55-ef5d-441a-83a5-dcc2af038678.png) - - -You will be prompted to enter the email addresses of the users you want to invite to your Space. You can enter any number of email addresses, separated by a comma, to send multiple invitations at once. - -Next, choose the War Rooms you want to invite these users to. Once logged in, these users are not restricted only to -these War Rooms. They can be invited to others, or join any that are public. - -Next, pick a role for the invited user. You can read more about [which roles are available](/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md#what-roles-are-available) based on your [subscription plan](/docs/netdata-cloud/view-plan-and-billing.md). - -Click the **Send** button to send an email invitation, which will prompt them -to [sign up](/docs/netdata-cloud/authentication-and-authorization/README.md) and join your Space. +Invite your entire SRE, DevOPs, or ITOps team to your Space, to give everyone access into your infrastructure from a single pane of glass. -![image](https://user-images.githubusercontent.com/70198089/227888899-8511081b-0157-4e22-81d9-898cc464dcb0.png) +To do so, click on **Invite Users** in the [Space](#netdata-cloud-spaces) management area or any other such prompt around the UI. -Any unaccepted invitations remain under **Invitations awaiting response**. These invitations can be rescinded at any -time by clicking the trash can icon. +Follow the instructions on screen, to provide the right access and role to the users you want to invite. diff --git a/integrations/cloud-notifications/integrations/webhook.md b/integrations/cloud-notifications/integrations/webhook.md index 8d177f0cbe9f9d..24ab78232d9c42 100644 --- a/integrations/cloud-notifications/integrations/webhook.md +++ b/integrations/cloud-notifications/integrations/webhook.md @@ -67,7 +67,7 @@ From the Netdata Cloud UI, you can manage your space's notification settings and | chart | string | The chart associated with the alert. | | context | string | The chart context. | | space | string | The space where the node that raised the alert is assigned. | - | rooms | object[object(string,string)] | Object with list of rooms names and urls where the node belongs to. | + | Rooms | object[object(string,string)] | Object with list of Rooms names and urls where the node belongs to. | | family | string | Context family. | | class | string | Classification of the alert, e.g. "Error". | | severity | string | Alert severity, can be one of "warning", "critical" or "clear". | diff --git a/integrations/cloud-notifications/metadata.yaml b/integrations/cloud-notifications/metadata.yaml index 88bc9cc4200b4c..5a3e2ca351b4c5 100644 --- a/integrations/cloud-notifications/metadata.yaml +++ b/integrations/cloud-notifications/metadata.yaml @@ -595,7 +595,7 @@ | chart | string | The chart associated with the alert. | | context | string | The chart context. | | space | string | The space where the node that raised the alert is assigned. | - | rooms | object[object(string,string)] | Object with list of rooms names and urls where the node belongs to. | + | Rooms | object[object(string,string)] | Object with list of Rooms names and urls where the node belongs to. | | family | string | Context family. | | class | string | Classification of the alert, e.g. "Error". | | severity | string | Alert severity, can be one of "warning", "critical" or "clear". | diff --git a/packaging/installer/methods/freebsd.md b/packaging/installer/methods/freebsd.md index 8e0de16ea480b2..3a33d2e90d7422 100644 --- a/packaging/installer/methods/freebsd.md +++ b/packaging/installer/methods/freebsd.md @@ -39,8 +39,6 @@ Please respond in the affirmative for any relevant prompts during the installati Once the installation is completed, you should be able to start monitoring the FreeBSD server using Netdata. -![image](https://user-images.githubusercontent.com/24860547/202489210-3c5a3346-8f53-4b7b-9832-f9383b34d864.png) - Netdata can also be installed via [FreeBSD ports](https://www.freshports.org/net-mgmt/netdata). ## Manual installation @@ -86,8 +84,6 @@ cd /opt/netdata/usr/libexec/netdata/ && ./netdata-updater.sh You can now access the Netdata dashboard by navigating to `http://NODE:19999`, replacing `NODE` with the IP address or hostname of your system. -![image](https://user-images.githubusercontent.com/2662304/48304090-fd384080-e51b-11e8-80ae-eecb03118dda.png) - Starting with v1.30, Netdata collects anonymous usage information by default and sends it to a self hosted PostHog instance within the Netdata infrastructure. To read more about the information collected and how to opt-out, check the [anonymous statistics page](/docs/netdata-agent/configuration/anonymous-telemetry-events.md). diff --git a/packaging/installer/methods/kickstart.md b/packaging/installer/methods/kickstart.md index 19113c866f5fa3..a525cc70deb435 100644 --- a/packaging/installer/methods/kickstart.md +++ b/packaging/installer/methods/kickstart.md @@ -35,7 +35,7 @@ To install Netdata, run the following as your normal user: > :bookmark_tabs: Note > > If you plan to also connect the node to Netdata Cloud, make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space, -> and `YOUR_ROOM_ID` with the ID of the room you are willing to connect the node to. +> and `YOUR_ROOM_ID` with the ID of the Room you are willing to connect the node to. ## Verify script integrity @@ -240,7 +240,7 @@ By default, the kickstart script will provide a Netdata agent installation that - `--claim-url` Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`. Use this option to change the Netdata Cloud URL to point to your Netdata Cloud installation. - `--claim-rooms` - Specify a comma-separated list of tokens for each War Room this node should appear in. + Specify a comma-separated list of tokens for each Room this node should appear in. - `--claim-proxy` Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy. See [connecting through a proxy](/src/claim/README.md#connect-through-a-proxy) for details. - `--claim-only` diff --git a/packaging/installer/methods/kubernetes.md b/packaging/installer/methods/kubernetes.md index 2f0e6f2d253b76..6a0dee98ad3f8a 100644 --- a/packaging/installer/methods/kubernetes.md +++ b/packaging/installer/methods/kubernetes.md @@ -97,7 +97,7 @@ On an existing installation, in order to connect it to Netdata Cloud you will ne > :bookmark_tabs: Note > > Make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space, - > and `YOUR_ROOM_ID` with the ID of the room you are willing to connect to. + > and `YOUR_ROOM_ID` with the ID of the Room you are willing to connect to. These settings connect your `parent`/`child` nodes to Netdata Cloud and store more metrics in the nodes' time-series databases. diff --git a/packaging/installer/methods/macos.md b/packaging/installer/methods/macos.md index f537aca15f6175..31aaebf980f774 100644 --- a/packaging/installer/methods/macos.md +++ b/packaging/installer/methods/macos.md @@ -42,7 +42,7 @@ area](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#netda - `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node after the install. -- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in. +- `--claim-rooms`: Specify a comma-separated list of tokens for each Room this node should appear in. - `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy. See [connecting through a proxy](/src/claim/README.md#connect-through-a-proxy) for details. - `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`. diff --git a/src/claim/README.md b/src/claim/README.md index 2e123307c17003..dff6067722d01a 100644 --- a/src/claim/README.md +++ b/src/claim/README.md @@ -10,7 +10,7 @@ features like centralized monitoring and easier collaboration. There are two places in the UI where you can add/connect your Node: -- **Space/Room settings**: Click the cogwheel (the bottom-left corner or next to the War Room name at the top) and +- **Space/Room settings**: Click the cogwheel (the bottom-left corner or next to the Room name at the top) and select "Nodes." Click the "+" button to add a new node. - [**Nodes tab**](/docs/dashboards-and-charts/nodes-tab.md): Click on the "Add nodes" button. @@ -60,7 +60,7 @@ Claiming script options: | Option | Description | Required | Default value | |--------|--------------------------------------------------------------------|:--------:|:------------------------------------------------------| | token | The claiming token for your Netdata Cloud Space. | yes | | -| rooms | A comma-separated list of War Rooms to add the Agent to. | no | The Agent will be added to the "All nodes" room only. | +| rooms | A comma-separated list of Rooms to add the Agent to. | no | The Agent will be added to the "All nodes" Room only. | | id | The unique identifier of the Agent. | no | The Agent's MACHINE_GUID. | | proxy | The URL of a proxy server to use for the connection, if necessary. | no | | @@ -70,7 +70,7 @@ Example: netdata-claim.sh -token=MYTOKEN1234567 -rooms=room1,room2 ``` -This command connects the Agent and adds it to the "room1" and "room2" War Rooms using your claiming token +This command connects the Agent and adds it to the "room1" and "room2" Rooms using your claiming token MYTOKEN1234567. ## Reconnect @@ -85,7 +85,7 @@ sudo rm -rf cloud.d/ ``` This node no longer has access to the credentials it was used when connecting to Netdata Cloud via the ACLK. You will -still be able to see this node in your War Rooms in an **unreachable** state. +still be able to see this node in your Rooms in an **unreachable** state. If you want to reconnect this node, you need to: diff --git a/src/daemon/README.md b/src/daemon/README.md index fee8989b386c5a..bc2ec7757f8a69 100644 --- a/src/daemon/README.md +++ b/src/daemon/README.md @@ -105,7 +105,7 @@ The command line options of the Netdata 1.10.0 version are the following: Check if string matches pattern and exit. -W "claim -token=TOKEN -rooms=ROOM1,ROOM2 url=https://app.netdata.cloud" - Connect the agent to the workspace rooms pointed to by TOKEN and ROOM*. + Connect the agent to the workspace Rooms pointed to by TOKEN and ROOM*. Signals netdata handles: diff --git a/src/database/engine/README.md b/src/database/engine/README.md index 822343dd47727d..078271228accab 100644 --- a/src/database/engine/README.md +++ b/src/database/engine/README.md @@ -130,7 +130,7 @@ See (change how long netdata stores metrics)[https://github.com/netdata/netdata/ #### Exceptions -Netdata has several protection mechanisms to prevent the use of more memory (than the above), by incrementally fetching data from disk and aggressively evicting old data to make room for new data, but still memory may grow beyond the above limit under the following conditions: +Netdata has several protection mechanisms to prevent the use of more memory (than the above), by incrementally fetching data from disk and aggressively evicting old data to make Room for new data, but still memory may grow beyond the above limit under the following conditions: 1. The number of pages concurrently used in queries do not fit the in the above size. This can happen when multiple queries of unreasonably long time-frames run on lower, higher resolution, tiers. The Netdata query planner attempts to avoid such situations by gradually loading pages, but still under extreme conditions the system may use more memory to satisfy these queries. @@ -158,7 +158,7 @@ Then `x 2` is the worst case estimate for the dirty queue. If all collected metr The memory we saved with the above is used to improve the LRU cache. So, although we reserved 32MiB for the LRU, in bigger setups (Netdata Parents) the LRU grows a lot more, within the limits of the equation. -In practice, the main cache sizes itself with `hot x 1.5` instead of `host x 2`. The reason is that 5% of main cache is reserved for expanding open cache, 5% for expanding extent cache and we need room for the extensive buffers that are allocated in these setups. When the main cache exceeds `hot x 1.5` it enters a mode of critical evictions, and aggresively frees pages from the LRU to maintain a healthy memory footprint within its design limits. +In practice, the main cache sizes itself with `hot x 1.5` instead of `host x 2`. The reason is that 5% of main cache is reserved for expanding open cache, 5% for expanding extent cache and we need Room for the extensive buffers that are allocated in these setups. When the main cache exceeds `hot x 1.5` it enters a mode of critical evictions, and aggresively frees pages from the LRU to maintain a healthy memory footprint within its design limits. #### Open Cache diff --git a/src/health/guides/entropy/lowest_entropy.md b/src/health/guides/entropy/lowest_entropy.md index 37b35cd2156a22..c25dc4d019695e 100644 --- a/src/health/guides/entropy/lowest_entropy.md +++ b/src/health/guides/entropy/lowest_entropy.md @@ -12,7 +12,7 @@ Entropy is similar to "randomness". A Linux system gathers "real" random numbers Encryption and cryptography applications require random numbers to operate. A function or an algorithm that produces numbers -*that seem to be random*- is very predictable, if you know what function is used. -In real life, we use our surroundings and our thoughts to produce truly random numbers. A computer can't really do this by itself, so it gathers numbers from a lot of sources. For example, it can get the CO2 levels in a room from a sensor on the system and use that as a random number. +In real life, we use our surroundings and our thoughts to produce truly random numbers. A computer can't really do this by itself, so it gathers numbers from a lot of sources. For example, it can get the CO2 levels in a Room from a sensor on the system and use that as a random number. This way all the values are random and there is no pattern to be found among them. diff --git a/src/health/notifications/matrix/README.md b/src/health/notifications/matrix/README.md index 98065d2b7e2e85..766af1047d24d6 100644 --- a/src/health/notifications/matrix/README.md +++ b/src/health/notifications/matrix/README.md @@ -27,7 +27,7 @@ Send notifications to Matrix network rooms using Netdata's Agent alert notificat - The url of the homeserver (`https://homeserver:port`). - Credentials for connecting to the homeserver, in the form of a valid access token for your account (or for a dedicated notification account). These tokens usually don't expire. -- The room ids that you want to sent the notification to. +- The Room ids that you want to sent the notification to. - Access to the terminal where Netdata Agent is running @@ -57,7 +57,7 @@ The following options can be defined for this notification | SEND_MATRIX | Set `SEND_MATRIX` to YES | YES | yes | | MATRIX_HOMESERVER | set `MATRIX_HOMESERVER` to the URL of the Matrix homeserver. | | yes | | MATRIX_ACCESSTOKEN | Set `MATRIX_ACCESSTOKEN` to the access token from your Matrix account. | | yes | -| DEFAULT_RECIPIENT_MATRIX | Set `DEFAULT_RECIPIENT_MATRIX` to the rooms you want the alert notifications to be sent to. The format is `!roomid:homeservername`. | | yes | +| DEFAULT_RECIPIENT_MATRIX | Set `DEFAULT_RECIPIENT_MATRIX` to the Rooms you want the alert notifications to be sent to. The format is `!roomid:homeservername`. | | yes | ##### MATRIX_ACCESSTOKEN @@ -69,13 +69,13 @@ curl -XPOST -d '{"type":"m.login.password", "user":"example", "password":"wordpa ##### DEFAULT_RECIPIENT_MATRIX -The room ids are unique identifiers and can be obtained from the room settings in a Matrix client (e.g. Riot). +The Room ids are unique identifiers and can be obtained from the Room settings in a Matrix client (e.g. Riot). -You can define multiple rooms like this: `!roomid1:homeservername` `!roomid2:homeservername`. +You can define multiple Rooms like this: `!roomid1:homeservername` `!roomid2:homeservername`. All roles will default to this variable if left unconfigured. -You can have different rooms per role, by editing `DEFAULT_RECIPIENT_MATRIX` with the `!roomid:homeservername` you want, in the following entries at the bottom of the same file: +You can have different Rooms per role, by editing `DEFAULT_RECIPIENT_MATRIX` with the `!roomid:homeservername` you want, in the following entries at the bottom of the same file: ```conf role_recipients_matrix[sysadmin]="!roomid1:homeservername" diff --git a/src/health/notifications/matrix/metadata.yaml b/src/health/notifications/matrix/metadata.yaml index 17135aa3ad535d..db7f92eb11d369 100644 --- a/src/health/notifications/matrix/metadata.yaml +++ b/src/health/notifications/matrix/metadata.yaml @@ -20,7 +20,7 @@ description: | - The url of the homeserver (`https://homeserver:port`). - Credentials for connecting to the homeserver, in the form of a valid access token for your account (or for a dedicated notification account). These tokens usually don't expire. - - The room ids that you want to sent the notification to. + - The Room ids that you want to sent the notification to. - Access to the terminal where Netdata Agent is running configuration: file: @@ -50,16 +50,16 @@ ``` - name: 'DEFAULT_RECIPIENT_MATRIX' default_value: '' - description: "Set `DEFAULT_RECIPIENT_MATRIX` to the rooms you want the alert notifications to be sent to. The format is `!roomid:homeservername`." + description: "Set `DEFAULT_RECIPIENT_MATRIX` to the Rooms you want the alert notifications to be sent to. The format is `!roomid:homeservername`." required: true detailed_description: | - The room ids are unique identifiers and can be obtained from the room settings in a Matrix client (e.g. Riot). + The Room ids are unique identifiers and can be obtained from the Room settings in a Matrix client (e.g. Riot). - You can define multiple rooms like this: `!roomid1:homeservername` `!roomid2:homeservername`. + You can define multiple Rooms like this: `!roomid1:homeservername` `!roomid2:homeservername`. All roles will default to this variable if left unconfigured. - You can have different rooms per role, by editing `DEFAULT_RECIPIENT_MATRIX` with the `!roomid:homeservername` you want, in the following entries at the bottom of the same file: + You can have different Rooms per role, by editing `DEFAULT_RECIPIENT_MATRIX` with the `!roomid:homeservername` you want, in the following entries at the bottom of the same file: ```conf role_recipients_matrix[sysadmin]="!roomid1:homeservername" diff --git a/src/web/gui/README.md b/src/web/gui/README.md index 12ca8598966fe1..248cee4da8b8f7 100644 --- a/src/web/gui/README.md +++ b/src/web/gui/README.md @@ -29,7 +29,7 @@ Beyond charts, the local dashboard can be broken down into three key areas: - [Sections](#sections) - [Time \& date picker](#time--date-picker) - [Metrics menus](#metrics-menus) - - [Cloud menus (Spaces, War Rooms, and Visited nodes)](#cloud-menus-spaces-war-rooms-and-visited-nodes) + - [Cloud menus (Spaces, Rooms, and Visited nodes)](#cloud-menus-spaces-rooms-and-visited-nodes) - [Customizing the local dashboard](#customizing-the-local-dashboard) - [Custom dashboards](#custom-dashboards) @@ -89,12 +89,12 @@ partition Netdata recognizes. ![Screenshot of some metrics submenus](https://user-images.githubusercontent.com/1153921/80834697-11577e00-8ba6-11ea-979c-92fd19cdb480.png) -### Cloud menus (Spaces, War Rooms, and Visited nodes) +### Cloud menus (Spaces, Rooms, and Visited nodes) The dashboard also features a menu related to Netdata Cloud functionality. You can view your existing Spaces or create new ones via the left vertical column of boxes. This menu also displays the name of your current Space, shows a list of -any War Rooms you've added you your Space, and lists any notes you recently visited via their Agent dashboards. Click on -a War Room's name to jump to the Netdata Cloud web interface. +any Rooms you've added you your Space, and lists any notes you recently visited via their Agent dashboards. Click on +a Room's name to jump to the Netdata Cloud web interface. ![A screenshot of the Cloud menus](https://user-images.githubusercontent.com/1153921/80837210-3f8b8c80-8bab-11ea-9c75-128c2d823ef8.png)