mirror of synced 2026-01-07 09:05:45 -05:00

Files

devin-ai-integration[bot] 34282926a1 docs: Generate version 2.0 of platform documentation (#68102 )

## What

Generates version 2.0 of the Airbyte platform documentation using
Docusaurus's built-in versioning system. This creates a frozen snapshot
of the current documentation that users can reference.

Requested by ian.alton@airbyte.io via [Slack
thread](https://airbytehq-team.slack.com/archives/D08FX8EC9L0/p1760490197805979?thread_ts=1760490197.805979).

Link to Devin run:
https://app.devin.ai/sessions/689693593bac44f4903f476aa17b872e

## How

- Ran `pnpm run docusaurus docs:version:platform 2.0` in the docusaurus
directory
- This automatically:
- Created `platform_versioned_docs/version-2.0/` containing a snapshot
of all current platform docs
- Created `platform_versioned_sidebars/version-2.0-sidebars.json` with
the sidebar navigation structure
  - Updated `platform_versions.json` to add "2.0" to the version list
- Ran prettier to format the JSON files
- Verified the documentation builds successfully locally (build
completed in ~3 minutes with only pre-existing broken anchor warnings)

## Review guide

1. **Verify timing**: Confirm this is the correct time to release
version 2.0 of the documentation
2. **Version order**: Check `docusaurus/platform_versions.json` - verify
"2.0" is first in the array (newest version first)
3. **Build verification**: Ensure CI/Vercel builds pass without errors
4. **Spot check**: Optionally review 2-3 files in
`docusaurus/platform_versioned_docs/version-2.0/` to ensure content
looks reasonable

Note: This is a standard Docusaurus versioning operation that creates a
frozen snapshot of the current "next" documentation. The generated files
are extensive (500+ files) but follow Docusaurus conventions.

## User Impact

Users will see version 2.0 available in the version dropdown on
docs.airbyte.com. This provides a stable reference point for platform
documentation at this point in time. Existing versions (1.6, 1.7, 1.8)
remain unchanged.

## Can this PR be safely reverted and rolled back?

- [x] YES 💚

This is an additive change that doesn't modify existing versioned docs.
Reverting would simply remove version 2.0 from the version list and
delete the associated documentation files.

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>

2025-10-14 18:27:24 -07:00

5.7 KiB

Raw Blame History

products

products
oss-enterprise

OpenTelemetry metrics monitoring

Airbyte Self-Managed Enterprise generates a number of crucial metrics about syncs and volumes of data moved. You can configure Airbyte to send telemetry data to an OpenTelemetry collector endpoint so you can consume these metrics in your downstream monitoring tool of choice. Airbyte doesn't send traces and logs.

Airbyte sends specific metrics to provide you with health insight in the following areas.

Resource provisioning: Monitor API requests and sync attempts to ensure your deployment has adequate resources
Sync performance: Track sync duration and data volume moved to understand performance
System health: Monitor sync status and completion rates to ensure system stability

Example dashboard

Here's an example of a dashboard in Datadog using Airbyte's OpenTelemetry metrics.

Configure OpenTelemetry metrics

Deploy an OpenTelemetry Collector if you don't already have one. See the OpenTelemetry documentation for help doing this. If you use Datadog as your monitoring tool, they have an in-depth guide to set up a Datadog Collector and Exporter.
1. For Airbyte to send metrics to your server, your OpenTelemetry service (collector or otherwise) must accept OpenTelemetry Protocol (OTLP) over HTTP. If you use an OpenTelemetry Collector, your configuration would need to include some variation of the below to accept OTLP over HTTP:
```
receivers:
  otlp:
    protocols:
      http:
        endpoint: 0.0.0.0:4318
```

Update Airbyte's values.yaml file to enable OpenTelemetry.

global:
    edition: enterprise # This is an enterprise-only feature
    metrics:
        enabled: true
        otlp:
            enabled: true
            # The OpenTelemetry Collector endpoint Airbyte sends metrics to. You configure this endpoint outside of Airbyte as part of your OpenTelemetry deployment
            # This endpoint also needs to end in the metrics ingestion endpoint. For OpenTelemetry Collector users, this is /v1/metrics.
            # e.g. http://localhost:4318/v1/metrics
            collectorEndpoint: "YOUR_ENDPOINT"

Redeploy Airbyte with the updated values.

Airbyte sends metrics to the collector you specified in your configuration.

Available metrics

The following metrics are available. They're published every minute.

Metric	Tag	Example Value
`airbyte.syncs`	`connection_id`	653a067e-cd0b-4cab-96b5-5e5cb03f159b
	`workspace_id`	bed3b473-1518-4461-a37f-730ea3d3a848
	`job_id`	23642492
	`status`	success, failed
	`attempt_count`	3
	`source_connector_id`	82c7fb2d-7de1-4d4e-b12e-510b0d61e374
	`destination_connector_id`	3cb42982-755b-4644-9ed4-19651b53ebdd
	`version`	1.5.0
	`service`	airbyte-worker
`airbyte.gb_moved`	`connection_id`	653a067e-cd0b-4cab-96b5-5e5cb03f159b
	`workspace_id`	bed3b473-1518-4461-a37f-730ea3d3a848
	`job_id`	23642492
	`source_connector_id`	82c7fb2d-7de1-4d4e-b12e-510b0d61e374
	`destination_connector_id`	3cb42982-755b-4644-9ed4-19651b53ebdd
	`version`	1.5.0
	`service`	airbyte-worker
`airbyte.sync_duration`	`connection_id`	653a067e-cd0b-4cab-96b5-5e5cb03f159b
	`workspace_id`	bed3b473-1518-4461-a37f-730ea3d3a848
	`job_id`	23642492
	`source_connector_id`	82c7fb2d-7de1-4d4e-b12e-510b0d61e374
	`destination_connector_id`	3cb42982-755b-4644-9ed4-19651b53ebdd
	`version`	1.5.0
	`service`	airbyte-worker
`airbyte.api_requests`	`uri`	/v1/applications/create
	`status`	200
	`exception`	NullPointerException
	`method`	GET, POST
	`version`	1.5.0
	`service`	airbyte-server

5.7 KiB Raw Blame History

OpenTelemetry metrics monitoring

Example dashboard

Configure OpenTelemetry metrics

Available metrics

5.7 KiB

Raw Blame History