Giter Site home page Giter Site logo

ovh-exporter's Introduction

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.

ovh-exporter's People

Contributors

renovate-bot avatar renovate[bot] avatar ssube avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

ovh-exporter's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

dockerfile
Dockerfile.stretch
  • apextoaster/node 16.19
npm
package.json
  • ovh ^2.0.3
  • prom-client ^14.0.0

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.