Skip to content
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

Add more usage details in README? #562

Open
JamesKyburz opened this issue Jan 10, 2023 · 2 comments
Open

Add more usage details in README? #562

JamesKyburz opened this issue Jan 10, 2023 · 2 comments
Assignees

Comments

@JamesKyburz
Copy link

The README states that AWS don't recommend using this SDK, however that's not the case if all you want is X-Ray. Also if using Node 18 with ESM handlers, then there currently is no other option than this SDK due to this issue.

https://docs.aws.amazon.com/xray/latest/devguide/xray-instrumenting-your-app.html#xray-instrumenting-choosing

We recommend choosing an X-Ray SDK for instrumenting your application if you need the following:

  • A tightly integrated single-vendor solution

  • Integration with X-Ray centralized sampling rules, including the ability to configure sampling rules from the X-Ray console and automatically use them across multiple hosts, when using Node.js, Python, Ruby, or .NET

@willarmiros
Copy link
Contributor

Hi @JamesKyburz - thanks for pointing this out. We need to better align our documentation in these two places to reflect the latest AWS recommendation.

@willarmiros
Copy link
Contributor

We are updating our documentation now to address the first issue. Regarding the ESM handler issue, can this SDK be used for ESM module applications? My understanding is we require you to wrap require statements, and that there is no workaround to do the same wrapping for ESM imports.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants