[GitHub] [pulsar] Huanli-Meng commented on a change in pull request #10133: [Doc] Add monitoring guidelines for function and connector

[GitBox <gi...@apache.org>]

Huanli-Meng commented on a change in pull request #10133:
URL: https://github.com/apache/pulsar/pull/10133#discussion_r607403218



##########
File path: site2/docs/reference-metrics.md
##########
@@ -416,6 +416,50 @@ All the Pulsar Functions metrics are labelled with the following labels:
 | pulsar_function_last_invocation | Gauge | The timestamp of the last invocation of the function. |
 | pulsar_function_received_total | Counter | Total number of messages received from source. |
 | pulsar_function_received_total_1min | Counter | Total number of messages received from source in the last 1 minute. |
+pulsar_function_user_metric_ | Summary|User defined metric.
+
+## Connectors
+
+All the Pulsar connector metrics are labelled with the following labels:
+
+- *cluster*: `cluster=${pulsar_cluster}`. `${pulsar_cluster}` is the cluster name that you have configured in the `broker.conf` file.
+- *namespace*: `namespace=${pulsar_namespace}`. `${pulsar_namespace}` is the namespace name.
+
+Connector metrics contain **source** metrics and **sink** metrics.
+
+- **Source** metrics
+
+  | Name | Type | Description |
+  |---|---|---|
+  pulsar_source_written_total|Counter|Total number of records written to a Pulsar topic.

Review comment:
       I think it's better to use "the total number of...", same comments for the following similar descriptions.

##########
File path: site2/docs/reference-metrics.md
##########
@@ -416,6 +416,50 @@ All the Pulsar Functions metrics are labelled with the following labels:
 | pulsar_function_last_invocation | Gauge | The timestamp of the last invocation of the function. |
 | pulsar_function_received_total | Counter | Total number of messages received from source. |
 | pulsar_function_received_total_1min | Counter | Total number of messages received from source in the last 1 minute. |
+pulsar_function_user_metric_ | Summary|User defined metric.
+
+## Connectors
+
+All the Pulsar connector metrics are labelled with the following labels:
+
+- *cluster*: `cluster=${pulsar_cluster}`. `${pulsar_cluster}` is the cluster name that you have configured in the `broker.conf` file.
+- *namespace*: `namespace=${pulsar_namespace}`. `${pulsar_namespace}` is the namespace name.
+
+Connector metrics contain **source** metrics and **sink** metrics.
+
+- **Source** metrics
+
+  | Name | Type | Description |
+  |---|---|---|
+  pulsar_source_written_total|Counter|Total number of records written to a Pulsar topic.
+  pulsar_source_written_total_1min|Counter|Total number of records written to a Pulsar topic in the last 1 minute.
+  pulsar_source_received_total|Counter|Total number of records received from source.
+  pulsar_source_received_total_1min|Counter|Total number of records received from source in the last 1 minute.
+  pulsar_source_last_invocation|Gauge|The timestamp of the last invocation of the source.
+  pulsar_source_source_exception|Gauge|Exception from a source.
+  pulsar_source_source_exceptions_total|Counter|Total number of source exceptions.
+  pulsar_source_source_exceptions_total_1min |Counter|Total number of source exceptions in the last 1 minute.
+  pulsar_source_system_exception|Gauge|Exception from system code.
+  pulsar_source_system_exceptions_total|Counter|Total number of system exceptions.
+  pulsar_source_system_exceptions_total_1min|Counter|Total number of system exceptions in the last 1 minute.
+  pulsar_source_user_metric_ | Summary|User defined metric.

Review comment:
       ```suggestion
     pulsar_source_user_metric_ | Summary|User-defined metrics.
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org