boto3.py 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. from functools import partial
  2. import sentry_sdk
  3. from sentry_sdk.consts import OP, SPANDATA
  4. from sentry_sdk.integrations import _check_minimum_version, Integration, DidNotEnable
  5. from sentry_sdk.tracing import Span
  6. from sentry_sdk.utils import (
  7. capture_internal_exceptions,
  8. ensure_integration_enabled,
  9. parse_url,
  10. parse_version,
  11. )
  12. from typing import TYPE_CHECKING
  13. if TYPE_CHECKING:
  14. from typing import Any
  15. from typing import Dict
  16. from typing import Optional
  17. from typing import Type
  18. try:
  19. from botocore import __version__ as BOTOCORE_VERSION # type: ignore
  20. from botocore.client import BaseClient # type: ignore
  21. from botocore.response import StreamingBody # type: ignore
  22. from botocore.awsrequest import AWSRequest # type: ignore
  23. except ImportError:
  24. raise DidNotEnable("botocore is not installed")
  25. class Boto3Integration(Integration):
  26. identifier = "boto3"
  27. origin = f"auto.http.{identifier}"
  28. @staticmethod
  29. def setup_once():
  30. # type: () -> None
  31. version = parse_version(BOTOCORE_VERSION)
  32. _check_minimum_version(Boto3Integration, version, "botocore")
  33. orig_init = BaseClient.__init__
  34. def sentry_patched_init(self, *args, **kwargs):
  35. # type: (Type[BaseClient], *Any, **Any) -> None
  36. orig_init(self, *args, **kwargs)
  37. meta = self.meta
  38. service_id = meta.service_model.service_id.hyphenize()
  39. meta.events.register(
  40. "request-created",
  41. partial(_sentry_request_created, service_id=service_id),
  42. )
  43. meta.events.register("after-call", _sentry_after_call)
  44. meta.events.register("after-call-error", _sentry_after_call_error)
  45. BaseClient.__init__ = sentry_patched_init
  46. @ensure_integration_enabled(Boto3Integration)
  47. def _sentry_request_created(service_id, request, operation_name, **kwargs):
  48. # type: (str, AWSRequest, str, **Any) -> None
  49. description = "aws.%s.%s" % (service_id, operation_name)
  50. span = sentry_sdk.start_span(
  51. op=OP.HTTP_CLIENT,
  52. name=description,
  53. origin=Boto3Integration.origin,
  54. )
  55. with capture_internal_exceptions():
  56. parsed_url = parse_url(request.url, sanitize=False)
  57. span.set_data("aws.request.url", parsed_url.url)
  58. span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
  59. span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)
  60. span.set_tag("aws.service_id", service_id)
  61. span.set_tag("aws.operation_name", operation_name)
  62. span.set_data(SPANDATA.HTTP_METHOD, request.method)
  63. # We do it in order for subsequent http calls/retries be
  64. # attached to this span.
  65. span.__enter__()
  66. # request.context is an open-ended data-structure
  67. # where we can add anything useful in request life cycle.
  68. request.context["_sentrysdk_span"] = span
  69. def _sentry_after_call(context, parsed, **kwargs):
  70. # type: (Dict[str, Any], Dict[str, Any], **Any) -> None
  71. span = context.pop("_sentrysdk_span", None) # type: Optional[Span]
  72. # Span could be absent if the integration is disabled.
  73. if span is None:
  74. return
  75. span.__exit__(None, None, None)
  76. body = parsed.get("Body")
  77. if not isinstance(body, StreamingBody):
  78. return
  79. streaming_span = span.start_child(
  80. op=OP.HTTP_CLIENT_STREAM,
  81. name=span.description,
  82. origin=Boto3Integration.origin,
  83. )
  84. orig_read = body.read
  85. orig_close = body.close
  86. def sentry_streaming_body_read(*args, **kwargs):
  87. # type: (*Any, **Any) -> bytes
  88. try:
  89. ret = orig_read(*args, **kwargs)
  90. if not ret:
  91. streaming_span.finish()
  92. return ret
  93. except Exception:
  94. streaming_span.finish()
  95. raise
  96. body.read = sentry_streaming_body_read
  97. def sentry_streaming_body_close(*args, **kwargs):
  98. # type: (*Any, **Any) -> None
  99. streaming_span.finish()
  100. orig_close(*args, **kwargs)
  101. body.close = sentry_streaming_body_close
  102. def _sentry_after_call_error(context, exception, **kwargs):
  103. # type: (Dict[str, Any], Type[BaseException], **Any) -> None
  104. span = context.pop("_sentrysdk_span", None) # type: Optional[Span]
  105. # Span could be absent if the integration is disabled.
  106. if span is None:
  107. return
  108. span.__exit__(type(exception), exception, None)