github.com/kaituanwang/hyperledger@v2.0.1+incompatible/docs/source/metrics_reference.rst (about)

     1  Metrics Reference
     2  =================
     3  
     4  Orderer Metrics
     5  ---------------
     6  
     7  Prometheus
     8  ~~~~~~~~~~
     9  
    10  The following orderer metrics are exported for consumption by Prometheus.
    11  
    12  +----------------------------------------------+-----------+------------------------------------------------------------+--------------------------------------------------------------------------------+
    13  | Name                                         | Type      | Description                                                | Labels                                                                         |
    14  +==============================================+===========+============================================================+===============+================================================================+
    15  | blockcutter_block_fill_duration              | histogram | The time from first transaction enqueing to the block      | channel       |                                                                |
    16  |                                              |           | being cut in seconds.                                      |               |                                                                |
    17  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    18  | broadcast_enqueue_duration                   | histogram | The time to enqueue a transaction in seconds.              | channel       |                                                                |
    19  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    20  |                                              |           |                                                            | type          |                                                                |
    21  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    22  |                                              |           |                                                            | status        |                                                                |
    23  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    24  | broadcast_processed_count                    | counter   | The number of transactions processed.                      | channel       |                                                                |
    25  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    26  |                                              |           |                                                            | type          |                                                                |
    27  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    28  |                                              |           |                                                            | status        |                                                                |
    29  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    30  | broadcast_validate_duration                  | histogram | The time to validate a transaction in seconds.             | channel       |                                                                |
    31  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    32  |                                              |           |                                                            | type          |                                                                |
    33  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    34  |                                              |           |                                                            | status        |                                                                |
    35  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    36  | cluster_comm_egress_queue_capacity           | gauge     | Capacity of the egress queue.                              | host          |                                                                |
    37  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    38  |                                              |           |                                                            | msg_type      |                                                                |
    39  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    40  |                                              |           |                                                            | channel       |                                                                |
    41  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    42  | cluster_comm_egress_queue_length             | gauge     | Length of the egress queue.                                | host          |                                                                |
    43  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    44  |                                              |           |                                                            | msg_type      |                                                                |
    45  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    46  |                                              |           |                                                            | channel       |                                                                |
    47  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    48  | cluster_comm_egress_queue_workers            | gauge     | Count of egress queue workers.                             | channel       |                                                                |
    49  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    50  | cluster_comm_egress_stream_count             | gauge     | Count of streams to other nodes.                           | channel       |                                                                |
    51  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    52  | cluster_comm_egress_tls_connection_count     | gauge     | Count of TLS connections to other nodes.                   |               |                                                                |
    53  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    54  | cluster_comm_ingress_stream_count            | gauge     | Count of streams from other nodes.                         |               |                                                                |
    55  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    56  | cluster_comm_msg_dropped_count               | counter   | Count of messages dropped.                                 | host          |                                                                |
    57  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    58  |                                              |           |                                                            | channel       |                                                                |
    59  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    60  | cluster_comm_msg_send_time                   | histogram | The time it takes to send a message in seconds.            | host          |                                                                |
    61  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
    62  |                                              |           |                                                            | channel       |                                                                |
    63  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    64  | consensus_etcdraft_active_nodes              | gauge     | Number of active nodes in this channel.                    | channel       |                                                                |
    65  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    66  | consensus_etcdraft_cluster_size              | gauge     | Number of nodes in this channel.                           | channel       |                                                                |
    67  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    68  | consensus_etcdraft_committed_block_number    | gauge     | The block number of the latest block committed.            | channel       |                                                                |
    69  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    70  | consensus_etcdraft_config_proposals_received | counter   | The total number of proposals received for config type     | channel       |                                                                |
    71  |                                              |           | transactions.                                              |               |                                                                |
    72  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    73  | consensus_etcdraft_data_persist_duration     | histogram | The time taken for etcd/raft data to be persisted in       | channel       |                                                                |
    74  |                                              |           | storage (in seconds).                                      |               |                                                                |
    75  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    76  | consensus_etcdraft_is_leader                 | gauge     | The leadership status of the current node: 1 if it is the  | channel       |                                                                |
    77  |                                              |           | leader else 0.                                             |               |                                                                |
    78  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    79  | consensus_etcdraft_leader_changes            | counter   | The number of leader changes since process start.          | channel       |                                                                |
    80  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    81  | consensus_etcdraft_normal_proposals_received | counter   | The total number of proposals received for normal type     | channel       |                                                                |
    82  |                                              |           | transactions.                                              |               |                                                                |
    83  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    84  | consensus_etcdraft_proposal_failures         | counter   | The number of proposal failures.                           | channel       |                                                                |
    85  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    86  | consensus_etcdraft_snapshot_block_number     | gauge     | The block number of the latest snapshot.                   | channel       |                                                                |
    87  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    88  | consensus_kafka_batch_size                   | gauge     | The mean batch size in bytes sent to topics.               | topic         |                                                                |
    89  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    90  | consensus_kafka_compression_ratio            | gauge     | The mean compression ratio (as percentage) for topics.     | topic         |                                                                |
    91  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    92  | consensus_kafka_incoming_byte_rate           | gauge     | Bytes/second read off brokers.                             | broker_id     |                                                                |
    93  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    94  | consensus_kafka_last_offset_persisted        | gauge     | The offset specified in the block metadata of the most     | channel       |                                                                |
    95  |                                              |           | recently committed block.                                  |               |                                                                |
    96  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    97  | consensus_kafka_outgoing_byte_rate           | gauge     | Bytes/second written to brokers.                           | broker_id     |                                                                |
    98  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
    99  | consensus_kafka_record_send_rate             | gauge     | The number of records per second sent to topics.           | topic         |                                                                |
   100  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   101  | consensus_kafka_records_per_request          | gauge     | The mean number of records sent per request to topics.     | topic         |                                                                |
   102  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   103  | consensus_kafka_request_latency              | gauge     | The mean request latency in ms to brokers.                 | broker_id     |                                                                |
   104  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   105  | consensus_kafka_request_rate                 | gauge     | Requests/second sent to brokers.                           | broker_id     |                                                                |
   106  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   107  | consensus_kafka_request_size                 | gauge     | The mean request size in bytes to brokers.                 | broker_id     |                                                                |
   108  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   109  | consensus_kafka_response_rate                | gauge     | Requests/second sent to brokers.                           | broker_id     |                                                                |
   110  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   111  | consensus_kafka_response_size                | gauge     | The mean response size in bytes from brokers.              | broker_id     |                                                                |
   112  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   113  | couchdb_processing_time                      | histogram | Time taken in seconds for the function to complete request | database      |                                                                |
   114  |                                              |           | to CouchDB                                                 +---------------+----------------------------------------------------------------+
   115  |                                              |           |                                                            | function_name |                                                                |
   116  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   117  |                                              |           |                                                            | result        |                                                                |
   118  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   119  | deliver_blocks_sent                          | counter   | The number of blocks sent by the deliver service.          | channel       |                                                                |
   120  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   121  |                                              |           |                                                            | filtered      |                                                                |
   122  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   123  |                                              |           |                                                            | data_type     |                                                                |
   124  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   125  | deliver_requests_completed                   | counter   | The number of deliver requests that have been completed.   | channel       |                                                                |
   126  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   127  |                                              |           |                                                            | filtered      |                                                                |
   128  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   129  |                                              |           |                                                            | data_type     |                                                                |
   130  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   131  |                                              |           |                                                            | success       |                                                                |
   132  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   133  | deliver_requests_received                    | counter   | The number of deliver requests that have been received.    | channel       |                                                                |
   134  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   135  |                                              |           |                                                            | filtered      |                                                                |
   136  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   137  |                                              |           |                                                            | data_type     |                                                                |
   138  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   139  | deliver_streams_closed                       | counter   | The number of GRPC streams that have been closed for the   |               |                                                                |
   140  |                                              |           | deliver service.                                           |               |                                                                |
   141  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   142  | deliver_streams_opened                       | counter   | The number of GRPC streams that have been opened for the   |               |                                                                |
   143  |                                              |           | deliver service.                                           |               |                                                                |
   144  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   145  | fabric_version                               | gauge     | The active version of Fabric.                              | version       |                                                                |
   146  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   147  | grpc_comm_conn_closed                        | counter   | gRPC connections closed. Open minus closed is the active   |               |                                                                |
   148  |                                              |           | number of connections.                                     |               |                                                                |
   149  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   150  | grpc_comm_conn_opened                        | counter   | gRPC connections opened. Open minus closed is the active   |               |                                                                |
   151  |                                              |           | number of connections.                                     |               |                                                                |
   152  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   153  | grpc_server_stream_messages_received         | counter   | The number of stream messages received.                    | service       |                                                                |
   154  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   155  |                                              |           |                                                            | method        |                                                                |
   156  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   157  | grpc_server_stream_messages_sent             | counter   | The number of stream messages sent.                        | service       |                                                                |
   158  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   159  |                                              |           |                                                            | method        |                                                                |
   160  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   161  | grpc_server_stream_request_duration          | histogram | The time to complete a stream request.                     | service       |                                                                |
   162  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   163  |                                              |           |                                                            | method        |                                                                |
   164  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   165  |                                              |           |                                                            | code          |                                                                |
   166  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   167  | grpc_server_stream_requests_completed        | counter   | The number of stream requests completed.                   | service       |                                                                |
   168  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   169  |                                              |           |                                                            | method        |                                                                |
   170  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   171  |                                              |           |                                                            | code          |                                                                |
   172  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   173  | grpc_server_stream_requests_received         | counter   | The number of stream requests received.                    | service       |                                                                |
   174  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   175  |                                              |           |                                                            | method        |                                                                |
   176  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   177  | grpc_server_unary_request_duration           | histogram | The time to complete a unary request.                      | service       |                                                                |
   178  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   179  |                                              |           |                                                            | method        |                                                                |
   180  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   181  |                                              |           |                                                            | code          |                                                                |
   182  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   183  | grpc_server_unary_requests_completed         | counter   | The number of unary requests completed.                    | service       |                                                                |
   184  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   185  |                                              |           |                                                            | method        |                                                                |
   186  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   187  |                                              |           |                                                            | code          |                                                                |
   188  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   189  | grpc_server_unary_requests_received          | counter   | The number of unary requests received.                     | service       |                                                                |
   190  |                                              |           |                                                            +---------------+----------------------------------------------------------------+
   191  |                                              |           |                                                            | method        |                                                                |
   192  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   193  | ledger_blockchain_height                     | gauge     | Height of the chain in blocks.                             | channel       |                                                                |
   194  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   195  | ledger_blockstorage_commit_time              | histogram | Time taken in seconds for committing the block to storage. | channel       |                                                                |
   196  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   197  | logging_entries_checked                      | counter   | Number of log entries checked against the active logging   | level         |                                                                |
   198  |                                              |           | level                                                      |               |                                                                |
   199  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   200  | logging_entries_written                      | counter   | Number of log entries that are written                     | level         |                                                                |
   201  +----------------------------------------------+-----------+------------------------------------------------------------+---------------+----------------------------------------------------------------+
   202  
   203  StatsD
   204  ~~~~~~
   205  
   206  The following orderer metrics are emitted for consumption by StatsD. The
   207  ``%{variable_name}`` nomenclature represents segments that vary based on
   208  context.
   209  
   210  For example, ``%{channel}`` will be replaced with the name of the channel
   211  associated with the metric.
   212  
   213  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   214  | Bucket                                                                    | Type      | Description                                                |
   215  +===========================================================================+===========+============================================================+
   216  | blockcutter.block_fill_duration.%{channel}                                | histogram | The time from first transaction enqueing to the block      |
   217  |                                                                           |           | being cut in seconds.                                      |
   218  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   219  | broadcast.enqueue_duration.%{channel}.%{type}.%{status}                   | histogram | The time to enqueue a transaction in seconds.              |
   220  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   221  | broadcast.processed_count.%{channel}.%{type}.%{status}                    | counter   | The number of transactions processed.                      |
   222  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   223  | broadcast.validate_duration.%{channel}.%{type}.%{status}                  | histogram | The time to validate a transaction in seconds.             |
   224  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   225  | cluster.comm.egress_queue_capacity.%{host}.%{msg_type}.%{channel}         | gauge     | Capacity of the egress queue.                              |
   226  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   227  | cluster.comm.egress_queue_length.%{host}.%{msg_type}.%{channel}           | gauge     | Length of the egress queue.                                |
   228  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   229  | cluster.comm.egress_queue_workers.%{channel}                              | gauge     | Count of egress queue workers.                             |
   230  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   231  | cluster.comm.egress_stream_count.%{channel}                               | gauge     | Count of streams to other nodes.                           |
   232  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   233  | cluster.comm.egress_tls_connection_count                                  | gauge     | Count of TLS connections to other nodes.                   |
   234  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   235  | cluster.comm.ingress_stream_count                                         | gauge     | Count of streams from other nodes.                         |
   236  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   237  | cluster.comm.msg_dropped_count.%{host}.%{channel}                         | counter   | Count of messages dropped.                                 |
   238  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   239  | cluster.comm.msg_send_time.%{host}.%{channel}                             | histogram | The time it takes to send a message in seconds.            |
   240  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   241  | consensus.etcdraft.active_nodes.%{channel}                                | gauge     | Number of active nodes in this channel.                    |
   242  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   243  | consensus.etcdraft.cluster_size.%{channel}                                | gauge     | Number of nodes in this channel.                           |
   244  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   245  | consensus.etcdraft.committed_block_number.%{channel}                      | gauge     | The block number of the latest block committed.            |
   246  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   247  | consensus.etcdraft.config_proposals_received.%{channel}                   | counter   | The total number of proposals received for config type     |
   248  |                                                                           |           | transactions.                                              |
   249  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   250  | consensus.etcdraft.data_persist_duration.%{channel}                       | histogram | The time taken for etcd/raft data to be persisted in       |
   251  |                                                                           |           | storage (in seconds).                                      |
   252  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   253  | consensus.etcdraft.is_leader.%{channel}                                   | gauge     | The leadership status of the current node: 1 if it is the  |
   254  |                                                                           |           | leader else 0.                                             |
   255  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   256  | consensus.etcdraft.leader_changes.%{channel}                              | counter   | The number of leader changes since process start.          |
   257  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   258  | consensus.etcdraft.normal_proposals_received.%{channel}                   | counter   | The total number of proposals received for normal type     |
   259  |                                                                           |           | transactions.                                              |
   260  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   261  | consensus.etcdraft.proposal_failures.%{channel}                           | counter   | The number of proposal failures.                           |
   262  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   263  | consensus.etcdraft.snapshot_block_number.%{channel}                       | gauge     | The block number of the latest snapshot.                   |
   264  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   265  | consensus.kafka.batch_size.%{topic}                                       | gauge     | The mean batch size in bytes sent to topics.               |
   266  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   267  | consensus.kafka.compression_ratio.%{topic}                                | gauge     | The mean compression ratio (as percentage) for topics.     |
   268  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   269  | consensus.kafka.incoming_byte_rate.%{broker_id}                           | gauge     | Bytes/second read off brokers.                             |
   270  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   271  | consensus.kafka.last_offset_persisted.%{channel}                          | gauge     | The offset specified in the block metadata of the most     |
   272  |                                                                           |           | recently committed block.                                  |
   273  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   274  | consensus.kafka.outgoing_byte_rate.%{broker_id}                           | gauge     | Bytes/second written to brokers.                           |
   275  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   276  | consensus.kafka.record_send_rate.%{topic}                                 | gauge     | The number of records per second sent to topics.           |
   277  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   278  | consensus.kafka.records_per_request.%{topic}                              | gauge     | The mean number of records sent per request to topics.     |
   279  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   280  | consensus.kafka.request_latency.%{broker_id}                              | gauge     | The mean request latency in ms to brokers.                 |
   281  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   282  | consensus.kafka.request_rate.%{broker_id}                                 | gauge     | Requests/second sent to brokers.                           |
   283  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   284  | consensus.kafka.request_size.%{broker_id}                                 | gauge     | The mean request size in bytes to brokers.                 |
   285  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   286  | consensus.kafka.response_rate.%{broker_id}                                | gauge     | Requests/second sent to brokers.                           |
   287  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   288  | consensus.kafka.response_size.%{broker_id}                                | gauge     | The mean response size in bytes from brokers.              |
   289  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   290  | couchdb.processing_time.%{database}.%{function_name}.%{result}            | histogram | Time taken in seconds for the function to complete request |
   291  |                                                                           |           | to CouchDB                                                 |
   292  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   293  | deliver.blocks_sent.%{channel}.%{filtered}.%{data_type}                   | counter   | The number of blocks sent by the deliver service.          |
   294  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   295  | deliver.requests_completed.%{channel}.%{filtered}.%{data_type}.%{success} | counter   | The number of deliver requests that have been completed.   |
   296  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   297  | deliver.requests_received.%{channel}.%{filtered}.%{data_type}             | counter   | The number of deliver requests that have been received.    |
   298  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   299  | deliver.streams_closed                                                    | counter   | The number of GRPC streams that have been closed for the   |
   300  |                                                                           |           | deliver service.                                           |
   301  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   302  | deliver.streams_opened                                                    | counter   | The number of GRPC streams that have been opened for the   |
   303  |                                                                           |           | deliver service.                                           |
   304  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   305  | fabric_version.%{version}                                                 | gauge     | The active version of Fabric.                              |
   306  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   307  | grpc.comm.conn_closed                                                     | counter   | gRPC connections closed. Open minus closed is the active   |
   308  |                                                                           |           | number of connections.                                     |
   309  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   310  | grpc.comm.conn_opened                                                     | counter   | gRPC connections opened. Open minus closed is the active   |
   311  |                                                                           |           | number of connections.                                     |
   312  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   313  | grpc.server.stream_messages_received.%{service}.%{method}                 | counter   | The number of stream messages received.                    |
   314  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   315  | grpc.server.stream_messages_sent.%{service}.%{method}                     | counter   | The number of stream messages sent.                        |
   316  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   317  | grpc.server.stream_request_duration.%{service}.%{method}.%{code}          | histogram | The time to complete a stream request.                     |
   318  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   319  | grpc.server.stream_requests_completed.%{service}.%{method}.%{code}        | counter   | The number of stream requests completed.                   |
   320  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   321  | grpc.server.stream_requests_received.%{service}.%{method}                 | counter   | The number of stream requests received.                    |
   322  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   323  | grpc.server.unary_request_duration.%{service}.%{method}.%{code}           | histogram | The time to complete a unary request.                      |
   324  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   325  | grpc.server.unary_requests_completed.%{service}.%{method}.%{code}         | counter   | The number of unary requests completed.                    |
   326  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   327  | grpc.server.unary_requests_received.%{service}.%{method}                  | counter   | The number of unary requests received.                     |
   328  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   329  | ledger.blockchain_height.%{channel}                                       | gauge     | Height of the chain in blocks.                             |
   330  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   331  | ledger.blockstorage_commit_time.%{channel}                                | histogram | Time taken in seconds for committing the block to storage. |
   332  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   333  | logging.entries_checked.%{level}                                          | counter   | Number of log entries checked against the active logging   |
   334  |                                                                           |           | level                                                      |
   335  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   336  | logging.entries_written.%{level}                                          | counter   | Number of log entries that are written                     |
   337  +---------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   338  
   339  Peer Metrics
   340  ------------
   341  
   342  Prometheus
   343  ~~~~~~~~~~
   344  
   345  The following peer metrics are exported for consumption by Prometheus.
   346  
   347  +-----------------------------------------------------+-----------+------------------------------------------------------------+--------------------------------------------------------------------------------+
   348  | Name                                                | Type      | Description                                                | Labels                                                                         |
   349  +=====================================================+===========+============================================================+==================+=============================================================+
   350  | chaincode_execute_timeouts                          | counter   | The number of chaincode executions (Init or Invoke) that   | chaincode        |                                                             |
   351  |                                                     |           | have timed out.                                            |                  |                                                             |
   352  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   353  | chaincode_launch_duration                           | histogram | The time to launch a chaincode.                            | chaincode        |                                                             |
   354  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   355  |                                                     |           |                                                            | success          |                                                             |
   356  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   357  | chaincode_launch_failures                           | counter   | The number of chaincode launches that have failed.         | chaincode        |                                                             |
   358  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   359  | chaincode_launch_timeouts                           | counter   | The number of chaincode launches that have timed out.      | chaincode        |                                                             |
   360  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   361  | chaincode_shim_request_duration                     | histogram | The time to complete chaincode shim requests.              | type             |                                                             |
   362  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   363  |                                                     |           |                                                            | channel          |                                                             |
   364  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   365  |                                                     |           |                                                            | chaincode        |                                                             |
   366  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   367  |                                                     |           |                                                            | success          |                                                             |
   368  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   369  | chaincode_shim_requests_completed                   | counter   | The number of chaincode shim requests completed.           | type             |                                                             |
   370  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   371  |                                                     |           |                                                            | channel          |                                                             |
   372  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   373  |                                                     |           |                                                            | chaincode        |                                                             |
   374  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   375  |                                                     |           |                                                            | success          |                                                             |
   376  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   377  | chaincode_shim_requests_received                    | counter   | The number of chaincode shim requests received.            | type             |                                                             |
   378  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   379  |                                                     |           |                                                            | channel          |                                                             |
   380  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   381  |                                                     |           |                                                            | chaincode        |                                                             |
   382  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   383  | couchdb_processing_time                             | histogram | Time taken in seconds for the function to complete request | database         |                                                             |
   384  |                                                     |           | to CouchDB                                                 +------------------+-------------------------------------------------------------+
   385  |                                                     |           |                                                            | function_name    |                                                             |
   386  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   387  |                                                     |           |                                                            | result           |                                                             |
   388  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   389  | deliver_blocks_sent                                 | counter   | The number of blocks sent by the deliver service.          | channel          |                                                             |
   390  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   391  |                                                     |           |                                                            | filtered         |                                                             |
   392  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   393  |                                                     |           |                                                            | data_type        |                                                             |
   394  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   395  | deliver_requests_completed                          | counter   | The number of deliver requests that have been completed.   | channel          |                                                             |
   396  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   397  |                                                     |           |                                                            | filtered         |                                                             |
   398  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   399  |                                                     |           |                                                            | data_type        |                                                             |
   400  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   401  |                                                     |           |                                                            | success          |                                                             |
   402  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   403  | deliver_requests_received                           | counter   | The number of deliver requests that have been received.    | channel          |                                                             |
   404  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   405  |                                                     |           |                                                            | filtered         |                                                             |
   406  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   407  |                                                     |           |                                                            | data_type        |                                                             |
   408  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   409  | deliver_streams_closed                              | counter   | The number of GRPC streams that have been closed for the   |                  |                                                             |
   410  |                                                     |           | deliver service.                                           |                  |                                                             |
   411  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   412  | deliver_streams_opened                              | counter   | The number of GRPC streams that have been opened for the   |                  |                                                             |
   413  |                                                     |           | deliver service.                                           |                  |                                                             |
   414  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   415  | dockercontroller_chaincode_container_build_duration | histogram | The time to build a chaincode image in seconds.            | chaincode        |                                                             |
   416  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   417  |                                                     |           |                                                            | success          |                                                             |
   418  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   419  | endorser_chaincode_instantiation_failures           | counter   | The number of chaincode instantiations or upgrade that     | channel          |                                                             |
   420  |                                                     |           | have failed.                                               +------------------+-------------------------------------------------------------+
   421  |                                                     |           |                                                            | chaincode        |                                                             |
   422  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   423  | endorser_duplicate_transaction_failures             | counter   | The number of failed proposals due to duplicate            | channel          |                                                             |
   424  |                                                     |           | transaction ID.                                            +------------------+-------------------------------------------------------------+
   425  |                                                     |           |                                                            | chaincode        |                                                             |
   426  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   427  | endorser_endorsement_failures                       | counter   | The number of failed endorsements.                         | channel          |                                                             |
   428  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   429  |                                                     |           |                                                            | chaincode        |                                                             |
   430  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   431  |                                                     |           |                                                            | chaincodeerror   |                                                             |
   432  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   433  | endorser_proposal_acl_failures                      | counter   | The number of proposals that failed ACL checks.            | channel          |                                                             |
   434  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   435  |                                                     |           |                                                            | chaincode        |                                                             |
   436  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   437  | endorser_proposal_duration                          | histogram | The time to complete a proposal.                           | channel          |                                                             |
   438  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   439  |                                                     |           |                                                            | chaincode        |                                                             |
   440  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   441  |                                                     |           |                                                            | success          |                                                             |
   442  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   443  | endorser_proposal_validation_failures               | counter   | The number of proposals that have failed initial           |                  |                                                             |
   444  |                                                     |           | validation.                                                |                  |                                                             |
   445  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   446  | endorser_proposals_received                         | counter   | The number of proposals received.                          |                  |                                                             |
   447  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   448  | endorser_successful_proposals                       | counter   | The number of successful proposals.                        |                  |                                                             |
   449  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   450  | fabric_version                                      | gauge     | The active version of Fabric.                              | version          |                                                             |
   451  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   452  | gossip_comm_messages_received                       | counter   | Number of messages received                                |                  |                                                             |
   453  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   454  | gossip_comm_messages_sent                           | counter   | Number of messages sent                                    |                  |                                                             |
   455  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   456  | gossip_comm_overflow_count                          | counter   | Number of outgoing queue buffer overflows                  |                  |                                                             |
   457  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   458  | gossip_leader_election_leader                       | gauge     | Peer is leader (1) or follower (0)                         | channel          |                                                             |
   459  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   460  | gossip_membership_total_peers_known                 | gauge     | Total known peers                                          | channel          |                                                             |
   461  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   462  | gossip_payload_buffer_size                          | gauge     | Size of the payload buffer                                 | channel          |                                                             |
   463  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   464  | gossip_privdata_commit_block_duration               | histogram | Time it takes to commit private data and the corresponding | channel          |                                                             |
   465  |                                                     |           | block (in seconds)                                         |                  |                                                             |
   466  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   467  | gossip_privdata_fetch_duration                      | histogram | Time it takes to fetch missing private data from peers (in | channel          |                                                             |
   468  |                                                     |           | seconds)                                                   |                  |                                                             |
   469  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   470  | gossip_privdata_list_missing_duration               | histogram | Time it takes to list the missing private data (in         | channel          |                                                             |
   471  |                                                     |           | seconds)                                                   |                  |                                                             |
   472  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   473  | gossip_privdata_pull_duration                       | histogram | Time it takes to pull a missing private data element (in   | channel          |                                                             |
   474  |                                                     |           | seconds)                                                   |                  |                                                             |
   475  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   476  | gossip_privdata_purge_duration                      | histogram | Time it takes to purge private data (in seconds)           | channel          |                                                             |
   477  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   478  | gossip_privdata_reconciliation_duration             | histogram | Time it takes for reconciliation to complete (in seconds)  | channel          |                                                             |
   479  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   480  | gossip_privdata_retrieve_duration                   | histogram | Time it takes to retrieve missing private data elements    | channel          |                                                             |
   481  |                                                     |           | from the ledger (in seconds)                               |                  |                                                             |
   482  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   483  | gossip_privdata_send_duration                       | histogram | Time it takes to send a missing private data element (in   | channel          |                                                             |
   484  |                                                     |           | seconds)                                                   |                  |                                                             |
   485  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   486  | gossip_privdata_validation_duration                 | histogram | Time it takes to validate a block (in seconds)             | channel          |                                                             |
   487  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   488  | gossip_state_commit_duration                        | histogram | Time it takes to commit a block in seconds                 | channel          |                                                             |
   489  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   490  | gossip_state_height                                 | gauge     | Current ledger height                                      | channel          |                                                             |
   491  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   492  | grpc_comm_conn_closed                               | counter   | gRPC connections closed. Open minus closed is the active   |                  |                                                             |
   493  |                                                     |           | number of connections.                                     |                  |                                                             |
   494  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   495  | grpc_comm_conn_opened                               | counter   | gRPC connections opened. Open minus closed is the active   |                  |                                                             |
   496  |                                                     |           | number of connections.                                     |                  |                                                             |
   497  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   498  | grpc_server_stream_messages_received                | counter   | The number of stream messages received.                    | service          |                                                             |
   499  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   500  |                                                     |           |                                                            | method           |                                                             |
   501  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   502  | grpc_server_stream_messages_sent                    | counter   | The number of stream messages sent.                        | service          |                                                             |
   503  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   504  |                                                     |           |                                                            | method           |                                                             |
   505  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   506  | grpc_server_stream_request_duration                 | histogram | The time to complete a stream request.                     | service          |                                                             |
   507  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   508  |                                                     |           |                                                            | method           |                                                             |
   509  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   510  |                                                     |           |                                                            | code             |                                                             |
   511  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   512  | grpc_server_stream_requests_completed               | counter   | The number of stream requests completed.                   | service          |                                                             |
   513  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   514  |                                                     |           |                                                            | method           |                                                             |
   515  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   516  |                                                     |           |                                                            | code             |                                                             |
   517  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   518  | grpc_server_stream_requests_received                | counter   | The number of stream requests received.                    | service          |                                                             |
   519  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   520  |                                                     |           |                                                            | method           |                                                             |
   521  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   522  | grpc_server_unary_request_duration                  | histogram | The time to complete a unary request.                      | service          |                                                             |
   523  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   524  |                                                     |           |                                                            | method           |                                                             |
   525  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   526  |                                                     |           |                                                            | code             |                                                             |
   527  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   528  | grpc_server_unary_requests_completed                | counter   | The number of unary requests completed.                    | service          |                                                             |
   529  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   530  |                                                     |           |                                                            | method           |                                                             |
   531  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   532  |                                                     |           |                                                            | code             |                                                             |
   533  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   534  | grpc_server_unary_requests_received                 | counter   | The number of unary requests received.                     | service          |                                                             |
   535  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   536  |                                                     |           |                                                            | method           |                                                             |
   537  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   538  | ledger_block_processing_time                        | histogram | Time taken in seconds for ledger block processing.         | channel          |                                                             |
   539  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   540  | ledger_blockchain_height                            | gauge     | Height of the chain in blocks.                             | channel          |                                                             |
   541  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   542  | ledger_blockstorage_and_pvtdata_commit_time         | histogram | Time taken in seconds for committing the block and private | channel          |                                                             |
   543  |                                                     |           | data to storage.                                           |                  |                                                             |
   544  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   545  | ledger_blockstorage_commit_time                     | histogram | Time taken in seconds for committing the block to storage. | channel          |                                                             |
   546  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   547  | ledger_statedb_commit_time                          | histogram | Time taken in seconds for committing block changes to      | channel          |                                                             |
   548  |                                                     |           | state db.                                                  |                  |                                                             |
   549  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   550  | ledger_transaction_count                            | counter   | Number of transactions processed.                          | channel          |                                                             |
   551  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   552  |                                                     |           |                                                            | transaction_type |                                                             |
   553  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   554  |                                                     |           |                                                            | chaincode        |                                                             |
   555  |                                                     |           |                                                            +------------------+-------------------------------------------------------------+
   556  |                                                     |           |                                                            | validation_code  |                                                             |
   557  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   558  | logging_entries_checked                             | counter   | Number of log entries checked against the active logging   | level            |                                                             |
   559  |                                                     |           | level                                                      |                  |                                                             |
   560  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   561  | logging_entries_written                             | counter   | Number of log entries that are written                     | level            |                                                             |
   562  +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+
   563  
   564  StatsD
   565  ~~~~~~
   566  
   567  The following peer metrics are emitted for consumption by StatsD. The
   568  ``%{variable_name}`` nomenclature represents segments that vary based on
   569  context.
   570  
   571  For example, ``%{channel}`` will be replaced with the name of the channel
   572  associated with the metric.
   573  
   574  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   575  | Bucket                                                                                  | Type      | Description                                                |
   576  +=========================================================================================+===========+============================================================+
   577  | chaincode.execute_timeouts.%{chaincode}                                                 | counter   | The number of chaincode executions (Init or Invoke) that   |
   578  |                                                                                         |           | have timed out.                                            |
   579  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   580  | chaincode.launch_duration.%{chaincode}.%{success}                                       | histogram | The time to launch a chaincode.                            |
   581  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   582  | chaincode.launch_failures.%{chaincode}                                                  | counter   | The number of chaincode launches that have failed.         |
   583  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   584  | chaincode.launch_timeouts.%{chaincode}                                                  | counter   | The number of chaincode launches that have timed out.      |
   585  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   586  | chaincode.shim_request_duration.%{type}.%{channel}.%{chaincode}.%{success}              | histogram | The time to complete chaincode shim requests.              |
   587  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   588  | chaincode.shim_requests_completed.%{type}.%{channel}.%{chaincode}.%{success}            | counter   | The number of chaincode shim requests completed.           |
   589  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   590  | chaincode.shim_requests_received.%{type}.%{channel}.%{chaincode}                        | counter   | The number of chaincode shim requests received.            |
   591  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   592  | couchdb.processing_time.%{database}.%{function_name}.%{result}                          | histogram | Time taken in seconds for the function to complete request |
   593  |                                                                                         |           | to CouchDB                                                 |
   594  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   595  | deliver.blocks_sent.%{channel}.%{filtered}.%{data_type}                                 | counter   | The number of blocks sent by the deliver service.          |
   596  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   597  | deliver.requests_completed.%{channel}.%{filtered}.%{data_type}.%{success}               | counter   | The number of deliver requests that have been completed.   |
   598  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   599  | deliver.requests_received.%{channel}.%{filtered}.%{data_type}                           | counter   | The number of deliver requests that have been received.    |
   600  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   601  | deliver.streams_closed                                                                  | counter   | The number of GRPC streams that have been closed for the   |
   602  |                                                                                         |           | deliver service.                                           |
   603  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   604  | deliver.streams_opened                                                                  | counter   | The number of GRPC streams that have been opened for the   |
   605  |                                                                                         |           | deliver service.                                           |
   606  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   607  | dockercontroller.chaincode_container_build_duration.%{chaincode}.%{success}             | histogram | The time to build a chaincode image in seconds.            |
   608  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   609  | endorser.chaincode_instantiation_failures.%{channel}.%{chaincode}                       | counter   | The number of chaincode instantiations or upgrade that     |
   610  |                                                                                         |           | have failed.                                               |
   611  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   612  | endorser.duplicate_transaction_failures.%{channel}.%{chaincode}                         | counter   | The number of failed proposals due to duplicate            |
   613  |                                                                                         |           | transaction ID.                                            |
   614  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   615  | endorser.endorsement_failures.%{channel}.%{chaincode}.%{chaincodeerror}                 | counter   | The number of failed endorsements.                         |
   616  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   617  | endorser.proposal_acl_failures.%{channel}.%{chaincode}                                  | counter   | The number of proposals that failed ACL checks.            |
   618  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   619  | endorser.proposal_duration.%{channel}.%{chaincode}.%{success}                           | histogram | The time to complete a proposal.                           |
   620  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   621  | endorser.proposal_validation_failures                                                   | counter   | The number of proposals that have failed initial           |
   622  |                                                                                         |           | validation.                                                |
   623  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   624  | endorser.proposals_received                                                             | counter   | The number of proposals received.                          |
   625  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   626  | endorser.successful_proposals                                                           | counter   | The number of successful proposals.                        |
   627  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   628  | fabric_version.%{version}                                                               | gauge     | The active version of Fabric.                              |
   629  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   630  | gossip.comm.messages_received                                                           | counter   | Number of messages received                                |
   631  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   632  | gossip.comm.messages_sent                                                               | counter   | Number of messages sent                                    |
   633  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   634  | gossip.comm.overflow_count                                                              | counter   | Number of outgoing queue buffer overflows                  |
   635  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   636  | gossip.leader_election.leader.%{channel}                                                | gauge     | Peer is leader (1) or follower (0)                         |
   637  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   638  | gossip.membership.total_peers_known.%{channel}                                          | gauge     | Total known peers                                          |
   639  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   640  | gossip.payload_buffer.size.%{channel}                                                   | gauge     | Size of the payload buffer                                 |
   641  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   642  | gossip.privdata.commit_block_duration.%{channel}                                        | histogram | Time it takes to commit private data and the corresponding |
   643  |                                                                                         |           | block (in seconds)                                         |
   644  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   645  | gossip.privdata.fetch_duration.%{channel}                                               | histogram | Time it takes to fetch missing private data from peers (in |
   646  |                                                                                         |           | seconds)                                                   |
   647  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   648  | gossip.privdata.list_missing_duration.%{channel}                                        | histogram | Time it takes to list the missing private data (in         |
   649  |                                                                                         |           | seconds)                                                   |
   650  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   651  | gossip.privdata.pull_duration.%{channel}                                                | histogram | Time it takes to pull a missing private data element (in   |
   652  |                                                                                         |           | seconds)                                                   |
   653  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   654  | gossip.privdata.purge_duration.%{channel}                                               | histogram | Time it takes to purge private data (in seconds)           |
   655  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   656  | gossip.privdata.reconciliation_duration.%{channel}                                      | histogram | Time it takes for reconciliation to complete (in seconds)  |
   657  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   658  | gossip.privdata.retrieve_duration.%{channel}                                            | histogram | Time it takes to retrieve missing private data elements    |
   659  |                                                                                         |           | from the ledger (in seconds)                               |
   660  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   661  | gossip.privdata.send_duration.%{channel}                                                | histogram | Time it takes to send a missing private data element (in   |
   662  |                                                                                         |           | seconds)                                                   |
   663  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   664  | gossip.privdata.validation_duration.%{channel}                                          | histogram | Time it takes to validate a block (in seconds)             |
   665  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   666  | gossip.state.commit_duration.%{channel}                                                 | histogram | Time it takes to commit a block in seconds                 |
   667  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   668  | gossip.state.height.%{channel}                                                          | gauge     | Current ledger height                                      |
   669  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   670  | grpc.comm.conn_closed                                                                   | counter   | gRPC connections closed. Open minus closed is the active   |
   671  |                                                                                         |           | number of connections.                                     |
   672  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   673  | grpc.comm.conn_opened                                                                   | counter   | gRPC connections opened. Open minus closed is the active   |
   674  |                                                                                         |           | number of connections.                                     |
   675  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   676  | grpc.server.stream_messages_received.%{service}.%{method}                               | counter   | The number of stream messages received.                    |
   677  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   678  | grpc.server.stream_messages_sent.%{service}.%{method}                                   | counter   | The number of stream messages sent.                        |
   679  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   680  | grpc.server.stream_request_duration.%{service}.%{method}.%{code}                        | histogram | The time to complete a stream request.                     |
   681  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   682  | grpc.server.stream_requests_completed.%{service}.%{method}.%{code}                      | counter   | The number of stream requests completed.                   |
   683  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   684  | grpc.server.stream_requests_received.%{service}.%{method}                               | counter   | The number of stream requests received.                    |
   685  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   686  | grpc.server.unary_request_duration.%{service}.%{method}.%{code}                         | histogram | The time to complete a unary request.                      |
   687  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   688  | grpc.server.unary_requests_completed.%{service}.%{method}.%{code}                       | counter   | The number of unary requests completed.                    |
   689  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   690  | grpc.server.unary_requests_received.%{service}.%{method}                                | counter   | The number of unary requests received.                     |
   691  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   692  | ledger.block_processing_time.%{channel}                                                 | histogram | Time taken in seconds for ledger block processing.         |
   693  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   694  | ledger.blockchain_height.%{channel}                                                     | gauge     | Height of the chain in blocks.                             |
   695  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   696  | ledger.blockstorage_and_pvtdata_commit_time.%{channel}                                  | histogram | Time taken in seconds for committing the block and private |
   697  |                                                                                         |           | data to storage.                                           |
   698  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   699  | ledger.blockstorage_commit_time.%{channel}                                              | histogram | Time taken in seconds for committing the block to storage. |
   700  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   701  | ledger.statedb_commit_time.%{channel}                                                   | histogram | Time taken in seconds for committing block changes to      |
   702  |                                                                                         |           | state db.                                                  |
   703  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   704  | ledger.transaction_count.%{channel}.%{transaction_type}.%{chaincode}.%{validation_code} | counter   | Number of transactions processed.                          |
   705  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   706  | logging.entries_checked.%{level}                                                        | counter   | Number of log entries checked against the active logging   |
   707  |                                                                                         |           | level                                                      |
   708  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   709  | logging.entries_written.%{level}                                                        | counter   | Number of log entries that are written                     |
   710  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
   711  
   712  .. Licensed under Creative Commons Attribution 4.0 International License
   713     https://creativecommons.org/licenses/by/4.0/