Plugins

Carbonaut Plugin information. Implementations are located in the pkg/plugins folder.

Dynamic Environment Plugins

Electricity Map plugin implementation.

  • Configuration key: electricitymaps
  • Requires an API key which is specified as environment variable in the carbonaut configuration file.

Example configuration:

dynamic_environment:
    plugin: electricitymaps
    access_key_env: "ELECTRICITY_MAP_AUTH_TOKEN"

Dynamic Resource Plugins

Scaphandre plugin implementation.

  • Configuration key: scaphandre
  • Requires information about the port and endpoint

Example configuration:

dynamic_resource:
    plugin: scaphandre
    endpoint: ":8080/metrics"

Static Resource Plugins

Equinix plugin implementation.

  • Configuration key: equinix
  • Requires an API key which is specified as environment variable in the carbonaut configuration file.

Example configuration:

xyz-equinix-abc:
    static_resource:
        plugin: equinix
        access_key_env: "METAL_AUTH_TOKEN"