diff --git a/.changelog/5194.added b/.changelog/5194.added new file mode 100644 index 00000000000..1844e73578b --- /dev/null +++ b/.changelog/5194.added @@ -0,0 +1 @@ +`opentelemetry-exporter-http-transport`: add 'opentelemetry-exporter-http-transport' package for HTTP exporters diff --git a/.changelog/5219.added b/.changelog/5219.added new file mode 100644 index 00000000000..3576c821d31 --- /dev/null +++ b/.changelog/5219.added @@ -0,0 +1 @@ +`opentelemetry-exporter-otlp-proto-http`: Update exporter to use new HTTP transport package diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index f3fe9675be9..4b19e745044 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -195,6 +195,25 @@ jobs: - name: Run tests run: tox -e lint-opentelemetry-opencensus-shim + lint-opentelemetry-exporter-http-transport: + name: opentelemetry-exporter-http-transport + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.14 + uses: actions/setup-python@v5 + with: + python-version: "3.14" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e lint-opentelemetry-exporter-http-transport + lint-opentelemetry-exporter-opencensus: name: opentelemetry-exporter-opencensus runs-on: ubuntu-latest diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index b481fbfa706..e8369130112 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1414,6 +1414,234 @@ jobs: - name: Run tests run: tox -e py314-test-opentelemetry-opencensus-shim -- -ra + py310-test-opentelemetry-exporter-http-transport-oldest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-oldest 3.10 Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.10 + uses: actions/setup-python@v5 + with: + python-version: "3.10" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py310-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py310-test-opentelemetry-exporter-http-transport-latest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-latest 3.10 Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.10 + uses: actions/setup-python@v5 + with: + python-version: "3.10" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py310-test-opentelemetry-exporter-http-transport-latest -- -ra + + py311-test-opentelemetry-exporter-http-transport-oldest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-oldest 3.11 Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.11 + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py311-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py311-test-opentelemetry-exporter-http-transport-latest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-latest 3.11 Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.11 + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py311-test-opentelemetry-exporter-http-transport-latest -- -ra + + py312-test-opentelemetry-exporter-http-transport-oldest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-oldest 3.12 Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.12 + uses: actions/setup-python@v5 + with: + python-version: "3.12" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py312-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py312-test-opentelemetry-exporter-http-transport-latest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-latest 3.12 Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.12 + uses: actions/setup-python@v5 + with: + python-version: "3.12" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py312-test-opentelemetry-exporter-http-transport-latest -- -ra + + py313-test-opentelemetry-exporter-http-transport-oldest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-oldest 3.13 Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.13 + uses: actions/setup-python@v5 + with: + python-version: "3.13" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py313-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py313-test-opentelemetry-exporter-http-transport-latest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-latest 3.13 Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.13 + uses: actions/setup-python@v5 + with: + python-version: "3.13" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py313-test-opentelemetry-exporter-http-transport-latest -- -ra + + py314-test-opentelemetry-exporter-http-transport-oldest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-oldest 3.14 Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.14 + uses: actions/setup-python@v5 + with: + python-version: "3.14" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py314-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py314-test-opentelemetry-exporter-http-transport-latest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-latest 3.14 Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.14 + uses: actions/setup-python@v5 + with: + python-version: "3.14" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py314-test-opentelemetry-exporter-http-transport-latest -- -ra + + py314t-test-opentelemetry-exporter-http-transport-oldest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-oldest 3.14t Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.14t + uses: actions/setup-python@v5 + with: + python-version: "3.14t" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py314t-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py314t-test-opentelemetry-exporter-http-transport-latest_ubuntu-latest: + name: opentelemetry-exporter-http-transport-latest 3.14t Ubuntu + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.14t + uses: actions/setup-python@v5 + with: + python-version: "3.14t" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py314t-test-opentelemetry-exporter-http-transport-latest -- -ra + py310-test-opentelemetry-exporter-opencensus_ubuntu-latest: name: opentelemetry-exporter-opencensus 3.10 Ubuntu runs-on: ubuntu-latest @@ -4667,6 +4895,258 @@ jobs: - name: Run tests run: tox -e py314-test-opentelemetry-opencensus-shim -- -ra + py310-test-opentelemetry-exporter-http-transport-oldest_windows-latest: + name: opentelemetry-exporter-http-transport-oldest 3.10 Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.10 + uses: actions/setup-python@v5 + with: + python-version: "3.10" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py310-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py310-test-opentelemetry-exporter-http-transport-latest_windows-latest: + name: opentelemetry-exporter-http-transport-latest 3.10 Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.10 + uses: actions/setup-python@v5 + with: + python-version: "3.10" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py310-test-opentelemetry-exporter-http-transport-latest -- -ra + + py311-test-opentelemetry-exporter-http-transport-oldest_windows-latest: + name: opentelemetry-exporter-http-transport-oldest 3.11 Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.11 + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py311-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py311-test-opentelemetry-exporter-http-transport-latest_windows-latest: + name: opentelemetry-exporter-http-transport-latest 3.11 Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.11 + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py311-test-opentelemetry-exporter-http-transport-latest -- -ra + + py312-test-opentelemetry-exporter-http-transport-oldest_windows-latest: + name: opentelemetry-exporter-http-transport-oldest 3.12 Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.12 + uses: actions/setup-python@v5 + with: + python-version: "3.12" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py312-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py312-test-opentelemetry-exporter-http-transport-latest_windows-latest: + name: opentelemetry-exporter-http-transport-latest 3.12 Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.12 + uses: actions/setup-python@v5 + with: + python-version: "3.12" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py312-test-opentelemetry-exporter-http-transport-latest -- -ra + + py313-test-opentelemetry-exporter-http-transport-oldest_windows-latest: + name: opentelemetry-exporter-http-transport-oldest 3.13 Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.13 + uses: actions/setup-python@v5 + with: + python-version: "3.13" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py313-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py313-test-opentelemetry-exporter-http-transport-latest_windows-latest: + name: opentelemetry-exporter-http-transport-latest 3.13 Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.13 + uses: actions/setup-python@v5 + with: + python-version: "3.13" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py313-test-opentelemetry-exporter-http-transport-latest -- -ra + + py314-test-opentelemetry-exporter-http-transport-oldest_windows-latest: + name: opentelemetry-exporter-http-transport-oldest 3.14 Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.14 + uses: actions/setup-python@v5 + with: + python-version: "3.14" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py314-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py314-test-opentelemetry-exporter-http-transport-latest_windows-latest: + name: opentelemetry-exporter-http-transport-latest 3.14 Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.14 + uses: actions/setup-python@v5 + with: + python-version: "3.14" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py314-test-opentelemetry-exporter-http-transport-latest -- -ra + + py314t-test-opentelemetry-exporter-http-transport-oldest_windows-latest: + name: opentelemetry-exporter-http-transport-oldest 3.14t Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.14t + uses: actions/setup-python@v5 + with: + python-version: "3.14t" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py314t-test-opentelemetry-exporter-http-transport-oldest -- -ra + + py314t-test-opentelemetry-exporter-http-transport-latest_windows-latest: + name: opentelemetry-exporter-http-transport-latest 3.14t Windows + runs-on: windows-latest + timeout-minutes: 30 + steps: + - name: Configure git to support long filenames + run: git config --system core.longpaths true + - name: Checkout repo @ SHA - ${{ github.sha }} + uses: actions/checkout@v4 + + - name: Set up Python 3.14t + uses: actions/setup-python@v5 + with: + python-version: "3.14t" + + - name: Install tox + run: pip install tox-uv + + - name: Run tests + run: tox -e py314t-test-opentelemetry-exporter-http-transport-latest -- -ra + py310-test-opentelemetry-exporter-opencensus_windows-latest: name: opentelemetry-exporter-opencensus 3.10 Windows runs-on: windows-latest diff --git a/dev-requirements.txt b/dev-requirements.txt index 9b9727d3402..b472ce3588f 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -1,5 +1,6 @@ pylint==3.3.4 httpretty==1.1.4 +mocket==3.14.1 pyright==1.1.405 sphinx==7.1.2 sphinx-rtd-theme==2.0.0rc4 diff --git a/docs/conf.py b/docs/conf.py index 45fc14df0cf..08a58586b2c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -90,6 +90,7 @@ "wrapt": ("https://wrapt.readthedocs.io/en/latest/", None), "pymongo": ("https://pymongo.readthedocs.io/en/stable/", None), "grpc": ("https://grpc.github.io/grpc/python/", None), + "requests": ("https://requests.readthedocs.io/en/latest/", None), } # http://www.sphinx-doc.org/en/master/config.html#confval-nitpicky @@ -135,6 +136,10 @@ "py:class", "opentelemetry.exporter.otlp.proto.grpc.exporter.OTLPExporterMixin", ), + ( + "py:class", + "opentelemetry.exporter.http.transport._base.BaseHTTPTransport", + ), ( "py:class", "opentelemetry.proto.collector.trace.v1.trace_service_pb2.ExportTraceServiceRequest", diff --git a/eachdist.ini b/eachdist.ini index 09e62be3b22..67fe4ec8706 100644 --- a/eachdist.ini +++ b/eachdist.ini @@ -32,6 +32,7 @@ version=0.63b0.dev packages= opentelemetry-opentracing-shim opentelemetry-opencensus-shim + opentelemetry-exporter-http-transport opentelemetry-exporter-opencensus opentelemetry-exporter-prometheus opentelemetry-exporter-otlp-json-common diff --git a/exporter/opentelemetry-exporter-http-transport/LICENSE b/exporter/opentelemetry-exporter-http-transport/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/exporter/opentelemetry-exporter-http-transport/README.rst b/exporter/opentelemetry-exporter-http-transport/README.rst new file mode 100644 index 00000000000..67dfec0a04e --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/README.rst @@ -0,0 +1,37 @@ +OpenTelemetry Exporters HTTP Transport +====================================== + +|pypi| + +.. |pypi| image:: https://badge.fury.io/py/opentelemetry-exporter-http-transport.svg + :target: https://pypi.org/project/opentelemetry-exporter-http-transport/ + +This package provides shared HTTP transport abstractions and an OTLP HTTP +client used by OpenTelemetry exporters. + +The package has **no required dependencies**. The ``requests`` and ``urllib3`` +transports are available as optional extras. + +Installation +------------ + +Core package (no HTTP backend included):: + + pip install opentelemetry-exporter-http-transport + +With the ``requests`` backend:: + + pip install opentelemetry-exporter-http-transport[requests] + +With the ``urllib3`` backend:: + + pip install opentelemetry-exporter-http-transport[urllib3] + + +References +---------- + +* `OpenTelemetry `_ +* `OpenTelemetry Protocol Specification `_ +* `requests `_ +* `urllib3 `_ diff --git a/exporter/opentelemetry-exporter-http-transport/pyproject.toml b/exporter/opentelemetry-exporter-http-transport/pyproject.toml new file mode 100644 index 00000000000..e2ecb426cbb --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/pyproject.toml @@ -0,0 +1,52 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "opentelemetry-exporter-http-transport" +dynamic = ["version"] +description = "OpenTelemetry Exporters HTTP transport" +readme = "README.rst" +license = "Apache-2.0" +requires-python = ">=3.10" +authors = [ + { name = "OpenTelemetry Authors", email = "cncf-opentelemetry-contributors@lists.cncf.io" }, +] +classifiers = [ + "Development Status :: 4 - Beta", + "Framework :: OpenTelemetry", + "Framework :: OpenTelemetry :: Exporters", + "Intended Audience :: Developers", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", +] +dependencies = [] + +[project.optional-dependencies] +urllib3 = [ + "urllib3 >= 1.26" +] +requests = [ + "requests ~= 2.25" +] + +[project.urls] +Homepage = "https://github.com/open-telemetry/opentelemetry-python/tree/main/exporter/opentelemetry-exporter-http-transport" +Repository = "https://github.com/open-telemetry/opentelemetry-python" + +[tool.hatch.version] +path = "src/opentelemetry/exporter/http/transport/version/__init__.py" + +[tool.hatch.build.targets.sdist] +include = [ + "/src", + "/tests", +] + +[tool.hatch.build.targets.wheel] +packages = ["src/opentelemetry"] diff --git a/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/__init__.py b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/__init__.py new file mode 100644 index 00000000000..e57cf4aba95 --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/__init__.py @@ -0,0 +1,2 @@ +# Copyright The OpenTelemetry Authors +# SPDX-License-Identifier: Apache-2.0 diff --git a/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_base.py b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_base.py new file mode 100644 index 00000000000..a52de97a85c --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_base.py @@ -0,0 +1,50 @@ +# Copyright The OpenTelemetry Authors +# SPDX-License-Identifier: Apache-2.0 + +from abc import ABC, abstractmethod +from dataclasses import dataclass + + +@dataclass(frozen=True, slots=True) +class BaseHTTPResult(ABC): + """Outcome of a single HTTP request made by a :class:`BaseHTTPTransport`. + + Either ``status_code`` and ``reason`` are populated (server responded), + or ``error`` is set (request failed before a response was received). + """ + + status_code: int | None = None + reason: str | None = None + error: Exception | None = None + + @abstractmethod + def is_connection_error(self) -> bool: + """Return ``True`` if the failure is a transport-level connection error.""" + + +class BaseHTTPTransport(ABC): + """Abstract HTTP transport interface used by OTLP HTTP exporters.""" + + @abstractmethod + def request( + self, + method: str, + url: str, + *, + headers: dict[str, str] | None = None, + timeout: float | None = None, + data: bytes | None = None, + ) -> BaseHTTPResult: + """Send an HTTP request and return the result. + + :param method: HTTP method (e.g. ``"POST"``). + :param url: Target URL. + :param headers: Optional HTTP headers to include in the request. + :param timeout: Optional request timeout in seconds. + :param data: Optional request body. + :returns: A :class:`BaseHTTPResult` describing the outcome. + """ + + @abstractmethod + def close(self) -> None: + """Release any resources held by the transport.""" diff --git a/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_otlp_client.py b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_otlp_client.py new file mode 100644 index 00000000000..8d1110a8ed5 --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_otlp_client.py @@ -0,0 +1,203 @@ +# Copyright The OpenTelemetry Authors +# SPDX-License-Identifier: Apache-2.0 + +import enum +import gzip +import logging +import random +import threading +import time +import zlib +from collections.abc import Mapping +from dataclasses import dataclass +from http import HTTPStatus +from io import BytesIO +from typing import Final, Literal + +# pylint: disable-next=import-error +from opentelemetry.exporter.http.transport._base import ( + BaseHTTPResult, + BaseHTTPTransport, +) + +_logger = logging.getLogger(__name__) + +_MAX_RETRIES: Final[int] = 6 + + +def _is_retryable(status_code: int | None) -> bool: + if status_code is None: + return False + if status_code == HTTPStatus.REQUEST_TIMEOUT.value: + return True + if 500 <= status_code <= 599: + return True + return False + + +class Compression(enum.Enum): + NONE = "none" + DEFLATE = "deflate" + GZIP = "gzip" + + @staticmethod + def from_str(value: str) -> "Compression": + match value.strip().lower(): + case "none": + return Compression.NONE + case "deflate": + return Compression.DEFLATE + case "gzip": + return Compression.GZIP + case _: + _logger.warning("Unknown compression type: %s", value) + return Compression.NONE + + +@dataclass(slots=True, frozen=True) +class ExportResult: + """Outcome of an OTLP export attempt, including retry exhaustion.""" + + success: bool + status_code: int | None + reason: str | None + error: Exception | None + + +class OTLPHTTPClient: + """Sends serialized OTLP payloads over HTTP with retry logic. + + Compression, backoff, and connection-error recovery are handled internally. + Callers interact through the :meth:`export` and :meth:`close` methods. + """ + + def __init__( + self, + transport: BaseHTTPTransport, + endpoint: str, + timeout: float, + compression: Compression, + shutdown_event: threading.Event, + headers: Mapping[str, str], + kind: Literal["spans", "logs", "metrics"], + jitter: float = 0.2, + ) -> None: + self._transport = transport + self._endpoint = endpoint + self._timeout = timeout + self._compression = compression + self._shutdown_event = shutdown_event + self._headers = dict(headers) + self._kind = kind + self._jitter = min(max(jitter, 0.0), 1.0) + + def _compute_backoff(self, retry: int) -> float: + return 2**retry * random.uniform(1 - self._jitter, 1 + self._jitter) + + def _compress(self, serialized_data: bytes) -> bytes: + if self._compression is Compression.GZIP: + buf = BytesIO() + with gzip.GzipFile(fileobj=buf, mode="w") as gz: + gz.write(serialized_data) + return buf.getvalue() + if self._compression is Compression.DEFLATE: + return zlib.compress(serialized_data) + return serialized_data + + def _submit(self, data: bytes, timeout: float) -> BaseHTTPResult: + deadline = time.time() + timeout + result = self._transport.request( + "POST", + self._endpoint, + headers=self._headers, + data=data, + timeout=timeout, + ) + if ( + result.error is not None + and result.is_connection_error() + and (remaining := deadline - time.time()) > 0 + ): + # Immediately retry connection errors once without backoff. These + # usually indicate a stale pooled connection that the transport will + # reestablish on the next attempt. + result = self._transport.request( + "POST", + self._endpoint, + headers=self._headers, + data=data, + timeout=remaining, + ) + return result + + def export(self, data: bytes) -> ExportResult: + """Export a serialized payload, retrying on transient failures. + + :param data: Serialized bytes to send. + :returns: An :class:`ExportResult` indicating success or the reason for failure. + """ + data = self._compress(data) + deadline = time.time() + self._timeout + + for retry in range(_MAX_RETRIES): + backoff = self._compute_backoff(retry) + status_code: int | None = None + reason: str | None = None + export_error: Exception | None + retryable: bool + + try: + result = self._submit(data, max(deadline - time.time(), 0.0)) + # pylint: disable-next=broad-exception-caught + except Exception as error: + export_error = error + retryable = False + else: + status_code = result.status_code + reason = result.reason + if status_code is not None and 200 <= status_code < 400: + return ExportResult(True, status_code, reason, None) + export_error = result.error + retryable = ( + _is_retryable(status_code) + if status_code + else result.is_connection_error() + ) + + if not retryable: + _logger.error( + "Failed to export %s batch code: %s, reason: %s", + self._kind, + status_code, + reason or export_error or "unknown", + ) + return ExportResult(False, status_code, reason, export_error) + + if ( + retry + 1 == _MAX_RETRIES + or backoff > (deadline - time.time()) + or self._shutdown_event.is_set() + ): + _logger.error( + "Failed to export %s batch due to timeout, " + "max retries or shutdown.", + self._kind, + ) + return ExportResult(False, status_code, reason, export_error) + + _logger.warning( + "Transient error %s encountered while exporting %s batch, retrying in %.2fs.", + reason or export_error, + self._kind, + backoff, + ) + shutdown = self._shutdown_event.wait(backoff) + if shutdown: + _logger.warning("Shutdown in progress, aborting retry.") + break + + return ExportResult(False, None, None, None) + + def close(self) -> None: + """Close the underlying transport and release its resources.""" + self._transport.close() diff --git a/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_requests.py b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_requests.py new file mode 100644 index 00000000000..fbab43d85b5 --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_requests.py @@ -0,0 +1,98 @@ +# Copyright The OpenTelemetry Authors +# SPDX-License-Identifier: Apache-2.0 + +from __future__ import annotations + +import functools +import warnings +from dataclasses import dataclass +from typing import TYPE_CHECKING + +# pylint: disable-next=import-error +from opentelemetry.exporter.http.transport._base import ( + BaseHTTPResult, + BaseHTTPTransport, +) + +if TYPE_CHECKING: + import requests + + +@functools.cache +def _get_connection_error_types() -> tuple[type[Exception], ...]: + # pylint: disable-next=import-outside-toplevel + import requests.exceptions # noqa: PLC0415 + + return ( + requests.exceptions.ConnectionError, + requests.exceptions.ConnectTimeout, + requests.exceptions.ReadTimeout, + requests.exceptions.Timeout, + requests.exceptions.SSLError, + requests.exceptions.ProxyError, + ) + + +@dataclass(frozen=True, slots=True) +class RequestsHTTPResult(BaseHTTPResult): + def is_connection_error(self) -> bool: + if self.error is None: + return False + return isinstance(self.error, _get_connection_error_types()) + + +class RequestsHTTPTransport(BaseHTTPTransport): + def __init__( + self, + *, + verify: bool | str = True, + cert: str | tuple[str, str] | None = None, + session: requests.Session | None = None, + ) -> None: + # pylint: disable-next=import-outside-toplevel + import requests # noqa: PLC0415 + + self._session = session if session is not None else requests.Session() + self._session.verify = verify + if cert is not None: + self._session.cert = cert + + if verify is False: + # pylint: disable-next=import-outside-toplevel + from urllib3.exceptions import ( # noqa: PLC0415 + InsecureRequestWarning, + ) + + warnings.filterwarnings("ignore", category=InsecureRequestWarning) + + def request( + self, + method: str, + url: str, + *, + headers: dict[str, str] | None = None, + timeout: float | None = None, + data: bytes | None = None, + ) -> BaseHTTPResult: + try: + response = self._session.request( + method=method, + url=url, + headers=headers, + data=data, + timeout=timeout, + allow_redirects=False, + ) + # pylint: disable-next=broad-exception-caught + except Exception as error: + # pylint: disable-next=unexpected-keyword-arg + return RequestsHTTPResult(error=error) + + # pylint: disable-next=unexpected-keyword-arg + return RequestsHTTPResult( + status_code=response.status_code, + reason=response.reason, + ) + + def close(self) -> None: + self._session.close() diff --git a/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_urllib3.py b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_urllib3.py new file mode 100644 index 00000000000..1e537056d8f --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/_urllib3.py @@ -0,0 +1,112 @@ +# Copyright The OpenTelemetry Authors +# SPDX-License-Identifier: Apache-2.0 + +import functools +import warnings +from dataclasses import dataclass + +# pylint: disable-next=import-error +from opentelemetry.exporter.http.transport._base import ( + BaseHTTPResult, + BaseHTTPTransport, +) + + +@functools.cache +def _get_connection_error_types() -> tuple[type[Exception], ...]: + # pylint: disable-next=import-outside-toplevel + import urllib3.exceptions # noqa: PLC0415 + + types: list[type[Exception]] = [ + urllib3.exceptions.ConnectionError, + urllib3.exceptions.NewConnectionError, + urllib3.exceptions.ConnectTimeoutError, + urllib3.exceptions.MaxRetryError, + urllib3.exceptions.ProtocolError, + ] + + # NameResolutionError was added in urllib3 2.0 + name_resolution_error = getattr( + urllib3.exceptions, "NameResolutionError", None + ) + if name_resolution_error is not None: + types.append(name_resolution_error) + + return tuple(types) + + +@dataclass(frozen=True, slots=True) +class Urllib3HTTPResult(BaseHTTPResult): + def is_connection_error(self) -> bool: + if self.error is None: + return False + return isinstance(self.error, _get_connection_error_types()) + + +class Urllib3HTTPTransport(BaseHTTPTransport): + def __init__( + self, + *, + verify: bool | str = True, + cert: str | tuple[str, str] | None = None, + ) -> None: + # pylint: disable-next=import-outside-toplevel + import urllib3 # noqa: PLC0415 + + pool_kwargs: dict[str, object] = { + "retries": urllib3.Retry(0, redirect=False), + } + if verify is False: + pool_kwargs["cert_reqs"] = "CERT_NONE" + warnings.filterwarnings( + "ignore", + category=urllib3.exceptions.InsecureRequestWarning, + ) + else: + pool_kwargs["cert_reqs"] = "CERT_REQUIRED" + if isinstance(verify, str): + pool_kwargs["ca_certs"] = verify + if isinstance(cert, tuple): + pool_kwargs["cert_file"] = cert[0] + pool_kwargs["key_file"] = cert[1] + elif isinstance(cert, str): + pool_kwargs["cert_file"] = cert + + self._pool = urllib3.PoolManager(**pool_kwargs) # type: ignore + + def request( + self, + method: str, + url: str, + *, + headers: dict[str, str] | None = None, + timeout: float | None = None, + data: bytes | None = None, + ) -> BaseHTTPResult: + # pylint: disable-next=import-outside-toplevel + import urllib3 # noqa: PLC0415 + + try: + response = self._pool.request( + method=method, + url=url, + headers=headers, + body=data, + timeout=urllib3.Timeout(total=timeout) + if timeout is not None + else None, + preload_content=True, + ) + # pylint: disable-next=broad-exception-caught + except Exception as error: + # pylint: disable-next=unexpected-keyword-arg + return Urllib3HTTPResult(error=error) + + # pylint: disable-next=unexpected-keyword-arg + return Urllib3HTTPResult( + status_code=response.status, + reason=response.reason, + ) + + def close(self) -> None: + self._pool.clear() diff --git a/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/version/__init__.py b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/version/__init__.py new file mode 100644 index 00000000000..716ad67f7d6 --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/src/opentelemetry/exporter/http/transport/version/__init__.py @@ -0,0 +1,4 @@ +# Copyright The OpenTelemetry Authors +# SPDX-License-Identifier: Apache-2.0 + +__version__ = "0.63b0.dev" diff --git a/exporter/opentelemetry-exporter-http-transport/test-requirements.in b/exporter/opentelemetry-exporter-http-transport/test-requirements.in new file mode 100644 index 00000000000..e8b1ac224dd --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/test-requirements.in @@ -0,0 +1,6 @@ +iniconfig==2.3.0 +mocket==3.14.1 +packaging==26.2 +pluggy==1.6.0 +pytest==7.4.4 +-e exporter/opentelemetry-exporter-http-transport[urllib3,requests] diff --git a/exporter/opentelemetry-exporter-http-transport/test-requirements.latest.txt b/exporter/opentelemetry-exporter-http-transport/test-requirements.latest.txt new file mode 100644 index 00000000000..b1ec00aea69 --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/test-requirements.latest.txt @@ -0,0 +1,51 @@ +# This file was autogenerated by uv via the following command: +# uv pip compile --python 3.10 --universal --resolution highest exporter/opentelemetry-exporter-http-transport/test-requirements.in -o exporter/opentelemetry-exporter-http-transport/test-requirements.latest.txt +-e exporter/opentelemetry-exporter-http-transport + # via -r exporter/opentelemetry-exporter-http-transport/test-requirements.in +certifi==2026.4.22 + # via requests +charset-normalizer==3.4.7 + # via requests +colorama==0.4.6 ; sys_platform == 'win32' + # via pytest +decorator==5.2.1 + # via mocket +exceptiongroup==1.3.1 ; python_full_version < '3.11' + # via pytest +h11==0.16.0 + # via mocket +idna==3.14 + # via requests +iniconfig==2.3.0 + # via + # -r exporter/opentelemetry-exporter-http-transport/test-requirements.in + # pytest +mocket==3.14.1 + # via -r exporter/opentelemetry-exporter-http-transport/test-requirements.in +packaging==26.2 + # via + # -r exporter/opentelemetry-exporter-http-transport/test-requirements.in + # pytest +pluggy==1.6.0 + # via + # -r exporter/opentelemetry-exporter-http-transport/test-requirements.in + # pytest +puremagic==1.30 ; python_full_version < '3.12' + # via mocket +puremagic==2.2.0 ; python_full_version >= '3.12' + # via mocket +pytest==7.4.4 + # via -r exporter/opentelemetry-exporter-http-transport/test-requirements.in +requests==2.34.0 + # via opentelemetry-exporter-http-transport +tomli==2.4.1 ; python_full_version < '3.11' + # via pytest +typing-extensions==4.15.0 + # via + # exceptiongroup + # mocket +urllib3==2.7.0 + # via + # mocket + # opentelemetry-exporter-http-transport + # requests diff --git a/exporter/opentelemetry-exporter-http-transport/test-requirements.oldest.txt b/exporter/opentelemetry-exporter-http-transport/test-requirements.oldest.txt new file mode 100644 index 00000000000..c9b33dc117a --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/test-requirements.oldest.txt @@ -0,0 +1,51 @@ +# This file was autogenerated by uv via the following command: +# uv pip compile --python 3.10 --universal --resolution lowest-direct exporter/opentelemetry-exporter-http-transport/test-requirements.in -o exporter/opentelemetry-exporter-http-transport/test-requirements.oldest.txt +-e exporter/opentelemetry-exporter-http-transport + # via -r exporter/opentelemetry-exporter-http-transport/test-requirements.in +certifi==2026.4.22 + # via requests +chardet==3.0.4 + # via requests +colorama==0.4.6 ; sys_platform == 'win32' + # via pytest +decorator==5.2.1 + # via mocket +exceptiongroup==1.3.1 ; python_full_version < '3.11' + # via pytest +h11==0.16.0 + # via mocket +idna==2.10 + # via requests +iniconfig==2.3.0 + # via + # -r exporter/opentelemetry-exporter-http-transport/test-requirements.in + # pytest +mocket==3.14.1 + # via -r exporter/opentelemetry-exporter-http-transport/test-requirements.in +packaging==26.2 + # via + # -r exporter/opentelemetry-exporter-http-transport/test-requirements.in + # pytest +pluggy==1.6.0 + # via + # -r exporter/opentelemetry-exporter-http-transport/test-requirements.in + # pytest +puremagic==1.30 ; python_full_version < '3.12' + # via mocket +puremagic==2.2.0 ; python_full_version >= '3.12' + # via mocket +pytest==7.4.4 + # via -r exporter/opentelemetry-exporter-http-transport/test-requirements.in +requests==2.25.0 + # via opentelemetry-exporter-http-transport +tomli==2.4.1 ; python_full_version < '3.11' + # via pytest +typing-extensions==4.15.0 + # via + # exceptiongroup + # mocket +urllib3==1.26.20 + # via + # mocket + # opentelemetry-exporter-http-transport + # requests diff --git a/exporter/opentelemetry-exporter-http-transport/tests/__init__.py b/exporter/opentelemetry-exporter-http-transport/tests/__init__.py new file mode 100644 index 00000000000..e57cf4aba95 --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/tests/__init__.py @@ -0,0 +1,2 @@ +# Copyright The OpenTelemetry Authors +# SPDX-License-Identifier: Apache-2.0 diff --git a/exporter/opentelemetry-exporter-http-transport/tests/test_otlp_client.py b/exporter/opentelemetry-exporter-http-transport/tests/test_otlp_client.py new file mode 100644 index 00000000000..21b14dd3663 --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/tests/test_otlp_client.py @@ -0,0 +1,394 @@ +# Copyright The OpenTelemetry Authors +# SPDX-License-Identifier: Apache-2.0 + +import gzip +import threading +import unittest +import zlib +from collections.abc import Callable, Iterator +from contextlib import contextmanager +from dataclasses import dataclass +from unittest.mock import Mock, patch + +# pylint: disable=unexpected-keyword-arg +# pylint: disable-next=import-error +from opentelemetry.exporter.http.transport._base import ( + BaseHTTPResult, + BaseHTTPTransport, +) + +# pylint: disable-next=import-error +from opentelemetry.exporter.http.transport._otlp_client import ( + Compression, + OTLPHTTPClient, +) + + +@contextmanager +def _mock_clock( + shutdown_event: Mock | None = None, +) -> Iterator[Callable[[float], None]]: + _now = [0.0] + + def advance(delta: float) -> None: + _now[0] += delta + + def get_time() -> float: + return _now[0] + + if shutdown_event is not None: + + def _wait(duration: float) -> bool: + advance(duration) + return False + + shutdown_event.wait.side_effect = _wait + + with patch( + "opentelemetry.exporter.http.transport._otlp_client.time.time", + side_effect=get_time, + ): + yield advance + + +@dataclass(frozen=True, slots=True) +class _TestHTTPResult(BaseHTTPResult): + connection_error: bool = False + + def is_connection_error(self) -> bool: + return self.connection_error + + +class _TestHTTPTransport(BaseHTTPTransport): + def __init__(self, *results): + self.results = list(results) + self.requests = [] + self.closed = False + + def request( + self, + method, + url, + *, + headers=None, + timeout=None, + data=None, + ): + self.requests.append( + { + "method": method, + "url": url, + "headers": headers, + "timeout": timeout, + "data": data, + } + ) + result = self.results.pop(0) + if callable(result): + result = result() + if isinstance(result, Exception): + raise result + return result + + def close(self): + self.closed = True + + +class TestOTLPHTTPClient(unittest.TestCase): + @staticmethod + def _client( + transport, + *, + timeout=5.0, + compression=Compression.NONE, + shutdown_event=None, + jitter=0.0, + ): + return OTLPHTTPClient( + transport=transport, + endpoint="http://example.test/v1/traces", + timeout=timeout, + compression=compression, + shutdown_event=shutdown_event or threading.Event(), + headers={"content-type": "application/x-protobuf"}, + kind="spans", + jitter=jitter, + ) + + def test_export_success_status_codes(self): + cases = ( + (200, "OK"), + (204, "No Content"), + (302, "Found"), + ) + + for status_code, reason in cases: + with self.subTest(status_code=status_code): + transport = _TestHTTPTransport( + _TestHTTPResult(status_code=status_code, reason=reason) + ) + client = self._client(transport) + + result = client.export(b"payload") + + self.assertTrue(result.success) + self.assertEqual(result.status_code, status_code) + self.assertEqual(result.reason, reason) + self.assertIsNone(result.error) + + @patch( + "opentelemetry.exporter.http.transport._otlp_client.time.time", + side_effect=(100.0, 100.0, 100.0), + ) + def test_export_request_arguments(self, mock_time): + transport = _TestHTTPTransport( + _TestHTTPResult(status_code=200, reason="OK") + ) + client = self._client(transport, timeout=3.0) + + client.export(b"payload") + + self.assertEqual(len(transport.requests), 1) + self.assertEqual( + transport.requests[0], + { + "method": "POST", + "url": "http://example.test/v1/traces", + "headers": {"content-type": "application/x-protobuf"}, + "timeout": 3.0, + "data": b"payload", + }, + ) + self.assertEqual(mock_time.call_count, 3) + + def test_export_compresses_payload(self): + cases = ( + ( + Compression.NONE, + lambda data: data, + ), + ( + Compression.GZIP, + gzip.decompress, + ), + ( + Compression.DEFLATE, + zlib.decompress, + ), + ) + + for compression, decompress in cases: + with self.subTest(compression=compression): + transport = _TestHTTPTransport( + _TestHTTPResult(status_code=200, reason="OK") + ) + client = self._client(transport, compression=compression) + + result = client.export(b"payload") + + self.assertTrue(result.success) + self.assertEqual( + decompress(transport.requests[0]["data"]), b"payload" + ) + + def test_export_retryable_status_codes(self): + cases = ( + (408, "Request Timeout"), + (500, "Internal Server Error"), + (503, "Service Unavailable"), + ) + + for status_code, reason in cases: + with self.subTest(status_code=status_code): + shutdown_event = Mock(spec=threading.Event) + shutdown_event.is_set.return_value = False + shutdown_event.wait.return_value = False + transport = _TestHTTPTransport( + _TestHTTPResult( + status_code=status_code, + reason=reason, + ), + _TestHTTPResult(status_code=200, reason="OK"), + ) + client = self._client( + transport, + shutdown_event=shutdown_event, + ) + + result = client.export(b"payload") + + self.assertTrue(result.success) + self.assertEqual(len(transport.requests), 2) + shutdown_event.wait.assert_called_once_with(1.0) + + def test_export_connection_errors(self): + error = RuntimeError("connection failed") + transport = _TestHTTPTransport( + _TestHTTPResult(error=error, connection_error=True), + _TestHTTPResult(status_code=200, reason="OK"), + ) + client = self._client(transport) + + result = client.export(b"payload") + + self.assertTrue(result.success) + self.assertEqual(len(transport.requests), 2) + self.assertAlmostEqual(transport.requests[0]["timeout"], 5.0, 2) + self.assertLessEqual( + transport.requests[1]["timeout"], + transport.requests[0]["timeout"], + ) + self.assertGreater(transport.requests[1]["timeout"], 0.0) + + def test_export_non_retryable_errors(self): + exception = RuntimeError("request failed") + cases = ( + ( + _TestHTTPResult(status_code=400, reason="Bad Request"), + 400, + "Bad Request", + None, + ), + ( + _TestHTTPResult(error=exception), + None, + None, + exception, + ), + ( + exception, + None, + None, + exception, + ), + ) + + for ( + response, + expected_status_code, + expected_reason, + expected_error, + ) in cases: + with self.subTest(response=type(response).__name__): + transport = _TestHTTPTransport(response) + client = self._client(transport) + + result = client.export(b"payload") + + self.assertFalse(result.success) + self.assertEqual(result.status_code, expected_status_code) + self.assertEqual(result.reason, expected_reason) + self.assertIs(result.error, expected_error) + + def test_export_with_shutdown(self): + shutdown_event = Mock(spec=threading.Event) + shutdown_event.is_set.return_value = True + transport = _TestHTTPTransport( + _TestHTTPResult(status_code=503, reason="Service Unavailable") + ) + client = self._client(transport, shutdown_event=shutdown_event) + + result = client.export(b"payload") + + self.assertFalse(result.success) + self.assertEqual(result.status_code, 503) + self.assertEqual(result.reason, "Service Unavailable") + shutdown_event.wait.assert_not_called() + + def test_close_closes_transport(self): + transport = _TestHTTPTransport() + client = self._client(transport) + + client.close() + + self.assertTrue(transport.closed) + + def test_export_timeout_decreases_per_retry(self): + shutdown_event = Mock(spec=threading.Event) + shutdown_event.is_set.return_value = False + transport = _TestHTTPTransport( + _TestHTTPResult(status_code=503, reason="Service Unavailable"), + _TestHTTPResult(status_code=503, reason="Service Unavailable"), + _TestHTTPResult(status_code=200, reason="OK"), + ) + client = self._client( + transport, timeout=10.0, jitter=0.0, shutdown_event=shutdown_event + ) + + with _mock_clock(shutdown_event): + result = client.export(b"payload") + + # retry=0: wait(1.0) -> time=1.0, retry=1: wait(2.0) -> time=3.0, success + self.assertTrue(result.success) + self.assertAlmostEqual(transport.requests[0]["timeout"], 10.0) + self.assertAlmostEqual(transport.requests[1]["timeout"], 9.0) + self.assertAlmostEqual(transport.requests[2]["timeout"], 7.0) + + def test_export_backoff_exhausts_remaining_timeout(self): + shutdown_event = Mock(spec=threading.Event) + shutdown_event.is_set.return_value = False + transport = _TestHTTPTransport( + _TestHTTPResult(status_code=503, reason="Service Unavailable"), + _TestHTTPResult(status_code=503, reason="Service Unavailable"), + ) + # timeout=1.5: retry=0 backoff=1.0 fits -> wait(1.0) -> time=1.0 + # retry=1 backoff=2.0 > 0.5 remaining -> give up + client = self._client( + transport, timeout=1.5, jitter=0.0, shutdown_event=shutdown_event + ) + + with _mock_clock(shutdown_event): + result = client.export(b"payload") + + self.assertFalse(result.success) + self.assertEqual(result.status_code, 503) + self.assertEqual(len(transport.requests), 2) + shutdown_event.wait.assert_called_once_with(1.0) + + def test_export_exhausts_max_retries(self): + shutdown_event = Mock(spec=threading.Event) + shutdown_event.is_set.return_value = False + transport = _TestHTTPTransport( + *[_TestHTTPResult(status_code=503, reason="Service Unavailable")] + * 6 + ) + client = self._client( + transport, + timeout=1000.0, + jitter=0.0, + shutdown_event=shutdown_event, + ) + + with _mock_clock(shutdown_event): + result = client.export(b"payload") + + self.assertFalse(result.success) + self.assertEqual(len(transport.requests), 6) + self.assertEqual(shutdown_event.wait.call_count, 5) + self.assertEqual( + [call.args[0] for call in shutdown_event.wait.call_args_list], + [1.0, 2.0, 4.0, 8.0, 16.0], + ) + + def test_export_connection_error_gets_reduced_timeout(self): + transport = _TestHTTPTransport( + _TestHTTPResult(status_code=200, reason="OK"), + ) + + with _mock_clock() as advance: + + def _slow_connection_error() -> _TestHTTPResult: + advance(2.0) + return _TestHTTPResult( + error=RuntimeError("stale connection"), + connection_error=True, + ) + + transport.results.insert(0, _slow_connection_error) + client = self._client(transport, timeout=5.0) + result = client.export(b"payload") + + # _submit: deadline=0+5=5.0, after first request time=2.0, remaining=3.0 + self.assertTrue(result.success) + self.assertEqual(len(transport.requests), 2) + self.assertAlmostEqual(transport.requests[1]["timeout"], 3.0) diff --git a/exporter/opentelemetry-exporter-http-transport/tests/test_requests_transport.py b/exporter/opentelemetry-exporter-http-transport/tests/test_requests_transport.py new file mode 100644 index 00000000000..0233daf93ab --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/tests/test_requests_transport.py @@ -0,0 +1,190 @@ +# Copyright The OpenTelemetry Authors +# SPDX-License-Identifier: Apache-2.0 + +from __future__ import annotations + +import unittest +from unittest.mock import MagicMock, patch + +import requests +import requests.exceptions +from mocket import Mocket, Mocketizer, mocketize +from mocket.mocks.mockhttp import Entry + +# pylint: disable-next=import-error +from opentelemetry.exporter.http.transport._requests import ( + RequestsHTTPResult, + RequestsHTTPTransport, +) + +_TEST_URL = "http://example.test/v1/traces" + + +class TestRequestsHTTPResult(unittest.TestCase): + def test_is_connection_error(self): + cases = [ + (RequestsHTTPResult(status_code=200, reason="OK"), False), + ( + RequestsHTTPResult( + error=requests.exceptions.ConnectionError("error") + ), + True, + ), + ( + RequestsHTTPResult( + error=requests.exceptions.ConnectTimeout("error") + ), + True, + ), + ( + RequestsHTTPResult( + error=requests.exceptions.ReadTimeout("error") + ), + True, + ), + ( + RequestsHTTPResult(error=requests.exceptions.Timeout("error")), + True, + ), + ( + RequestsHTTPResult( + error=requests.exceptions.SSLError("error") + ), + True, + ), + ( + RequestsHTTPResult( + error=requests.exceptions.ProxyError("error") + ), + True, + ), + ( + RequestsHTTPResult( + error=requests.exceptions.HTTPError("error") + ), + False, + ), + ( + RequestsHTTPResult( + error=requests.exceptions.RequestException("error") + ), + False, + ), + (RequestsHTTPResult(error=RuntimeError("error")), False), + (RequestsHTTPResult(error=ValueError("error")), False), + ] + for result, expected in cases: + with self.subTest(error_type=type(result.error).__name__): + self.assertEqual(result.is_connection_error(), expected) + + +# pylint: disable=protected-access,no-self-use +class TestRequestsHTTPTransport(unittest.TestCase): + def test_request_returns_status_code_and_reason(self): + cases = [ + (200, "OK"), + (400, "Bad Request"), + (503, "Service Unavailable"), + ] + for status_code, reason in cases: + with self.subTest(status_code=status_code): + with Mocketizer(): + Entry.single_register( + Entry.POST, _TEST_URL, status=status_code + ) + transport = RequestsHTTPTransport() + result = transport.request("POST", _TEST_URL) + self.assertEqual(result.status_code, status_code) + self.assertEqual(result.reason, reason) + self.assertIsNone(result.error) + + @mocketize + def test_request_result_is_not_a_connection_error(self): + Entry.single_register(Entry.POST, _TEST_URL, status=200) + transport = RequestsHTTPTransport() + result = transport.request("POST", _TEST_URL) + self.assertFalse(result.is_connection_error()) + + @mocketize + def test_request_forwards_headers(self): + headers = { + "content-type": "application/x-protobuf", + "x-custom": "value", + } + Entry.single_register(Entry.POST, _TEST_URL, status=200) + transport = RequestsHTTPTransport() + result = transport.request("POST", _TEST_URL, headers=headers) + self.assertEqual(result.status_code, 200) + req = Mocket.last_request() + for key, value in headers.items(): + self.assertEqual(req.headers[key], value) + + @mocketize + def test_request_forwards_data(self): + Entry.single_register(Entry.POST, _TEST_URL, status=200) + transport = RequestsHTTPTransport() + result = transport.request("POST", _TEST_URL, data=b"payload") + self.assertEqual(result.status_code, 200) + self.assertEqual(Mocket.last_request().body, "payload") + + def test_request_catches_exception(self): + cases = [ + (RuntimeError("unexpected"), False), + (requests.exceptions.ConnectionError("failed"), True), + ] + for error, expected_is_connection_error in cases: + with self.subTest(error_type=type(error).__name__): + with patch("requests.Session.request", side_effect=error): + transport = RequestsHTTPTransport() + result = transport.request("POST", _TEST_URL) + self.assertIsNone(result.status_code) + self.assertIsNone(result.reason) + self.assertIs(result.error, error) + self.assertEqual( + result.is_connection_error(), expected_is_connection_error + ) + + def test_verify_sets_session_verify(self): + cases = [ + (True, True), + (False, False), + ("/path/to/ca.pem", "/path/to/ca.pem"), + ] + for verify, expected in cases: + with self.subTest(verify=verify): + mock_session = MagicMock(spec=requests.Session) + RequestsHTTPTransport(verify=verify, session=mock_session) + self.assertEqual(mock_session.verify, expected) + + def test_cert_none_does_not_set_session_cert(self): + mock_session = MagicMock(spec=requests.Session) + RequestsHTTPTransport(cert=None, session=mock_session) + self.assertFalse(hasattr(mock_session, "cert")) + + def test_cert_sets_session_cert(self): + cases = [ + "/path/to/cert.pem", + ("/path/to/cert.pem", "/path/to/key.pem"), + ] + for cert in cases: + with self.subTest(cert=cert): + mock_session = MagicMock(spec=requests.Session) + RequestsHTTPTransport(cert=cert, session=mock_session) + self.assertEqual(mock_session.cert, cert) + + def test_custom_session_is_used(self): + mock_session = MagicMock(spec=requests.Session) + mock_session.request.return_value = MagicMock( + status_code=200, reason="OK" + ) + transport = RequestsHTTPTransport(session=mock_session) + result = transport.request("POST", _TEST_URL) + mock_session.request.assert_called_once() + self.assertEqual(result.status_code, 200) + self.assertEqual(result.reason, "OK") + + def test_close_closes_session(self): + mock_session = MagicMock(spec=requests.Session) + transport = RequestsHTTPTransport(session=mock_session) + transport.close() + mock_session.close.assert_called_once() diff --git a/exporter/opentelemetry-exporter-http-transport/tests/test_urllib3_transport.py b/exporter/opentelemetry-exporter-http-transport/tests/test_urllib3_transport.py new file mode 100644 index 00000000000..9b4400b2249 --- /dev/null +++ b/exporter/opentelemetry-exporter-http-transport/tests/test_urllib3_transport.py @@ -0,0 +1,225 @@ +# Copyright The OpenTelemetry Authors +# SPDX-License-Identifier: Apache-2.0 + +from __future__ import annotations + +import unittest +from unittest.mock import MagicMock, patch + +import urllib3 +import urllib3.exceptions +from mocket import Mocket, Mocketizer, mocketize +from mocket.mocks.mockhttp import Entry + +# pylint: disable-next=import-error +from opentelemetry.exporter.http.transport._urllib3 import ( + Urllib3HTTPResult, + Urllib3HTTPTransport, +) + +_TEST_URL = "http://example.test/v1/traces" + + +class TestUrllib3HTTPResult(unittest.TestCase): + def test_is_connection_error(self): + cases: list[tuple[Urllib3HTTPResult, bool]] = [ + (Urllib3HTTPResult(status_code=200, reason="OK"), False), + ( + Urllib3HTTPResult( + error=urllib3.exceptions.ProtocolError("error") + ), + True, + ), + ( + Urllib3HTTPResult( + error=urllib3.exceptions.NewConnectionError(None, "error") + ), + True, + ), + ( + Urllib3HTTPResult( + error=urllib3.exceptions.ConnectTimeoutError(None, "error") + ), + True, + ), + ( + Urllib3HTTPResult( + error=urllib3.exceptions.MaxRetryError(None, "http://x") + ), + True, + ), + ( + Urllib3HTTPResult(error=urllib3.exceptions.HTTPError("error")), + False, + ), + ( + Urllib3HTTPResult( + error=urllib3.exceptions.ReadTimeoutError( + None, "http://x", "timeout" + ) + ), + False, + ), + (Urllib3HTTPResult(error=RuntimeError("error")), False), + (Urllib3HTTPResult(error=ValueError("error")), False), + ] + name_resolution_error = getattr( + urllib3.exceptions, "NameResolutionError", None + ) + if name_resolution_error is not None: + cases.append( + ( + Urllib3HTTPResult( + error=name_resolution_error("host", None, "error") + ), + True, + ) + ) + for result, expected in cases: + with self.subTest(error_type=type(result.error).__name__): + self.assertEqual(result.is_connection_error(), expected) + + +# pylint: disable=protected-access,no-self-use +class TestUrllib3HTTPTransport(unittest.TestCase): + def test_request_returns_status_code_and_reason(self): + cases = [ + (200, "OK"), + (400, "Bad Request"), + (503, "Service Unavailable"), + ] + for status_code, reason in cases: + with self.subTest(status_code=status_code): + with Mocketizer(): + Entry.single_register( + Entry.POST, _TEST_URL, status=status_code + ) + transport = Urllib3HTTPTransport() + result = transport.request("POST", _TEST_URL) + self.assertEqual(result.status_code, status_code) + self.assertEqual(result.reason, reason) + self.assertIsNone(result.error) + + @mocketize + def test_request_result_is_not_a_connection_error(self): + Entry.single_register(Entry.POST, _TEST_URL, status=200) + transport = Urllib3HTTPTransport() + result = transport.request("POST", _TEST_URL) + self.assertFalse(result.is_connection_error()) + + @mocketize + def test_request_forwards_headers(self): + headers = { + "content-type": "application/x-protobuf", + "x-custom": "value", + } + Entry.single_register(Entry.POST, _TEST_URL, status=200) + transport = Urllib3HTTPTransport() + result = transport.request("POST", _TEST_URL, headers=headers) + self.assertEqual(result.status_code, 200) + req = Mocket.last_request() + for key, value in headers.items(): + self.assertEqual(req.headers[key], value) + + @mocketize + def test_request_forwards_data(self): + Entry.single_register(Entry.POST, _TEST_URL, status=200) + transport = Urllib3HTTPTransport() + result = transport.request("POST", _TEST_URL, data=b"payload") + self.assertEqual(result.status_code, 200) + self.assertEqual(Mocket.last_request().body, "payload") + + def test_request_catches_exception(self): + cases = [ + (RuntimeError("unexpected"), False), + (urllib3.exceptions.ProtocolError("failed"), True), + ] + for error, expected_is_connection_error in cases: + with self.subTest(error_type=type(error).__name__): + transport = Urllib3HTTPTransport() + with patch.object( + transport._pool, "request", side_effect=error + ): + result = transport.request("POST", _TEST_URL) + self.assertIsNone(result.status_code) + self.assertIsNone(result.reason) + self.assertIs(result.error, error) + self.assertEqual( + result.is_connection_error(), expected_is_connection_error + ) + + def test_request_passes_timeout(self): + cases = [ + (3.5,), + (None,), + ] + for (timeout,) in cases: + with self.subTest(timeout=timeout): + transport = Urllib3HTTPTransport() + with patch.object(transport._pool, "request") as mock_request: + mock_request.return_value = MagicMock( + status=200, reason="OK" + ) + transport.request("POST", _TEST_URL, timeout=timeout) + timeout_kwarg = mock_request.call_args.kwargs["timeout"] + if timeout is not None: + self.assertIsInstance(timeout_kwarg, urllib3.Timeout) + self.assertEqual(timeout_kwarg.total, timeout) + else: + self.assertIsNone(timeout_kwarg) + + def test_verify_sets_pool_manager_kwargs(self): + cases = [ + (True, "CERT_REQUIRED", None), + (False, "CERT_NONE", None), + ("/path/to/ca.pem", "CERT_REQUIRED", "/path/to/ca.pem"), + ] + for verify, expected_cert_reqs, expected_ca_certs in cases: + with self.subTest(verify=verify): + with patch("urllib3.PoolManager") as mock_pm: + Urllib3HTTPTransport(verify=verify) + kwargs = mock_pm.call_args.kwargs + self.assertEqual(kwargs["cert_reqs"], expected_cert_reqs) + if expected_ca_certs is not None: + self.assertEqual(kwargs["ca_certs"], expected_ca_certs) + else: + self.assertNotIn("ca_certs", kwargs) + + def test_cert_none_does_not_set_cert_file(self): + with patch("urllib3.PoolManager") as mock_pm: + Urllib3HTTPTransport(cert=None) + self.assertNotIn("cert_file", mock_pm.call_args.kwargs) + + def test_cert_sets_pool_manager_kwargs(self): + cases = [ + ("/path/to/cert.pem", "/path/to/cert.pem", None), + ( + ("/path/to/cert.pem", "/path/to/key.pem"), + "/path/to/cert.pem", + "/path/to/key.pem", + ), + ] + for cert, expected_cert_file, expected_key_file in cases: + with self.subTest(cert=cert): + with patch("urllib3.PoolManager") as mock_pm: + Urllib3HTTPTransport(cert=cert) + kwargs = mock_pm.call_args.kwargs + self.assertEqual(kwargs["cert_file"], expected_cert_file) + if expected_key_file is not None: + self.assertEqual(kwargs["key_file"], expected_key_file) + else: + self.assertNotIn("key_file", kwargs) + + def test_retries_disabled(self): + with patch("urllib3.PoolManager") as mock_pm: + Urllib3HTTPTransport() + retries = mock_pm.call_args.kwargs["retries"] + self.assertIsInstance(retries, urllib3.Retry) + self.assertEqual(retries.total, 0) + self.assertFalse(retries.redirect) + + def test_close_clears_pool(self): + with patch("urllib3.PoolManager") as mock_pm: + transport = Urllib3HTTPTransport() + transport.close() + mock_pm.return_value.clear.assert_called_once() diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/pyproject.toml b/exporter/opentelemetry-exporter-otlp-proto-http/pyproject.toml index 719a2cd84f3..ef87d2c2909 100644 --- a/exporter/opentelemetry-exporter-otlp-proto-http/pyproject.toml +++ b/exporter/opentelemetry-exporter-otlp-proto-http/pyproject.toml @@ -31,8 +31,9 @@ dependencies = [ "opentelemetry-proto == 1.42.0.dev", "opentelemetry-sdk ~= 1.42.0.dev", "opentelemetry-exporter-otlp-proto-common == 1.42.0.dev", - "requests ~= 2.7", + "opentelemetry-exporter-http-transport == 0.63b0.dev", "typing-extensions >= 4.5.0", + "urllib3 >= 1.11" ] [project.entry-points.opentelemetry_traces_exporter] @@ -52,6 +53,9 @@ Repository = "https://github.com/open-telemetry/opentelemetry-python" gcp-auth = [ "opentelemetry-exporter-credential-provider-gcp >= 0.59b0", ] +requests = [ + "requests ~= 2.7", +] [tool.hatch.version] path = "src/opentelemetry/exporter/otlp/proto/http/version/__init__.py" diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/__init__.py b/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/__init__.py index 69f51ec0557..9f5999e9c67 100644 --- a/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/__init__.py +++ b/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/__init__.py @@ -60,10 +60,13 @@ """ import enum +from typing import Final from .version import __version__ -_OTLP_HTTP_HEADERS = { +_CONTENT_ENCODING_HEADER: Final[str] = "Content-Encoding" + +_OTLP_HTTP_HEADERS: Final[dict[str, str]] = { "Content-Type": "application/x-protobuf", "User-Agent": "OTel-OTLP-Exporter-Python/" + __version__, } diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/_common/__init__.py b/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/_common/__init__.py index 57bd7ca065a..9f3340eea44 100644 --- a/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/_common/__init__.py +++ b/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/_common/__init__.py @@ -1,26 +1,73 @@ # Copyright The OpenTelemetry Authors # SPDX-License-Identifier: Apache-2.0 +from __future__ import annotations from os import environ -from typing import Literal - -import requests +from typing import TYPE_CHECKING, Final, Literal +from opentelemetry.exporter.http.transport._base import BaseHTTPTransport +from opentelemetry.exporter.http.transport._otlp_client import ( + Compression as TransportCompression, +) +from opentelemetry.exporter.http.transport._requests import ( + RequestsHTTPTransport, +) +from opentelemetry.exporter.http.transport._urllib3 import ( + Urllib3HTTPTransport, +) +from opentelemetry.exporter.otlp.proto.http import Compression from opentelemetry.sdk.environment_variables import ( _OTEL_PYTHON_EXPORTER_OTLP_HTTP_CREDENTIAL_PROVIDER, + OTEL_EXPORTER_OTLP_COMPRESSION, + OTEL_EXPORTER_OTLP_ENDPOINT, ) from opentelemetry.util._importlib_metadata import entry_points +if TYPE_CHECKING: + import requests -def _is_retryable(resp: requests.Response) -> bool: - if resp.status_code == 408: - return True - if resp.status_code >= 500 and resp.status_code <= 599: - return True - return False +_DEFAULT_ENDPOINT: Final[str] = "http://localhost:4318" +DEFAULT_COMPRESSION: Final[Compression] = Compression.NoCompression -def _load_session_from_envvar( +def _compression_from_env( + signal_compression_envvar: Literal[ + "OTEL_EXPORTER_OTLP_LOGS_COMPRESSION", + "OTEL_EXPORTER_OTLP_METRICS_COMPRESSION", + "OTEL_EXPORTER_OTLP_TRACES_COMPRESSION", + ], +) -> Compression: + compression = ( + environ.get( + signal_compression_envvar, + environ.get( + OTEL_EXPORTER_OTLP_COMPRESSION, DEFAULT_COMPRESSION.value + ), + ) + .lower() + .strip() + ) + return Compression(compression) + + +def _endpoint_from_env( + signal_endpoint_envvar: Literal[ + "OTEL_EXPORTER_OTLP_LOGS_ENDPOINT", + "OTEL_EXPORTER_OTLP_METRICS_ENDPOINT", + "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT", + ], + default_signal_path: Literal["v1/logs", "v1/metrics", "v1/traces"], +) -> str: + base = ( + environ.get( + OTEL_EXPORTER_OTLP_ENDPOINT, _DEFAULT_ENDPOINT + ).removesuffix("/") + + "/" + ) + return environ.get(signal_endpoint_envvar, base + default_signal_path) + + +def _session_from_env( cred_envvar: Literal[ "OTEL_PYTHON_EXPORTER_OTLP_HTTP_LOGS_CREDENTIAL_PROVIDER", "OTEL_PYTHON_EXPORTER_OTLP_HTTP_TRACES_CREDENTIAL_PROVIDER", @@ -45,6 +92,8 @@ def _load_session_from_envvar( f"Requested component '{_credential_env}' not found in " f"entry point 'opentelemetry_otlp_credential_provider'" ) + import requests # noqa: PLC0415 + if isinstance(maybe_session, requests.Session): return maybe_session else: @@ -53,3 +102,25 @@ def _load_session_from_envvar( f" must be of type `requests.Session`." ) return None + + +def _transport_from_args( + session: requests.Session | None, + verify: bool | str, + cert: str | tuple[str, str] | None, +) -> BaseHTTPTransport: + if session is not None: + return RequestsHTTPTransport(verify=verify, cert=cert, session=session) + return Urllib3HTTPTransport(verify=verify, cert=cert) + + +def _as_transport_compression( + compression: Compression, +) -> TransportCompression: + match compression: + case Compression.Gzip: + return TransportCompression.GZIP + case Compression.Deflate: + return TransportCompression.DEFLATE + case _: + return TransportCompression.NONE diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/_log_exporter/__init__.py b/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/_log_exporter/__init__.py index 56906b96501..58c101ae544 100644 --- a/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/_log_exporter/__init__.py +++ b/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/_log_exporter/__init__.py @@ -1,32 +1,41 @@ # Copyright The OpenTelemetry Authors # SPDX-License-Identifier: Apache-2.0 -import gzip +from __future__ import annotations + import logging -import os -import random import threading -import zlib from collections.abc import Sequence -from io import BytesIO from os import environ -from time import time +from typing import ( + TYPE_CHECKING, + Final, + Literal, + overload, +) from urllib.parse import urlparse -import requests -from requests.exceptions import ConnectionError - +from opentelemetry.exporter.http.transport._base import ( + BaseHTTPTransport, +) +from opentelemetry.exporter.http.transport._otlp_client import ( + OTLPHTTPClient, +) from opentelemetry.exporter.otlp.proto.common._exporter_metrics import ( - create_exporter_metrics, + ExporterMetrics, ) from opentelemetry.exporter.otlp.proto.common._log_encoder import encode_logs from opentelemetry.exporter.otlp.proto.http import ( + _CONTENT_ENCODING_HEADER, _OTLP_HTTP_HEADERS, Compression, ) from opentelemetry.exporter.otlp.proto.http._common import ( - _is_retryable, - _load_session_from_envvar, + _as_transport_compression, + _compression_from_env, + _endpoint_from_env, + _session_from_env, + _transport_from_args, ) from opentelemetry.metrics import MeterProvider from opentelemetry.sdk._logs import ReadableLogRecord @@ -40,8 +49,6 @@ OTEL_EXPORTER_OTLP_CERTIFICATE, OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE, OTEL_EXPORTER_OTLP_CLIENT_KEY, - OTEL_EXPORTER_OTLP_COMPRESSION, - OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE, OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE, @@ -51,7 +58,6 @@ OTEL_EXPORTER_OTLP_LOGS_HEADERS, OTEL_EXPORTER_OTLP_LOGS_TIMEOUT, OTEL_EXPORTER_OTLP_TIMEOUT, - OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, ) from opentelemetry.semconv._incubating.attributes.otel_attributes import ( OtelComponentTypeValues, @@ -61,19 +67,51 @@ ) from opentelemetry.util.re import parse_env_headers +if TYPE_CHECKING: + import requests + _logger = logging.getLogger(__name__) # This prevents logs generated when a log fails to be written to generate another log which fails to be written etc. etc. _logger.addFilter(DuplicateFilter()) -DEFAULT_COMPRESSION = Compression.NoCompression -DEFAULT_ENDPOINT = "http://localhost:4318/" -DEFAULT_LOGS_EXPORT_PATH = "v1/logs" -DEFAULT_TIMEOUT = 10 # in seconds -_MAX_RETRYS = 6 +DEFAULT_TIMEOUT: Final[int] = 10 # in seconds +DEFAULT_LOGS_EXPORT_PATH: Final[Literal["v1/logs"]] = "v1/logs" class OTLPLogExporter(LogRecordExporter): + @overload + def __init__( + self, + endpoint: str | None = ..., + certificate_file: str | None = ..., + client_key_file: str | None = ..., + client_certificate_file: str | None = ..., + headers: dict[str, str] | None = ..., + timeout: float | None = ..., + compression: Compression | None = ..., + session: requests.Session | None = ..., + *, + meter_provider: MeterProvider | None = ..., + _transport: None = ..., + ) -> None: ... + + @overload + def __init__( + self, + endpoint: str | None = ..., + certificate_file: str | None = ..., + client_key_file: str | None = ..., + client_certificate_file: str | None = ..., + headers: dict[str, str] | None = ..., + timeout: float | None = ..., + compression: Compression | None = ..., + session: None = ..., + *, + meter_provider: MeterProvider | None = ..., + _transport: BaseHTTPTransport, + ) -> None: ... + def __init__( self, endpoint: str | None = None, @@ -86,13 +124,11 @@ def __init__( session: requests.Session | None = None, *, meter_provider: MeterProvider | None = None, + _transport: BaseHTTPTransport | None = None, ): - self._shutdown_is_occuring = threading.Event() - self._endpoint = endpoint or environ.get( - OTEL_EXPORTER_OTLP_LOGS_ENDPOINT, - _append_logs_path( - environ.get(OTEL_EXPORTER_OTLP_ENDPOINT, DEFAULT_ENDPOINT) - ), + self._shutdown_event = threading.Event() + self._endpoint = endpoint or _endpoint_from_env( + OTEL_EXPORTER_OTLP_LOGS_ENDPOINT, DEFAULT_LOGS_EXPORT_PATH ) # Keeping these as instance variables because they are used in tests self._certificate_file = certificate_file or environ.get( @@ -125,72 +161,44 @@ def __init__( environ.get(OTEL_EXPORTER_OTLP_TIMEOUT, DEFAULT_TIMEOUT), ) ) - self._compression = compression or _compression_from_env() - self._session = ( + self._compression = compression or _compression_from_env( + OTEL_EXPORTER_OTLP_LOGS_COMPRESSION + ) + + transport = _transport or _transport_from_args( session - or _load_session_from_envvar( + or _session_from_env( _OTEL_PYTHON_EXPORTER_OTLP_HTTP_LOGS_CREDENTIAL_PROVIDER - ) - or requests.Session() + ), + self._certificate_file, + self._client_cert, ) - self._session.headers.update(self._headers) - self._session.headers.update(_OTLP_HTTP_HEADERS) - # let users override our defaults - self._session.headers.update(self._headers) + + client_headers: dict[str, str] = { + **_OTLP_HTTP_HEADERS, + **self._headers, + } if self._compression is not Compression.NoCompression: - self._session.headers.update( - {"Content-Encoding": self._compression.value} - ) + client_headers[_CONTENT_ENCODING_HEADER] = self._compression.value + + self._client = OTLPHTTPClient( + transport=transport, + endpoint=self._endpoint, + timeout=self._timeout, + compression=_as_transport_compression(self._compression), + shutdown_event=self._shutdown_event, + headers=client_headers, + kind="logs", + ) self._shutdown = False - self._metrics = create_exporter_metrics( + self._metrics = ExporterMetrics( OtelComponentTypeValues.OTLP_HTTP_LOG_EXPORTER, "logs", urlparse(self._endpoint), meter_provider, - os.environ.get(OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, "") - .strip() - .lower() - == "true", ) - def _export( - self, serialized_data: bytes, timeout_sec: float | None = None - ): - data = serialized_data - if self._compression == Compression.Gzip: - gzip_data = BytesIO() - with gzip.GzipFile(fileobj=gzip_data, mode="w") as gzip_stream: - gzip_stream.write(serialized_data) - data = gzip_data.getvalue() - elif self._compression == Compression.Deflate: - data = zlib.compress(serialized_data) - - if timeout_sec is None: - timeout_sec = self._timeout - - # By default, keep-alive is enabled in Session's request - # headers. Backends may choose to close the connection - # while a post happens which causes an unhandled - # exception. This try/except will retry the post on such exceptions - try: - resp = self._session.post( - url=self._endpoint, - data=data, - verify=self._certificate_file, - timeout=timeout_sec, - cert=self._client_cert, - ) - except ConnectionError: - resp = self._session.post( - url=self._endpoint, - data=data, - verify=self._certificate_file, - timeout=timeout_sec, - cert=self._client_cert, - ) - return resp - def export( self, batch: Sequence[ReadableLogRecord] ) -> LogRecordExportResult: @@ -200,66 +208,15 @@ def export( with self._metrics.export_operation(len(batch)) as result: serialized_data = encode_logs(batch).SerializeToString() - deadline_sec = time() + self._timeout - for retry_num in range(_MAX_RETRYS): - # multiplying by a random number between .8 and 1.2 introduces a +/20% jitter to each backoff. - backoff_seconds = 2**retry_num * random.uniform(0.8, 1.2) - export_error: Exception | None = None - try: - resp = self._export(serialized_data, deadline_sec - time()) - if resp.ok: - return LogRecordExportResult.SUCCESS - except requests.exceptions.RequestException as error: - reason = error - export_error = error - retryable = isinstance(error, ConnectionError) - status_code = None - else: - reason = resp.reason - retryable = _is_retryable(resp) - status_code = resp.status_code - - if not retryable: - _logger.error( - "Failed to export logs batch code: %s, reason: %s", - status_code, - reason, - ) - error_attrs = ( - {HTTP_RESPONSE_STATUS_CODE: status_code} - if status_code is not None - else None - ) - result.error = export_error - result.error_attrs = error_attrs - return LogRecordExportResult.FAILURE - - if ( - retry_num + 1 == _MAX_RETRYS - or backoff_seconds > (deadline_sec - time()) - or self._shutdown - ): - _logger.error( - "Failed to export logs batch due to timeout, " - "max retries or shutdown." - ) - error_attrs = ( - {HTTP_RESPONSE_STATUS_CODE: status_code} - if status_code is not None - else None - ) - result.error = export_error - result.error_attrs = error_attrs - return LogRecordExportResult.FAILURE - _logger.warning( - "Transient error %s encountered while exporting logs batch, retrying in %.2fs.", - reason, - backoff_seconds, - ) - shutdown = self._shutdown_is_occuring.wait(backoff_seconds) - if shutdown: - _logger.warning("Shutdown in progress, aborting retry.") - break + export_result = self._client.export(serialized_data) + if export_result.success: + return LogRecordExportResult.SUCCESS + + result.error = export_result.error + if export_result.status_code is not None: + result.error_attrs = { + HTTP_RESPONSE_STATUS_CODE: export_result.status_code + } return LogRecordExportResult.FAILURE def force_flush(self, timeout_millis: float = 10_000) -> bool: @@ -271,23 +228,5 @@ def shutdown(self): _logger.warning("Exporter already shutdown, ignoring call") return self._shutdown = True - self._shutdown_is_occuring.set() - self._session.close() - - -def _compression_from_env() -> Compression: - compression = ( - environ.get( - OTEL_EXPORTER_OTLP_LOGS_COMPRESSION, - environ.get(OTEL_EXPORTER_OTLP_COMPRESSION, "none"), - ) - .lower() - .strip() - ) - return Compression(compression) - - -def _append_logs_path(endpoint: str) -> str: - if endpoint.endswith("/"): - return endpoint + DEFAULT_LOGS_EXPORT_PATH - return endpoint + f"/{DEFAULT_LOGS_EXPORT_PATH}" + self._shutdown_event.set() + self._client.close() diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/metric_exporter/__init__.py b/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/metric_exporter/__init__.py index eb1e69cfe4f..f24a1a6a35e 100644 --- a/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/metric_exporter/__init__.py +++ b/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/metric_exporter/__init__.py @@ -1,29 +1,31 @@ # Copyright The OpenTelemetry Authors # SPDX-License-Identifier: Apache-2.0 + from __future__ import annotations -import gzip import logging -import os -import random import threading -import zlib from collections.abc import Callable, Iterable -from io import BytesIO from os import environ -from time import time from typing import ( # noqa: F401 + TYPE_CHECKING, Any, - Optional, + Final, + Literal, + overload, ) from urllib.parse import urlparse -import requests -from requests.exceptions import ConnectionError from typing_extensions import deprecated +from opentelemetry.exporter.http.transport._base import ( + BaseHTTPTransport, +) +from opentelemetry.exporter.http.transport._otlp_client import ( + OTLPHTTPClient, +) from opentelemetry.exporter.otlp.proto.common._exporter_metrics import ( - create_exporter_metrics, + ExporterMetrics, ) from opentelemetry.exporter.otlp.proto.common._internal import ( _get_resource_data, @@ -35,12 +37,16 @@ encode_metrics, ) from opentelemetry.exporter.otlp.proto.http import ( + _CONTENT_ENCODING_HEADER, _OTLP_HTTP_HEADERS, Compression, ) from opentelemetry.exporter.otlp.proto.http._common import ( - _is_retryable, - _load_session_from_envvar, + _as_transport_compression, + _compression_from_env, + _endpoint_from_env, + _session_from_env, + _transport_from_args, ) from opentelemetry.metrics import MeterProvider from opentelemetry.proto.collector.metrics.v1.metrics_service_pb2 import ( # noqa: F401 @@ -63,8 +69,6 @@ OTEL_EXPORTER_OTLP_CERTIFICATE, OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE, OTEL_EXPORTER_OTLP_CLIENT_KEY, - OTEL_EXPORTER_OTLP_COMPRESSION, - OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE, OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE, @@ -74,7 +78,6 @@ OTEL_EXPORTER_OTLP_METRICS_HEADERS, OTEL_EXPORTER_OTLP_METRICS_TIMEOUT, OTEL_EXPORTER_OTLP_TIMEOUT, - OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, ) from opentelemetry.sdk.metrics._internal.aggregation import Aggregation from opentelemetry.sdk.metrics.export import ( # noqa: F401 @@ -97,17 +100,56 @@ ) from opentelemetry.util.re import parse_env_headers +if TYPE_CHECKING: + import requests + + _logger = logging.getLogger(__name__) -DEFAULT_COMPRESSION = Compression.NoCompression -DEFAULT_ENDPOINT = "http://localhost:4318/" -DEFAULT_METRICS_EXPORT_PATH = "v1/metrics" -DEFAULT_TIMEOUT = 10 # in seconds -_MAX_RETRYS = 6 +DEFAULT_TIMEOUT: Final[int] = 10 # in seconds +DEFAULT_METRICS_EXPORT_PATH: Final[Literal["v1/metrics"]] = "v1/metrics" class OTLPMetricExporter(MetricExporter, OTLPMetricExporterMixin): + @overload + def __init__( + self, + endpoint: str | None = ..., + certificate_file: str | None = ..., + client_key_file: str | None = ..., + client_certificate_file: str | None = ..., + headers: dict[str, str] | None = ..., + timeout: float | None = ..., + compression: Compression | None = ..., + session: requests.Session | None = ..., + preferred_temporality: dict[type, AggregationTemporality] | None = ..., + preferred_aggregation: dict[type, Aggregation] | None = ..., + max_export_batch_size: int | None = ..., + *, + meter_provider: MeterProvider | None = ..., + _transport: None = ..., + ) -> None: ... + + @overload + def __init__( + self, + endpoint: str | None = ..., + certificate_file: str | None = ..., + client_key_file: str | None = ..., + client_certificate_file: str | None = ..., + headers: dict[str, str] | None = ..., + timeout: float | None = ..., + compression: Compression | None = ..., + session: None = ..., + preferred_temporality: dict[type, AggregationTemporality] | None = ..., + preferred_aggregation: dict[type, Aggregation] | None = ..., + max_export_batch_size: int | None = ..., + *, + meter_provider: MeterProvider | None = ..., + _transport: BaseHTTPTransport, + ) -> None: ... + def __init__( self, endpoint: str | None = None, @@ -124,6 +166,7 @@ def __init__( max_export_batch_size: int | None = None, *, meter_provider: MeterProvider | None = None, + _transport: BaseHTTPTransport | None = None, ): """OTLP HTTP metrics exporter @@ -146,12 +189,9 @@ def __init__( If not set there is no limit to the number of data points in a request. If it is set and the number of data points exceeds the max, the request will be split. """ - self._shutdown_in_progress = threading.Event() - self._endpoint = endpoint or environ.get( - OTEL_EXPORTER_OTLP_METRICS_ENDPOINT, - _append_metrics_path( - environ.get(OTEL_EXPORTER_OTLP_ENDPOINT, DEFAULT_ENDPOINT) - ), + self._shutdown_event = threading.Event() + self._endpoint = endpoint or _endpoint_from_env( + OTEL_EXPORTER_OTLP_METRICS_ENDPOINT, DEFAULT_METRICS_EXPORT_PATH ) self._certificate_file = certificate_file or environ.get( OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE, @@ -183,22 +223,35 @@ def __init__( environ.get(OTEL_EXPORTER_OTLP_TIMEOUT, DEFAULT_TIMEOUT), ) ) - self._compression = compression or _compression_from_env() - self._session = ( + self._compression = compression or _compression_from_env( + OTEL_EXPORTER_OTLP_METRICS_COMPRESSION + ) + + transport = _transport or _transport_from_args( session - or _load_session_from_envvar( + or _session_from_env( _OTEL_PYTHON_EXPORTER_OTLP_HTTP_METRICS_CREDENTIAL_PROVIDER - ) - or requests.Session() + ), + self._certificate_file, + self._client_cert, ) - self._session.headers.update(self._headers) - self._session.headers.update(_OTLP_HTTP_HEADERS) - # let users override our defaults - self._session.headers.update(self._headers) + + client_headers: dict[str, str] = { + **_OTLP_HTTP_HEADERS, + **self._headers, + } if self._compression is not Compression.NoCompression: - self._session.headers.update( - {"Content-Encoding": self._compression.value} - ) + client_headers[_CONTENT_ENCODING_HEADER] = self._compression.value + + self._client = OTLPHTTPClient( + transport=transport, + endpoint=self._endpoint, + timeout=self._timeout, + compression=_as_transport_compression(self._compression), + shutdown_event=self._shutdown_event, + headers=client_headers, + kind="metrics", + ) self._common_configuration( preferred_temporality, preferred_aggregation @@ -206,131 +259,37 @@ def __init__( self._max_export_batch_size: int | None = max_export_batch_size self._shutdown = False - self._metrics = create_exporter_metrics( + self._metrics = ExporterMetrics( OtelComponentTypeValues.OTLP_HTTP_METRIC_EXPORTER, "metrics", urlparse(self._endpoint), meter_provider, - os.environ.get(OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, "") - .strip() - .lower() - == "true", ) - def _export( - self, serialized_data: bytes, timeout_sec: float | None = None - ): - data = serialized_data - if self._compression == Compression.Gzip: - gzip_data = BytesIO() - with gzip.GzipFile(fileobj=gzip_data, mode="w") as gzip_stream: - gzip_stream.write(serialized_data) - data = gzip_data.getvalue() - elif self._compression == Compression.Deflate: - data = zlib.compress(serialized_data) - - if timeout_sec is None: - timeout_sec = self._timeout - - # By default, keep-alive is enabled in Session's request - # headers. Backends may choose to close the connection - # while a post happens which causes an unhandled - # exception. This try/except will retry the post on such exceptions - try: - resp = self._session.post( - url=self._endpoint, - data=data, - verify=self._certificate_file, - timeout=timeout_sec, - cert=self._client_cert, - ) - except ConnectionError: - resp = self._session.post( - url=self._endpoint, - data=data, - verify=self._certificate_file, - timeout=timeout_sec, - cert=self._client_cert, - ) - return resp - def _export_with_retries( self, export_request: ExportMetricsServiceRequest, - deadline_sec: float, num_items: int, ) -> MetricExportResult: - """Export serialized data with retry logic until success, non-transient error, or exponential backoff maxed out. + """Export serialized data via the shared OTLPHTTPClient. Args: export_request: ExportMetricsServiceRequest object containing metrics data to export - deadline_sec: timestamp deadline for the export Returns: MetricExportResult: SUCCESS if export succeeded, FAILURE otherwise """ with self._metrics.export_operation(num_items) as result: serialized_data = export_request.SerializeToString() - deadline_sec = time() + self._timeout - for retry_num in range(_MAX_RETRYS): - # multiplying by a random number between .8 and 1.2 introduces a +/20% jitter to each backoff. - backoff_seconds = 2**retry_num * random.uniform(0.8, 1.2) - export_error: Exception | None = None - try: - resp = self._export(serialized_data, deadline_sec - time()) - if resp.ok: - return MetricExportResult.SUCCESS - except requests.exceptions.RequestException as error: - reason = error - export_error = error - retryable = isinstance(error, ConnectionError) - status_code = None - else: - reason = resp.reason - retryable = _is_retryable(resp) - status_code = resp.status_code - - if not retryable: - _logger.error( - "Failed to export metrics batch code: %s, reason: %s", - status_code, - reason, - ) - error_attrs = ( - {HTTP_RESPONSE_STATUS_CODE: status_code} - if status_code is not None - else None - ) - result.error = export_error - result.error_attrs = error_attrs - return MetricExportResult.FAILURE - if ( - retry_num + 1 == _MAX_RETRYS - or backoff_seconds > (deadline_sec - time()) - or self._shutdown - ): - _logger.error( - "Failed to export metrics batch due to timeout, " - "max retries or shutdown." - ) - error_attrs = ( - {HTTP_RESPONSE_STATUS_CODE: status_code} - if status_code is not None - else None - ) - result.error = export_error - result.error_attrs = error_attrs - return MetricExportResult.FAILURE - - _logger.warning( - "Transient error %s encountered while exporting metrics batch, retrying in %.2fs.", - reason, - backoff_seconds, - ) - shutdown = self._shutdown_in_progress.wait(backoff_seconds) - if shutdown: - _logger.warning("Shutdown in progress, aborting retry.") - break + export_result = self._client.export(serialized_data) + if export_result.success: + return MetricExportResult.SUCCESS + + result.error = export_result.error + if export_result.status_code is not None: + result.error_attrs = { + HTTP_RESPONSE_STATUS_CODE: export_result.status_code + } return MetricExportResult.FAILURE def export( @@ -350,13 +309,10 @@ def export( num_items += len(metric.data.data_points) export_request = encode_metrics(metrics_data) - deadline_sec = time() + self._timeout # If no batch size configured, export as single batch with retries as configured if self._max_export_batch_size is None: - return self._export_with_retries( - export_request, deadline_sec, num_items - ) + return self._export_with_retries(export_request, num_items) # Else, export in batches of configured size batched_export_requests = _split_metrics_data( @@ -366,7 +322,6 @@ def export( for split_metrics_data in batched_export_requests: export_result = self._export_with_retries( split_metrics_data, - deadline_sec, num_items, ) if export_result != MetricExportResult.SUCCESS: @@ -380,8 +335,8 @@ def shutdown(self, timeout_millis: float = 30_000, **kwargs) -> None: _logger.warning("Exporter already shutdown, ignoring call") return self._shutdown = True - self._shutdown_in_progress.set() - self._session.close() + self._shutdown_event.set() + self._client.close() @property def _exporting(self) -> str: @@ -392,15 +347,11 @@ def force_flush(self, timeout_millis: float = 10_000) -> bool: return True def set_meter_provider(self, meter_provider: MeterProvider) -> None: - self._metrics = create_exporter_metrics( + self._metrics = ExporterMetrics( OtelComponentTypeValues.OTLP_HTTP_METRIC_EXPORTER, "metrics", urlparse(self._endpoint), meter_provider, - os.environ.get(OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, "") - .strip() - .lower() - == "true", ) @@ -722,21 +673,3 @@ def get_resource_data( name: str, ) -> list[PB2Resource]: return _get_resource_data(sdk_resource_scope_data, resource_class, name) - - -def _compression_from_env() -> Compression: - compression = ( - environ.get( - OTEL_EXPORTER_OTLP_METRICS_COMPRESSION, - environ.get(OTEL_EXPORTER_OTLP_COMPRESSION, "none"), - ) - .lower() - .strip() - ) - return Compression(compression) - - -def _append_metrics_path(endpoint: str) -> str: - if endpoint.endswith("/"): - return endpoint + DEFAULT_METRICS_EXPORT_PATH - return endpoint + f"/{DEFAULT_METRICS_EXPORT_PATH}" diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/trace_exporter/__init__.py b/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/trace_exporter/__init__.py index 2be240103c0..8f6d54348da 100644 --- a/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/trace_exporter/__init__.py +++ b/exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/trace_exporter/__init__.py @@ -1,34 +1,43 @@ # Copyright The OpenTelemetry Authors # SPDX-License-Identifier: Apache-2.0 -import gzip +from __future__ import annotations + import logging -import os -import random import threading -import zlib from collections.abc import Sequence -from io import BytesIO from os import environ -from time import time +from typing import ( + TYPE_CHECKING, + Final, + Literal, + overload, +) from urllib.parse import urlparse -import requests -from requests.exceptions import ConnectionError - +from opentelemetry.exporter.http.transport._base import ( + BaseHTTPTransport, +) +from opentelemetry.exporter.http.transport._otlp_client import ( + OTLPHTTPClient, +) from opentelemetry.exporter.otlp.proto.common._exporter_metrics import ( - create_exporter_metrics, + ExporterMetrics, ) from opentelemetry.exporter.otlp.proto.common.trace_encoder import ( encode_spans, ) from opentelemetry.exporter.otlp.proto.http import ( + _CONTENT_ENCODING_HEADER, _OTLP_HTTP_HEADERS, Compression, ) from opentelemetry.exporter.otlp.proto.http._common import ( - _is_retryable, - _load_session_from_envvar, + _as_transport_compression, + _compression_from_env, + _endpoint_from_env, + _session_from_env, + _transport_from_args, ) from opentelemetry.metrics import MeterProvider from opentelemetry.sdk.environment_variables import ( @@ -36,8 +45,6 @@ OTEL_EXPORTER_OTLP_CERTIFICATE, OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE, OTEL_EXPORTER_OTLP_CLIENT_KEY, - OTEL_EXPORTER_OTLP_COMPRESSION, - OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_TIMEOUT, OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE, @@ -47,7 +54,6 @@ OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_HEADERS, OTEL_EXPORTER_OTLP_TRACES_TIMEOUT, - OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, ) from opentelemetry.sdk.trace import ReadableSpan from opentelemetry.sdk.trace.export import SpanExporter, SpanExportResult @@ -59,17 +65,49 @@ ) from opentelemetry.util.re import parse_env_headers +if TYPE_CHECKING: + import requests + _logger = logging.getLogger(__name__) -DEFAULT_COMPRESSION = Compression.NoCompression -DEFAULT_ENDPOINT = "http://localhost:4318/" -DEFAULT_TRACES_EXPORT_PATH = "v1/traces" -DEFAULT_TIMEOUT = 10 # in seconds -_MAX_RETRYS = 6 +DEFAULT_TIMEOUT: Final[int] = 10 # in seconds +DEFAULT_TRACES_EXPORT_PATH: Final[Literal["v1/traces"]] = "v1/traces" class OTLPSpanExporter(SpanExporter): + @overload + def __init__( + self, + endpoint: str | None = ..., + certificate_file: str | None = ..., + client_key_file: str | None = ..., + client_certificate_file: str | None = ..., + headers: dict[str, str] | None = ..., + timeout: float | None = ..., + compression: Compression | None = ..., + session: requests.Session | None = ..., + *, + meter_provider: MeterProvider | None = ..., + _transport: None = ..., + ) -> None: ... + + @overload + def __init__( + self, + endpoint: str | None = ..., + certificate_file: str | None = ..., + client_key_file: str | None = ..., + client_certificate_file: str | None = ..., + headers: dict[str, str] | None = ..., + timeout: float | None = ..., + compression: Compression | None = ..., + session: None = ..., + *, + meter_provider: MeterProvider | None = ..., + _transport: BaseHTTPTransport, + ) -> None: ... + def __init__( self, endpoint: str | None = None, @@ -82,13 +120,11 @@ def __init__( session: requests.Session | None = None, *, meter_provider: MeterProvider | None = None, + _transport: BaseHTTPTransport | None = None, ): - self._shutdown_in_progress = threading.Event() - self._endpoint = endpoint or environ.get( - OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, - _append_trace_path( - environ.get(OTEL_EXPORTER_OTLP_ENDPOINT, DEFAULT_ENDPOINT) - ), + self._shutdown_event = threading.Event() + self._endpoint = endpoint or _endpoint_from_env( + OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, DEFAULT_TRACES_EXPORT_PATH ) self._certificate_file = certificate_file or environ.get( OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE, @@ -120,72 +156,44 @@ def __init__( environ.get(OTEL_EXPORTER_OTLP_TIMEOUT, DEFAULT_TIMEOUT), ) ) - self._compression = compression or _compression_from_env() - self._session = ( + self._compression = compression or _compression_from_env( + OTEL_EXPORTER_OTLP_TRACES_COMPRESSION + ) + + transport = _transport or _transport_from_args( session - or _load_session_from_envvar( + or _session_from_env( _OTEL_PYTHON_EXPORTER_OTLP_HTTP_TRACES_CREDENTIAL_PROVIDER - ) - or requests.Session() + ), + self._certificate_file, + self._client_cert, ) - self._session.headers.update(self._headers) - self._session.headers.update(_OTLP_HTTP_HEADERS) - # let users override our defaults - self._session.headers.update(self._headers) + + client_headers: dict[str, str] = { + **_OTLP_HTTP_HEADERS, + **self._headers, + } if self._compression is not Compression.NoCompression: - self._session.headers.update( - {"Content-Encoding": self._compression.value} - ) + client_headers[_CONTENT_ENCODING_HEADER] = self._compression.value + + self._client = OTLPHTTPClient( + transport=transport, + endpoint=self._endpoint, + timeout=self._timeout, + compression=_as_transport_compression(self._compression), + shutdown_event=self._shutdown_event, + headers=client_headers, + kind="spans", + ) self._shutdown = False - self._metrics = create_exporter_metrics( + self._metrics = ExporterMetrics( OtelComponentTypeValues.OTLP_HTTP_SPAN_EXPORTER, "traces", urlparse(self._endpoint), meter_provider, - os.environ.get(OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, "") - .strip() - .lower() - == "true", ) - def _export( - self, serialized_data: bytes, timeout_sec: float | None = None - ): - data = serialized_data - if self._compression == Compression.Gzip: - gzip_data = BytesIO() - with gzip.GzipFile(fileobj=gzip_data, mode="w") as gzip_stream: - gzip_stream.write(serialized_data) - data = gzip_data.getvalue() - elif self._compression == Compression.Deflate: - data = zlib.compress(serialized_data) - - if timeout_sec is None: - timeout_sec = self._timeout - - # By default, keep-alive is enabled in Session's request - # headers. Backends may choose to close the connection - # while a post happens which causes an unhandled - # exception. This try/except will retry the post on such exceptions - try: - resp = self._session.post( - url=self._endpoint, - data=data, - verify=self._certificate_file, - timeout=timeout_sec, - cert=self._client_cert, - ) - except ConnectionError: - resp = self._session.post( - url=self._endpoint, - data=data, - verify=self._certificate_file, - timeout=timeout_sec, - cert=self._client_cert, - ) - return resp - def export(self, spans: Sequence[ReadableSpan]) -> SpanExportResult: if self._shutdown: _logger.warning("Exporter already shutdown, ignoring batch") @@ -193,66 +201,15 @@ def export(self, spans: Sequence[ReadableSpan]) -> SpanExportResult: with self._metrics.export_operation(len(spans)) as result: serialized_data = encode_spans(spans).SerializePartialToString() - deadline_sec = time() + self._timeout - for retry_num in range(_MAX_RETRYS): - # multiplying by a random number between .8 and 1.2 introduces a +/20% jitter to each backoff. - backoff_seconds = 2**retry_num * random.uniform(0.8, 1.2) - export_error: Exception | None = None - try: - resp = self._export(serialized_data, deadline_sec - time()) - if resp.ok: - return SpanExportResult.SUCCESS - except requests.exceptions.RequestException as error: - reason = error - export_error = error - retryable = isinstance(error, ConnectionError) - status_code = None - else: - reason = resp.reason - retryable = _is_retryable(resp) - status_code = resp.status_code - - if not retryable: - _logger.error( - "Failed to export span batch code: %s, reason: %s", - status_code, - reason, - ) - error_attrs = ( - {HTTP_RESPONSE_STATUS_CODE: status_code} - if status_code is not None - else None - ) - result.error = export_error - result.error_attrs = error_attrs - return SpanExportResult.FAILURE - - if ( - retry_num + 1 == _MAX_RETRYS - or backoff_seconds > (deadline_sec - time()) - or self._shutdown - ): - _logger.error( - "Failed to export span batch due to timeout, " - "max retries or shutdown." - ) - error_attrs = ( - {HTTP_RESPONSE_STATUS_CODE: status_code} - if status_code is not None - else None - ) - result.error = export_error - result.error_attrs = error_attrs - return SpanExportResult.FAILURE - _logger.warning( - "Transient error %s encountered while exporting span batch, retrying in %.2fs.", - reason, - backoff_seconds, - ) - shutdown = self._shutdown_in_progress.wait(backoff_seconds) - if shutdown: - _logger.warning("Shutdown in progress, aborting retry.") - break + export_result = self._client.export(serialized_data) + if export_result.success: + return SpanExportResult.SUCCESS + + result.error = export_result.error + if export_result.status_code is not None: + result.error_attrs = { + HTTP_RESPONSE_STATUS_CODE: export_result.status_code + } return SpanExportResult.FAILURE def shutdown(self): @@ -260,27 +217,9 @@ def shutdown(self): _logger.warning("Exporter already shutdown, ignoring call") return self._shutdown = True - self._shutdown_in_progress.set() - self._session.close() + self._shutdown_event.set() + self._client.close() def force_flush(self, timeout_millis: int = 30000) -> bool: """Nothing is buffered in this exporter, so this method does nothing.""" return True - - -def _compression_from_env() -> Compression: - compression = ( - environ.get( - OTEL_EXPORTER_OTLP_TRACES_COMPRESSION, - environ.get(OTEL_EXPORTER_OTLP_COMPRESSION, "none"), - ) - .lower() - .strip() - ) - return Compression(compression) - - -def _append_trace_path(endpoint: str) -> str: - if endpoint.endswith("/"): - return endpoint + DEFAULT_TRACES_EXPORT_PATH - return endpoint + f"/{DEFAULT_TRACES_EXPORT_PATH}" diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/test-requirements.txt b/exporter/opentelemetry-exporter-otlp-proto-http/test-requirements.txt index c49d47791fb..e9a28ee3370 100644 --- a/exporter/opentelemetry-exporter-otlp-proto-http/test-requirements.txt +++ b/exporter/opentelemetry-exporter-otlp-proto-http/test-requirements.txt @@ -23,3 +23,4 @@ wrapt==1.16.0 -e opentelemetry-sdk -e opentelemetry-semantic-conventions -e exporter/opentelemetry-exporter-otlp-proto-http +-e exporter/opentelemetry-exporter-http-transport diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/tests/metrics/test_otlp_metrics_exporter.py b/exporter/opentelemetry-exporter-otlp-proto-http/tests/metrics/test_otlp_metrics_exporter.py index 84a11e8ae90..d68b1247f25 100644 --- a/exporter/opentelemetry-exporter-otlp-proto-http/tests/metrics/test_otlp_metrics_exporter.py +++ b/exporter/opentelemetry-exporter-otlp-proto-http/tests/metrics/test_otlp_metrics_exporter.py @@ -7,20 +7,32 @@ from logging import WARNING from os import environ from unittest import TestCase -from unittest.mock import ANY, MagicMock, Mock, patch +from unittest.mock import ANY, MagicMock, patch import requests from requests import Session from requests.exceptions import ConnectionError from requests.models import Response +from opentelemetry.exporter.http.transport._otlp_client import ( + ExportResult, + OTLPHTTPClient, +) +from opentelemetry.exporter.http.transport._requests import ( + RequestsHTTPTransport, +) +from opentelemetry.exporter.http.transport._urllib3 import ( + Urllib3HTTPTransport, +) from opentelemetry.exporter.otlp.proto.common.metrics_encoder import ( encode_metrics, ) from opentelemetry.exporter.otlp.proto.http import Compression -from opentelemetry.exporter.otlp.proto.http.metric_exporter import ( +from opentelemetry.exporter.otlp.proto.http._common import ( + _DEFAULT_ENDPOINT, DEFAULT_COMPRESSION, - DEFAULT_ENDPOINT, +) +from opentelemetry.exporter.otlp.proto.http.metric_exporter import ( DEFAULT_METRICS_EXPORT_PATH, DEFAULT_TIMEOUT, OTLPMetricExporter, @@ -57,7 +69,6 @@ OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE, OTEL_EXPORTER_OTLP_METRICS_TIMEOUT, OTEL_EXPORTER_OTLP_TIMEOUT, - OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, ) from opentelemetry.sdk.metrics import ( Counter, @@ -132,7 +143,8 @@ def test_constructor_default(self): exporter = OTLPMetricExporter() self.assertEqual( - exporter._endpoint, DEFAULT_ENDPOINT + DEFAULT_METRICS_EXPORT_PATH + exporter._endpoint, + f"{_DEFAULT_ENDPOINT}/{DEFAULT_METRICS_EXPORT_PATH}", ) self.assertEqual(exporter._certificate_file, True) self.assertEqual(exporter._client_certificate_file, None) @@ -140,16 +152,18 @@ def test_constructor_default(self): self.assertEqual(exporter._timeout, DEFAULT_TIMEOUT) self.assertIs(exporter._compression, DEFAULT_COMPRESSION) self.assertEqual(exporter._headers, {}) - self.assertIsInstance(exporter._session, Session) - self.assertIn("User-Agent", exporter._session.headers) + self.assertIn("User-Agent", exporter._client._headers) self.assertEqual( - exporter._session.headers.get("Content-Type"), + exporter._client._headers.get("Content-Type"), "application/x-protobuf", ) self.assertEqual( - exporter._session.headers.get("User-Agent"), + exporter._client._headers.get("User-Agent"), "OTel-OTLP-Exporter-Python/" + __version__, ) + self.assertIsInstance( + exporter._client._transport, Urllib3HTTPTransport + ) @patch.dict( "os.environ", @@ -200,13 +214,17 @@ def f(): "user-agent": "metrics-user-agent", }, ) - self.assertIsInstance(exporter._session, Session) + self.assertIsInstance( + exporter._client._transport, RequestsHTTPTransport + ) + self.assertIs(exporter._client._transport._session, credential) + self.assertIsInstance(exporter._client._transport._session, Session) self.assertEqual( - exporter._session.headers.get("User-Agent"), + exporter._client._headers.get("user-agent"), "metrics-user-agent", ) self.assertEqual( - exporter._session.headers.get("Content-Type"), + exporter._client._headers.get("Content-Type"), "application/x-protobuf", ) @@ -224,6 +242,7 @@ def f(): }, ) def test_exporter_constructor_take_priority(self): + session = Session() exporter = OTLPMetricExporter( endpoint="example.com/1234", certificate_file="path/to/service.crt", @@ -232,7 +251,7 @@ def test_exporter_constructor_take_priority(self): headers={"testHeader1": "value1", "testHeader2": "value2"}, timeout=20, compression=Compression.NoCompression, - session=Session(), + session=session, ) self.assertEqual(exporter._endpoint, "example.com/1234") @@ -247,7 +266,11 @@ def test_exporter_constructor_take_priority(self): exporter._headers, {"testHeader1": "value1", "testHeader2": "value2"}, ) - self.assertIsInstance(exporter._session, Session) + self.assertIsInstance( + exporter._client._transport, RequestsHTTPTransport + ) + self.assertIs(exporter._client._transport._session, session) + self.assertIsInstance(exporter._client._transport._session, Session) @patch.dict( "os.environ", @@ -323,16 +346,13 @@ def test_headers_parse_from_env(self): ), ) - @patch.dict( - "os.environ", {OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED: " true "} - ) - @patch.object(Session, "post") + @patch.object(Session, "request") def test_success(self, mock_post): resp = Response() resp.status_code = 200 mock_post.return_value = resp - exporter = OTLPMetricExporter() + exporter = OTLPMetricExporter(session=Session()) exporter.set_meter_provider(self.meter_provider) self.assertEqual( @@ -364,16 +384,13 @@ def test_success(self, mock_post): metrics[2].data.data_points[0].attributes ) - @patch.dict( - "os.environ", {OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED: "true"} - ) - @patch.object(Session, "post") + @patch.object(Session, "request") def test_failure(self, mock_post): resp = Response() resp.status_code = 401 mock_post.return_value = resp - exporter = OTLPMetricExporter() + exporter = OTLPMetricExporter(session=Session()) exporter.set_meter_provider(self.meter_provider) self.assertEqual( @@ -428,13 +445,13 @@ def test_failure(self, mock_post): 401, ) - @patch.object(Session, "post") - def test_serialization(self, mock_post): + @patch.object(Session, "request") + def test_serialization(self, mock_request): resp = Response() resp.status_code = 200 - mock_post.return_value = resp + mock_request.return_value = resp - exporter = OTLPMetricExporter() + exporter = OTLPMetricExporter(session=Session()) self.assertEqual( exporter.export(self.metrics["sum_int"]), @@ -442,12 +459,13 @@ def test_serialization(self, mock_post): ) serialized_data = encode_metrics(self.metrics["sum_int"]) - mock_post.assert_called_once_with( + mock_request.assert_called_once_with( + method="POST", url=exporter._endpoint, + headers=ANY, data=serialized_data.SerializeToString(), - verify=exporter._certificate_file, timeout=ANY, # Timeout is a float based on real time, can't put an exact value here. - cert=exporter._client_cert, + allow_redirects=False, ) def test_split_metrics_data_many_data_points(self): @@ -947,7 +965,7 @@ def _create_metrics_data_multiple_data_points( ] ) - @patch.object(Session, "post") + @patch.object(Session, "request") def test_export_max_export_batch_size_single_batch_integration( self, mock_post ): @@ -959,7 +977,9 @@ def test_export_max_export_batch_size_single_batch_integration( metrics_data = ( TestOTLPMetricExporter._create_metrics_data_multiple_data_points(2) ) - exporter = OTLPMetricExporter(max_export_batch_size=3) + exporter = OTLPMetricExporter( + session=Session(), max_export_batch_size=3 + ) result = exporter.export(metrics_data) self.assertEqual(result, MetricExportResult.SUCCESS) @@ -969,9 +989,6 @@ def test_export_max_export_batch_size_single_batch_integration( call_args = mock_post.call_args self.assertEqual(call_args.kwargs["url"], exporter._endpoint) self.assertIsInstance(call_args.kwargs["data"], bytes) - self.assertEqual( - call_args.kwargs["verify"], exporter._certificate_file - ) batch_data = call_args.kwargs["data"] request = ExportMetricsServiceRequest() request.ParseFromString(batch_data) @@ -981,7 +998,7 @@ def test_export_max_export_batch_size_single_batch_integration( metric_names = {metric.name for metric in metrics} self.assertEqual(metric_names, {"sum_int_0", "sum_int_1"}) - @patch.object(Session, "post") + @patch.object(Session, "request") def test_export_max_export_batch_size_multiple_batches_integration( self, mock_post ): @@ -993,7 +1010,9 @@ def test_export_max_export_batch_size_multiple_batches_integration( metrics_data = ( TestOTLPMetricExporter._create_metrics_data_multiple_data_points(3) ) - exporter = OTLPMetricExporter(max_export_batch_size=2) + exporter = OTLPMetricExporter( + session=Session(), max_export_batch_size=2 + ) result = exporter.export(metrics_data) self.assertEqual(result, MetricExportResult.SUCCESS) @@ -1002,9 +1021,6 @@ def test_export_max_export_batch_size_multiple_batches_integration( for call_args in mock_post.call_args_list: self.assertEqual(call_args.kwargs["url"], exporter._endpoint) self.assertIsInstance(call_args.kwargs["data"], bytes) - self.assertEqual( - call_args.kwargs["verify"], exporter._certificate_file - ) self.assertEqual(len(mock_post.call_args_list), 2) # First batch should contain sum_int_0 and sum_int_1 @@ -1030,7 +1046,7 @@ def test_export_max_export_batch_size_multiple_batches_integration( self.assertEqual(len(second_metrics), 1) self.assertEqual(second_metrics[0].name, "sum_int_2") - @patch.object(Session, "post") + @patch.object(Session, "request") def test_export_max_export_batch_size_retry_scenarios_integration( self, mock_post ): @@ -1046,7 +1062,9 @@ def test_export_max_export_batch_size_retry_scenarios_integration( metrics_data = ( TestOTLPMetricExporter._create_metrics_data_multiple_data_points(3) ) - exporter = OTLPMetricExporter(max_export_batch_size=2) + exporter = OTLPMetricExporter( + session=Session(), max_export_batch_size=2 + ) # Export should fail when second batch fails result = exporter.export(metrics_data) @@ -1065,7 +1083,7 @@ def test_export_max_export_batch_size_retry_scenarios_integration( first_metric_names = {metric.name for metric in first_metrics} self.assertEqual(first_metric_names, {"sum_int_0", "sum_int_1"}) - @patch.object(Session, "post") + @patch.object(Session, "request") def test_export_max_export_batch_size_retryable_failure_integration( self, mock_post ): @@ -1084,7 +1102,9 @@ def test_export_max_export_batch_size_retryable_failure_integration( metrics_data = ( TestOTLPMetricExporter._create_metrics_data_multiple_data_points(3) ) - exporter = OTLPMetricExporter(max_export_batch_size=2, timeout=2.0) + exporter = OTLPMetricExporter( + session=Session(), max_export_batch_size=2, timeout=2.0 + ) # Export should eventually succeed after retry result = exporter.export(metrics_data) @@ -1260,8 +1280,12 @@ def test_exponential_explicit_bucket_histogram(self): ExplicitBucketHistogramAggregation, ) - @patch.object(OTLPMetricExporter, "_export", return_value=Mock(ok=True)) - def test_2xx_status_code(self, mock_otlp_metric_exporter): + @patch.object( + OTLPHTTPClient, + "export", + return_value=ExportResult(True, 200, "OK", None), + ) + def test_2xx_status_code(self, mock_client_export): """ Test that any HTTP 2XX code returns a successful result """ @@ -1271,21 +1295,6 @@ def test_2xx_status_code(self, mock_otlp_metric_exporter): MetricExportResult.SUCCESS, ) - @patch.dict("os.environ", {}, clear=True) - @patch.object(OTLPMetricExporter, "_export", return_value=Mock(ok=True)) - def test_exporter_metrics_disabled_after_set_meter_provider( - self, _mock_export - ): - exporter = OTLPMetricExporter() - exporter.set_meter_provider(self.meter_provider) - - self.assertEqual( - exporter.export(self.metrics["sum_int"]), - MetricExportResult.SUCCESS, - ) - - self.assertIsNone(self.metric_reader.get_metrics_data()) - def test_preferred_aggregation_override(self): histogram_aggregation = ExplicitBucketHistogramAggregation( boundaries=[0.05, 0.1, 0.5, 1, 5, 10], @@ -1301,13 +1310,10 @@ def test_preferred_aggregation_override(self): exporter._preferred_aggregation[Histogram], histogram_aggregation ) - @patch.dict( - "os.environ", {OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED: "true"} - ) - @patch.object(Session, "post") + @patch.object(Session, "request") def test_retry_timeout(self, mock_post): exporter = OTLPMetricExporter( - timeout=1.5, meter_provider=self.meter_provider + session=Session(), timeout=1.5, meter_provider=self.meter_provider ) resp = Response() @@ -1378,9 +1384,9 @@ def test_retry_timeout(self, mock_post): 503, ) - @patch.object(Session, "post") + @patch.object(Session, "request") def test_export_no_collector_available_retryable(self, mock_post): - exporter = OTLPMetricExporter(timeout=1.5) + exporter = OTLPMetricExporter(session=Session(), timeout=1.5) msg = "Server not available." mock_post.side_effect = ConnectionError(msg) with self.assertLogs(level=WARNING) as warning: @@ -1396,9 +1402,9 @@ def test_export_no_collector_available_retryable(self, mock_post): warning.records[0].message, ) - @patch.object(Session, "post") + @patch.object(Session, "request") def test_export_no_collector_available(self, mock_post): - exporter = OTLPMetricExporter(timeout=1.5) + exporter = OTLPMetricExporter(session=Session(), timeout=1.5) mock_post.side_effect = requests.exceptions.RequestException() with self.assertLogs(level=WARNING) as warning: @@ -1412,7 +1418,7 @@ def test_export_no_collector_available(self, mock_post): warning.records[0].message, ) - @patch.object(Session, "post") + @patch.object(Session, "request") def test_timeout_set_correctly(self, mock_post): resp = Response() resp.status_code = 200 @@ -1423,12 +1429,12 @@ def export_side_effect(*args, **kwargs): return resp mock_post.side_effect = export_side_effect - exporter = OTLPMetricExporter(timeout=0.4) + exporter = OTLPMetricExporter(session=Session(), timeout=0.4) exporter.export(self.metrics["sum_int"]) - @patch.object(Session, "post") + @patch.object(Session, "request") def test_shutdown_interrupts_retry_backoff(self, mock_post): - exporter = OTLPMetricExporter(timeout=1.5) + exporter = OTLPMetricExporter(session=Session(), timeout=1.5) resp = Response() resp.status_code = 503 diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_log_exporter.py b/exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_log_exporter.py index d7f3592e288..5dc53f4fb97 100644 --- a/exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_log_exporter.py +++ b/exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_log_exporter.py @@ -7,7 +7,7 @@ import time import unittest from logging import WARNING -from unittest.mock import MagicMock, Mock, patch +from unittest.mock import MagicMock, patch import requests from google.protobuf.json_format import MessageToDict @@ -16,10 +16,22 @@ from requests.models import Response from opentelemetry._logs import LogRecord, SeverityNumber +from opentelemetry.exporter.http.transport._otlp_client import ( + ExportResult, + OTLPHTTPClient, +) +from opentelemetry.exporter.http.transport._requests import ( + RequestsHTTPTransport, +) +from opentelemetry.exporter.http.transport._urllib3 import ( + Urllib3HTTPTransport, +) from opentelemetry.exporter.otlp.proto.http import Compression -from opentelemetry.exporter.otlp.proto.http._log_exporter import ( +from opentelemetry.exporter.otlp.proto.http._common import ( + _DEFAULT_ENDPOINT, DEFAULT_COMPRESSION, - DEFAULT_ENDPOINT, +) +from opentelemetry.exporter.otlp.proto.http._log_exporter import ( DEFAULT_LOGS_EXPORT_PATH, DEFAULT_TIMEOUT, OTLPLogExporter, @@ -46,7 +58,6 @@ OTEL_EXPORTER_OTLP_LOGS_HEADERS, OTEL_EXPORTER_OTLP_LOGS_TIMEOUT, OTEL_EXPORTER_OTLP_TIMEOUT, - OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, ) from opentelemetry.sdk.metrics import MeterProvider from opentelemetry.sdk.metrics.export import InMemoryMetricReader @@ -79,7 +90,8 @@ def test_constructor_default(self): exporter = OTLPLogExporter() self.assertEqual( - exporter._endpoint, DEFAULT_ENDPOINT + DEFAULT_LOGS_EXPORT_PATH + exporter._endpoint, + f"{_DEFAULT_ENDPOINT}/{DEFAULT_LOGS_EXPORT_PATH}", ) self.assertEqual(exporter._certificate_file, True) self.assertEqual(exporter._client_certificate_file, None) @@ -87,16 +99,18 @@ def test_constructor_default(self): self.assertEqual(exporter._timeout, DEFAULT_TIMEOUT) self.assertIs(exporter._compression, DEFAULT_COMPRESSION) self.assertEqual(exporter._headers, {}) - self.assertIsInstance(exporter._session, requests.Session) - self.assertIn("User-Agent", exporter._session.headers) + self.assertIn("User-Agent", exporter._client._headers) self.assertEqual( - exporter._session.headers.get("Content-Type"), + exporter._client._headers.get("Content-Type"), "application/x-protobuf", ) self.assertEqual( - exporter._session.headers.get("User-Agent"), + exporter._client._headers.get("User-Agent"), "OTel-OTLP-Exporter-Python/" + __version__, ) + self.assertIsInstance( + exporter._client._transport, Urllib3HTTPTransport + ) @patch.dict( "os.environ", @@ -147,15 +161,12 @@ def f(): "user-agent": "LogsUserAgent", }, ) - self.assertIs(exporter._session, credential) - self.assertIsInstance(exporter._session, requests.Session) - self.assertEqual( - exporter._session.headers.get("User-Agent"), - "LogsUserAgent", + self.assertIsInstance( + exporter._client._transport, RequestsHTTPTransport ) - self.assertEqual( - exporter._session.headers.get("Content-Type"), - "application/x-protobuf", + self.assertIs(exporter._client._transport._session, credential) + self.assertIsInstance( + exporter._client._transport._session, requests.Session ) @patch.dict( @@ -200,7 +211,7 @@ def test_exception_raised_when_entrypoint_does_not_exist(self): }, ) def test_exporter_constructor_take_priority(self): - sess = MagicMock() + session = Session() exporter = OTLPLogExporter( endpoint="endpoint.local:69/logs", certificate_file="/hello.crt", @@ -209,7 +220,7 @@ def test_exporter_constructor_take_priority(self): headers={"testHeader1": "value1", "testHeader2": "value2"}, timeout=70, compression=Compression.NoCompression, - session=sess(), + session=session, ) self.assertEqual(exporter._endpoint, "endpoint.local:69/logs") @@ -222,7 +233,10 @@ def test_exporter_constructor_take_priority(self): exporter._headers, {"testHeader1": "value1", "testHeader2": "value2"}, ) - self.assertTrue(sess.called) + self.assertIsInstance( + exporter._client._transport, RequestsHTTPTransport + ) + self.assertIs(exporter._client._transport._session, session) @patch.dict( "os.environ", @@ -257,14 +271,17 @@ def test_exporter_env(self): "user-agent": "Overridden", }, ) - self.assertIsInstance(exporter._session, requests.Session) @staticmethod def export_log_and_deserialize(log): - with patch("requests.Session.post") as mock_post: - exporter = OTLPLogExporter() + resp = Response() + resp.status_code = 200 + with patch( + "requests.Session.request", return_value=resp + ) as mock_request: + exporter = OTLPLogExporter(session=Session()) exporter.export([log]) - request_body = mock_post.call_args[1]["data"] + request_body = mock_request.call_args[1]["data"] request = ExportLogsServiceRequest() request.ParseFromString(request_body) request_dict = MessageToDict(request) @@ -445,8 +462,12 @@ def _get_sdk_log_data() -> list[ReadWriteLogRecord]: return [log1, log2, log3, log4] - @patch.object(OTLPLogExporter, "_export", return_value=Mock(ok=True)) - def test_2xx_status_code(self, mock_otlp_metric_exporter): + @patch.object( + OTLPHTTPClient, + "export", + return_value=ExportResult(True, 200, "OK", None), + ) + def test_2xx_status_code(self, mock_client_export): """ Test that any HTTP 2XX code returns a successful result """ @@ -456,19 +477,16 @@ def test_2xx_status_code(self, mock_otlp_metric_exporter): LogRecordExportResult.SUCCESS, ) - @patch.dict( - "os.environ", {OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED: " true "} - ) - @patch.object(Session, "post") - def test_retry_timeout(self, mock_post): + @patch.object(Session, "request") + def test_retry_timeout(self, mock_request): exporter = OTLPLogExporter( - timeout=1.5, meter_provider=self.meter_provider + session=Session(), timeout=1.5, meter_provider=self.meter_provider ) resp = Response() resp.status_code = 503 resp.reason = "UNAVAILABLE" - mock_post.return_value = resp + mock_request.return_value = resp with self.assertLogs(level=WARNING) as warning: before = time.time() # Set timeout to 1.5 seconds @@ -478,7 +496,7 @@ def test_retry_timeout(self, mock_post): ) after = time.time() # First call at time 0, second at time 1, then an early return before the second backoff sleep b/c it would exceed timeout. - self.assertEqual(mock_post.call_count, 2) + self.assertEqual(mock_request.call_count, 2) # There's a +/-20% jitter on each backoff. self.assertTrue(0.75 < after - before < 1.25) self.assertIn( @@ -529,11 +547,11 @@ def test_retry_timeout(self, mock_post): 503, ) - @patch.object(Session, "post") - def test_export_no_collector_available_retryable(self, mock_post): - exporter = OTLPLogExporter(timeout=1.5) + @patch.object(Session, "request") + def test_export_no_collector_available_retryable(self, mock_request): + exporter = OTLPLogExporter(session=Session(), timeout=1.5) msg = "Server not available." - mock_post.side_effect = ConnectionError(msg) + mock_request.side_effect = ConnectionError(msg) with self.assertLogs(level=WARNING) as warning: self.assertEqual( exporter.export(self._get_sdk_log_data()), @@ -541,28 +559,25 @@ def test_export_no_collector_available_retryable(self, mock_post): ) # Check for greater 2 because the request is on each retry # done twice at the moment. - self.assertGreater(mock_post.call_count, 2) + self.assertGreater(mock_request.call_count, 2) self.assertIn( f"Transient error {msg} encountered while exporting logs batch, retrying in", warning.records[0].message, ) - @patch.dict( - "os.environ", {OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED: "true"} - ) - @patch.object(Session, "post") - def test_export_no_collector_available(self, mock_post): + @patch.object(Session, "request") + def test_export_no_collector_available(self, mock_request): exporter = OTLPLogExporter( - timeout=1.5, meter_provider=self.meter_provider + session=Session(), timeout=1.5, meter_provider=self.meter_provider ) - mock_post.side_effect = requests.exceptions.RequestException() + mock_request.side_effect = requests.exceptions.RequestException() with self.assertLogs(level=WARNING) as warning: self.assertEqual( exporter.export(self._get_sdk_log_data()), LogRecordExportResult.FAILURE, ) - self.assertEqual(mock_post.call_count, 1) + self.assertEqual(mock_request.call_count, 1) self.assertIn( "Failed to export logs batch code", warning.records[0].message, @@ -611,8 +626,8 @@ def test_export_no_collector_available(self, mock_post): metrics[2].data.data_points[0].attributes, ) - @patch.object(Session, "post") - def test_timeout_set_correctly(self, mock_post): + @patch.object(Session, "request") + def test_timeout_set_correctly(self, mock_request): resp = Response() resp.status_code = 200 @@ -621,18 +636,18 @@ def export_side_effect(*args, **kwargs): self.assertAlmostEqual(0.4, kwargs["timeout"], 2) return resp - mock_post.side_effect = export_side_effect - exporter = OTLPLogExporter(timeout=0.4) + mock_request.side_effect = export_side_effect + exporter = OTLPLogExporter(session=Session(), timeout=0.4) exporter.export(self._get_sdk_log_data()) - @patch.object(Session, "post") - def test_shutdown_interrupts_retry_backoff(self, mock_post): - exporter = OTLPLogExporter(timeout=1.5) + @patch.object(Session, "request") + def test_shutdown_interrupts_retry_backoff(self, mock_request): + exporter = OTLPLogExporter(session=Session(), timeout=1.5) resp = Response() resp.status_code = 503 resp.reason = "UNAVAILABLE" - mock_post.return_value = resp + mock_request.return_value = resp thread = threading.Thread( target=exporter.export, args=(self._get_sdk_log_data(),) ) diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_span_exporter.py b/exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_span_exporter.py index 1580e5a1802..d606b1f24dc 100644 --- a/exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_span_exporter.py +++ b/exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_span_exporter.py @@ -12,10 +12,22 @@ from requests.exceptions import ConnectionError from requests.models import Response +from opentelemetry.exporter.http.transport._otlp_client import ( + ExportResult, + OTLPHTTPClient, +) +from opentelemetry.exporter.http.transport._requests import ( + RequestsHTTPTransport, +) +from opentelemetry.exporter.http.transport._urllib3 import ( + Urllib3HTTPTransport, +) from opentelemetry.exporter.otlp.proto.http import Compression -from opentelemetry.exporter.otlp.proto.http.trace_exporter import ( +from opentelemetry.exporter.otlp.proto.http._common import ( + _DEFAULT_ENDPOINT, DEFAULT_COMPRESSION, - DEFAULT_ENDPOINT, +) +from opentelemetry.exporter.otlp.proto.http.trace_exporter import ( DEFAULT_TIMEOUT, DEFAULT_TRACES_EXPORT_PATH, OTLPSpanExporter, @@ -37,7 +49,6 @@ OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_HEADERS, OTEL_EXPORTER_OTLP_TRACES_TIMEOUT, - OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, ) from opentelemetry.sdk.metrics import MeterProvider from opentelemetry.sdk.metrics.export import InMemoryMetricReader @@ -75,7 +86,8 @@ def test_constructor_default(self): exporter = OTLPSpanExporter() self.assertEqual( - exporter._endpoint, DEFAULT_ENDPOINT + DEFAULT_TRACES_EXPORT_PATH + exporter._endpoint, + f"{_DEFAULT_ENDPOINT}/{DEFAULT_TRACES_EXPORT_PATH}", ) self.assertEqual(exporter._certificate_file, True) self.assertEqual(exporter._client_certificate_file, None) @@ -83,16 +95,18 @@ def test_constructor_default(self): self.assertEqual(exporter._timeout, DEFAULT_TIMEOUT) self.assertIs(exporter._compression, DEFAULT_COMPRESSION) self.assertEqual(exporter._headers, {}) - self.assertIsInstance(exporter._session, requests.Session) - self.assertIn("User-Agent", exporter._session.headers) + self.assertIn("User-Agent", exporter._client._headers) self.assertEqual( - exporter._session.headers.get("Content-Type"), + exporter._client._headers.get("Content-Type"), "application/x-protobuf", ) self.assertEqual( - exporter._session.headers.get("User-Agent"), + exporter._client._headers.get("User-Agent"), "OTel-OTLP-Exporter-Python/" + __version__, ) + self.assertIsInstance( + exporter._client._transport, Urllib3HTTPTransport + ) @patch.dict( "os.environ", @@ -143,15 +157,12 @@ def f(): "user-agent": "TraceUserAgent", }, ) - self.assertIs(exporter._session, credential) - self.assertIsInstance(exporter._session, requests.Session) - self.assertEqual( - exporter._session.headers.get("Content-Type"), - "application/x-protobuf", + self.assertIsInstance( + exporter._client._transport, RequestsHTTPTransport ) - self.assertEqual( - exporter._session.headers.get("User-Agent"), - "TraceUserAgent", + self.assertIs(exporter._client._transport._session, credential) + self.assertIsInstance( + exporter._client._transport._session, requests.Session ) @patch.dict( @@ -168,6 +179,7 @@ def f(): }, ) def test_exporter_constructor_take_priority(self): + session = requests.Session() exporter = OTLPSpanExporter( endpoint="example.com/1234", certificate_file="path/to/service.crt", @@ -176,7 +188,7 @@ def test_exporter_constructor_take_priority(self): headers={"testHeader1": "value1", "testHeader2": "value2"}, timeout=20, compression=Compression.NoCompression, - session=requests.Session(), + session=session, ) self.assertEqual(exporter._endpoint, "example.com/1234") @@ -191,7 +203,13 @@ def test_exporter_constructor_take_priority(self): exporter._headers, {"testHeader1": "value1", "testHeader2": "value2"}, ) - self.assertIsInstance(exporter._session, requests.Session) + self.assertIsInstance( + exporter._client._transport, RequestsHTTPTransport + ) + self.assertIs(exporter._client._transport._session, session) + self.assertIsInstance( + exporter._client._transport._session, requests.Session + ) @patch.dict( "os.environ", @@ -267,8 +285,12 @@ def test_headers_parse_from_env(self): ), ) - @patch.object(OTLPSpanExporter, "_export", return_value=Mock(ok=True)) - def test_2xx_status_code(self, mock_otlp_metric_exporter): + @patch.object( + OTLPHTTPClient, + "export", + return_value=ExportResult(True, 200, "OK", None), + ) + def test_2xx_status_code(self, mock_client_export): """ Test that any HTTP 2XX code returns a successful result """ @@ -277,30 +299,16 @@ def test_2xx_status_code(self, mock_otlp_metric_exporter): OTLPSpanExporter().export(MagicMock()), SpanExportResult.SUCCESS ) - @patch.dict("os.environ", {}, clear=True) - @patch.object(OTLPSpanExporter, "_export", return_value=Mock(ok=True)) - def test_exporter_metrics_disabled_by_default(self, _mock_export): - exporter = OTLPSpanExporter(meter_provider=self.meter_provider) - - self.assertEqual( - exporter.export([BASIC_SPAN]), SpanExportResult.SUCCESS - ) - - self.assertIsNone(self.metric_reader.get_metrics_data()) - - @patch.dict( - "os.environ", {OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED: " true "} - ) - @patch.object(Session, "post") - def test_retry_timeout(self, mock_post): + @patch.object(Session, "request") + def test_retry_timeout(self, mock_request): exporter = OTLPSpanExporter( - timeout=1.5, meter_provider=self.meter_provider + session=Session(), timeout=1.5, meter_provider=self.meter_provider ) resp = Response() resp.status_code = 503 resp.reason = "UNAVAILABLE" - mock_post.return_value = resp + mock_request.return_value = resp with self.assertLogs(level=WARNING) as warning: before = time.time() # Set timeout to 1.5 seconds @@ -310,11 +318,11 @@ def test_retry_timeout(self, mock_post): ) after = time.time() # First call at time 0, second at time 1, then an early return before the second backoff sleep b/c it would exceed timeout. - self.assertEqual(mock_post.call_count, 2) + self.assertEqual(mock_request.call_count, 2) # There's a +/-20% jitter on each backoff. self.assertTrue(0.75 < after - before < 1.25) self.assertIn( - "Transient error UNAVAILABLE encountered while exporting span batch, retrying in", + "Transient error UNAVAILABLE encountered while exporting spans batch, retrying in", warning.records[0].message, ) @@ -361,11 +369,11 @@ def test_retry_timeout(self, mock_post): metrics[2].data.data_points[0].attributes, ) - @patch.object(Session, "post") - def test_export_no_collector_available_retryable(self, mock_post): - exporter = OTLPSpanExporter(timeout=1.5) + @patch.object(Session, "request") + def test_export_no_collector_available_retryable(self, mock_request): + exporter = OTLPSpanExporter(session=Session(), timeout=1.5) msg = "Server not available." - mock_post.side_effect = ConnectionError(msg) + mock_request.side_effect = ConnectionError(msg) with self.assertLogs(level=WARNING) as warning: self.assertEqual( exporter.export([BASIC_SPAN]), @@ -373,30 +381,27 @@ def test_export_no_collector_available_retryable(self, mock_post): ) # Check for greater 2 because the request is on each retry # done twice at the moment. - self.assertGreater(mock_post.call_count, 2) + self.assertGreater(mock_request.call_count, 2) self.assertIn( - f"Transient error {msg} encountered while exporting span batch, retrying in", + f"Transient error {msg} encountered while exporting spans batch, retrying in", warning.records[0].message, ) - @patch.dict( - "os.environ", {OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED: "true"} - ) - @patch.object(Session, "post") - def test_export_no_collector_available(self, mock_post): + @patch.object(Session, "request") + def test_export_no_collector_available(self, mock_request): exporter = OTLPSpanExporter( - timeout=1.5, meter_provider=self.meter_provider + session=Session(), timeout=1.5, meter_provider=self.meter_provider ) - mock_post.side_effect = requests.exceptions.RequestException() + mock_request.side_effect = requests.exceptions.RequestException() with self.assertLogs(level=WARNING) as warning: self.assertEqual( exporter.export([BASIC_SPAN]), SpanExportResult.FAILURE, ) - self.assertEqual(mock_post.call_count, 1) + self.assertEqual(mock_request.call_count, 1) self.assertIn( - "Failed to export span batch code", + "Failed to export spans batch code", warning.records[0].message, ) @@ -443,8 +448,8 @@ def test_export_no_collector_available(self, mock_post): metrics[2].data.data_points[0].attributes, ) - @patch.object(Session, "post") - def test_timeout_set_correctly(self, mock_post): + @patch.object(Session, "request") + def test_timeout_set_correctly(self, mock_request): resp = Response() resp.status_code = 200 @@ -453,18 +458,18 @@ def export_side_effect(*args, **kwargs): self.assertAlmostEqual(0.4, kwargs["timeout"], 2) return resp - mock_post.side_effect = export_side_effect - exporter = OTLPSpanExporter(timeout=0.4) + mock_request.side_effect = export_side_effect + exporter = OTLPSpanExporter(session=Session(), timeout=0.4) exporter.export([BASIC_SPAN]) - @patch.object(Session, "post") - def test_shutdown_interrupts_retry_backoff(self, mock_post): - exporter = OTLPSpanExporter(timeout=1.5) + @patch.object(Session, "request") + def test_shutdown_interrupts_retry_backoff(self, mock_request): + exporter = OTLPSpanExporter(session=Session(), timeout=1.5) resp = Response() resp.status_code = 503 resp.reason = "UNAVAILABLE" - mock_post.return_value = resp + mock_request.return_value = resp thread = threading.Thread(target=exporter.export, args=([BASIC_SPAN],)) with self.assertLogs(level=WARNING) as warning: before = time.time() @@ -476,7 +481,7 @@ def test_shutdown_interrupts_retry_backoff(self, mock_post): thread.join() after = time.time() self.assertIn( - "Transient error UNAVAILABLE encountered while exporting span batch, retrying in", + "Transient error UNAVAILABLE encountered while exporting spans batch, retrying in", warning.records[0].message, ) self.assertIn( diff --git a/exporter/opentelemetry-exporter-otlp/test-requirements.txt b/exporter/opentelemetry-exporter-otlp/test-requirements.txt index e1119b8a4c4..0a73365c05d 100644 --- a/exporter/opentelemetry-exporter-otlp/test-requirements.txt +++ b/exporter/opentelemetry-exporter-otlp/test-requirements.txt @@ -16,3 +16,4 @@ wrapt==1.16.0 -e opentelemetry-sdk -e opentelemetry-semantic-conventions -e exporter/opentelemetry-exporter-otlp +-e exporter/opentelemetry-exporter-http-transport diff --git a/pyproject.toml b/pyproject.toml index 28295af8658..1e765782d56 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,6 +9,7 @@ dependencies = [ "opentelemetry-proto", "opentelemetry-proto-json", "opentelemetry-test-utils", + "opentelemetry-exporter-http-transport", "opentelemetry-exporter-otlp-proto-grpc", "opentelemetry-exporter-otlp-proto-http", "opentelemetry-exporter-otlp-proto-common", @@ -32,6 +33,7 @@ opentelemetry-proto = { workspace = true } opentelemetry-proto-json = { workspace = true } opentelemetry-semantic-conventions = { workspace = true } opentelemetry-test-utils = { workspace = true } +opentelemetry-exporter-http-transport = { workspace = true } opentelemetry-exporter-otlp-proto-grpc = { workspace = true } opentelemetry-exporter-otlp-proto-http = { workspace = true } opentelemetry-exporter-otlp-proto-common = { workspace = true } @@ -119,6 +121,7 @@ include = [ "opentelemetry-api", "opentelemetry-sdk", "opentelemetry-proto-json", + "exporter/opentelemetry-exporter-http-transport", "exporter/opentelemetry-exporter-otlp-proto-grpc", "exporter/opentelemetry-exporter-otlp-proto-http", "exporter/opentelemetry-exporter-otlp-json-common", @@ -137,6 +140,7 @@ exclude = [ "opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/metric_reader_storage.py", "opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/view.py", "opentelemetry-sdk/benchmarks", + "exporter/opentelemetry-exporter-http-transport/tests", "exporter/opentelemetry-exporter-otlp-proto-grpc/tests", "exporter/opentelemetry-exporter-otlp-proto-http/tests", "exporter/opentelemetry-exporter-otlp-json-common/tests", diff --git a/tests/opentelemetry-docker-tests/tests/otlpexporter/test_otlp_http_exporter_functional.py b/tests/opentelemetry-docker-tests/tests/otlpexporter/test_otlp_http_exporter_functional.py index 95aa772716b..d87ce2c0e4e 100644 --- a/tests/opentelemetry-docker-tests/tests/otlpexporter/test_otlp_http_exporter_functional.py +++ b/tests/opentelemetry-docker-tests/tests/otlpexporter/test_otlp_http_exporter_functional.py @@ -30,9 +30,9 @@ def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.export_call_count = 0 - def _export(self, *args, **kwargs): + def _export_with_retries(self, *args, **kwargs): self.export_call_count += 1 - return super()._export(*args, **kwargs) + return super()._export_with_retries(*args, **kwargs) class TestOTLPHTTPExporter(BaseTestOTLPExporter, TestBase): diff --git a/tox.ini b/tox.ini index 5ebf34c3f37..a7c5c976b3c 100644 --- a/tox.ini +++ b/tox.ini @@ -44,6 +44,10 @@ envlist = ; opencensus-shim intentionally excluded from pypy3 (grpcio install fails) lint-opentelemetry-opencensus-shim + py3{10,11,12,13,14,14t}-test-opentelemetry-exporter-http-transport-{oldest,latest} + ; exporter-http-transport intentionally excluded from pypy3 + lint-opentelemetry-exporter-http-transport + py3{10,11,12,13,14}-test-opentelemetry-exporter-opencensus ; exporter-opencensus intentionally excluded from pypy3 lint-opentelemetry-exporter-opencensus @@ -136,6 +140,9 @@ deps = opentelemetry-protojson-gen-oldest: -r {toxinidir}/opentelemetry-proto-json/test-requirements.oldest.txt opentelemetry-protojson-gen-latest: -r {toxinidir}/opentelemetry-proto-json/test-requirements.latest.txt + opentelemetry-exporter-http-transport-oldest: -r {toxinidir}/exporter/opentelemetry-exporter-http-transport/test-requirements.oldest.txt + opentelemetry-exporter-http-transport-latest: -r {toxinidir}/exporter/opentelemetry-exporter-http-transport/test-requirements.latest.txt + exporter-opencensus: -r {toxinidir}/exporter/opentelemetry-exporter-opencensus/test-requirements.txt exporter-otlp-proto-common: -r {toxinidir}/exporter/opentelemetry-exporter-otlp-proto-common/test-requirements.txt @@ -230,6 +237,9 @@ commands = test-opentelemetry-opencensus-shim: pytest {toxinidir}/shim/opentelemetry-opencensus-shim/tests {posargs} lint-opentelemetry-opencensus-shim: sh -c "cd shim && pylint --rcfile ../.pylintrc {toxinidir}/shim/opentelemetry-opencensus-shim" + test-opentelemetry-exporter-http-transport: pytest {toxinidir}/exporter/opentelemetry-exporter-http-transport/tests {posargs} + lint-opentelemetry-exporter-http-transport: sh -c "cd exporter && pylint --rcfile ../.pylintrc {toxinidir}/exporter/opentelemetry-exporter-http-transport" + test-opentelemetry-exporter-opencensus: pytest {toxinidir}/exporter/opentelemetry-exporter-opencensus/tests {posargs} lint-opentelemetry-exporter-opencensus: sh -c "cd exporter && pylint --rcfile ../.pylintrc {toxinidir}/exporter/opentelemetry-exporter-opencensus" @@ -335,6 +345,7 @@ deps = -e {toxinidir}/tests/opentelemetry-test-utils ; OTLP packages otlpexporter: -e {toxinidir}/opentelemetry-proto + otlpexporter: -e {toxinidir}/exporter/opentelemetry-exporter-http-transport otlpexporter: -e {toxinidir}/exporter/opentelemetry-exporter-otlp-proto-common otlpexporter: -e {toxinidir}/exporter/opentelemetry-exporter-otlp-proto-grpc otlpexporter: -e {toxinidir}/exporter/opentelemetry-exporter-otlp-proto-http @@ -402,6 +413,7 @@ deps = -e {toxinidir}/opentelemetry-semantic-conventions -e {toxinidir}/opentelemetry-sdk[file-configuration] -e {toxinidir}/tests/opentelemetry-test-utils + -e {toxinidir}/exporter/opentelemetry-exporter-http-transport -e {toxinidir}/exporter/opentelemetry-exporter-otlp-proto-common -e {toxinidir}/exporter/opentelemetry-exporter-otlp-json-common -e {toxinidir}/exporter/opentelemetry-exporter-otlp diff --git a/uv.lock b/uv.lock index c7eb242e8dc..f7f1ca139ce 100644 --- a/uv.lock +++ b/uv.lock @@ -11,6 +11,7 @@ resolution-markers = [ members = [ "opentelemetry-api", "opentelemetry-codegen-json", + "opentelemetry-exporter-http-transport", "opentelemetry-exporter-otlp", "opentelemetry-exporter-otlp-json-common", "opentelemetry-exporter-otlp-proto-common", @@ -840,6 +841,25 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/45/a4/d59629684cef86a9da39241edd25dc2dff849d08def6200d50c951e1dd2a/opentelemetry_exporter_credential_provider_gcp-0.62b0-py3-none-any.whl", hash = "sha256:56d15d6486c40d9f958f34b1e9b4b6c9122789f5d136fc1381948b7b4b3af3ca", size = 8343, upload-time = "2026-04-09T14:39:18.399Z" }, ] +[[package]] +name = "opentelemetry-exporter-http-transport" +source = { editable = "exporter/opentelemetry-exporter-http-transport" } + +[package.optional-dependencies] +requests = [ + { name = "requests" }, +] +urllib3 = [ + { name = "urllib3" }, +] + +[package.metadata] +requires-dist = [ + { name = "requests", marker = "extra == 'requests'", specifier = "~=2.25" }, + { name = "urllib3", marker = "extra == 'urllib3'", specifier = ">=1.26" }, +] +provides-extras = ["requests", "urllib3"] + [[package]] name = "opentelemetry-exporter-otlp" source = { editable = "exporter/opentelemetry-exporter-otlp" } @@ -917,30 +937,36 @@ source = { editable = "exporter/opentelemetry-exporter-otlp-proto-http" } dependencies = [ { name = "googleapis-common-protos" }, { name = "opentelemetry-api" }, + { name = "opentelemetry-exporter-http-transport" }, { name = "opentelemetry-exporter-otlp-proto-common" }, { name = "opentelemetry-proto" }, { name = "opentelemetry-sdk" }, - { name = "requests" }, { name = "typing-extensions" }, + { name = "urllib3" }, ] [package.optional-dependencies] gcp-auth = [ { name = "opentelemetry-exporter-credential-provider-gcp" }, ] +requests = [ + { name = "requests" }, +] [package.metadata] requires-dist = [ { name = "googleapis-common-protos", specifier = "~=1.52" }, { name = "opentelemetry-api", editable = "opentelemetry-api" }, { name = "opentelemetry-exporter-credential-provider-gcp", marker = "extra == 'gcp-auth'", specifier = ">=0.59b0" }, + { name = "opentelemetry-exporter-http-transport", editable = "exporter/opentelemetry-exporter-http-transport" }, { name = "opentelemetry-exporter-otlp-proto-common", editable = "exporter/opentelemetry-exporter-otlp-proto-common" }, { name = "opentelemetry-proto", editable = "opentelemetry-proto" }, { name = "opentelemetry-sdk", editable = "opentelemetry-sdk" }, - { name = "requests", specifier = "~=2.7" }, + { name = "requests", marker = "extra == 'requests'", specifier = "~=2.7" }, { name = "typing-extensions", specifier = ">=4.5.0" }, + { name = "urllib3", specifier = ">=1.11" }, ] -provides-extras = ["gcp-auth"] +provides-extras = ["gcp-auth", "requests"] [[package]] name = "opentelemetry-exporter-prometheus" @@ -1019,6 +1045,7 @@ source = { virtual = "." } dependencies = [ { name = "opentelemetry-api" }, { name = "opentelemetry-codegen-json" }, + { name = "opentelemetry-exporter-http-transport" }, { name = "opentelemetry-exporter-otlp-json-common" }, { name = "opentelemetry-exporter-otlp-proto-common" }, { name = "opentelemetry-exporter-otlp-proto-grpc" }, @@ -1047,6 +1074,7 @@ dev = [ requires-dist = [ { name = "opentelemetry-api", editable = "opentelemetry-api" }, { name = "opentelemetry-codegen-json", editable = "codegen/opentelemetry-codegen-json" }, + { name = "opentelemetry-exporter-http-transport", editable = "exporter/opentelemetry-exporter-http-transport" }, { name = "opentelemetry-exporter-otlp-json-common", editable = "exporter/opentelemetry-exporter-otlp-json-common" }, { name = "opentelemetry-exporter-otlp-proto-common", editable = "exporter/opentelemetry-exporter-otlp-proto-common" }, { name = "opentelemetry-exporter-otlp-proto-grpc", editable = "exporter/opentelemetry-exporter-otlp-proto-grpc" },