diff --git a/opentelemetry-exporter-gcp-logging/setup.cfg b/opentelemetry-exporter-gcp-logging/setup.cfg index 2f6e198d..6ceb3fd6 100644 --- a/opentelemetry-exporter-gcp-logging/setup.cfg +++ b/opentelemetry-exporter-gcp-logging/setup.cfg @@ -40,4 +40,4 @@ test = opentelemetry_logs_exporter = gcp_logging = opentelemetry.exporter.cloud_logging:CloudLoggingExporter opentelemetry_environment_variables = - gcp_logging = opentelemetry.exporter.cloud_logging.environment_variables + gcp_logging = opentelemetry.exporter.cloud_logging.environment_variables \ No newline at end of file diff --git a/opentelemetry-exporter-gcp-monitoring/setup.cfg b/opentelemetry-exporter-gcp-monitoring/setup.cfg index 9f1886a0..db9390f8 100644 --- a/opentelemetry-exporter-gcp-monitoring/setup.cfg +++ b/opentelemetry-exporter-gcp-monitoring/setup.cfg @@ -40,5 +40,7 @@ test = [options.entry_points] opentelemetry_metrics_exporter = gcp_monitoring = opentelemetry.exporter.cloud_monitoring:CloudMonitoringMetricsExporter +opentelemetry_otlp_credential_provider = + gcp_grpc_channel_credentials = opentelemetry.exporter.cloud_monitoring:create_google_grpc_credentials opentelemetry_environment_variables = gcp_monitoring = opentelemetry.exporter.cloud_monitoring.environment_variables diff --git a/opentelemetry-gcp-auth-provider/CHANGELOG.md b/opentelemetry-gcp-auth-provider/CHANGELOG.md new file mode 100644 index 00000000..e69de29b diff --git a/opentelemetry-gcp-auth-provider/LICENSE b/opentelemetry-gcp-auth-provider/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/opentelemetry-gcp-auth-provider/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/opentelemetry-gcp-auth-provider/MANIFEST.in b/opentelemetry-gcp-auth-provider/MANIFEST.in new file mode 100644 index 00000000..aed3e332 --- /dev/null +++ b/opentelemetry-gcp-auth-provider/MANIFEST.in @@ -0,0 +1,9 @@ +graft src +graft tests +global-exclude *.pyc +global-exclude *.pyo +global-exclude __pycache__/* +include CHANGELOG.md +include MANIFEST.in +include README.rst +include LICENSE diff --git a/opentelemetry-gcp-auth-provider/README.rst b/opentelemetry-gcp-auth-provider/README.rst new file mode 100644 index 00000000..ac2c4f7a --- /dev/null +++ b/opentelemetry-gcp-auth-provider/README.rst @@ -0,0 +1,53 @@ +OpenTelemetry GCP Credential Provider for OTLP Exporters +============================================== + +.. image:: https://badge.fury.io/py/opentelemetry-exporter-gcp-logging.svg + :target: https://badge.fury.io/py/opentelemetry-exporter-gcp-logging + +.. image:: https://readthedocs.org/projects/google-cloud-opentelemetry/badge/?version=latest + :target: https://google-cloud-opentelemetry.readthedocs.io/en/latest/?badge=latest + :alt: Documentation Status + +This library provides support for supplying GCP authentication credentials to Python's auto instrumentation. +The credentials are passed to gRPC/HTTP exporters to send telemetry to `telemetry.googleapis.com`. + + +To get started with instrumentation in Google Cloud, see `Generate traces and metrics with +Python `_. + +To learn more about instrumentation and observability, including opinionated recommendations +for Google Cloud Observability, visit `Instrumentation and observability +`_. + +For resource detection and GCP trace context propagation, see +`opentelemetry-tools-google-cloud +`_. For the +Google Cloud Trace exporter, see `opentelemetry-exporter-gcp-trace +`_. + +Installation +------------ + +.. code:: bash + + pip install opentelemetry-gcp-auth-provider + +Usage +----- + +Set the following environment variables: +`export OTEL_RESOURCE_ATTRIBUTES="gcp.project_id="` + +To have python auto instrumentation use the HTTP OTLP Exporter to send traces to Cloud Trace: +`SET` + +To have python auto instrumentation use the GRPC OTLP Exporter to send traces to Cloud Trace: +'' + + + +References +---------- + +* `Cloud Logging `_ +* `OpenTelemetry Project `_ diff --git a/opentelemetry-gcp-auth-provider/mypy.ini b/opentelemetry-gcp-auth-provider/mypy.ini new file mode 100644 index 00000000..f6455a4e --- /dev/null +++ b/opentelemetry-gcp-auth-provider/mypy.ini @@ -0,0 +1,7 @@ +[mypy] +namespace_packages = True +explicit_package_bases = True +mypy_path = $MYPY_CONFIG_FILE_DIR/src + +[mypy-google.auth.*] +ignore_missing_imports = True diff --git a/opentelemetry-gcp-auth-provider/setup.cfg b/opentelemetry-gcp-auth-provider/setup.cfg new file mode 100644 index 00000000..5543b740 --- /dev/null +++ b/opentelemetry-gcp-auth-provider/setup.cfg @@ -0,0 +1,39 @@ +[metadata] +name = opentelemetry-exporter-gcp-auth-provider +description = Google Cloud Platform authentication provider +long_description = file: README.rst +long_description_content_type = text/x-rst +author = Google +author_email = opentelemetry-pypi@google.com +url = https://github.com/GoogleCloudPlatform/opentelemetry-operations-python/tree/main/opentelemetry-gcp-auth-provider +platforms = any +license = Apache-2.0 +classifiers = + Development Status :: 4 - Beta + Intended Audience :: Developers + License :: OSI Approved :: Apache Software License + Programming Language :: Python + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.9 + Programming Language :: Python :: 3.10 + Programming Language :: Python :: 3.11 + Programming Language :: Python :: 3.12 + Programming Language :: Python :: 3.13 + +[options] +python_requires = >=3.9 +package_dir= + =src +packages=find_namespace: +install_requires = + requests ~= 2.3 + google-auth ~= 2.4 + grpcio ~= 1.7 + +[options.packages.find] +where = src + +[options.entry_points] +opentelemetry_otlp_credential_provider = + gcp_grpc_channel_credentials = opentelemetry.gcp_auth_provider:create_google_grpc_credentials + gcp_http_authorized_session = opentelemetry.gcp_auth_provider:create_google_authorized_session diff --git a/opentelemetry-gcp-auth-provider/setup.py b/opentelemetry-gcp-auth-provider/setup.py new file mode 100644 index 00000000..9b0a4e8c --- /dev/null +++ b/opentelemetry-gcp-auth-provider/setup.py @@ -0,0 +1,33 @@ +# Copyright 2021 The OpenTelemetry Authors +# +# 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. +import os + +import setuptools + +BASE_DIR = os.path.dirname(__file__) +VERSION_FILENAME = os.path.join( + BASE_DIR, + "src", + "opentelemetry", + "gcp_auth_provider", + "version.py", +) +PACKAGE_INFO = {} +with open(VERSION_FILENAME) as f: + exec(f.read(), PACKAGE_INFO) + +setuptools.setup( + version=PACKAGE_INFO["__version__"], + package_data={"opentelemetry": ["py.typed"]}, +) diff --git a/opentelemetry-gcp-auth-provider/src/opentelemetry/gcp_auth_provider/__init__.py b/opentelemetry-gcp-auth-provider/src/opentelemetry/gcp_auth_provider/__init__.py new file mode 100644 index 00000000..ec3b9343 --- /dev/null +++ b/opentelemetry-gcp-auth-provider/src/opentelemetry/gcp_auth_provider/__init__.py @@ -0,0 +1,35 @@ +# Copyright 2025 Google LLC +# +# 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. + +import google.auth +import google.auth.transport.requests +import grpc +import requests +from google.auth.transport.grpc import AuthMetadataPlugin +from google.auth.transport.requests import AuthorizedSession, Request + + +def create_google_grpc_credentials() -> grpc.ChannelCredentials: + credentials, _ = google.auth.default() + return grpc.composite_channel_credentials( + grpc.ssl_channel_credentials(), + grpc.metadata_call_credentials( + AuthMetadataPlugin(credentials=credentials, request=Request()) + ), + ) + + +def create_google_authorized_session() -> requests.Session: + credentials, _ = google.auth.default() + return AuthorizedSession(credentials) diff --git a/opentelemetry-gcp-auth-provider/src/opentelemetry/gcp_auth_provider/version.py b/opentelemetry-gcp-auth-provider/src/opentelemetry/gcp_auth_provider/version.py new file mode 100644 index 00000000..8827fcbc --- /dev/null +++ b/opentelemetry-gcp-auth-provider/src/opentelemetry/gcp_auth_provider/version.py @@ -0,0 +1,15 @@ +# Copyright 2025 Google LLC +# +# 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. + +__version__ = "1.10.0.dev0" diff --git a/opentelemetry-gcp-auth-provider/tests/test_credential_provider.py b/opentelemetry-gcp-auth-provider/tests/test_credential_provider.py new file mode 100644 index 00000000..1a477ba1 --- /dev/null +++ b/opentelemetry-gcp-auth-provider/tests/test_credential_provider.py @@ -0,0 +1,70 @@ +# Copyright 2023 Google LLC +# +# 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 +# +# https://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. +from os import environ +from unittest import TestCase +from unittest.mock import patch + +from google.auth.transport.requests import AuthorizedSession +from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import ( + OTLPSpanExporter as GRPCOTLPSpanExporter, +) +from opentelemetry.exporter.otlp.proto.http.trace_exporter import ( + OTLPSpanExporter, +) + +# private import for testing only +from opentelemetry.sdk._configuration import _init_exporter +from opentelemetry.sdk.environment_variables import ( + OTEL_PYTHON_EXPORTER_OTLP_TRACES_CREDENTIAL_PROVIDER, +) + + +# These tests will not pass until the upstream PR is submitted. +class TestOTLPTraceAutoInstrumentGcpCredential(TestCase): + @patch.dict( + environ, + { + OTEL_PYTHON_EXPORTER_OTLP_TRACES_CREDENTIAL_PROVIDER: "gcp_http_authorized_session" + }, + ) + def test_loads_otlp_http_exporter_with_google_session(self): + """Test that OTel configuration internals can load the credentials from entrypoint by + name""" + + exporter = _init_exporter( + "traces", + {}, + OTLPSpanExporter, + otlp_credential_param_for_all_signal_types=None, + ) + assert isinstance(exporter._session, AuthorizedSession) + + @patch.dict( + environ, + { + OTEL_PYTHON_EXPORTER_OTLP_TRACES_CREDENTIAL_PROVIDER: "gcp_grpc_channel_credentials" + }, + ) + def test_loads_otlp_grpc_exporter_with_google_channel_creds(self): + """Test that OTel configuration internals can load the credentials from entrypoint by + name""" + + exporter = _init_exporter( + "traces", + {}, + GRPCOTLPSpanExporter, + otlp_credential_param_for_all_signal_types=None, + ) + # TODO: Figure out how to assert something about exporter.credentials. google's grpc credentials obj look exactly like + # the default one.. diff --git a/tox.ini b/tox.ini index e7e7a4eb..f330a057 100644 --- a/tox.ini +++ b/tox.ini @@ -5,13 +5,13 @@ requires = tox>=4 envlist = ; Add the `ci` factor to any env that should be running during CI. - py3{9,10,11,12,13}-ci-test-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging} - {lint,mypy}-ci-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging} + py3{9,10,11,12,13}-ci-test-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging, gcpauthprovider} + {lint,mypy}-ci-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging, gcpauthprovider} docs-ci ; These are development commands and share the same virtualenv within each ; package root directory - {fix}-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging} + {fix}-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging, gcpauthprovider} ; Installs dev depenedencies and all packages in this repo with editable ; install into a single env. Useful for editor autocompletion @@ -59,8 +59,9 @@ setenv = cloudlogging: PACKAGE_NAME = opentelemetry-exporter-gcp-logging propagator: PACKAGE_NAME = opentelemetry-propagator-gcp resourcedetector: PACKAGE_NAME = opentelemetry-resourcedetector-gcp + gcpauthprovider: PACKAGE_NAME = opentelemetry-gcp-auth-provider -[testenv:py3{9,10,11,12,13}-ci-test-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging}] +[testenv:py3{9,10,11,12,13}-ci-test-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging, gcpauthprovider}] deps = ; editable install the package itself -e {toxinidir}/{env:PACKAGE_NAME} @@ -81,7 +82,7 @@ allowlist_externals = bash {toxinidir}/get_mock_server.sh -[testenv:{lint,mypy}-ci-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging}] +[testenv:{lint,mypy}-ci-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging, gcpauthprovider}] basepython = {[constants]dev_basepython} deps = ; editable install the package itself @@ -109,7 +110,7 @@ allowlist_externals = make bash -[testenv:{fix}-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging}] +[testenv:{fix}-{cloudtrace,cloudmonitoring,propagator,resourcedetector, cloudlogging, gcpauthprovider}] basepython = {[constants]dev_basepython} envdir = cloudtrace: opentelemetry-exporter-gcp-trace/venv @@ -117,6 +118,7 @@ envdir = propagator: opentelemetry-propagator-gcp/venv resourcedetector: opentelemetry-resourcedetector-gcp/venv cloudlogging: opentelemetry-exporter-gcp-logging/venv + gcpauthprovider: opentelemetry-gcp-auth-provider/venv deps = {[constants]dev_deps} {[constants]monorepo_deps} @@ -138,3 +140,4 @@ deps = -e opentelemetry-propagator-gcp -e opentelemetry-resourcedetector-gcp -e opentelemetry-exporter-gcp-logging + -e opentelemetry-gcp-auth-provider