otel-collector

Description

This provider enables gathering and exporting OpenTelemetry data for the Garden execution.

It provides detailed insights into what a Garden command is doing at any given time and can be used for alerting on performance regressions or debugging performance issues.

It does that by running an OpenTelemetry Collector on the local machine for the duration of the command execution, which then exports the gathered data to the desired service.

Currently supported exporters are Datadog, Newrelic, Honeycomb and 'OTLP HTTP'.

Below is the full schema reference for the provider configuration. For an introduction to configuring a Garden project with providers, please look at our configuration guide.

The reference is divided into two sections. The first section contains the complete YAML schema, and the second section describes each schema key.

Complete YAML Schema

The values in the schema below are the default values.

providers:
  - # The name of the provider plugin to use.
    name:

    # List other providers that should be resolved before this one.
    #
    # Example: `["exec"]`
    dependencies: []

    # If specified, this provider will only be used in the listed environments. Note that an empty array effectively
    # disables the provider. To use a provider in all environments, omit this field.
    #
    # Example: `["dev","stage"]`
    environments:

    exporters:
      - name:

        enabled:

        verbosity: normal

Configuration Keys

providers[]

Type	Default	Required
array[object]	[]	No

providers[].name

providers > name

The name of the provider plugin to use.

Type	Required
string	Yes

providers[].dependencies[]

providers > dependencies

List other providers that should be resolved before this one.

Example: ["exec"]

Type	Default	Required
array	[]	No

providers[].environments[]

providers > environments

If specified, this provider will only be used in the listed environments. Note that an empty array effectively disables the provider. To use a provider in all environments, omit this field.

Example: ["dev","stage"]

Type	Required
array	No

providers[].exporters[]

providers > exporters

Type	Required
array	Yes

providers[].exporters[].name

providers > exporters > name

Type	Required
string	No

providers[].exporters[].enabled

providers > exporters > enabled

Type	Required
boolean	No

providers[].exporters[].verbosity

providers > exporters > verbosity

Type	Allowed Values	Default	Required
string	"detailed", "normal", "basic"	"normal"	No