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.

Sign up for GitHub

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

docs: improve tracing doc for sdk instrumentation #1687

Merged
merged 3 commits into from
Jul 4, 2024
Merged

docs: improve tracing doc for sdk instrumentation #1687

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d115f4d
fix tracing links for xray
jeromevdl Jul 4, 2024
e102943
improve tracing links for xray
jeromevdl Jul 4, 2024
594ff95
Merge branch 'main' into docs/tracing-xray-links
jeromevdl Jul 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions docs/core/tracing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,9 +376,24 @@ under a subsegment, or you are doing multithreaded programming. Refer examples b

## Instrumenting SDK clients and HTTP calls

User should make sure to instrument the SDK clients explicitly based on the function dependency. Refer details on
Powertools for Lambda (Java) cannot intercept SDK clients instantiation to add X-Ray instrumentation. You should make sure to instrument the SDK clients explicitly. Refer details on
[how to instrument SDK client with Xray](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java.html#xray-sdk-java-awssdkclients)
and [outgoing http calls](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java.html#xray-sdk-java-httpclients).
and [outgoing http calls](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java.html#xray-sdk-java-httpclients). For example:

=== "LambdaHandler.java"

```java hl_lines="1 2 7"
import com.amazonaws.xray.AWSXRay;
import com.amazonaws.xray.handlers.TracingHandler;

public class LambdaHandler {
private AmazonDynamoDB client = AmazonDynamoDBClientBuilder.standard()
.withRegion(Regions.fromName(System.getenv("AWS_REGION")))
.withRequestHandlers(new TracingHandler(AWSXRay.getGlobalRecorder()))
.build();
// ...
}
```

## Testing your code

Expand Down
Loading