https://github.com/ssube/ovh-exporter

Prometheus exporter for the OVH cloud API
https://github.com/ssube/ovh-exporter

ovh ovh-api ovhcloud prometheus prometheus-exporter prometheus-metrics

Last synced: 12 days ago
JSON representation

Prometheus exporter for the OVH cloud API

• Host: GitHub
• URL: https://github.com/ssube/ovh-exporter
• Owner: ssube
• License: mit
• Created: 2021-08-02T14:01:37.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-10-09T11:40:24.000Z (about 1 year ago)
• Last Synced: 2024-11-05T11:28:18.537Z (about 2 months ago)
• Topics: ovh, ovh-api, ovhcloud, prometheus, prometheus-exporter, prometheus-metrics
• Language: JavaScript
• Homepage:
• Size: 18.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# OVH Exporter

This is a Prometheus exporter for the OVH cloud API.

## API Auth

The OVH API uses a signed token, generated by their SDK, using an app key/secret and consumer secret.

The full process is described in https://docs.ovh.com/gb/en/api/first-steps-with-ovh-api/#advanced-usage-pair-ovhcloud-apis-with-an-application_2.

1. Sign up as a new app using the `/createToken` endpoint for your selected API, such as https://api.us.ovhcloud.com/createToken/

2. Put the resulting secrets in an `.env` file or k8s secret

3. Mount or source those secrets before running `node index.js`

## Configuration

The following environment variables must be set:

- `OVH_ENDPOINT`

  - the name of the API endpoint to be used

  - like `ovh-ca`, `ovh-eu`, `ovh-us`

- `OVH_APP`

  - the application key, AK in the docs

- `OVH_SECRET`

  - the secret application key, AS in the docs

- `OVH_CONSUMER`

  - the secret consumer key, CK in the docs

- `OVH_PROJECT`

  - the ID of your public cloud project

## Metrics

The API has a number of GET endpoints that expose project usage and quota information. Some of these are

collected and exposed as Prometheus metrics.

- `ovh_project_quota_max`

  - `region`

    - name

  - `resource`

    - `cores`

    - `instances`

    - `memory`

- `ovh_project_quota_used`

  - `region`

    - name

  - `resource`

    - `cores`

    - `instances`

    - `memory`

- `ovh_swift_bucket_bytes_total`

  - `bucket`

    - name

  - `region`

    - name

- `ovh_swift_bucket_objects_total`

  - `bucket`

    - name

  - `region`

    - name

Metrics are fetched once on startup, then on a scheduled interval, by default every 10 minutes.