Skip to content

DOCS-10600: Tracing API Gateway #28916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 5, 2025
Merged

Conversation

cswatt
Copy link
Contributor

@cswatt cswatt commented Apr 22, 2025

What does this PR do? What is the motivation?

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

@cswatt cswatt added the WORK IN PROGRESS No review needed, it's a wip ;) label Apr 22, 2025
@cswatt cswatt requested review from a team as code owners April 22, 2025 19:03
@github-actions github-actions bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR labels Apr 22, 2025
Copy link
Contributor

github-actions bot commented Apr 22, 2025

@github-actions github-actions bot added the Guide Content impacting a guide label Apr 24, 2025
@cswatt cswatt added editorial review Waiting on a more in-depth review and removed WORK IN PROGRESS No review needed, it's a wip ;) labels Apr 24, 2025
@cswatt
Copy link
Contributor Author

cswatt commented Apr 24, 2025

Added DOCS-10711 to track docs review.

Copy link
Contributor

@nevilgeorge nevilgeorge left a comment

Choose a reason for hiding this comment

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

one small comment but nothing blocking approval

Comment on lines +19 to +20
{{< callout url="#" btn_hidden="true" header="Tracing for Amazon API Gateway is in Preview" >}}
This feature is in Preview.
Copy link
Contributor

Choose a reason for hiding this comment

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

do you think we need both the header and the message? Might be duplicative?

Copy link
Contributor

@domalessi domalessi left a comment

Choose a reason for hiding this comment

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

Just a few minor tweaks. Otherwise, looks great!

API Gateway must pass the following headers in the request for the tracer to create the inferred span:
| header | value |
| ------ | ----- |
| `x-dd-proxy` | `'aws-apigateway'` |
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm removing the quotes to stay consistent with the other things, but I'm not sure if this is required (this is the only guy that doesn't follow the context.* pattern, so I don't know if the quotes were intentional/appropriate).

Suggested change
| `x-dd-proxy` | `'aws-apigateway'` |
| `x-dd-proxy` | `aws-apigateway` |

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yup—the quotes should be kept on this one

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
@cswatt cswatt requested a review from domalessi May 2, 2025 23:05
Copy link
Contributor

@brooklynebkbk brooklynebkbk left a comment

Choose a reason for hiding this comment

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

Updated pages look good to me!

I'm seeing the API Gateway logo on the Tracing Proxies page and it's linking to the new docs as expected

https://docs-staging.datadoghq.com/cswatt/aws-api-gateway/tracing/trace_collection/proxy_setup/

@cswatt
Copy link
Contributor Author

cswatt commented May 5, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented May 5, 2025

View all feedbacks in Devflow UI.

2025-05-05 19:38:36 UTC ℹ️ Start processing command /merge


2025-05-05 19:38:42 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in master is approximately 20m (p90).


2025-05-05 19:56:34 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 025f370 into master May 5, 2025
14 of 17 checks passed
@dd-mergequeue dd-mergequeue bot deleted the cswatt/aws-api-gateway branch May 5, 2025 19:56
aldrickdev pushed a commit that referenced this pull request May 7, 2025
* initial commit

* adding  further reading

* removing button

* splitting column

* edits

* update

* add link

* Apply suggestions from code review

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>

---------

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
estherk15 pushed a commit that referenced this pull request May 8, 2025
* initial commit

* adding  further reading

* removing button

* splitting column

* edits

* update

* add link

* Apply suggestions from code review

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>

---------

Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review Guide Content impacting a guide Images Images are added/removed with this PR mergequeue-status: done
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants