github.com/adecaro/fabric-ca@v2.0.0-alpha+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  | api_request_duration                                | histogram | Time taken in seconds for the request to an API to be      | api_name ca_name   |
    13  |                                                     |           | completed.                                                 | status_code        |
    14  +-----------------------------------------------------+-----------+------------------------------------------------------------+--------------------+
    15  | api_request_count                                   | counter   | Number of request made to an API.                          | api_name ca_name   |
    16  |                                                     |           |                                                            | status_code        |
    17  +-----------------------------------------------------+-----------+------------------------------------------------------------+--------------------+
    18  
    19  StatsD Metrics
    20  --------------
    21  
    22  The following metrics are currently emitted for consumption by StatsD. The
    23  ``%{variable_name}`` nomenclature represents segments that vary based on
    24  context.
    25  
    26  For example, ``%{ca_name}`` will be replaced with the name of the ca
    27  associated with the metric.
    28  
    29  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
    30  | Bucket                                                                                  | Type      | Description                                                |
    31  +=========================================================================================+===========+============================================================+
    32  | api_request_duration.%{ca_name}.%{api_name}.%{status_code}                              | histogram | Time taken in seconds for the request to an API to be      |
    33  |                                                                                         |           | completed.                                                 |
    34  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+
    35  | api_request_count.%{ca_name}.%{api_name}.%{status_code}                                 | counter   | Number of request made to an API.                          |
    36  |                                                                                         |           |                                                            |
    37  +-----------------------------------------------------------------------------------------+-----------+------------------------------------------------------------+