Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

AAGM already ships a Prometheus and its Push-GatewayPushgateway. https://apiida.atlassian.net/wiki/spaces/AAGM/pages/7760183321/Installation#Install-using-Docker-Compose
Once set up successfully, everything should connect automatically and start collecting metrics from APIs registered in AAGM.

...

Using an external Prometheus

  • The url of Prometheus and the Prometheus Pushgateway must be stored in the configuration of AAGM under

...

  • General settings.

  • Prometheus must receive the

...

View metrics directly in Prometheus

Here are a few examples of how to retrieve metrics directly in Prometheus.

Example: Nodes

...

  • cpuLoadPercentage{name="Docker GW 1"}

  • memoryLoadPercentage{hostPort="host.docker.internal:8444"}

  • cpuLoadPercentage

...

Example: APIs

...

  • allRequestsCount{name="APIIDA Metrics API"}

  • allRequestsCount{job="Docker GW 1 APIIDA Metrics API"}

  • allRequestsCount{nodeID="2"}

...

...

Jobs, Labels and Metric Names

https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels https://prometheus.io/docs/concepts/jobs_instances/

All possible filters can also be viewed there here or directly on the PushGateway.

Useful

Grafan .

...

Jobs

The name of the job consists of the name of the gateway and the name of the API.

Labels

Enable the Prometheus dimensional data model to identify any combination of labels for the same metric name.

  • id

    • Id of the API or Node

  • name

    • Name of the API or Node

  • nodeId

    • Id of the node on which the API is running

  • type

    • Type of job, either “api” or “node”. Influences which metrics are available.

Metric Names

Specify the general characteristic of a system that is being measured

All Metric Names for Label type=api
  • allRequestsCount

  • averageBackendResponseTimeMillis

  • averageFrontendResponseTimeMillis

  • maxBackendResponseTimeMillis

  • maxFrontendResponseTimeMillis

  • minBackendResponseTimeMillis

  • minFrontendResponseTimeMillis

  • policyViolationCount

  • routingFailureCount

  • successfulRequestsCount

All Metric Names for Label type=node
  • cpuLoadPercentage

  • memoryLoadPercentage

  • diskSpacePercentage

  • totalDiskSpaceMB

  • freeDiskSpaceMB

  • sqlDelay

Grafana

Grafana supports the Prometheus query. The Grafana data source for Prometheus is included since Grafana 2.5.0 https://prometheus.io/docs/visualization/grafana/#grafana-support-for-prometheus

Grafana user: admin pass: admin

...