DOCS-10600: Tracing API Gateway #28916
Conversation
github-actions
bot
added
Architecture
Preview links (active after the
|
|
|
||
| #### Supported versions and web frameworks | ||
|
|
||
| | Runtime | Datadog Tracer version | Frameworks | |
There was a problem hiding this comment.
Let's split Datadog Tracer version into two columns to make it more readable: Datadog tracer and Tracer version.
^ doesn't look very nice.
|
|
||
| ### Prerequisites | ||
| - Amazon API Gateway is configured on your environment. Datadog recommends testing on a development environment before releasing to production. | ||
| - The API Gateway is using the REST API option (API Gateway V1). The HTTP API (V2) is not supported. |
There was a problem hiding this comment.
Let's add relevant hyperlinks.
REST API: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-rest-api.html
HTTP API: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html
There was a problem hiding this comment.
Also, can we be consistent with V1 and V2?
| | Runtime | Datadog Tracer version | Frameworks | | ||
| | ------- | -------------- | ---------- | | ||
| | Node.js | `dd-trace-js` v[4.50.0][1]+ or v[5.26.0][2]+ | express, fastify, hapi, koa, microgateway-core, next, paperplane, restify, router, apollo | | ||
| | Go | `dd-trace-go` v[1.72.1][3]+ | chi.v5 / chi, dimfeld/httptreemux.v5, echo.v4 / echo v4 / echo v3, emicklei/go-restful / go-restful / go-restful.v3, fiber / gofiber/fiber.v2, gin-gonic/gin / Gin, gorilla/mux / Gorilla Mux, julienschmidt/httprouter, valyala/fasthttp.v1, zenazn/goji.v1, 99designs/gqlgen | |
There was a problem hiding this comment.
This list looks messy because we duplicate info.
Here's a list of just the package names, I think it'll be better to just use that.
chi
httptreemux
echo
go-restful
fiber
gin
gorilla mux
httprouter
fasthttp
goji
(I removed gqlgen because it shouldn't have been on this list.)
| | x-dd-proxy | 'aws-apigateway' | | ||
| | x-dd-proxy-request-time-ms | context.requestTimeEpoch | | ||
| | x-dd-proxy-domain-name | context.domainName | | ||
| | x-dd-proxy-httpmethod | context.httpMethod | | ||
| | x-dd-proxy-path | context.path | | ||
| | x-dd-proxy-stage | context.stage | |
There was a problem hiding this comment.
both header and value should be in markdown code formatting.
|
|
||
| --- | ||
|
|
||
| {{< callout url="#" btn_hidden="false" header="Join the Preview" >}} |
There was a problem hiding this comment.
As discussed over Slack, let's remove this button.
It would still be helpful to indicate this is a preview some way though. In the Google Doc documentation, I've been using the following snippet:
Is there a recommended way to indicate a feature is in preview in the official documentation?
What does this PR do? What is the motivation?
Merge instructions
Merge readiness:
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:
Additional notes