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