Skip to content

Commit 2a11d61

Browse files
Incorporated Simon's suggestions and deleted unwanted sentences and images
1 parent 42c0549 commit 2a11d61

5 files changed

Lines changed: 5 additions & 53 deletions

File tree

-143 KB
Binary file not shown.
-212 KB
Binary file not shown.
-242 KB
Binary file not shown.
-260 KB
Binary file not shown.
Lines changed: 5 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,22 @@
11
= Statistics
2-
:description: Eventing Statistics, for each deployed Function, can be fetched from an Eventing node using the Web Console or using the REST API.
2+
:description: You can fetch Eventing Statistics for each deployed Function from an Eventing node using the Web Console or using the Capella UI.
33
:page-edition: Enterprise Edition
44

55
[abstract]
66
{description}
77

8-
*Via the Web Console's Eventing page*
8+
== Via the Capella UI Eventing Tab
99

1010
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.
1111
These three key metrics or Deployment Statistics are updated every 10 seconds by default and displayed as numeric values:
1212

1313
* *success* - displays the number of processed Functions and also Eventing timer callbacks.
1414
* *failure* - displays the number of failures while processing the Eventing Function code.
15-
* *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.
16+
* *backlog* - displays the number of Functions in the backlog.
1617

17-
// image::stats_00_counts.png[,100%]
1818

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.
21-
22-
* *success* - displays the rate of processed Functions and also Eventing timer callbacks.
23-
* *failure* - displays the rate of failures while processing the Function Eventing Function code.
24-
* *timeout* - displays the rate of Functions which have encountered a timeout condition.
25-
26-
// image::stats_01_counts_and_charts.png[,100%]
27-
28-
In addition, per Function Statistics can be accessed via the Web Console or using the REST API.
19+
In addition to the numeric statistics, you can also click the Log button (icon:fine-Lines[]) to display the log for any deployed function.
2920

3021
*Via the Web Console's custom Dashboards*
3122

@@ -44,42 +35,3 @@ There are six Eventing measures (three rates + three counts) these Dashboard sta
4435
* Failed Function Invocations
4536
* Eventing Timeouts
4637

47-
////
48-
49-
image::stats_02_add_charts.png[,100%]
50-
51-
An example of all the possible dashboard charts is shown below:
52-
53-
image::stats_02_system_charts.png[,100%]
54-
55-
Note, you may click and expand any of the above graphs for any deployed Eventing Function or any Dashboard chart.
56-
57-
////
58-
59-
*Via the REST API*
60-
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).
62-
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.
65-
66-
You must have appropriate RBAC privileges to view an Eventing Function's Application log in the UI or via the REST API.
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].
69-
70-
The following REST endpoint could be used to get the full set of Eventing statistics:
71-
[source,shell]
72-
----
73-
curl http://user:pass@localhost:8096/api/v1/stats?type=full
74-
----
75-
This will return the full statistics set inclusive of events processing, events remaining, execution, failure, latency, worker PIDs and sequence processed.
76-
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.
78-
79-
The above statistics can also be individually obtained through the following REST endpoints:
80-
[source,shell]
81-
----
82-
curl http://user:pass@localhost:8096/getExecutionStats?name=function_name
83-
curl http://user:pass@localhost:8096/getLatencyStats?name=function_name
84-
curl http://user:pass@localhost:8096/getFailureStats?name=function_name
85-
----

0 commit comments

Comments
 (0)