Skip to content

Commit 42c0549

Browse files
Fixed some errors, included line breaks, and corrected some typos
1 parent ca62012 commit 42c0549

1 file changed

Lines changed: 22 additions & 13 deletions

File tree

modules/eventing/pages/eventing-statistics.adoc

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,33 @@
77

88
*Via the Web Console's Eventing page*
99

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:
1112

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.
1314
* *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.
1516
1617
// image::stats_00_counts.png[,100%]
1718

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.
1921

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.
2123
* *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.
2325
2426
// image::stats_01_counts_and_charts.png[,100%]
2527

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.
2729

2830
*Via the Web Console's custom Dashboards*
2931

3032
Eventing Statistics, for each deployed Function, can be fetched from an Eventing node using the Web Console.
3133

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).
3337

3438
There are six Eventing measures (three rates + three counts) these Dashboard statistics are NOT per bucket and are NOT per function.
3539

@@ -40,23 +44,28 @@ There are six Eventing measures (three rates + three counts) these Dashboard sta
4044
* Failed Function Invocations
4145
* Eventing Timeouts
4246
43-
// image::stats_02_add_charts.png[,100%]
47+
////
48+
49+
image::stats_02_add_charts.png[,100%]
4450

4551
An example of all the possible dashboard charts is shown below:
4652

4753
image::stats_02_system_charts.png[,100%]
4854

4955
Note, you may click and expand any of the above graphs for any deployed Eventing Function or any Dashboard chart.
5056

57+
////
58+
5159
*Via the REST API*
5260

5361
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).
5462

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.
5765

5866
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].
6069

6170
The following REST endpoint could be used to get the full set of Eventing statistics:
6271
[source,shell]
@@ -65,7 +74,7 @@ curl http://user:pass@localhost:8096/api/v1/stats?type=full
6574
----
6675
This will return the full statistics set inclusive of events processing, events remaining, execution, failure, latency, worker PIDs and sequence processed.
6776

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.
6978

7079
The above statistics can also be individually obtained through the following REST endpoints:
7180
[source,shell]

0 commit comments

Comments
 (0)