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

docs(tracer): new ignore_endpoint feature #931

Merged

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Dec 31, 2021

Issue #, if available: #910

Description of changes:

Documents new ignore_endpoint feature in Tracer.

from aws_lambda_powertools import Tracer

tracer = Tracer()
# ignore all calls to `ec2.amazon.com`
tracer.ignore_endpoint(hostname="ec2.amazon.com")
# ignore calls to `*.sensitive.com/password` and  `*.sensitive.com/credit-card`
tracer.ignore_endpoint(hostname="*.sensitive.com", urls=["/password", "/credit-card"])


def ec2_api_calls():
    return "suppress_api_responses"

@tracer.capture_lambda_handler
def handler(event, context):
    for x in long_list:
        ec2_api_calls()

Checklist

Breaking change checklist

RFC issue #:

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

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


View rendered docs/core/tracer.md

@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Dec 31, 2021
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Dec 31, 2021
@codecov-commenter
Copy link

Codecov Report

Merging #931 (9ae6ed2) into develop (be15e3c) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #931   +/-   ##
========================================
  Coverage    99.96%   99.96%           
========================================
  Files          118      118           
  Lines         5281     5291   +10     
  Branches       606      608    +2     
========================================
+ Hits          5279     5289   +10     
  Partials         2        2           
Impacted Files Coverage Δ
aws_lambda_powertools/logging/logger.py 100.00% <0.00%> (ø)
aws_lambda_powertools/logging/formatter.py 100.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update be15e3c...9ae6ed2. Read the comment docs.

@heitorlessa heitorlessa merged commit efeedd2 into aws-powertools:develop Dec 31, 2021
@heitorlessa heitorlessa deleted the docs/tracer-ignore-endpoints branch December 31, 2021 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants