Monitoring Airbyte

Cloud Self-Managed Community (OSS)Self-Managed Enterprise

Airbyte offers you various ways to monitor your ELT pipelines. These options range from using open-source tools to integrating with enterprise-grade SaaS platforms.

Here's a quick overview:

• Connection Logging: All Airbyte instances provide extensive logs for each connector, giving detailed reports on the data synchronization process. This is available across all Airbyte offerings.
• Airbyte Datadog Integration: Airbyte customers can leverage our integration with Datadog. This lets you monitor and analyze your data pipelines right within your Datadog dashboards at no additional cost.
• Airbyte OpenTelemetry (OTEL) Integration: This allows you to push metrics to your self-hosted monitoring solution using OpenTelemetry.

Please browse the sections below for more details on each option and how to set it up.

Airbyte Datadog Integration

info

Monitoring your Airbyte instance using Datadog is an early preview feature and still in development. Expect changes to this feature and the configuration to happen in the future. This feature will be only for Airbyte Enterprise customers in the future.

Airbyte's new integration with Datadog brings the convenience of monitoring and analyzing your Airbyte data pipelines directly within your Datadog dashboards. This integration brings forth new airbyte.* metrics along with new dashboards. The list of metrics is found here.

Setup Instructions

Setting up this integration for Airbyte instances deployed with Docker involves five straightforward steps:

1. Set Datadog Airbyte Config: Create or configure the datadog.yaml file with the contents below:

dogstatsd_mapper_profiles:
  - name: airbyte_worker
    prefix: "worker."
    mappings:
      - match: "worker.temporal_workflow_*"
        name: "airbyte.worker.temporal_workflow.$1"
      - match: "worker.worker_*"
        name: "airbyte.worker.$1"
      - match: "worker.state_commit_*"
        name: "airbyte.worker.state_commit.$1"
      - match: "worker.job_*"
        name: "airbyte.worker.job.$1"
      - match: "worker.attempt_*"
        name: "airbyte.worker.attempt.$1"
      - match: "worker.activity_*"
        name: "airbyte.worker.activity.$1"
      - match: "worker.*"
        name: "airbyte.worker.$1"
  - name: airbyte_cron
    prefix: "cron."
    mappings:
      - match: "cron.cron_jobs_run"
        name: "airbyte.cron.jobs_run"
      - match: "cron.*"
        name: "airbyte.cron.$1"
  - name: airbyte_metrics_reporter
    prefix: "metrics-reporter."
    mappings:
      - match: "metrics-reporter.*"
        name: "airbyte.metrics_reporter.$1"
  - name: airbyte_orchestrator
    prefix: "orchestrator."
    mappings:
      - match: "orchestrator.*"
        name: "airbyte.orchestrator.$1"
  - name: airbyte_server
    prefix: "server."
    mappings:
      - match: "server.*"
        name: "airbyte.server.$1"
  - name: airbyte_general
    prefix: "airbyte."
    mappings:
      - match: "airbyte.worker.temporal_workflow_*"
        name: "airbyte.worker.temporal_workflow.$1"
      - match: "airbyte.worker.worker_*"
        name: "airbyte.worker.$1"
      - match: "airbyte.worker.state_commit_*"
        name: "airbyte.worker.state_commit.$1"
      - match: "airbyte.worker.job_*"
        name: "airbyte.worker.job.$1"
      - match: "airbyte.worker.attempt_*"
        name: "airbyte.worker.attempt.$1"
      - match: "airbyte.worker.activity_*"
        name: "airbyte.worker.activity.$1"
      - match: "airbyte.cron.cron_jobs_run"
        name: "airbyte.cron.jobs_run"

2. Add Datadog Agent and Mount Config: If the Datadog Agent is not yet deployed to your instances running Airbyte, you can modify the provided docker-compose.yaml file in the Airbyte repository to include the Datadog Agent. For the Datadog agent to submit metrics, you will need to add an API key. Then, be sure to properly mount your datadog.yaml file as a Docker volume:

  dd-agent:
    container_name: dd-agent
    image: gcr.io/datadoghq/agent:7
    pid: host
    environment:
      - DD_API_KEY={REPLACE-WITH-DATADOG-API-KEY}
      - DD_SITE=datadoghq.com
      - DD_HOSTNAME={REPLACE-WITH-DATADOG-HOSTNAME}
      - DD_DOGSTATSD_NON_LOCAL_TRAFFIC=true
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - /proc/:/host/proc/:ro
      - /sys/fs/cgroup:/host/sys/fs/cgroup:ro
      - {REPLACE-WITH-PATH-TO}/datadog.yaml:/etc/datadog-agent/datadog.yaml
    networks:
      - airbyte_internal

3. Update Docker Compose Configuration: Modify your docker-compose.yaml file in the Airbyte repository to include the metrics-reporter container. This submits Airbyte metrics to the Datadog Agent:

  metric-reporter:
    image: airbyte/metrics-reporter:${VERSION}
    container_name: metric-reporter
    networks:
      - airbyte_internal
    environment:
      - DATABASE_PASSWORD=${DATABASE_PASSWORD}
      - DATABASE_URL=${DATABASE_URL}
      - DATABASE_USER=${DATABASE_USER}
      - DD_AGENT_HOST=${DD_AGENT_HOST}
      - DD_DOGSTATSD_PORT=${DD_DOGSTATSD_PORT}
      - METRIC_CLIENT=${METRIC_CLIENT}
      - PUBLISH_METRICS=${PUBLISH_METRICS}

4. Set Environment Variables: Amend your .env file with the correct values needed by docker-compose.yaml:

PUBLISH_METRICS=true
METRIC_CLIENT=datadog
DD_AGENT_HOST=dd-agent
DD_DOGSTATSD_PORT=8125

5. Re-deploy Airbyte and the Datadog Agent: With the updated configurations, you're ready to deploy your Airbyte application by running docker compose up.

Airbyte OpenTelemetry Integration

Docker Compose Setup Instructions

Setting up this integration for Airbyte instances deployed with Docker Compose involves four straightforward steps:

1. Deploy an OpenTelemetry Collector: Follow the official Docker Compose Getting Started documentation.

  otel-collector:
    image: otel/opentelemetry-collector-contrib
    volumes:
      - ./otel-collector-config.yaml:/etc/otelcol-contrib/config.yaml
    ports:
      - 1888:1888 # pprof extension
      - 8888:8888 # Prometheus metrics exposed by the collector
      - 8889:8889 # Prometheus exporter metrics
      - 13133:13133 # health_check extension
      - 4317:4317 # OTLP gRPC receiver
      - 4318:4318 # OTLP http receiver
      - 55679:55679 # zpages extension

2. Update Docker Compose Configuration: Modify your docker-compose.yaml file in the Airbyte repository to include the metrics-reporter container. This submits Airbyte metrics to the OpenTelemetry collector:

  metric-reporter:
    image: airbyte/metrics-reporter:${VERSION}
    container_name: metric-reporter
    networks:
      - airbyte_internal
    environment:
      - DATABASE_PASSWORD=${DATABASE_PASSWORD}
      - DATABASE_URL=${DATABASE_URL}
      - DATABASE_USER=${DATABASE_USER}
      - METRIC_CLIENT=${METRIC_CLIENT}
      - OTEL_COLLECTOR_ENDPOINT=${OTEL_COLLECTOR_ENDPOINT}

3. Set Environment Variables: Amend your .env file with the correct values needed by docker-compose.yaml:

PUBLISH_METRICS=true
METRIC_CLIENT=otel
OTEL_COLLECTOR_ENDPOINT=http://otel-collector:4317

4. Re-deploy Airbyte: With the updated configurations, you're ready to deploy your Airbyte application by running docker compose up.

Helm Chart Setup Instructions

Setting up this integration for Airbyte instances deployed with the helm chart involves three straightforward steps:

1. Deploy an OpenTelemetry Collector: Follow the official Kubernetes Getting Started documentation to deploy a collector in your kubernetes cluster.

2. Update the chart values: Modify your values.yaml file in the Airbyte repository to include the metrics-reporter container. This submits Airbyte metrics to the OpenTelemetry collector:

global:
  metrics:
    metricClient: "otel"
    otelCollectorEndpoint: "http://otel-collector.opentelemetry.svc:4317"

metrics:
  enabled: true

note

Update the value of otelCollectorEndpoint with your collector URL.

3. Re-deploy Airbyte: With the updated chart values, you're ready to deploy your Airbyte application by upgrading the chart.