Adding an analysis provider

This page describes how to add an Analysis Provider to analyize the metrics of your deployment.

To enable Automated deployment analysis feature, you have to set the needed information for Piped to connect to the Analysis Provider.

Currently, PipeCD supports the following providers:

Prometheus

Piped queries the range query endpoint to obtain metrics used to evaluate the deployment.

You need to define the Prometheus server address so that it can be accessed by your piped.

apiVersion: pipecd.dev/v1beta1
kind: Piped
spec:
  plugins:
    - name: analysis
      port:
      url:
      config:
        analysisProviders:
          - name: prometheus-dev
            type: PROMETHEUS
            config:
              address: https://your-prometheus.dev

To know more, see the full list of configurable fields.

Datadog

Piped queries the MetricsApi.QueryMetrics endpoint to obtain metrics used to evaluate the deployment.

apiVersion: pipecd.dev/v1beta1
kind: Piped
spec:
  plugins:
    - name: analysis
      port:
      url:
      config:
        analysisProviders:
          - name: datadog-dev
            type: DATADOG
            config: 
              apiKeyFile: /etc/piped-secret/datadog-api-key
              applicationKeyFile: /etc/piped-secret/datadog-application-key

To know more, see the full list of configurable fields.

If you choose Helm as the installation method, we recommend using --set-file to mount the key files while performing the upgrading process.

--set-file secret.data.datadog-api-key={PATH_TO_API_KEY_FILE} \
--set-file secret.data.datadog-application-key={PATH_TO_APPLICATION_KEY_FILE}