Structlog and Loguru Handlers with Examples

[carolinecgilbert]

Description

Implemented unit tests for an existing structlog handler PR and implemented a log handler for the Loguru logging library located in the handlers directory. The tests are located in the opentelemetry-instrumentation-logging test_logging.py file to be compatible with the tox testing framework.

Built basic example OTel applications that use the structlog and loguru handlers to provide guidance on how to implement the handlers.

Dependencies Required: structlog, loguru

Fixes # (issue) https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2139

Type of change

Please delete options that are not relevant.

• [ ] New feature (non-breaking change which adds functionality)
• [ ] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• [ ] Implemented handler unit tests in existing test_logging.py file in the tox framework
• [ ] tox -e test-instrumentation-logging

Does This PR Require a Core Repo Change?

• [ ] No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

• [x] Followed the style guidelines of this project
• [ ] Changelogs have been updated
• [x] Unit tests have been added
• [x] Documentation has been updated

[linux-foundation-easycla[bot]]

• :white_check_mark:login: MigCast9 / (4e18784d5a4c43f757518bc35b8d6a3eaa23768a)
• :white_check_mark:login: MigCast9 / (4e18784d5a4c43f757518bc35b8d6a3eaa23768a, 21e5c621dd82741c88c5c8bd88b57f07d062f330)
• :white_check_mark:login: MigCast9 / (4e18784d5a4c43f757518bc35b8d6a3eaa23768a, 21e5c621dd82741c88c5c8bd88b57f07d062f330, 39cde552779f00c65c516913b48b410d2c0552f9)
• :white_check_mark:login: MigCast9 / (4e18784d5a4c43f757518bc35b8d6a3eaa23768a, 21e5c621dd82741c88c5c8bd88b57f07d062f330, 39cde552779f00c65c516913b48b410d2c0552f9, 96548d6ee666a71597c13a904119df3b781e91c9)
• :white_check_mark:login: MigCast9 / (4e18784d5a4c43f757518bc35b8d6a3eaa23768a, 21e5c621dd82741c88c5c8bd88b57f07d062f330, 39cde552779f00c65c516913b48b410d2c0552f9, 96548d6ee666a71597c13a904119df3b781e91c9, 804b5795739d69ffbd35b5e8a72e10391c149b79)
• :white_check_mark:login: MigCast9 / (4e18784d5a4c43f757518bc35b8d6a3eaa23768a, 21e5c621dd82741c88c5c8bd88b57f07d062f330, 39cde552779f00c65c516913b48b410d2c0552f9, 96548d6ee666a71597c13a904119df3b781e91c9, 804b5795739d69ffbd35b5e8a72e10391c149b79, 2a84a0862a677cd7c97371fcd98bb3f0828a59c8)
• :white_check_mark:login: MigCast9 / (4e18784d5a4c43f757518bc35b8d6a3eaa23768a, 21e5c621dd82741c88c5c8bd88b57f07d062f330, 39cde552779f00c65c516913b48b410d2c0552f9, 96548d6ee666a71597c13a904119df3b781e91c9, 804b5795739d69ffbd35b5e8a72e10391c149b79, 2a84a0862a677cd7c97371fcd98bb3f0828a59c8, 3d3ae4f43423a52d4be5601d8380e5ea7db3dfef)
• :white_check_mark:login: MigCast9 / (4e18784d5a4c43f757518bc35b8d6a3eaa23768a, 21e5c621dd82741c88c5c8bd88b57f07d062f330, 39cde552779f00c65c516913b48b410d2c0552f9, 96548d6ee666a71597c13a904119df3b781e91c9, 804b5795739d69ffbd35b5e8a72e10391c149b79, 2a84a0862a677cd7c97371fcd98bb3f0828a59c8, 3d3ae4f43423a52d4be5601d8380e5ea7db3dfef, 5a2e2ee95fb8d939c3f73906309e9b7db21eac56)
• :white_check_mark:login: MigCast9 / (4e18784d5a4c43f757518bc35b8d6a3eaa23768a, 21e5c621dd82741c88c5c8bd88b57f07d062f330, 39cde552779f00c65c516913b48b410d2c0552f9, 96548d6ee666a71597c13a904119df3b781e91c9, 804b5795739d69ffbd35b5e8a72e10391c149b79, 2a84a0862a677cd7c97371fcd98bb3f0828a59c8, 3d3ae4f43423a52d4be5601d8380e5ea7db3dfef, 5a2e2ee95fb8d939c3f73906309e9b7db21eac56, 32881cefe476f532b8ba77a18e0cda3f19898339)
• :white_check_mark:login: MigCast9 / (4e18784d5a4c43f757518bc35b8d6a3eaa23768a, 21e5c621dd82741c88c5c8bd88b57f07d062f330, 39cde552779f00c65c516913b48b410d2c0552f9, 96548d6ee666a71597c13a904119df3b781e91c9, 804b5795739d69ffbd35b5e8a72e10391c149b79, 2a84a0862a677cd7c97371fcd98bb3f0828a59c8, 3d3ae4f43423a52d4be5601d8380e5ea7db3dfef, 5a2e2ee95fb8d939c3f73906309e9b7db21eac56, 32881cefe476f532b8ba77a18e0cda3f19898339, 1c92c51815aa3acfe31850ea055712bfbfc1f92c)
• :white_check_mark:login: doshi36 / (2e22c2e7da3bf2d93dd2747142adcba5731e5f5d)
• :white_check_mark:login: doshi36 / (2e22c2e7da3bf2d93dd2747142adcba5731e5f5d, 8515ee07eae70704f2a687b81e2fa958a78286c8)
• :white_check_mark:login: doshi36 / (2e22c2e7da3bf2d93dd2747142adcba5731e5f5d, 8515ee07eae70704f2a687b81e2fa958a78286c8, 3a648981140c8e52433f304370a005f9d9c5ac28)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79, 097be29acc1fa492498b53c4db8703f2054b199b)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79, 097be29acc1fa492498b53c4db8703f2054b199b, 8bf5af44f8fb7d8fa82a264e694a704b4dbe071c)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79, 097be29acc1fa492498b53c4db8703f2054b199b, 8bf5af44f8fb7d8fa82a264e694a704b4dbe071c, 45aa0a3a5b7c80816216a2daaeda95a2a73427f5)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79, 097be29acc1fa492498b53c4db8703f2054b199b, 8bf5af44f8fb7d8fa82a264e694a704b4dbe071c, 45aa0a3a5b7c80816216a2daaeda95a2a73427f5, 952c00377fa871bb08faa684cd9729866c412af1)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79, 097be29acc1fa492498b53c4db8703f2054b199b, 8bf5af44f8fb7d8fa82a264e694a704b4dbe071c, 45aa0a3a5b7c80816216a2daaeda95a2a73427f5, 952c00377fa871bb08faa684cd9729866c412af1, 21e411ed3b66d681a0efbbac7c278a580cde2634)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79, 097be29acc1fa492498b53c4db8703f2054b199b, 8bf5af44f8fb7d8fa82a264e694a704b4dbe071c, 45aa0a3a5b7c80816216a2daaeda95a2a73427f5, 952c00377fa871bb08faa684cd9729866c412af1, 21e411ed3b66d681a0efbbac7c278a580cde2634, 170ba0203afcc2ce89ad6ca5abb5a256b240f618)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79, 097be29acc1fa492498b53c4db8703f2054b199b, 8bf5af44f8fb7d8fa82a264e694a704b4dbe071c, 45aa0a3a5b7c80816216a2daaeda95a2a73427f5, 952c00377fa871bb08faa684cd9729866c412af1, 21e411ed3b66d681a0efbbac7c278a580cde2634, 170ba0203afcc2ce89ad6ca5abb5a256b240f618, a097455030ec8f08169ae3715c1e114c91bf2960)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79, 097be29acc1fa492498b53c4db8703f2054b199b, 8bf5af44f8fb7d8fa82a264e694a704b4dbe071c, 45aa0a3a5b7c80816216a2daaeda95a2a73427f5, 952c00377fa871bb08faa684cd9729866c412af1, 21e411ed3b66d681a0efbbac7c278a580cde2634, 170ba0203afcc2ce89ad6ca5abb5a256b240f618, a097455030ec8f08169ae3715c1e114c91bf2960, e08356566435b7ee0014b57a45ad5ce9bf7bc9c4)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79, 097be29acc1fa492498b53c4db8703f2054b199b, 8bf5af44f8fb7d8fa82a264e694a704b4dbe071c, 45aa0a3a5b7c80816216a2daaeda95a2a73427f5, 952c00377fa871bb08faa684cd9729866c412af1, 21e411ed3b66d681a0efbbac7c278a580cde2634, 170ba0203afcc2ce89ad6ca5abb5a256b240f618, a097455030ec8f08169ae3715c1e114c91bf2960, e08356566435b7ee0014b57a45ad5ce9bf7bc9c4, 4561989ba47824f2b5374c0b79de9c4459f1f581)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79, 097be29acc1fa492498b53c4db8703f2054b199b, 8bf5af44f8fb7d8fa82a264e694a704b4dbe071c, 45aa0a3a5b7c80816216a2daaeda95a2a73427f5, 952c00377fa871bb08faa684cd9729866c412af1, 21e411ed3b66d681a0efbbac7c278a580cde2634, 170ba0203afcc2ce89ad6ca5abb5a256b240f618, a097455030ec8f08169ae3715c1e114c91bf2960, e08356566435b7ee0014b57a45ad5ce9bf7bc9c4, 4561989ba47824f2b5374c0b79de9c4459f1f581, 37ef8f784bcc593465b514133b0dadc916d53c24)
• :white_check_mark:login: carolinecgilbert / (1133701752cd33e0d2c90b43af0e477b6f324ae0, 12a40358aa174aeaf37aaa8a650110d185178e79, 097be29acc1fa492498b53c4db8703f2054b199b, 8bf5af44f8fb7d8fa82a264e694a704b4dbe071c, 45aa0a3a5b7c80816216a2daaeda95a2a73427f5, 952c00377fa871bb08faa684cd9729866c412af1, 21e411ed3b66d681a0efbbac7c278a580cde2634, 170ba0203afcc2ce89ad6ca5abb5a256b240f618, a097455030ec8f08169ae3715c1e114c91bf2960, e08356566435b7ee0014b57a45ad5ce9bf7bc9c4, 4561989ba47824f2b5374c0b79de9c4459f1f581, 37ef8f784bcc593465b514133b0dadc916d53c24, 27bf6d93b4e478e98bc49f08014d38150acfa7f6)

The committers listed above are authorized under a signed CLA.

[xrmx]

Thanks for contributing but all 3 of you need to sign he CLA in order to get the code accepted

[pmcollins]

Thanks for the change. I might be missing some context, but perhaps consider splitting this into two PRs, one for loguru and the other for structlog. Multiple, smaller PRs tend to get through the review process faster than fewer larger ones.

[giulioindev]

Can this be merged if everything is ok?

[xrmx]

Can this be merged if everything is ok?

This should be splitted per https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2492#issuecomment-2203873674

[lzchen]

PR has been abandoned: https://github.com/open-telemetry/opentelemetry-python/issues/2993#issuecomment-2355851358

Anyone can feel free to pick up this work :)

[leonard-henriquez]

If the PR is ready to merge, why not merge it as it is ? @xrmx

[jlugao]

PR has been abandoned: open-telemetry/opentelemetry-python#2993 (comment)

Anyone can feel free to pick up this work :)

@lzchen I'd like to help but I'm a bit at loss with the status and expectations on this issue, I see @znd4 did most of the work here. Can you provide some guidance here on what is missing and what is expected?

I have some time available and a need to use this at the company I'm working for.

On https://github.com/Delgan/loguru/issues/674 there was a discussion about the instrumentation/formatting part of the integration. I'm now researching using an exporter to send logs through grpc/http.

Anyways, how can I help? Should I rebase https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2906 we do a round of review and go from there?