Skip to content

Conversation

@TalUsvyatsky
Copy link
Contributor

@TalUsvyatsky TalUsvyatsky commented Oct 30, 2025

What does this PR do? What is the motivation?

This PR updates our documentation for instrumenting lambda functions using the Datadog CDK construct. It addresses a few main issues:

  • Missing documentation for using CDK with .NET, Ruby, and Go lambdas
  • Incorrect documentation for using CDK construct v2 (construct is named DatadogLambda)
  • Existing docs conflate CDK app language with lambda runtime
    • In the Python tab we only show using CDK in Python, in Node.js tab we only show using CDK with Typescript
    • *But then for some reason in the Java tab we show Typescript and Python
    • The correct state is for all runtimes to show support for all three of Typescript, Python, Go
  • CDK Installation docs are duplicated across runtime tabs. This PR pulls it out into a shared component.

Note: The other tools' instructions could use some updates too, to be tackled separately:

  • Ensure CLI, SAM, Terraform support documented for all runtimes
  • Duplicated docs across different runtimes for each tool
  • Inconsistent formatting between runtime pages (see Node.js vs. Ruby for example)

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass 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.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

Additional notes

@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Oct 30, 2025
@TalUsvyatsky TalUsvyatsky changed the title [SVLS-7858] Update Lambda CDK Installation Docs [SVLS-7858] Update lambda CDK installation docs Oct 30, 2025
@TalUsvyatsky TalUsvyatsky marked this pull request as ready for review October 31, 2025 13:16
@TalUsvyatsky TalUsvyatsky requested review from a team as code owners October 31, 2025 13:16

datadogLambda := ddcdkconstruct.NewDatadogLambda(
stack,
jsii.String("Datadog"),

Choose a reason for hiding this comment

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

Do you actually need the jsii.{Type}? Do the built in ones not work?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I think so, without it the compiler complains about untyped constants

Copy link
Collaborator

@bgdeutsch bgdeutsch left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@estherk15 estherk15 merged commit b65ba78 into master Oct 31, 2025
31 of 36 checks passed
@estherk15 estherk15 deleted the tal.usvyatsky/update-cdk-install-lambda-docs branch October 31, 2025 19:02
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants