feat(tracer): Support for external observability providers - Tracer #2342

roger-zhangg · 2023-05-30T20:29:49Z

Issue number:
2030

Summary

Support provider in tracer

Changes

Modify the provider with more genreral tracer feature, provide a new x-ray provider.

User experience

This change doesn't affect users who just use default x-ray provider.
This change allows users to bring their own tracer provider to use other solution provider other than X-ray

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Meet tenets criteria
I have performed a self-review of this change
Changes have been tested
Changes are documented
PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

Migration process documented
Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

roger-zhangg · 2023-05-30T20:36:43Z

Drafted the first PR for tracer provider.

Provided a more general Tracer Provider interface.
Drafted a x-ray provider
I wasn't included in the initial discussions in this projects so I might have missed something.

Questions:

Decide how to refactor BaseSegment Class
Check on current x-ray provider's design.(Doesn't support add_span, end_span)
In the RFC there's a capture_method function included in the provider. But currently this function is in Tracer class. Do we need to move it into our provider?

codecov-commenter · 2024-01-31T21:32:31Z

Codecov Report

Attention: Patch coverage is 74.54545% with 28 lines in your changes are missing coverage. Please review.

Project coverage is 95.71%. Comparing base (e14e768) to head (aeaf6ff).
Report is 300 commits behind head on develop.

Files	Patch %	Lines
...da_powertools/tracing/provider/xray/xray_tracer.py	69.23%	17 Missing and 3 partials ⚠️
aws_lambda_powertools/tracing/tracer.py	69.56%	7 Missing ⚠️
aws_lambda_powertools/tracing/base.py	0.00%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2342      +/-   ##
===========================================
- Coverage    96.38%   95.71%   -0.67%     
===========================================
  Files          214      218       +4     
  Lines        10030    10485     +455     
  Branches      1846     1944      +98     
===========================================
+ Hits          9667    10036     +369     
- Misses         259      332      +73     
- Partials       104      117      +13

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…s-python into tracer

…ls-python into tracer

roger-zhangg · 2024-04-12T22:52:20Z

@rubenfonseca Thanks for the super detailed feedback. I've resolved all the comments now. Please help with a final review, thanks.

rubenfonseca

Super good progress! Just left some tiny picks and some questions on breaking changes. @leandrodamascena can you help implement the changes so we commit quickly?

rubenfonseca · 2024-04-17T09:53:19Z

examples/tracer/src/sdk_escape_hatch.py

@@ -11,7 +11,7 @@ def collect_payment(charge_id: str) -> str:
 @tracer.capture_lambda_handler
 def lambda_handler(event: dict, context: LambdaContext) -> str:
    charge_id = event.get("charge_id", "")
-    with tracer.provider.in_subsegment("## collect_payment") as subsegment:
+    with tracer.provider.in_subsegment("## collect_payment") as subsegment:  # type: ignore


We should review this to make sure we don't have a typing breaking change

rubenfonseca · 2024-04-17T11:04:52Z

aws_lambda_powertools/tracing/tracer.py

@@ -177,6 +178,36 @@ def __init__(
        if self._is_xray_provider():
            self._disable_xray_trace_batching()

+    def set_attribute(self, key: str, value: Any, **kwargs):
+        """Set attribute on current active span with a key-value pair.


Suggested change

"""Set attribute on current active span with a key-value pair.

"""Set an attribute on current active span with a key-value pair.

rubenfonseca · 2024-04-17T11:05:05Z

aws_lambda_powertools/tracing/tracer.py

+
+        Parameters
+        ----------
+        key : str


Suggested change

key : str

key: str

rubenfonseca · 2024-04-17T11:05:13Z

aws_lambda_powertools/tracing/tracer.py

+        ----------
+        key : str
+            attribute key
+        value : Any


Suggested change

value : Any

value: Any

rubenfonseca · 2024-04-17T11:05:29Z

aws_lambda_powertools/tracing/tracer.py

+
+        Example
+        -------
+        Set attribute for a pseudo service named payment


Suggested change

Set attribute for a pseudo service named payment

Set an attribute for a pseudo service named payment

rubenfonseca · 2024-04-17T11:09:36Z

aws_lambda_powertools/tracing/provider/xray/xray_tracer.py

+        **kwargs,
+    ) -> None:
+        """
+        Set attribute on the current active span with a key-value pair.


Suggested change

Set attribute on the current active span with a key-value pair.

Set an attribute on the current active span with a key-value pair.

rubenfonseca · 2024-04-17T11:09:43Z

aws_lambda_powertools/tracing/provider/xray/xray_tracer.py

+
+        Parameters
+        ----------
+        key : str


Suggested change

key : str

key: str

rubenfonseca · 2024-04-17T11:09:51Z

aws_lambda_powertools/tracing/provider/xray/xray_tracer.py

+        ----------
+        key : str
+            attribute key
+        value : Any


Suggested change

value : Any

value: Any

rubenfonseca · 2024-04-17T11:09:58Z

aws_lambda_powertools/tracing/provider/xray/xray_tracer.py

+            attribute key
+        value : Any
+            Value for attribute
+        category : Literal["Annotation","Metadata","Auto"] = "Auto"


Suggested change

category : Literal["Annotation","Metadata","Auto"] = "Auto"

category: Literal["Annotation","Metadata","Auto"] = "Auto"

rubenfonseca · 2024-04-17T11:12:42Z

aws_lambda_powertools/tracing/base.py

 class BaseSegment(abc.ABC):
    """Holds common properties and methods on segment and subsegment."""

    @abc.abstractmethod
-    def close(self, end_time: Optional[int] = None):
+    def close(self, end_time: Optional[float] = None):


Is this a breaking change? Or are we assuming that no one is inheriting from BaseSegment today?

We will deprecate this in Powertools v3. We're not using this class today, but we never know if customers are, so it's best to revert this change.

Reverted.

sonarcloud · 2024-04-17T15:34:11Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
8.6% Duplication on New Code

See analysis details on SonarCloud

leandrodamascena · 2024-04-17T16:40:25Z

We can consider this PR completed, but we will not merge it now. We'll start conversations about Powertools V3 and add this refactor when we're ready for it:

1 - We will deprecate the BaseSegment in Powertools v3.
2 - This is a potential breaking change for customers who are accessing the XRay methods directly.
3 - We can take this opportunity to standardize method names like trace instead of subsegment in our documentation and ease for customers adopt new Observability providers.

I'm approving this PR and changing it to Draft state just so I don't mess up our stats.

leandrodamascena

Thanks for another stellar job @roger-zhangg! This refactor will open the opportunity to expand the Tracer utility and add more observability providers.

I left a comment explaining why we are approving but not merging this PR right now:
#2342 (comment)

roger-zhangg added 2 commits May 28, 2023 20:08

refactor to standalone tracer class

06c9110

refactor tracer provider, add a xray provider

5eab094

boring-cyborg bot added the tracer Tracer utility label May 30, 2023

pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 30, 2023

roger-zhangg changed the title ~~(feature draft) Support for external observability providers - Tracer~~ feat(Tracer) Support for external observability providers - Tracer May 30, 2023

roger-zhangg changed the title ~~feat(Tracer) Support for external observability providers - Tracer~~ feat(tracer): Support for external observability providers - Tracer May 30, 2023

github-actions bot added the feature New feature or functionality label May 30, 2023

roger-zhangg added 2 commits May 30, 2023 14:47

fix static checking error

cbd75f9

Merge branch 'develop' into tracer

a6c6171

add_dd_poc

927710c

boring-cyborg bot added the dependencies Pull requests that update a dependency file label Feb 6, 2024

roger-zhangg added 3 commits February 15, 2024 19:07

first working POC for dd

e6b3a7c

fix close

dde7b7f

add OPTL POC

da8effc

heitorlessa mentioned this pull request Feb 26, 2024

Add easy support for Datadog and possibly other observability solutions #1433

Open

2 tasks

roger-zhangg and others added 8 commits February 29, 2024 10:48

add new base and xray provider

61f5757

add functional xray provider

0cb8463

Merging from develop

7f8bf6c

Merging from develop

64dd749

Merging from develop

f5fa320

Merge branch 'develop' into tracer

52cab66

fix to pass test

ef7c509

Merge branch 'tracer' of github.com:roger-zhangg/aws-lambda-powertool…

f66ad21

…s-python into tracer

boring-cyborg bot added the tests label Mar 19, 2024

leandrodamascena and others added 2 commits March 19, 2024 15:36

Merging from develop

2c3f42e

fix mypy, move into folder

78051f6

roger-zhangg marked this pull request as ready for review March 20, 2024 00:15

roger-zhangg requested a review from a team as a code owner March 20, 2024 00:15

heitorlessa mentioned this pull request Apr 10, 2024

[Test] Roadmap update reminder - April #4104

Closed

merge from develop

dede79c

roger-zhangg mentioned this pull request Apr 10, 2024

Maintenance: Deprecate tracing.base.BaseProvider #4105

Open

2 tasks

roger-zhangg added 8 commits April 10, 2024 23:35

address ruben comments

844d85b

change to new example

cedb2af

change to new example

ee869b3

docstring in current base class

68ee403

refactor set_attribute, fix test

07714e9

Merge branch 'develop' of github.com:roger-zhangg/aws-lambda-powertoo…

8712a30

…ls-python into tracer

fix poetry

5fb7990

remote print

aeaf6ff

rubenfonseca self-requested a review April 17, 2024 09:43

rubenfonseca suggested changes Apr 17, 2024

View reviewed changes

leandrodamascena added 4 commits April 17, 2024 13:39

Addressing Ruben's feedback

024db25

Reveting possible breaking change

80739fd

Merging from develop

d502dbf

Merging from develop

7efe7e4

leandrodamascena marked this pull request as draft April 17, 2024 16:40

leandrodamascena self-requested a review April 17, 2024 16:40

leandrodamascena approved these changes Apr 17, 2024

View reviewed changes

heitorlessa mentioned this pull request Apr 18, 2024

Roadmap update reminder - undefined #4155

Closed

leandrodamascena mentioned this pull request Apr 24, 2024

RFC: Powertools for AWS Lambda (Python) v3 #4189

Open

2 tasks

This was referenced Apr 29, 2024

Roadmap update reminder - April aws-powertools/actions#2

Closed

Roadmap update reminder - Python aws-powertools/actions#3

Open

Roadmap update reminder - May #4251

Closed

Roadmap update reminder - .NET aws-powertools/actions#11

Open

dreamorosi mentioned this pull request May 7, 2024

Roadmap update reminder - May aws-powertools/actions#23

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(tracer): Support for external observability providers - Tracer #2342

feat(tracer): Support for external observability providers - Tracer #2342

roger-zhangg commented May 30, 2023

roger-zhangg commented May 30, 2023

codecov-commenter commented Jan 31, 2024 •

edited

roger-zhangg commented Apr 12, 2024

rubenfonseca left a comment

rubenfonseca Apr 17, 2024

rubenfonseca Apr 17, 2024

rubenfonseca Apr 17, 2024

rubenfonseca Apr 17, 2024

rubenfonseca Apr 17, 2024

rubenfonseca Apr 17, 2024

rubenfonseca Apr 17, 2024

rubenfonseca Apr 17, 2024

rubenfonseca Apr 17, 2024

rubenfonseca Apr 17, 2024

leandrodamascena Apr 17, 2024

sonarcloud bot commented Apr 17, 2024

leandrodamascena commented Apr 17, 2024

leandrodamascena left a comment

	"""Set attribute on current active span with a key-value pair.
	"""Set an attribute on current active span with a key-value pair.

	Set attribute for a pseudo service named payment
	Set an attribute for a pseudo service named payment

	Set attribute on the current active span with a key-value pair.
	Set an attribute on the current active span with a key-value pair.

	category : Literal["Annotation","Metadata","Auto"] = "Auto"
	category: Literal["Annotation","Metadata","Auto"] = "Auto"

feat(tracer): Support for external observability providers - Tracer #2342

Are you sure you want to change the base?

feat(tracer): Support for external observability providers - Tracer #2342

Conversation

roger-zhangg commented May 30, 2023

Summary

Changes

User experience

Checklist

Acknowledgment

roger-zhangg commented May 30, 2023

codecov-commenter commented Jan 31, 2024 • edited

Codecov Report

roger-zhangg commented Apr 12, 2024

rubenfonseca left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Apr 17, 2024

Quality Gate passed

leandrodamascena commented Apr 17, 2024

leandrodamascena left a comment

Choose a reason for hiding this comment

codecov-commenter commented Jan 31, 2024 •

edited