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