Implementation of OpenMetrics

What does this MR do and why?

Adds metrics endpoints that provides OpenMetrics Compliant Data, for use with such products as Prometheus. Base set of metrics, any additional will be done on a per-request basis.

Screenshots or screen recordings

/metrics/

/metrics/servers/1/ (Number defining server id)

How to set up and validate locally

via terminal

export METRICS_TOKEN=<api_key>

curl -k https://<ip>:8443/metrics/?token=$METRICS_TOKEN            # Requires super user api key.
curl -k https://<ip>:8443/metrics/host/?token=$METRICS_TOKEN       # Requires super user api key.
curl -k https://<ip>:8443/metrics/servers/1/?token=$METRICS_TOKEN  # Requires super user or api key created by user with role for server.

via Prometheus

  - job_name: 'Crafty-metrics'
    scrape_interval: 1s
    static_configs:
      - targets:
          - '<ip>:8443'
    metrics_path: '/metrics/'
    params:
      token: ['token goes here']
    scheme: 'https'
    tls_config:
      insecure_skip_verify: true # If using crafty self signed

  - job_name: 'Crafty-host-metrics'
    scrape_interval: 1s
    static_configs:
      - targets:
          - '<ip>:8443'
    metrics_path: '/metrics/host/'
    params:
      token: ['token goes here']
    scheme: 'https'
    tls_config:
      insecure_skip_verify: true # If using crafty self signed

  - job_name: 'Crafty-server-metrics-1'
    scrape_interval: 1s
    static_configs:
      - targets:
          - '<ip>:8443'
    metrics_path: '/metrics/servers/1/' # UUID would be nice
    params:
      token: ['token goes here']
    scheme: 'https'
    tls_config:
      insecure_skip_verify: true # If using crafty self signed

Then use prometheus as as data source in Grafana, where you can use the metrics explorer to discover values.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

• Have you checked this doesn't interfere/conflict/duplicate someone elses work?
• Have you fully tested your changes?
• Have you resolved any lint issues?
• Have you assigned a reviewer?
• Have you applied correct labels?

changed title from Draft: Feature/openmetrics implementation to Draft: Implementation of OpenMetrics

added featureaddition label

assigned to @Silversthorn

added 1 commit

• eb6d9560 - Implementations of Prometheus Client

Compare with previous version

mentioned in issue #283 (closed)

added 1 commit

• 49914c7f - Improve OpenMetrics Registries Work

Compare with previous version

added 1 commit

• f49475c1 - Removing unused imports

Compare with previous version

added 253 commits

• f49475c1...3de57ec4 - 252 commits from branch dev
• 72a5f166 - Resolve Conflicts from Merge branch 'dev' into feature/openmetrics-implementation

Compare with previous version

added 22 commits

• 72a5f166...2f659712 - 21 commits from branch dev
• 5947d4eb - Merge branch 'dev' into feature/openmetrics-implementation

Compare with previous version

added 1 commit

• 814aaeb1 - Appease the linter

Compare with previous version

added 1 commit

• bcbafe22 - Fixed the last one ?

Compare with previous version

marked the checklist item Have you checked this doesn't interfere/conflict/duplicate someone elses work? as completed

marked the checklist item Have you resolved any lint issues? as completed

marked the checklist item Have you applied correct labels? as completed

marked the checklist item Have you fully tested your changes? as completed

marked the checklist item Have you assigned a reviewer? as completed

requested review from @amcmanu3 and @Zedifus

marked this merge request as ready

changed the description

approved this merge request