Enabling Web API metrics
The Web API metrics are accessed by the following URL:
http://<hostname>/SPSSMR/WebApi/Metrics/Prometheus
The Web API metrics endpoint is always available, but it normally requires the client to authenticate. For more information, see the following DPM properties in
Configuring the Web API components in DPM:
The client requesting the metrics must get an OAuth2.0 access token from http://<hostname>/SPSSMR/Oidc, and then include that access token as a bearer token in an authorization header, unless the MetricsRequireAuthentication property has been set to False.
By default, a “Prometheus” OAuth2.0 client is created in DPM under Site\Properties\Oidc\Clients\Prometheus. Change the ClientSecrets value to a unique value.
The Web API can return the list of metrics that it supports as either HTML or JSON by accessing the following URL:
http://<hostname>/SPSSMR/WebApi/Metrics/Defined?Api-Version=1.1
For the OpenApi definition of the Web API, an installed instance of the API can return its own API documentation: for more information, see
Endpoint reference.
See