refactor httpx instrumentation (#1403)

* refactor httpx instrumentation httpx 0.21 and httpcore 0.14 once again changed how it works, necessitating more special handling. To make this a tad less cumbersome, most of this code has moved into a utils file. To make the structure somewhat sane, httpx got its own package in instrumentation * update changelog

Author: beniwohli

.ci/.jenkins_framework_full.yml

@@ -77,6 +77,7 @@ FRAMEWORK:
  - graphene-2
  - httpx-0.13
  - httpx-0.14
+ - httpx-0.21
  - httpx-newest
  - httplib2-newest
  - sanic-20.12

CHANGELOG.asciidoc

@@ -38,8 +38,10 @@ endif::[]
 
 * Add support for Sanic framework {pull}1390[#1390]
 
-//[float]
-//===== Bug fixes
+[float]
+===== Bug fixes
+
+* fix compatibility issues with httpx 0.21 {pull}1403[#1403]
 
 [[release-notes-6.x]]
 === Python Agent version 6.x

elasticapm/instrumentation/packages/httpx/__init__.py

@@ -0,0 +1,29 @@
+# BSD 3-Clause License
+#
+# Copyright (c) 2021, Elasticsearch BV
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

elasticapm/instrumentation/packages/httpx/async/__init__.py

@@ -0,0 +1,29 @@
+# BSD 3-Clause License
+#
+# Copyright (c) 2021, Elasticsearch BV
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

elasticapm/instrumentation/packages/asyncio/httpcore.py renamed to elasticapm/instrumentation/packages/httpx/async/httpcore.py

@@ -1,6 +1,6 @@
 # BSD 3-Clause License
 #
-# Copyright (c) 2019, Elasticsearch BV
+# Copyright (c) 2021, Elasticsearch BV
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -28,9 +28,9 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-from elasticapm.conf import constants
 from elasticapm.contrib.asyncio.traces import async_capture_span
 from elasticapm.instrumentation.packages.asyncio.base import AsyncAbstractInstrumentedModule
+from elasticapm.instrumentation.packages.httpx import utils
 from elasticapm.traces import DroppedSpan, execution_context
 from elasticapm.utils import default_ports
 from elasticapm.utils.disttracing import TracingOptions
@@ -54,27 +54,8 @@ class HTTPCoreAsyncInstrumentation(AsyncAbstractInstrumentedModule):
  ]
 
  async def call(self, module, method, wrapped, instance, args, kwargs):
- if "method" in kwargs:
- method = kwargs["method"].decode("utf-8")
- else:
- method = args[0].decode("utf-8")
-
- # URL is a tuple of (scheme, host, port, path), we want path
- if "url" in kwargs:
- url = kwargs["url"][3].decode("utf-8")
- else:
- url = args[1][3].decode("utf-8")
-
- headers = None
- if "headers" in kwargs:
- headers = kwargs["headers"]
- if headers is None:
- headers = []
- kwargs["headers"] = headers
-
- scheme, host, port = instance.origin
- scheme = scheme.decode("utf-8")
- host = host.decode("utf-8")
+ url, method, headers = utils.get_request_data(args, kwargs)
+ scheme, host, port, target = url
 
  if port != default_ports.get(scheme):
  host += ":" + str(port)
@@ -104,16 +85,9 @@ async def call(self, module, method, wrapped, instance, args, kwargs):
  trace_parent = transaction.trace_parent.copy_from(
  span_id=parent_id, trace_options=TracingOptions(recorded=True)
  )
- self._set_disttracing_headers(headers, trace_parent, transaction)
+ utils.set_disttracing_headers(headers, trace_parent, transaction)
  response = await wrapped(*args, **kwargs)
- if len(response) > 4:
- # httpcore < 0.11.0
- # response = (http_version, status_code, reason_phrase, headers, stream)
- status_code = response[1]
- else:
- # httpcore >= 0.11.0
- # response = (status_code, headers, stream, ext)
- status_code = response[0]
+ status_code = utils.get_status(response)
  if status_code:
  if span.context:
  span.context["http"]["status_code"] = status_code
@@ -125,18 +99,6 @@ def mutate_unsampled_call_args(self, module, method, wrapped, instance, args, kw
  trace_parent = transaction.trace_parent.copy_from(
  span_id=transaction.id, trace_options=TracingOptions(recorded=False)
  )
- if "headers" in kwargs:
- headers = kwargs["headers"]
- if headers is None:
- headers = []
- kwargs["headers"] = headers
- self._set_disttracing_headers(headers, trace_parent, transaction)
+ headers = utils.get_request_data(args, kwargs)[2]
+ utils.set_disttracing_headers(headers, trace_parent, transaction)
  return args, kwargs
-
- def _set_disttracing_headers(self, headers, trace_parent, transaction):
- trace_parent_str = trace_parent.to_string()
- headers.append((bytes(constants.TRACEPARENT_HEADER_NAME, "utf-8"), bytes(trace_parent_str, "utf-8")))
- if transaction.tracer.config.use_elastic_traceparent_header:
- headers.append((bytes(constants.TRACEPARENT_LEGACY_HEADER_NAME, "utf-8"), bytes(trace_parent_str, "utf-8")))
- if trace_parent.tracestate:
- headers.append((bytes(constants.TRACESTATE_HEADER_NAME, "utf-8"), bytes(trace_parent.tracestate, "utf-8")))

elasticapm/instrumentation/packages/asyncio/httpx.py renamed to elasticapm/instrumentation/packages/httpx/async/httpx.py

@@ -0,0 +1,29 @@
+# BSD 3-Clause License
+#
+# Copyright (c) 2021, Elasticsearch BV
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

elasticapm/instrumentation/packages/httpx/sync/__init__.py

@@ -1,6 +1,6 @@
 # BSD 3-Clause License
 #
-# Copyright (c) 2019, Elasticsearch BV
+# Copyright (c) 2021, Elasticsearch BV
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -28,8 +28,8 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-from elasticapm.conf import constants
 from elasticapm.instrumentation.packages.base import AbstractInstrumentedModule
+from elasticapm.instrumentation.packages.httpx import utils
 from elasticapm.traces import DroppedSpan, capture_span, execution_context
 from elasticapm.utils import default_ports
 from elasticapm.utils.disttracing import TracingOptions
@@ -41,37 +41,18 @@ class HTTPCoreInstrumentation(AbstractInstrumentedModule):
  instrument_list = [
  ("httpcore._sync.connection", "SyncHTTPConnection.request"), # < httpcore 0.13
  ("httpcore._sync.connection", "SyncHTTPConnection.handle_request"), # >= httpcore 0.13
+ ("httpcore._sync.connection", "HTTPConnection.handle_request"), # httpcore >= 0.14 (hopefully...)
  ]
 
  def call(self, module, method, wrapped, instance, args, kwargs):
- if "method" in kwargs:
- method = kwargs["method"].decode("utf-8")
- else:
- method = args[0].decode("utf-8")
-
- # URL is a tuple of (scheme, host, port, path), we want path
- if "url" in kwargs:
- url = kwargs["url"][3].decode("utf-8")
- else:
- url = args[1][3].decode("utf-8")
-
- headers = None
- if "headers" in kwargs:
- headers = kwargs["headers"]
- if headers is None:
- headers = []
- kwargs["headers"] = headers
-
- scheme, host, port = instance.origin
- scheme = scheme.decode("utf-8")
- host = host.decode("utf-8")
-
+ url, method, headers = utils.get_request_data(args, kwargs)
+ scheme, host, port, target = url
  if port != default_ports.get(scheme):
  host += ":" + str(port)
 
  signature = "%s %s" % (method.upper(), host)
 
- url = "%s://%s%s" % (scheme, host, url)
+ url = "%s://%s%s" % (scheme, host, target)
 
  transaction = execution_context.get_transaction()
 
@@ -94,18 +75,11 @@ def call(self, module, method, wrapped, instance, args, kwargs):
  trace_parent = transaction.trace_parent.copy_from(
  span_id=parent_id, trace_options=TracingOptions(recorded=True)
  )
- self._set_disttracing_headers(headers, trace_parent, transaction)
+ utils.set_disttracing_headers(headers, trace_parent, transaction)
  if leaf_span:
  leaf_span.dist_tracing_propagated = True
  response = wrapped(*args, **kwargs)
- if len(response) > 4:
- # httpcore < 0.11.0
- # response = (http_version, status_code, reason_phrase, headers, stream)
- status_code = response[1]
- else:
- # httpcore >= 0.11.0
- # response = (status_code, headers, stream, ext)
- status_code = response[0]
+ status_code = utils.get_status(response)
  if status_code:
  if span.context:
  span.context["http"]["status_code"] = status_code
@@ -124,11 +98,3 @@ def mutate_unsampled_call_args(self, module, method, wrapped, instance, args, kw
  kwargs["headers"] = headers
  self._set_disttracing_headers(headers, trace_parent, transaction)
  return args, kwargs
-
- def _set_disttracing_headers(self, headers, trace_parent, transaction):
- trace_parent_str = trace_parent.to_string()
- headers.append((bytes(constants.TRACEPARENT_HEADER_NAME, "utf-8"), bytes(trace_parent_str, "utf-8")))
- if transaction.tracer.config.use_elastic_traceparent_header:
- headers.append((bytes(constants.TRACEPARENT_LEGACY_HEADER_NAME, "utf-8"), bytes(trace_parent_str, "utf-8")))
- if trace_parent.tracestate:
- headers.append((bytes(constants.TRACESTATE_HEADER_NAME, "utf-8"), bytes(trace_parent.tracestate, "utf-8")))

elasticapm/instrumentation/packages/httpcore.py renamed to elasticapm/instrumentation/packages/httpx/sync/httpcore.py

@@ -0,0 +1,87 @@
+# BSD 3-Clause License
+#
+# Copyright (c) 2021, Elasticsearch BV
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+from typing import Tuple
+
+from elasticapm.conf import constants
+
+
+def get_request_data(args, kwargs) -> Tuple[Tuple[str, str, int, str], str, list]:
+ if len(args) == 1 and hasattr(args[0], "method"):
+ # httpcore >= 0.14
+ request = args[0]
+ method = request.method.decode("utf-8")
+ headers = request.headers
+ url = (
+ request.url.scheme.decode("utf-8"),
+ request.url.host.decode("utf-8"),
+ request.url.port,
+ request.url.target.decode("utf-8"),
+ )
+ else:
+ if "method" in kwargs:
+ method = kwargs["method"].decode("utf-8")
+ else:
+ method = args[0].decode("utf-8")
+
+ # URL is a tuple of (scheme, host, port, path)
+ if "url" in kwargs:
+ url = kwargs["url"]
+ else:
+ url = args[1]
+ url = (url[0].decode("utf-8"), url[1].decode("utf-8"), url[2], url[3].decode("utf-8"))
+ print(kwargs)
+ if "headers" in kwargs:
+ headers = kwargs["headers"]
+ else:
+ headers = []
+ return url, method, headers
+
+
+def get_status(response) -> int:
+ if hasattr(response, "status"): # httpcore >= 0.14
+ status_code = response.status
+ elif len(response) > 4:
+ # httpcore < 0.11.0
+ # response = (http_version, status_code, reason_phrase, headers, stream)
+ status_code = response[1]
+ else:
+ # httpcore >= 0.11.0
+ # response = (status_code, headers, stream, ext)
+ status_code = response[0]
+ return status_code
+
+
+def set_disttracing_headers(headers, trace_parent, transaction):
+ trace_parent_str = trace_parent.to_string()
+ headers.append((bytes(constants.TRACEPARENT_HEADER_NAME, "utf-8"), bytes(trace_parent_str, "utf-8")))
+ if transaction.tracer.config.use_elastic_traceparent_header:
+ headers.append((bytes(constants.TRACEPARENT_LEGACY_HEADER_NAME, "utf-8"), bytes(trace_parent_str, "utf-8")))
+ if trace_parent.tracestate:
+ headers.append((bytes(constants.TRACESTATE_HEADER_NAME, "utf-8"), bytes(trace_parent.tracestate, "utf-8")))