-
Notifications
You must be signed in to change notification settings - Fork 497
docs(contrib/aws/datadog-lambda-go): docs(contrib/aws/datadog-lambda-… #4378
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
base: main
Are you sure you want to change the base?
Conversation
…go): add README with migration guidance
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files🚀 New features to boost your workflow:
|
BenchmarksBenchmark execution time: 2026-01-26 22:06:27 Comparing candidate commit d36a736 in PR branch Found 0 performance improvements and 0 performance regressions! Performance is the same for 155 metrics, 9 unstable metrics. |
joeyzhao2018
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
| Although Go tracer v1 remains available, Datadog recommends using v2, which is the | ||
| primary supported version. See the | ||
| [migration instructions](https://docs.datadoghq.com/tracing/trace_collection/custom_instrumentation/go/migration/#migration-instructions) | ||
| for guidance on upgrading from v1 to v2. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This only includes migrating the tracer. It does not include migrating any datadog-lambda-go code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Dogbu-cyber can we change this paragraph to
Although Go tracer v1 remains available, Datadog recommends using v2, which is the
primary supported version.
If you are upgrading a Go AWS Lambda function that previously used the legacy
datadog-lambda-go repository, simply replace go get github.com/DataDog/datadog-lambda-go to go get github.com/DataDog/dd-trace-go/contrib/aws/datadog-lambda-go/v2 for installation and also replace any import references from github.com/DataDog/datadog-lambda-go to github.com/DataDog/dd-trace-go/contrib/aws/datadog-lambda-go/v2.
Please follow the installation instructions for more details.
For general migration from dd-trace-go v1 to v2, follow this migration instructions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@joeyzhao2018 I've made this change now.
c93b827 to
3834015
Compare
3834015 to
d36a736
Compare
|
✅ Tests 🎉 All green!❄️ No new flaky tests detected 🔗 Commit SHA: 40d911b | Docs | Datadog PR Page | Was this helpful? Give us feedback! |
…go): replaced migration instructions with joey's suggestion
| ```go | ||
| go get github.com/DataDog/dd-trace-go/contrib/aws/datadog-lambda-go/v2 | ||
| ``` | ||
| for installation and also replace any import references from github.com/DataDog/datadog-lambda-go to github.com/DataDog/dd-trace-go/contrib/aws/datadog-lambda-go/v2. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we give these as code samples as well? Hold their hand through it.
| If you are upgrading a Go AWS Lambda function that previously used the legacy | ||
| datadog-lambda-go repository, simply replace | ||
|
|
||
| ```go |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ```go | |
| ```bash |
| go get github.com/DataDog/datadog-lambda-go | ||
| ``` | ||
| with | ||
| ```go |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ```go | |
| ```bash |
| ``` | ||
| for installation and also replace any import references from github.com/DataDog/datadog-lambda-go to github.com/DataDog/dd-trace-go/contrib/aws/datadog-lambda-go/v2. | ||
|
|
||
| Follow the [installation instructions](https://docs.datadoghq.com/serverless/aws_lambda/instrumentation/go/?tab=datadogui) for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is another step that they must take, then we should make this a numbered list.
…go): add README with migration guidance
What does this PR do?
This PR adds a README to the Go Lambda package in
dd-trace-goand documents therecommended use of Go tracer v2, including a link to the migration instructions
for upgrading from Go tracer v1 to v2.
Motivation
https://datadoghq.atlassian.net/browse/APMSVLS-315
Improve the migration experience for users moving from the deprecated
datadog-lambda-gorepository by adding clear documentation and links to theGo tracer v2 migration guide.
Reviewer's Checklist
./scripts/lint.shlocally.Unsure? Have a question? Request a review!