Skip to content

Update Datadog guides for the reworked upstream example - #1481

Merged
kristin-kronstain-brown merged 9 commits into
mainfrom
kkb-datadog-example-sync
Nov 17, 2026
Merged

kristin-kronstain-brown merged 9 commits into
mainfrom
kkb-datadog-example-sync

Conversation

@kristin-kronstain-brown

@kristin-kronstain-brown kristin-kronstain-brown commented Nov 6, 2026 •

Copy link
Copy Markdown
Collaborator

Updates the Datadog guides for the reworked upstream example in agentgateway/agentgateway#3935, which ships in 1.7.

The guides told readers to run files that #3935 removed: smoke.sh, smoke.py, compose.datadog.yaml, proxy-values.yaml, and controller-values.yaml. They also described an OpenTelemetry Collector the example no longer uses. The example now configures an existing agentgateway installation, uses the HomeHub demo model, and sends traces directly to the Datadog Agent.

Changes

Both datadog.md (Kubernetes) and datadog-standalone.md:

  • Rewrites the intro, prerequisites, "Run the complete example" steps, troubleshooting, and cleanup to match examples/datadog on main.
  • Explains why the example sets use_latest_spec. The proxy check uses true, because without it the Agent parses the proxy's OpenMetrics output as classic Prometheus text and drops every counter. The controller check uses false, because the controller serves classic Prometheus text.
  • Adds a troubleshooting entry: "Gauges appear but counters are missing".
  • Notes that traces from the example omit prompt and completion content.

Kubernetes only:

  • Splits the two port-forwards into separate steps, so later steps and the troubleshooting reference to step 8 are renumbered.
  • Uses the namespace snippet instead of a hardcoded agentgateway-system in commands.

Standalone only:

  • Shows the config.yaml fragment to merge, and notes that the controller widgets stay empty in standalone mode.

The direct trace export sections are unchanged.

Testing

Ran against agentgateway v1.7.0 with the upstream example at main, using a placeholder Datadog API key.

  • Kubernetes (kind): Ran steps 1–8 as written. The request returned the HomeHub reset answer with 12 input and 24 output tokens. The proxy exposed agentgateway_requests_total and agentgateway_gen_ai_client_token_usage. agent check openmetrics --check-rate --discovery-min-instances 2 found both instances, tagged component:proxy and component:controller, and produced agentgateway.requests.count, agentgateway.gen_ai.token.usage.sum, and agentgateway.controller.reconciliations.count.
  • Standalone (Docker Compose + v1.7.0 binary): The documented config.yaml fragment matches upstream and passes --validate-only. Ran steps 1–8 with the same request and metric results. The openmetrics check reported samples tagged component:proxy.
  • Earlier: compared the openmetrics check with and without use_latest_spec against the proxy and controller, and validated the standalone config on v1.6.0.
  • Hugo build passes. The Datadog pages render on 1.6.x, latest, and main for both deployment types, with no references to the removed files.
  • Vale is clean on both pages.
  • CI schema validation passes for datadog-traces-schema and datadog-schema. The remaining CI failures are in files this PR doesn't change (expose-ui.md, dataplane.md gates, and an mcp-authz link).

Not tested, because they need a real Datadog organization: steps 9–10 (Metrics Explorer and the dashboard import) and trace ingestion into Agent Observability. The trace screenshots in datadog-verify.md still show the old example's synthetic model and aren't updated in this PR.

🤖 Generated with Claude Code

Signed-off-by: Kristin Brown <kristin.brown@solo.io>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

Deploying agentproxy with  Cloudflare Pages  Cloudflare Pages

Latest commit: c669ce1
Status: ✅  Deploy successful!
Preview URL: https://cdfb85b8.agentproxy.pages.dev
Branch Preview URL: https://kkb-datadog-example-sync.agentproxy.pages.dev

View logs

Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
@kristin-kronstain-brown kristin-kronstain-brown changed the title Data dog metrics updates Update Datadog guides for the reworked upstream example Nov 17, 2026
Comment on lines +84 to +85
To reuse an existing Gateway, remove the Gateway definition from
`gateway.yaml` and update the other files to refer to your Gateway.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

maybe specify the files

Suggested change
To reuse an existing Gateway, remove the Gateway definition from
`gateway.yaml` and update the other files to refer to your Gateway.
To reuse an existing Gateway, remove the Gateway definition from `gateway.yaml`. Then update the HTTPRoute and AgentgatewayPolicy in that file to refer to your Gateway. Add `spec.infrastructure.parametersRef` to your Gateway that points to the `datadog-observability` AgentgatewayParameters. Without this reference, the proxy has no Datadog annotation and the Agent does not collect proxy metrics.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in 41cb58a. I used your wording, which names the HTTPRoute and AgentgatewayPolicy in gateway.yaml and the parametersRef to datadog-observability.

Comment on lines +87 to +91
The proxy check in `proxy-parameters.yaml` sets `use_latest_spec: true` so
that the Agent parses the proxy's output as OpenMetrics. Without this
setting, the Agent drops every counter. The controller
check in `controller-annotations.yaml` sets `use_latest_spec: false`, because
the controller serves the classic Prometheus text format.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is in the troubleshooting, too, maybe remove it to avoid duplication in one of the places.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Good catch. I removed the use_latest_spec paragraph from step 3 in 41cb58a and kept it in Troubleshooting, under "Gauges appear but counters are missing", where it has the fuller explanation.

To match your deployment, adjust the port and backend addresses.

```yaml
# yaml-language-server: $schema=https://agentgateway.dev/schema/config

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why is this not using the shortcode? same in L177

Suggested change
# yaml-language-server: $schema=https://agentgateway.dev/schema/config
# yaml-language-server: $schema=`{{< reuse "agw-docs/snippets/schema.md" >}}`

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Switched both lines (95 and 177) back to the schema.md reuse shortcode in c669ce1. I left out the backticks, because inside the code fence they would render literally, and to match the other pages that use this snippet.

Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
@kristin-kronstain-brown
kristin-kronstain-brown merged commit 279da10 into main Nov 17, 2026
5 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants