Skip to content

Feature/add boto3 sqs instrumentation #2

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

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

oxeye-nikolay
Copy link
Owner

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 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

  • Test A

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

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

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

@oxeye-nikolay oxeye-nikolay self-assigned this May 3, 2022
# limitations under the License.
from typing import Collection

_instruments: Collection[str] = ("boto3 >= 1.21.46",)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't this support older versions?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied the one from boto3

retval = super(
Boto3SQSInstrumentor.ContextableList, self
).__getitem__(*args, **kwargs)
if isinstance(retval, dict):
Copy link

@oxeye-yuval oxeye-yuval May 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inverse the if

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

self._did_decorate = False

def _instrument(self, **kwargs: Dict[str, Any]) -> None:
self._did_decorate: bool = False

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not use the is_instrumented_by_opentelemetry function?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is_instrumented_by_opentelemetry defines a different thing. From the code, its basically a switch that prevents calling instrument twice. self._did_decorate defines if the functions of botocore.client.SQS are wrapped (which is not necessarily true because by calling instrument without calling boto3.client("sqs") these functions will not be wrapped)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants