Skip to main content

Integration with Datadog

Datadog provides easy integration of log and metrics collection in the kubernetes environment. This document describes how to integrate the Datadog with PhoenixAI.

see https://docs.datadoghq.com/containers/kubernetes/installation/?tab=helm for more details.

1. Install the Datadog chart​

If this is a fresh install, add the Helm Datadog repo:

helm repo add datadog https://helm.datadoghq.com
helm repo update datadog

Create a Kubernetes Secret to store your Datadog API key and app key:

export DD_API_KEY=xxx
export DD_APP_KEY=yyy
kubectl create secret generic datadog-secret --from-literal api-key=$DD_API_KEY --from-literal app-key=$DD_APP_KEY

Set the following parameters in your datadog-values.yaml to reference the secret:

datadog:
  apiKeyExistingSecret: datadog-secret
  appKeyExistingSecret: datadog-secret
  site: <DATADOG_SITE>   # Replace <DATADOG_SITE> with your Datadog site.
  logs:
    enabled: true
  prometheusScrape:
    enabled: true
    serviceEndpoints: true

Install the chart with the release name datadog-agent:

helm install datadog-agent  -f datadog-values.yaml datadog/datadog

2. Install or upgrade the phoenixai cluster​

If this is a fresh install, add the Helm PhoenixAI Operator repo

helm repo add phoenixai https://celerdata.github.io/phoenixai-kubernetes-operator
helm repo update phoenixai

Add the following configuration to your sr-values.yaml file:

datadog:
  log:
    enabled: true   # enable the log collection
    tags: '["env:test"]'
  metrics:
    enabled: true  # enable the metrics collection

Install or upgrade your phoenixai cluster:

# install
helm install -n phoenixai kube-anywhere -f sr-values.yaml phoenixai/kube-anywhere

# upgrade
helm upgrade -n phoenixai kube-anywhere -f sr-values.yaml phoenixai/kube-anywhere

When you execute helm install or helm upgrade command, the rendered configuration will be passed to the phoenixai cluster, like the following:

# sr-values.yaml
phoenixAIFeSpec:
  annotations:
    # change the value of ad.datadoghq.com/fe.logs to your own value
    ad.datadoghq.com/fe.logs: '[{"source": "fe","service": "phoenixai","tags": ["env:test"]}]'
  service:
    annotations:
      prometheus.io/path: "/metrics"
      prometheus.io/port: "8030"
      prometheus.io/scrape: "true"
  feEnvVars:
    - name: LOG_CONSOLE
      value: "1"
phoenixAICnSpec:
  annotations:
    # change the value of ad.datadoghq.com/cn.logs to your own value
    ad.datadoghq.com/cn.logs: '[{"source": "cn","service": "phoenixai","tags": ["env:test"]}]'
  service:
    annotations:
      prometheus.io/path: "/metrics"
      prometheus.io/port: "8040"
      prometheus.io/scrape: "true"
  cnEnvVars:
    - name: LOG_CONSOLE
      value: "1"