Skip to content

Commit

Permalink
Change "War Room" to "Room" and other docs changes (netdata#17783)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ancairon committed May 30, 2024
1 parent c50be67 commit 38baccf
Show file tree
Hide file tree
Showing 34 changed files with 113 additions and 228 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/Demo-Sites.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| :------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| :------------------------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 4 additions & 4 deletions docs/dashboards-and-charts/alerts-tab.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand All @@ -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.

Expand Down
12 changes: 6 additions & 6 deletions docs/dashboards-and-charts/dashboards-tab.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -71,26 +71,26 @@ 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.

### 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

Because of the visual complexity of individual charts, dashboards require a minimum browser viewport of 800px.

## 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.
Loading

0 comments on commit 38baccf

Please sign in to comment.