Events docs (#14341)
* initial draft of events doc! . * first draft of the events docs. * add link to the how page * fixed some gramatical errors. * initial draft of events doc! . * first draft of the events docs. * add link to the how page * fixed some gramatical errors. * added examples for node and alert evetns * added missing mostly agent and space statistic evetns * added on how-to the missing filtering details * initial draft of events doc! . * first draft of the events docs. * add link to the how page * fixed some gramatical errors. * added examples for node and alert evetns * initial draft of events doc! . * first draft of the events docs. * add link to the how page * fixed some gramatical errors. * added missing mostly agent and space statistic evetns * added on how-to the missing filtering details * replace p with br for breaks inside tables * fixed global links to the two new files * Update docs/cloud/insights/view-events-feed.md Co-authored-by: Alex Malkov <alex.a.malkov@gmail.com> * Update docs/cloud/insights/view-events-feed.md Co-authored-by: Alex Malkov <alex.a.malkov@gmail.com> * Update docs/cloud/insights/view-events-feed.md Co-authored-by: Alex Malkov <alex.a.malkov@gmail.com> * Update docs/cloud/insights/events-feed.md Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com> * Update docs/cloud/insights/events-feed.md Co-authored-by: Andrew Maguire <andrewm4894@gmail.com> * first updates from first pass on comment. did a minor fix on the roles file had an extra ) * change Become to Became * finalized latest review comments --------- Co-authored-by: Alex Malkov <alex.a.malkov@gmail.com> Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com> Co-authored-by: Andrew Maguire <andrewm4894@gmail.com>
Hugo Valente committed
Feb 10, 2023 at 17:01 UTC
a4d70e8243c1ec788514a6e50520bf4befd87f41
2 files changed
+78
-1
docs/cloud/insights/events-feed.md
new
+77
@@ -0,0 +1,77 @@
1
+<!--
2
+title: "Events feed"
3
+sidebar_label: "Events feed"
4
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/insights/events-feed.md"
5
+sidebar_position: "2800"
6
+learn_status: "Published"
7
+learn_topic_type: "Concepts"
8
+learn_rel_path: "Concepts"
9
+learn_docs_purpose: "Present the Netdata Events feed."
10
+-->
11
+
12
+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.
13
+
14
+## What are the available events?
15
+
16
+At a high-level view, these are the domains from which the Events feed will provide visibility into.
17
+
18
+> ⚠️ Based on your space's plan, different allowances are defined to query past data.
19
+
20
+| **Domains of events** | **Community** | **Pro** | **Business** |
21
+| :-- | :-- | :-- | :-- |
22
+| **Auditing events** - COMING SOON<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 |
23
+| **[Topology events](#topology-events)**<br/>Node state transition events, e.g. live or offline.| 4 hours | 7 days | 14 days |
24
+| **[Alert events](#alert-events)**<br/>Alert state transition events, can be seen as an alert history log.| 4 hours | 7 days | 90 days |
25
+
26
+### Topology events
27
+
28
+| **Event name** | **Description** | **Example** |
29
+| :-- | :-- | :-- |
30
+| Node Became Live | The node is collecting and streaming metrics to Cloud.| Node `netdata-k8s-state-xyz` was **live** |
31
+| Node Became Stale | The node is offline and not streaming metrics to Cloud. It can show historical data from a parent node. | Node `ip-xyz.ec2.internal` was **stale** |
32
+| Node Became Offline | The node is offline, not streaming metrics to Cloud and not available in any parent node.| Node `ip-xyz.ec2.internal` was **offline** |
33
+| Node Created | The node is created but it is still `Unseen` on Cloud, didn't establish a successful connection yet.| Node `ip-xyz.ec2.internal` was **created** |
34
+| 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)** |
35
+| Node Restored | The node was restored. See `Node Removed` above. | Node `ip-xyz.ec2.internal` was **restored** |
36
+| 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)** |
37
+| Agent Connected | The agent connected to the Cloud MQTT server (Agent-Cloud Link established).<br/>These events can only be seen on _All nodes_ War Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has connected to Cloud. |
38
+| Agent Disconnected | The agent disconnected from the Cloud MQTT server (Agent-Cloud Link severed).<br/>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**. |
39
+| Space Statistics | Daily snapshot of space node statistics.<br/>These events can only be seen on _All nodes_ War Room. | Space statistics. Nodes: **22 live**, **21 stale**, **18 removed**, **61 total**. |
40
+
41
+
42
+### Alert events
43
+
44
+| **Event name** | **Description** | **Example** |
45
+| :-- | :-- | :-- |
46
+| Node Alert State Changed | These are node alert state transition events and can be seen as an alert history log. You will be able to see transitions to or from any of these states: Cleared, Warning, Critical, Removed, Error or Unknown | Transition to Cleared:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` recovered with value **8.33%**<br/><br/>Transition from Cleared to Warning or Critical:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` was raised to **WARNING** with value **10%**<br/><br/>Transition from Warning to Critical:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` escalated to **CRITICAL** with value **25%**<br/><br/>Transition from Critical to Warning:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` was demoted to **WARNING** with value **10%**<br/><br/>Transition to Removed:<br/>Alert `httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` is no longer available, state can't be assessed.<br/><br/>Transition to Error:<br/>For this alert `httpcheck_web_service_bad_status` related to `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` we couldn't calculate the current value ⓘ|
47
+
48
+## Who can access the events?
49
+
50
+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-model.md).
51
+
52
+## How to use the events feed
53
+
54
+1. Click on the **Events** tab (located near the top of your screen)
55
+1. You will be presented with a table listing the events that occurred from the timeframe defined on the date time picker
56
+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
57
+
58
+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.
59
+
60
+### Event types and filters
61
+
62
+| Event type | Tags | Nodes | Alert Status | Alert Names | Chart Names |
63
+| :-- | :-- | :-- | :-- | :-- | :-- |
64
+| Node Became Live | node, lifecycle | Node name | - | - | - |
65
+| Node Became Stale | node, lifecycle | Node name | - | - | - |
66
+| Node Became Offline | node, lifecycle | Node name | - | - | - |
67
+| Node Created | node, lifecycle | Node name | - | - | - |
68
+| Node Removed | node, lifecycle | Node name | - | - | - |
69
+| Node Restored | node, lifecycle | Node name | - | - | - |
70
+| Node Deleted | node, lifecycle | Node name | - | - | - |
71
+| Agent Claimed | agent | - | - | - | - |
72
+| Agent Connected | agent | - | - | - | - |
73
+| Agent Disconnected | agent | - | - | - | - |
74
+| Agent Authenticated | agent | - | - | - | - |
75
+| Agent Authentication Failed | agent | - | - | - | - |
76
+| Space Statistics | space, node, statistics | Node name | - | - | - |
77
+| Node Alert State Changed | alert, node | Node name | Cleared, Warning, Critical, Removed, Error or Unknown | Alert name | Chart name |
docs/cloud/manage/role-based-access.md
+1
-1
@@ -1,7 +1,7 @@
1
<!--
2
title: "Role-Based Access model"
3
sidebar_label: "Role-Based Access model"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access-model.md)"
4
+custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access-model.md"
5
sidebar_position: "1"
6
learn_status: "Published"
7
learn_topic_type: "Concepts"