github.com/yacovm/fabric@v2.0.0-alpha.0.20191128145320-c5d4087dc723+incompatible/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_validation_failures | counter | The number of proposals that have failed initial | | | 204 | | | validation. | | | 205 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 206 | endorser_proposals_received | counter | The number of proposals received. | | | 207 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 208 | endorser_successful_proposals | counter | The number of successful proposals. | | | 209 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 210 | fabric_version | gauge | The active version of Fabric. | version | | 211 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 212 | gossip_comm_messages_received | counter | Number of messages received | | | 213 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 214 | gossip_comm_messages_sent | counter | Number of messages sent | | | 215 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 216 | gossip_comm_overflow_count | counter | Number of outgoing queue buffer overflows | | | 217 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 218 | gossip_leader_election_leader | gauge | Peer is leader (1) or follower (0) | channel | | 219 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 220 | gossip_membership_total_peers_known | gauge | Total known peers | channel | | 221 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 222 | gossip_payload_buffer_size | gauge | Size of the payload buffer | channel | | 223 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 224 | gossip_privdata_commit_block_duration | histogram | Time it takes to commit private data and the corresponding | channel | | 225 | | | block (in seconds) | | | 226 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 227 | gossip_privdata_fetch_duration | histogram | Time it takes to fetch missing private data from peers (in | channel | | 228 | | | seconds) | | | 229 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 230 | gossip_privdata_list_missing_duration | histogram | Time it takes to list the missing private data (in | channel | | 231 | | | seconds) | | | 232 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 233 | gossip_privdata_pull_duration | histogram | Time it takes to pull a missing private data element (in | channel | | 234 | | | seconds) | | | 235 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 236 | gossip_privdata_purge_duration | histogram | Time it takes to purge private data (in seconds) | channel | | 237 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 238 | gossip_privdata_reconciliation_duration | histogram | Time it takes for reconciliation to complete (in seconds) | channel | | 239 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 240 | gossip_privdata_retrieve_duration | histogram | Time it takes to retrieve missing private data elements | channel | | 241 | | | from the ledger (in seconds) | | | 242 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 243 | gossip_privdata_send_duration | histogram | Time it takes to send a missing private data element (in | channel | | 244 | | | seconds) | | | 245 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 246 | gossip_privdata_validation_duration | histogram | Time it takes to validate a block (in seconds) | channel | | 247 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 248 | gossip_state_commit_duration | histogram | Time it takes to commit a block in seconds | channel | | 249 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 250 | gossip_state_height | gauge | Current ledger height | channel | | 251 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 252 | grpc_comm_conn_closed | counter | gRPC connections closed. Open minus closed is the active | | | 253 | | | number of connections. | | | 254 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 255 | grpc_comm_conn_opened | counter | gRPC connections opened. Open minus closed is the active | | | 256 | | | number of connections. | | | 257 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 258 | grpc_server_stream_messages_received | counter | The number of stream messages received. | service | | 259 | | | +------------------+-------------------------------------------------------------+ 260 | | | | method | | 261 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 262 | grpc_server_stream_messages_sent | counter | The number of stream messages sent. | service | | 263 | | | +------------------+-------------------------------------------------------------+ 264 | | | | method | | 265 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 266 | grpc_server_stream_request_duration | histogram | The time to complete a stream request. | service | | 267 | | | +------------------+-------------------------------------------------------------+ 268 | | | | method | | 269 | | | +------------------+-------------------------------------------------------------+ 270 | | | | code | | 271 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 272 | grpc_server_stream_requests_completed | counter | The number of stream requests completed. | service | | 273 | | | +------------------+-------------------------------------------------------------+ 274 | | | | method | | 275 | | | +------------------+-------------------------------------------------------------+ 276 | | | | code | | 277 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 278 | grpc_server_stream_requests_received | counter | The number of stream requests received. | service | | 279 | | | +------------------+-------------------------------------------------------------+ 280 | | | | method | | 281 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 282 | grpc_server_unary_request_duration | histogram | The time to complete a unary request. | service | | 283 | | | +------------------+-------------------------------------------------------------+ 284 | | | | method | | 285 | | | +------------------+-------------------------------------------------------------+ 286 | | | | code | | 287 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 288 | grpc_server_unary_requests_completed | counter | The number of unary requests completed. | service | | 289 | | | +------------------+-------------------------------------------------------------+ 290 | | | | method | | 291 | | | +------------------+-------------------------------------------------------------+ 292 | | | | code | | 293 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 294 | grpc_server_unary_requests_received | counter | The number of unary requests received. | service | | 295 | | | +------------------+-------------------------------------------------------------+ 296 | | | | method | | 297 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 298 | ledger_block_processing_time | histogram | Time taken in seconds for ledger block processing. | channel | | 299 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 300 | ledger_blockchain_height | gauge | Height of the chain in blocks. | channel | | 301 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 302 | ledger_blockstorage_and_pvtdata_commit_time | histogram | Time taken in seconds for committing the block and private | channel | | 303 | | | data to storage. | | | 304 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 305 | ledger_blockstorage_commit_time | histogram | Time taken in seconds for committing the block to storage. | channel | | 306 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 307 | ledger_statedb_commit_time | histogram | Time taken in seconds for committing block changes to | channel | | 308 | | | state db. | | | 309 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 310 | ledger_transaction_count | counter | Number of transactions processed. | channel | | 311 | | | +------------------+-------------------------------------------------------------+ 312 | | | | transaction_type | | 313 | | | +------------------+-------------------------------------------------------------+ 314 | | | | chaincode | | 315 | | | +------------------+-------------------------------------------------------------+ 316 | | | | validation_code | | 317 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 318 | logging_entries_checked | counter | Number of log entries checked against the active logging | level | | 319 | | | level | | | 320 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 321 | logging_entries_written | counter | Number of log entries that are written | level | | 322 +-----------------------------------------------------+-----------+------------------------------------------------------------+------------------+-------------------------------------------------------------+ 323 324 325 StatsD Metrics 326 -------------- 327 328 The following metrics are currently emitted for consumption by StatsD. The 329 ``%{variable_name}`` nomenclature represents segments that vary based on 330 context. 331 332 For example, ``%{channel}`` will be replaced with the name of the channel 333 associated with the metric. 334 335 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 336 | Bucket | Type | Description | 337 +=========================================================================================+===========+============================================================+ 338 | blockcutter.block_fill_duration.%{channel} | histogram | The time from first transaction enqueing to the block | 339 | | | being cut in seconds. | 340 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 341 | broadcast.enqueue_duration.%{channel}.%{type}.%{status} | histogram | The time to enqueue a transaction in seconds. | 342 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 343 | broadcast.processed_count.%{channel}.%{type}.%{status} | counter | The number of transactions processed. | 344 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 345 | broadcast.validate_duration.%{channel}.%{type}.%{status} | histogram | The time to validate a transaction in seconds. | 346 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 347 | chaincode.execute_timeouts.%{chaincode} | counter | The number of chaincode executions (Init or Invoke) that | 348 | | | have timed out. | 349 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 350 | chaincode.launch_duration.%{chaincode}.%{success} | histogram | The time to launch a chaincode. | 351 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 352 | chaincode.launch_failures.%{chaincode} | counter | The number of chaincode launches that have failed. | 353 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 354 | chaincode.launch_timeouts.%{chaincode} | counter | The number of chaincode launches that have timed out. | 355 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 356 | chaincode.shim_request_duration.%{type}.%{channel}.%{chaincode}.%{success} | histogram | The time to complete chaincode shim requests. | 357 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 358 | chaincode.shim_requests_completed.%{type}.%{channel}.%{chaincode}.%{success} | counter | The number of chaincode shim requests completed. | 359 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 360 | chaincode.shim_requests_received.%{type}.%{channel}.%{chaincode} | counter | The number of chaincode shim requests received. | 361 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 362 | cluster.comm.egress_queue_capacity.%{host}.%{msg_type}.%{channel} | gauge | Capacity of the egress queue. | 363 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 364 | cluster.comm.egress_queue_length.%{host}.%{msg_type}.%{channel} | gauge | Length of the egress queue. | 365 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 366 | cluster.comm.egress_queue_workers.%{channel} | gauge | Count of egress queue workers. | 367 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 368 | cluster.comm.egress_stream_count.%{channel} | gauge | Count of streams to other nodes. | 369 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 370 | cluster.comm.egress_tls_connection_count | gauge | Count of TLS connections to other nodes. | 371 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 372 | cluster.comm.ingress_stream_count | gauge | Count of streams from other nodes. | 373 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 374 | cluster.comm.msg_dropped_count.%{host}.%{channel} | counter | Count of messages dropped. | 375 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 376 | cluster.comm.msg_send_time.%{host}.%{channel} | histogram | The time it takes to send a message in seconds. | 377 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 378 | consensus.etcdraft.active_nodes.%{channel} | gauge | Number of active nodes in this channel. | 379 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 380 | consensus.etcdraft.cluster_size.%{channel} | gauge | Number of nodes in this channel. | 381 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 382 | consensus.etcdraft.committed_block_number.%{channel} | gauge | The block number of the latest block committed. | 383 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 384 | consensus.etcdraft.config_proposals_received.%{channel} | counter | The total number of proposals received for config type | 385 | | | transactions. | 386 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 387 | consensus.etcdraft.data_persist_duration.%{channel} | histogram | The time taken for etcd/raft data to be persisted in | 388 | | | storage (in seconds). | 389 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 390 | consensus.etcdraft.is_leader.%{channel} | gauge | The leadership status of the current node: 1 if it is the | 391 | | | leader else 0. | 392 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 393 | consensus.etcdraft.leader_changes.%{channel} | counter | The number of leader changes since process start. | 394 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 395 | consensus.etcdraft.normal_proposals_received.%{channel} | counter | The total number of proposals received for normal type | 396 | | | transactions. | 397 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 398 | consensus.etcdraft.proposal_failures.%{channel} | counter | The number of proposal failures. | 399 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 400 | consensus.etcdraft.snapshot_block_number.%{channel} | gauge | The block number of the latest snapshot. | 401 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 402 | consensus.kafka.batch_size.%{topic} | gauge | The mean batch size in bytes sent to topics. | 403 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 404 | consensus.kafka.compression_ratio.%{topic} | gauge | The mean compression ratio (as percentage) for topics. | 405 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 406 | consensus.kafka.incoming_byte_rate.%{broker_id} | gauge | Bytes/second read off brokers. | 407 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 408 | consensus.kafka.last_offset_persisted.%{channel} | gauge | The offset specified in the block metadata of the most | 409 | | | recently committed block. | 410 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 411 | consensus.kafka.outgoing_byte_rate.%{broker_id} | gauge | Bytes/second written to brokers. | 412 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 413 | consensus.kafka.record_send_rate.%{topic} | gauge | The number of records per second sent to topics. | 414 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 415 | consensus.kafka.records_per_request.%{topic} | gauge | The mean number of records sent per request to topics. | 416 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 417 | consensus.kafka.request_latency.%{broker_id} | gauge | The mean request latency in ms to brokers. | 418 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 419 | consensus.kafka.request_rate.%{broker_id} | gauge | Requests/second sent to brokers. | 420 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 421 | consensus.kafka.request_size.%{broker_id} | gauge | The mean request size in bytes to brokers. | 422 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 423 | consensus.kafka.response_rate.%{broker_id} | gauge | Requests/second sent to brokers. | 424 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 425 | consensus.kafka.response_size.%{broker_id} | gauge | The mean response size in bytes from brokers. | 426 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 427 | couchdb.processing_time.%{database}.%{function_name}.%{result} | histogram | Time taken in seconds for the function to complete request | 428 | | | to CouchDB | 429 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 430 | deliver.blocks_sent.%{channel}.%{filtered}.%{data_type} | counter | The number of blocks sent by the deliver service. | 431 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 432 | deliver.requests_completed.%{channel}.%{filtered}.%{data_type}.%{success} | counter | The number of deliver requests that have been completed. | 433 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 434 | deliver.requests_received.%{channel}.%{filtered}.%{data_type} | counter | The number of deliver requests that have been received. | 435 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 436 | deliver.streams_closed | counter | The number of GRPC streams that have been closed for the | 437 | | | deliver service. | 438 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 439 | deliver.streams_opened | counter | The number of GRPC streams that have been opened for the | 440 | | | deliver service. | 441 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 442 | dockercontroller.chaincode_container_build_duration.%{chaincode}.%{success} | histogram | The time to build a chaincode image in seconds. | 443 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 444 | endorser.chaincode_instantiation_failures.%{channel}.%{chaincode} | counter | The number of chaincode instantiations or upgrade that | 445 | | | have failed. | 446 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 447 | endorser.duplicate_transaction_failures.%{channel}.%{chaincode} | counter | The number of failed proposals due to duplicate | 448 | | | transaction ID. | 449 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 450 | endorser.endorsement_failures.%{channel}.%{chaincode}.%{chaincodeerror} | counter | The number of failed endorsements. | 451 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 452 | endorser.proposal_acl_failures.%{channel}.%{chaincode} | counter | The number of proposals that failed ACL checks. | 453 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 454 | endorser.proposal_duration.%{channel}.%{chaincode}.%{success} | histogram | The time to complete a proposal. | 455 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 456 | endorser.proposal_validation_failures | counter | The number of proposals that have failed initial | 457 | | | validation. | 458 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 459 | endorser.proposals_received | counter | The number of proposals received. | 460 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 461 | endorser.successful_proposals | counter | The number of successful proposals. | 462 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 463 | fabric_version.%{version} | gauge | The active version of Fabric. | 464 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 465 | gossip.comm.messages_received | counter | Number of messages received | 466 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 467 | gossip.comm.messages_sent | counter | Number of messages sent | 468 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 469 | gossip.comm.overflow_count | counter | Number of outgoing queue buffer overflows | 470 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 471 | gossip.leader_election.leader.%{channel} | gauge | Peer is leader (1) or follower (0) | 472 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 473 | gossip.membership.total_peers_known.%{channel} | gauge | Total known peers | 474 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 475 | gossip.payload_buffer.size.%{channel} | gauge | Size of the payload buffer | 476 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 477 | gossip.privdata.commit_block_duration.%{channel} | histogram | Time it takes to commit private data and the corresponding | 478 | | | block (in seconds) | 479 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 480 | gossip.privdata.fetch_duration.%{channel} | histogram | Time it takes to fetch missing private data from peers (in | 481 | | | seconds) | 482 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 483 | gossip.privdata.list_missing_duration.%{channel} | histogram | Time it takes to list the missing private data (in | 484 | | | seconds) | 485 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 486 | gossip.privdata.pull_duration.%{channel} | histogram | Time it takes to pull a missing private data element (in | 487 | | | seconds) | 488 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 489 | gossip.privdata.purge_duration.%{channel} | histogram | Time it takes to purge private data (in seconds) | 490 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 491 | gossip.privdata.reconciliation_duration.%{channel} | histogram | Time it takes for reconciliation to complete (in seconds) | 492 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 493 | gossip.privdata.retrieve_duration.%{channel} | histogram | Time it takes to retrieve missing private data elements | 494 | | | from the ledger (in seconds) | 495 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 496 | gossip.privdata.send_duration.%{channel} | histogram | Time it takes to send a missing private data element (in | 497 | | | seconds) | 498 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 499 | gossip.privdata.validation_duration.%{channel} | histogram | Time it takes to validate a block (in seconds) | 500 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 501 | gossip.state.commit_duration.%{channel} | histogram | Time it takes to commit a block in seconds | 502 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 503 | gossip.state.height.%{channel} | gauge | Current ledger height | 504 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 505 | grpc.comm.conn_closed | counter | gRPC connections closed. Open minus closed is the active | 506 | | | number of connections. | 507 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 508 | grpc.comm.conn_opened | counter | gRPC connections opened. Open minus closed is the active | 509 | | | number of connections. | 510 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 511 | grpc.server.stream_messages_received.%{service}.%{method} | counter | The number of stream messages received. | 512 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 513 | grpc.server.stream_messages_sent.%{service}.%{method} | counter | The number of stream messages sent. | 514 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 515 | grpc.server.stream_request_duration.%{service}.%{method}.%{code} | histogram | The time to complete a stream request. | 516 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 517 | grpc.server.stream_requests_completed.%{service}.%{method}.%{code} | counter | The number of stream requests completed. | 518 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 519 | grpc.server.stream_requests_received.%{service}.%{method} | counter | The number of stream requests received. | 520 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 521 | grpc.server.unary_request_duration.%{service}.%{method}.%{code} | histogram | The time to complete a unary request. | 522 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 523 | grpc.server.unary_requests_completed.%{service}.%{method}.%{code} | counter | The number of unary requests completed. | 524 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 525 | grpc.server.unary_requests_received.%{service}.%{method} | counter | The number of unary requests received. | 526 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 527 | ledger.block_processing_time.%{channel} | histogram | Time taken in seconds for ledger block processing. | 528 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 529 | ledger.blockchain_height.%{channel} | gauge | Height of the chain in blocks. | 530 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 531 | ledger.blockstorage_and_pvtdata_commit_time.%{channel} | histogram | Time taken in seconds for committing the block and private | 532 | | | data to storage. | 533 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 534 | ledger.blockstorage_commit_time.%{channel} | histogram | Time taken in seconds for committing the block to storage. | 535 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 536 | ledger.statedb_commit_time.%{channel} | histogram | Time taken in seconds for committing block changes to | 537 | | | state db. | 538 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 539 | ledger.transaction_count.%{channel}.%{transaction_type}.%{chaincode}.%{validation_code} | counter | Number of transactions processed. | 540 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 541 | logging.entries_checked.%{level} | counter | Number of log entries checked against the active logging | 542 | | | level | 543 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 544 | logging.entries_written.%{level} | counter | Number of log entries that are written | 545 +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+ 546 547 548 .. Licensed under Creative Commons Attribution 4.0 International License 549 https://creativecommons.org/licenses/by/4.0/