[pulsar] branch master updated: [feature][doc] Add schema metrics doc (#14901)

[li...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

liuyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 0ed1afbc84f [feature][doc] Add schema metrics doc (#14901)
0ed1afbc84f is described below

commit 0ed1afbc84ff25ae3f18ddc7cdeda8f5634db85d
Author: Tao Jiuming <95...@users.noreply.github.com>
AuthorDate: Fri Apr 15 10:26:09 2022 +0800

    [feature][doc] Add schema metrics doc (#14901)
---
 site2/docs/reference-metrics.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/site2/docs/reference-metrics.md b/site2/docs/reference-metrics.md
index b11f4e7a54e..2589d5ca54c 100644
--- a/site2/docs/reference-metrics.md
+++ b/site2/docs/reference-metrics.md
@@ -111,6 +111,7 @@ The following metrics are available for broker:
   - [Authentication metrics](#authentication-metrics)
   - [Connection metrics](#connection-metrics)
   - [Jetty metrics](#jetty-metrics)
+  - [Schema metrics](#schema-metrics)
 - [Pulsar Functions](#pulsar-functions)
 - [Proxy](#proxy)
 - [Pulsar SQL Worker](#pulsar-sql-worker)
@@ -495,6 +496,25 @@ All the jetty metrics are labelled with the following labels:
 | jetty_stats_seconds | Gauge | Time in seconds stats have been collected for. |
 | jetty_responses_bytes_total | Counter | Total number of bytes across all responses. |
 
+### Schema metrics
+
+> For a functions-worker running separately from brokers, its schema metrics are only exposed when `includeStandardPrometheusMetrics` is set to `true`.
+
+All the schema 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.
+
+| Name | Type | Description |
+|---|---|---|
+| pulsar_schema_del_ops_failed_count | Counter | Number of failed operations to delete schemas. |
+| pulsar_schema_get_ops_failed_count | Counter | Number of failed operations to get schemas. |
+| pulsar_schema_put_ops_failed_count | Counter | Number of failed operations to send schemas. |
+| pulsar_schema_compatible_count | Counter | Number of compatible schemas. |
+| pulsar_schema_incompatible_count | Counter | Number of incompatible schemas. |
+| pulsar_schema_del_ops_latency | Summary | Latency of successful operations to delete schemas. |
+| pulsar_schema_get_ops_latency | Summary | Latency of successful operations to get schemas. |
+| pulsar_schema_put_ops_latency | Summary | Latency of successful operations to send schemas. |
+
 ## Pulsar Functions
 
 All the Pulsar Functions metrics are labelled with the following labels: