Docs: wrong documentation for tracer manual mode

[flochaz]

Bug description

Using #326 global examples and especially https://github.com/awslabs/aws-lambda-powertools-typescript/blob/examples/cdk/examples/cdk/lib/example-stack.MyFunction.ts#L43

Subsegment does not seems to be created in xray:

And inline doc is not correct (importing Segment and using Subsegment ... ):

• https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/packages/tracing/src/Tracer.ts#L59
• https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/packages/tracing/src/Tracer.ts#L65

Expected Behavior

To have a subsegment called MySubSegment showing up in xray.

Current Behavior

Just basic segment showing

Possible Solution

Steps to Reproduce

1. branch example/cdk
2. deploy example
3. check xray

Environment

• Powertools version used: 0.1.0-beta-9
• Packaging format (Layers, npm): npm
• AWS Lambda function runtime: NODEJS_14
• Debugging logs: NA

[dreamorosi]

Thanks for raising this, will take a look at it today and let you know!

[dreamorosi]

The examples shown for manual instrumentation in the docs are wrong (my bad - will update them), I've pushed a commit to your PR to provide examples that work & actually create the segments (see screenshots below) and I've also opened a separate issue #334 to expose better APIs as discussed.

Will be closing this for now.

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.