You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/eventing/pages/eventing-statistics.adoc
+22-13Lines changed: 22 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,29 +7,33 @@
7
7
8
8
*Via the Web Console's Eventing page*
9
9
10
-
As of 7.0.0, Eventing Statistics can be displayed in the Eventing main UI page for each deployed Function by clicking on the Function name to expand the Function controls. These three key metrics or Deployment Statistics are updated every 10 seconds by default and displayed as numeric values:
10
+
As of 7.0.0, Eventing Statistics can be displayed in the Eventing main UI page for each deployed Function by clicking on the Function name to expand the Function controls.
11
+
These three key metrics or Deployment Statistics are updated every 10 seconds by default and displayed as numeric values:
11
12
12
-
* *success* - displays the number of processed Functions and also Eventing timer callbacks.
13
+
* *success* - displays the number of processed Functions and also Eventing timer callbacks.
13
14
* *failure* - displays the number of failures while processing the Eventing Function code.
14
-
* *timeout* - displays the number of Functions which have encountered a timeout condition.
15
+
* *timeout* - displays the number of Functions which have encountered a timeout condition.
15
16
16
17
// image::stats_00_counts.png[,100%]
17
18
18
-
In addition to the per Function numeric statistics above as of 7.0.0 there are the rate charts that can be accessed from any deployed function. These charts are lagged by 30 seconds.
19
+
In addition to the per Function numeric statistics above as of 7.0.0 there are the rate charts that can be accessed from any deployed function.
20
+
These charts are lagged by 30 seconds.
19
21
20
-
* *success* - displays the rate of processed Functions and also Eventing timer callbacks.
22
+
* *success* - displays the rate of processed Functions and also Eventing timer callbacks.
21
23
* *failure* - displays the rate of failures while processing the Function Eventing Function code.
22
-
* *timeout* - displays the rate of Functions which have encountered a timeout condition.
24
+
* *timeout* - displays the rate of Functions which have encountered a timeout condition.
23
25
24
26
// image::stats_01_counts_and_charts.png[,100%]
25
27
26
-
In addition, per Function Statistics the Web Console or using the REST API.
28
+
In addition, per Function Statistics can be accessed via the Web Console or using the REST API.
27
29
28
30
*Via the Web Console's custom Dashboards*
29
31
30
32
Eventing Statistics, for each deployed Function, can be fetched from an Eventing node using the Web Console.
31
33
32
-
You can make custom dashboards for a node or a cluster to get aggregated Eventing statistics. Access the *Couchbase Web Console* > *Dashboard* page. Then select "_new dashboard..._" from the *Choose Dashboard* dropdown, then "Add Group" and finally "Add a Chart" (you of course are interested in Eventing charts).
34
+
You can make custom dashboards for a node or a cluster to get aggregated Eventing statistics.
35
+
Access the *Couchbase Web Console* > *Dashboard* page.
36
+
Select "_new dashboard..._" from the *Choose Dashboard* dropdown, then "Add Group" and finally select "Add a Chart" (you of course are interested in Eventing charts).
33
37
34
38
There are six Eventing measures (three rates + three counts) these Dashboard statistics are NOT per bucket and are NOT per function.
35
39
@@ -40,23 +44,28 @@ There are six Eventing measures (three rates + three counts) these Dashboard sta
40
44
* Failed Function Invocations
41
45
* Eventing Timeouts
42
46
43
-
// image::stats_02_add_charts.png[,100%]
47
+
////
48
+
49
+
image::stats_02_add_charts.png[,100%]
44
50
45
51
An example of all the possible dashboard charts is shown below:
46
52
47
53
image::stats_02_system_charts.png[,100%]
48
54
49
55
Note, you may click and expand any of the above graphs for any deployed Eventing Function or any Dashboard chart.
50
56
57
+
////
58
+
51
59
*Via the REST API*
52
60
53
61
NOTE: The Functions REST API endpoints on this page are fully supported, as long as the content of the Eventing Function body is not created or modified externally (as the internal format of the body is not yet standardized).
54
62
55
-
Eventing statistics can be fetched from each eventing node using REST API bound to localhost. The resulting
56
-
JSON based responses are local to the node, and suitable for further aggregation across nodes of the cluster.
63
+
Eventing statistics can be fetched from each eventing node using REST API bound to localhost.
64
+
The resulting JSON based responses are local to the node, and suitable for further aggregation across nodes of the cluster.
57
65
58
66
You must have appropriate RBAC privileges to view an Eventing Function's Application log in the UI or via the REST API.
59
-
The role of either "Full Admin" or "Eventing Full Admin" can access any Eventing Function endpoint. For more information refer to xref:eventing-rbac.adoc[Eventing Role-Based Access Control].
67
+
The role of either "Full Admin" or "Eventing Full Admin" can access any Eventing Function endpoint.
68
+
For more information refer to xref:eventing-rbac.adoc[Eventing Role-Based Access Control].
60
69
61
70
The following REST endpoint could be used to get the full set of Eventing statistics:
This will return the full statistics set inclusive of events processing, events remaining, execution, failure, latency, worker PIDs and sequence processed.
67
76
68
-
Note, omitting the parameter `type=full` will exclude `dcp_event_backlog_per_vb`, `doc_timer_debug_stats`, `latency_stats`, `plasma_stats` and `seqs_processed` from the response.
77
+
NOTE: Omitting the parameter `type=full` will exclude `dcp_event_backlog_per_vb`, `doc_timer_debug_stats`, `latency_stats`, `plasma_stats` and `seqs_processed` from the response.
69
78
70
79
The above statistics can also be individually obtained through the following REST endpoints:
0 commit comments