diff options
author | Fotis Voutsas <fotis@netdata.cloud> | 2024-05-01 11:19:42 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-05-01 11:19:42 +0300 |
commit | 23760ba78d977a564baae640e4c2d740bc25cce2 (patch) | |
tree | a620eeb2208a99f056e46ab4037b2de2789de184 /docs | |
parent | caf50d88ea91efe009edc3bccb4b96a470b504e1 (diff) |
Events tab documentation updates (#17521)
Co-authored-by: Hugo Valente <hugo@netdata.cloud>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/cloud/insights/events-feed.md | 62 |
1 files changed, 19 insertions, 43 deletions
diff --git a/docs/cloud/insights/events-feed.md b/docs/cloud/insights/events-feed.md index a56877ab1a..b0cfb3f7d5 100644 --- a/docs/cloud/insights/events-feed.md +++ b/docs/cloud/insights/events-feed.md @@ -1,29 +1,20 @@ -<!-- -title: "Events feed" -sidebar_label: "Events feed" -custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/insights/events-feed.md" -sidebar_position: "2800" -learn_status: "Published" -learn_topic_type: "Concepts" -learn_rel_path: "Concepts" -learn_docs_purpose: "Present the Netdata Events feed." ---> +# Events tab -# Events feed - -Netdata Cloud provides the Events feed which is a powerful feature that tracks events that happen on your infrastructure, or in your Space. The feed lets you investigate events that occurred in the past, which is invaluable for troubleshooting. Common use cases are ones like when a node goes offline, and you want to understand what events happened before that. A detailed event history can also assist in attributing sudden pattern changes in a time series to specific changes in your environment. +The Events tab provides a feed which is a powerful feature that tracks events that happen on your infrastructure, or in your Space. The feed lets you investigate events that occurred in the past, which is invaluable for troubleshooting. Common use cases are ones like when a node goes offline, and you want to understand what events happened before that. A detailed event history can also assist in attributing sudden pattern changes in a time series to specific changes in your environment. ## What are the available events? At a high-level view, these are the domains from which the Events feed will provide visibility into. -> ⚠️ Based on your space's plan, different allowances are defined to query past data. +> **Note** +> +> Based on your space's plan, different allowances are defined to query past data. -| **Domains of events** | **Community** | **Pro** | **Business** | -| :-- | :-- | :-- | :-- | -| **[Auditing events](#auditing-events)** - <br/>Events related to actions done on your Space, e.g. invite user, change user role or change plan.| 4 hours | 7 days | 90 days | -| **[Topology events](#topology-events)**<br/>Node state transition events, e.g. live or offline.| 4 hours | 7 days | 14 days | -| **[Alert events](#alert-events)**<br/>Alert state transition events, can be seen as an alert history log.| 4 hours | 7 days | 90 days | +| **Domains of events** | **Community** | **Business** | +| :-- | :-- | :-- | +| **[Auditing events](#auditing-events)** - <br/>Events related to actions done on your Space, e.g. invite user, change user role or change plan.| 4 hours | 90 days | +| **[Topology events](#topology-events)**<br/>Node state transition events, e.g. live or offline.| 4 hours | 14 days | +| **[Alert events](#alert-events)**<br/>Alert state transition events, can be seen as an alert history log.| 4 hours | 90 days | ### Auditing events @@ -44,6 +35,8 @@ At a high-level view, these are the domains from which the Events feed will prov | 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` | ### Topology events @@ -69,31 +62,14 @@ At a high-level view, these are the domains from which the Events feed will prov ## Who can access the events? -All users will be able to see events from the Topology and Alerts domain but Auditing events, once these are added, only be accessible to administrators. For more details checkout [Netdata Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md). +All users will be able to see events from the Topology and Alerts domain but Auditing events, once these are added, will only be accessible to administrators. For more details check the [Netdata Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md). ## How to use the events feed 1. Click on the **Events** tab (located near the top of your screen) -1. You will be presented with a table listing the events that occurred from the timeframe defined on the date time picker -1. You can use the filtering capabilities available on right-hand bar to slice through the results provided. See more details on event types and filters - -Note: When you try to query a longer period than what your space allows you will see an error message highlighting that you are querying data outside of your plan. - -### Event types and filters - -| Event type | Tags | Nodes | Alert Status | Alert Names | Chart Names | -| :-- | :-- | :-- | :-- | :-- | :-- | -| Node Became Live | node, lifecycle | Node name | - | - | - | -| Node Became Stale | node, lifecycle | Node name | - | - | - | -| Node Became Offline | node, lifecycle | Node name | - | - | - | -| Node Created | node, lifecycle | Node name | - | - | - | -| Node Removed | node, lifecycle | Node name | - | - | - | -| Node Restored | node, lifecycle | Node name | - | - | - | -| Node Deleted | node, lifecycle | Node name | - | - | - | -| Agent Claimed | agent | - | - | - | - | -| Agent Connected | agent | - | - | - | - | -| Agent Disconnected | agent | - | - | - | - | -| Agent Authenticated | agent | - | - | - | - | -| Agent Authentication Failed | agent | - | - | - | - | -| Space Statistics | space, node, statistics | Node name | - | - | - | -| Node Alert State Changed | alert, node | Node name | Cleared, Warning, Critical, Removed, Error or Unknown | Alert name | Chart name | +1. You will be presented with a table listing the events that occurred from the timeframe defined on the [date time picker](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md#date-and-time-selector) +1. You can use the filtering capabilities available on right-hand bar to slice through the results provided. See more details on [event types and filters](#event-types-and-filters) + +> **Note** +> +> When you try to query a longer period than what your space allows you will see an error message highlighting that you are querying data outside of your plan. |