feat(logger): add dynamic logging key support #1505

OGoodness · 2022-09-08T14:32:34Z

Issue number: #1167

Summary

Allows extra keywords provided to logger.xxx to be added to log via append_keys

Changes

Logger subclass extends the _log method, allowing extra keys to be passed in without throwing error due to excess parameters. Routes expected parameters directly to super _log after appending excess keys.

User experience

Nothing is removed from the user, and they can now add logging keys with little effort.

Checklist

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

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

Is this a breaking change?

No

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.

…rtools#1479)

…tools-python into develop * 'develop' of https://github.com/awslabs/aws-lambda-powertools-python: chore(ci): add linter for GitHub Actions as pre-commit hook (aws-powertools#1479) Signed-off-by: heitorlessa <[email protected]>

…s#1480)

…tools-python into develop * 'develop' of https://github.com/awslabs/aws-lambda-powertools-python: chore(ci): add workflow to suggest splitting large PRs (aws-powertools#1480)

…tools-python into develop * 'develop' of https://github.com/awslabs/aws-lambda-powertools-python: update changelog with latest changes

…60 (aws-powertools#1481) Bumps [mypy-boto3-dynamodb](https://github.com/youtype/mypy_boto3_builder) from 1.24.55.post1 to 1.24.60. - [Release notes](https://github.com/youtype/mypy_boto3_builder/releases) - [Commits](https://github.com/youtype/mypy_boto3_builder/commits) --- updated-dependencies: - dependency-name: mypy-boto3-dynamodb dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…60 (aws-powertools#306) Bumps [mypy-boto3-dynamodb](https://github.com/youtype/mypy_boto3_builder) from 1.24.55.post1 to 1.24.60. - [Release notes](https://github.com/youtype/mypy_boto3_builder/releases) - [Commits](https://github.com/youtype/mypy_boto3_builder/commits) --- updated-dependencies: - dependency-name: mypy-boto3-dynamodb dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…s-powertools#1474) Co-authored-by: Ruben Fonseca <[email protected]> Co-authored-by: Leandro Damascena <[email protected]>

)

…owertools-python into develop * 'develop' of https://github.com/heitorlessa/aws-lambda-powertools-python: chore(deps-dev): bump mypy-boto3-dynamodb from 1.24.55.post1 to 1.24.60 (aws-powertools#306)

…ools#1483) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

pyproject.toml isn't being pushed back to trunk as part of release.

…ws-powertools#1455) Co-authored-by: Heitor Lessa <[email protected]>

boring-cyborg · 2022-09-08T14:32:37Z

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our AWS Lambda Powertools Discord: Invite link

github-actions · 2022-09-08T15:15:46Z

No related issues found. Please ensure there is an open issue related to this change to avoid significant delays or closure.

…ls#1507) Bumps [aws-cdk-lib](https://github.com/aws/aws-cdk) from 2.40.0 to 2.41.0. - [Release notes](https://github.com/aws/aws-cdk/releases) - [Changelog](https://github.com/aws/aws-cdk/blob/main/CHANGELOG.v2.md) - [Commits](aws/aws-cdk@v2.40.0...v2.41.0) --- updated-dependencies: - dependency-name: aws-cdk-lib dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

leandrodamascena · 2022-09-09T14:46:40Z

Hi @OGoodness! Thanks for sending this PR and helping to improve the project!

We suggest not removing the Issue number: from the beginning. We use this to run some automation in the PR to keep governance on track. I fixed the labels for now, so it's not a problem anymore. 😄

Before I starting to review this PR, could you please check the errors in the build action and fix them ? You can run make pr locally and check if everything is working. If you have trouble fixing it locally, ping me on Discord and we can do it together.

Thank you 🚀

…ws-powertools#1499) Co-authored-by: Leandro Damascena <[email protected]> Co-authored-by: Heitor Lessa <[email protected]> Co-authored-by: heitorlessa <[email protected]> Co-authored-by: Release bot <[email protected]> Co-authored-by: Peter Schutt <[email protected]> Co-authored-by: Ran Isenberg <[email protected]> Co-authored-by: Ran Isenberg <[email protected]>

OGoodness · 2022-09-09T23:00:10Z

@leandrodamascena
Yeah, I ran make pr originally and everything worked fine on my machine. Looks like it had to do with a parameter that got added in python 3.8 and doesn't exist in python 3.7.

Decided to remove the optional parameter from the input and not pass it in to _log, as it's situational at best, and I believe the Logger already accounts for its feature.

Tested this build using 3.7, so it should be functional

OGoodness · 2022-09-09T23:08:45Z

🤦
Okay, let's try all 3 then. Hopefully this isn't an environment level thing.
(Trying out gitpod for the first time, so don't know how that might play into things)

OGoodness · 2022-09-10T00:14:52Z

Ran mypy individually on 3.7, 3.8, 3.9, then ran make pr. (Originally thought make pr was only for first runs)
This should be good to go @leandrodamascena Sorry for the wait

Notes:

Added python version check in the _log, this is to account for the difference mentioned earlier.
Removed # type: ignore from the super calls. Due to the version check, mypy would always flag one or the other as being an unnecessary ignore
changed exc_info to be Any, as this removes the need for the expected type that is a union of 3+ other types, simpler to set it to any, as that will avoid complexity if the type is ever changed.

leandrodamascena · 2022-09-24T13:40:21Z

Hello @OGoodness! Sorry for the delay in responding, but we were working on some items for v2 and are now I'm ready to work on it.

I see you've fixed most of the bugs in mypy, but I'm still worried about this support in Python 3.7. Could you please write some tests to cover this new code and make sure everything is working as expected?
After that we can work (I can help you) on updating the documentation and merge this PR!

Thank you 🚀

heitorlessa · 2022-10-26T14:36:09Z

As discussed, closing in favour of #1658

heitorlessa and others added 30 commits August 25, 2022 18:21

chore(ci): add linter for GitHub Actions as pre-commit hook (aws-powe…

becb38c

…rtools#1479)

chore(ci): add workflow to suggest splitting large PRs (aws-powertool…

62a976f

…s#1480)

Merge branch 'develop' of https://github.com/awslabs/aws-lambda-power…

e184a8e

…tools-python into develop * 'develop' of https://github.com/awslabs/aws-lambda-powertools-python: chore(ci): add workflow to suggest splitting large PRs (aws-powertools#1480)

docs(layer): upgrade to 1.28.0 (v33)

631c570

update changelog with latest changes

937ed38

fix(ci): event resolution for on_label_added workflow

8a608c5

Merge branch 'develop' of https://github.com/awslabs/aws-lambda-power…

fef99e9

…tools-python into develop * 'develop' of https://github.com/awslabs/aws-lambda-powertools-python: update changelog with latest changes

fix(ci): gracefully and successful exit changelog upon no changes

366b326

update changelog with latest changes

cae9557

chore(ci): enable ci checks for v2

06fb255

fix(ci): ensure PR_AUTHOR is present for large_pr_split workflow

c962046

feat(event_sources): add CloudWatch dashboard custom widget event (aw…

6f8769d

…s-powertools#1474) Co-authored-by: Ruben Fonseca <[email protected]> Co-authored-by: Leandro Damascena <[email protected]>

update changelog with latest changes

ee4b46a

fix(ci): on_label permissioning model & workflow execution

fc791a1

chore(ci): record pr details upon labeling

cd262b9

chore(ci): destructure assignment on comment_large_pr

bca9695

fix(ci): pass core fns to large pr workflow script

5a12125

chore(ci): add note for state persistence on comment_large_pr

74ec893

chore(ci): format comment on comment_large_pr script

973dc46

chore(ci): create reusable docs publishing workflow (aws-powertools#1482

acd7af1

)

chore(ci): create docs workflow for v2

30708d5

chore(ci): create adhoc docs workflow for v2

d09f6d7

chore(ci): create adhoc docs workflow for v2

fe78ae8

chore(deps-dev): bump mkdocs-material from 8.4.1 to 8.4.2 (aws-powert…

a832be8

…ools#1483) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

chore(ci): sync package version with pypi

2cf38cc

pyproject.toml isn't being pushed back to trunk as part of release.

feat(event_handler): improved support for headers and cookies in v2 (a…

c907140

…ws-powertools#1455) Co-authored-by: Heitor Lessa <[email protected]>

github-actions bot added the feature New feature or functionality label Sep 8, 2022

github-actions bot added do-not-merge need-issue PRs that are missing related issues labels Sep 8, 2022

heitorlessa requested review from leandrodamascena and removed request for mploski September 9, 2022 13:32

leandrodamascena removed do-not-merge need-issue PRs that are missing related issues labels Sep 9, 2022

leandrodamascena self-assigned this Sep 9, 2022

ran-isenberg and others added 4 commits September 9, 2022 17:48

update changelog with latest changes

d8b903a

Merge branch 'awslabs:develop' into develop

fbba006

Account for 3.7 compatability

4ab7e5c

OGoodness added 2 commits September 9, 2022 23:58

Handle Version Specific Inputs

e807a34

Removed Useless Ignore, Set Any type for compatability

f7d2562

rubenfonseca force-pushed the develop branch from 340333f to 7002812 Compare September 13, 2022 10:47

heitorlessa added the need-more-information Pending information to continue label Sep 28, 2022

heitorlessa assigned leandrodamascena and unassigned leandrodamascena Sep 28, 2022

heitorlessa linked an issue Oct 3, 2022 that may be closed by this pull request

Logger to support arbitrary key=value style arguments in log statements #1167

Closed

heitorlessa mentioned this pull request Oct 26, 2022

feat(logger): accept arbitrary keyword=value for ephemeral metadata #1658

Merged

7 tasks

heitorlessa closed this Oct 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(logger): add dynamic logging key support #1505

feat(logger): add dynamic logging key support #1505

OGoodness commented Sep 8, 2022 •

edited by leandrodamascena

Loading

boring-cyborg bot commented Sep 8, 2022

github-actions bot commented Sep 8, 2022

leandrodamascena commented Sep 9, 2022 •

edited

Loading

OGoodness commented Sep 9, 2022

OGoodness commented Sep 9, 2022

OGoodness commented Sep 10, 2022

leandrodamascena commented Sep 24, 2022

heitorlessa commented Oct 26, 2022

feat(logger): add dynamic logging key support #1505

feat(logger): add dynamic logging key support #1505

Conversation

OGoodness commented Sep 8, 2022 • edited by leandrodamascena Loading

Summary

Changes

User experience

Checklist

Acknowledgment

boring-cyborg bot commented Sep 8, 2022

github-actions bot commented Sep 8, 2022

leandrodamascena commented Sep 9, 2022 • edited Loading

OGoodness commented Sep 9, 2022

OGoodness commented Sep 9, 2022

OGoodness commented Sep 10, 2022

leandrodamascena commented Sep 24, 2022

heitorlessa commented Oct 26, 2022

OGoodness commented Sep 8, 2022 •

edited by leandrodamascena

Loading

leandrodamascena commented Sep 9, 2022 •

edited

Loading