Skip to content

Update doc for synthetics-private-locations#601

Merged
melkouri merged 4 commits into
mainfrom
malak.elkouri/add-synthetics-doc
Jul 2, 2026
Merged

Update doc for synthetics-private-locations#601
melkouri merged 4 commits into
mainfrom
malak.elkouri/add-synthetics-doc

Conversation

@melkouri

@melkouri melkouri commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Adds documentation for using Synthetics Private Locations with the Disaster Recovery (DDR) setup.

Description of the Change

Adds docs/synthetics-private-locations.md, a guide explaining how to replicate Synthetics Private Locations from a source to a destination org using datadog-sync-cli, and how to configure the PL worker's datadogHostOverride for failover. Updates the README to list synthetics_private_locations as a supported resource with a link to the new guide.

@melkouri
melkouri marked this pull request as ready for review June 30, 2026 14:50
@melkouri
melkouri requested a review from a team as a code owner June 30, 2026 14:50
@datadog-official

datadog-official Bot commented Jun 30, 2026

Copy link
Copy Markdown

Pipelines

Fix all issues with BitsAI

⚠️ Warnings

🚦 2 Pipeline jobs failed

Ensure labels | changelog   View in Datadog   GitHub Actions

Run Integrations Tests | test-integrations   View in Datadog   GitHub Actions

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 1c09f48 | Docs | Datadog PR Page | Give us feedback!

Comment thread docs/synthetics-private-locations.md Outdated

1. **Confirm the PL appears in both orgs.** Check the Synthetics → Settings → Private
Locations page in each org. The PL should be listed with the same name in both.
2. **Confirm the worker reports.** The PL should show as healthy in both orgs once the

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree with it because a PL can only be reporting to main DCs (and so one org) at a time. During the exercice only the DC where the override CNAME was point to, had an "healthy" PL

Comment thread docs/synthetics-private-locations.md Outdated
worker starts polling. If it only reports in one, double-check that the CNAME's current
DNS target is the region you expect.
3. **Run a test.** Create a test in either org targeting the replicated PL, unpause it,
and confirm results appear. During steady state, results land in your primary region;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same the result will appear only in the org/main DC that the CNAME used in datadogHostOverride parameter is resolving to.

Comment thread docs/synthetics-private-locations.md Outdated
Comment on lines +67 to +88
--datadog-host-override <your-failover-cname>.synthetics.datadoghq.com
```

### The `--datadog-host-override` flag

When you replicate a PL into the destination org, the tool needs to know which intake
hostname the destination-side PL should report to. You pass this via the
`--datadog-host-override` flag (or `DD_DATADOG_HOST_OVERRIDE` env var).

The value should be the **CNAME** that your DNS controls — the one whose target you flip
when failing over from one region to another. Example:

```bash
--datadog-host-override <your-failover-cname>.synthetics.datadoghq.com
```

That CNAME gets stored as `datadogHostOverride` in the destination PL's config, which the
worker then picks up.

If you don't pass the flag, the destination PL gets created without a `datadogHostOverride`,
which means the worker will fall back to the standard region intake for the secondary org.
That's usually **not** what you want for a failover setup — pass the flag.

@aletournel aletournel Jun 30, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed this part maybe simplified or removed as we probably don't need to take care of the datadogHostOverride during the sync.

The next section Configuring datadogHostOverride on your PL workers is what actually matter

melkouri and others added 3 commits June 30, 2026 17:43
…erride from sync command

- PL worker reports to only one datacenter at a time (the one the CNAME resolves to), not both simultaneously
- Remove --datadog-host-override flag from datadog-sync-cli examples; datadogHostOverride is configured on the worker, not the CLI
- Fix verifying steps to reflect that only the active region's org shows the PL as healthy

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
@melkouri
melkouri requested a review from aletournel July 1, 2026 09:13

@aletournel aletournel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@melkouri
melkouri merged commit 38cfcaf into main Jul 2, 2026
10 of 15 checks passed
@melkouri
melkouri deleted the malak.elkouri/add-synthetics-doc branch July 2, 2026 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants