nomad_client v0.13.0

NomadClient.Api.Metrics (nomad_client v0.13.0)

API calls for all endpoints tagged Metrics.

Link to this section Summary

Functions

get_metrics_summary(connection, opts \\ [])

Parameters

  • connection (NomadClient.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :format (String.t): The format the user requested for the metrics summary (e.g. prometheus)

Returns

  • {:ok, NomadClient.Model.MetricsSummary.t} on success
  • {:error, Tesla.Env.t} on failure

Link to this section Functions

Link to this function

get_metrics_summary(connection, opts \\ [])

@spec get_metrics_summary(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, NomadClient.Model.MetricsSummary.t()}
  | {:error, Tesla.Env.t()}

parameters

 Parameters

  • connection (NomadClient.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :format (String.t): The format the user requested for the metrics summary (e.g. prometheus)

returns

 Returns

  • {:ok, NomadClient.Model.MetricsSummary.t} on success
  • {:error, Tesla.Env.t} on failure