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