github.com/hyperledger/fabric-ca@v2.0.0-alpha.0.20201120210307-7b4f34729db1+incompatible/docs/source/metrics_reference.rst.tmpl (about)

     1  {{/* Copyright IBM Corp. All Rights Reserved. */ -}}
     2  {{/* SPDX-License-Identifier: Apache-2.0 */ -}}
     3  
     4  Metrics Reference
     5  =================
     6  
     7  Metrics exposed by the Fabric CA include *labels* to differentiate various
     8  characteristics of the item being measured. Five different labels are used.
     9  
    10    api_name
    11      For API requests, this is the path of the requested resource with the version
    12      prefix removed. The list of resource paths can be found in the
    13      `Swagger API Documentation <https://github.com/hyperledger/fabric-ca/blob/master/swagger/swagger-fabric-ca.json>`_.
    14      Examples include ``cainfo``, register``, and ``enroll``.
    15  
    16    ca_name
    17      The name of the certificate authority associated with the metric.
    18  
    19    db_api_name
    20      For database requests, this contains the SQL operation that was used.
    21      Examples include ``Commit``, ``Exec``, ``Get``, ``NamedExec``, ``Select``,
    22      and ``Queryx``
    23  
    24    func_name
    25      For database access, this includes the name of the function that initiated
    26      the database request. Examples include ``GetUser``, ``InsertUser``,
    27      ``LoginComplete``, and  ``ResetIncorrectLoginAttempts``.
    28  
    29    status_code
    30      For API requests, this is the HTTP status code of the response. Successful
    31      requests will have status codes that are less than 400.
    32  
    33  Prometheus Metrics
    34  ------------------
    35  
    36  The following metrics are currently exported for consumption by Prometheus.
    37  
    38  {{ PrometheusTable }}
    39  
    40  StatsD Metrics
    41  --------------
    42  
    43  The following metrics are currently emitted for consumption by StatsD. The
    44  ``%{label_name}`` nomenclature indicates the location of a label value in the
    45  bucket name.
    46  
    47  {{ StatsdTable }}
    48  
    49  .. Licensed under Creative Commons Attribution 4.0 International License
    50     https://creativecommons.org/licenses/by/4.0/