Many changes including OpenTelemetry support (#77)

Author: cretz

.github/workflows/ci.yml

@@ -40,7 +40,7 @@ jobs:
         with:
           go-version: "1.18"
       - run: python -m pip install --upgrade wheel poetry poethepoet
-      - run: poetry install --no-root
+      - run: poetry install --no-root -E opentelemetry
       - run: poe lint
       - run: poe build-develop
       - run: poe test -s -o log_cli_level=DEBUG
@@ -117,7 +117,7 @@ jobs:
 
       # Prepare
       - run: python -m pip install --upgrade wheel poetry poethepoet
-      - run: poetry install --no-root
+      - run: poetry install --no-root -E opentelemetry
 
       # Add the source dist only for Linux x64 for now
       - if: ${{ matrix.package-suffix == 'linux-amd64' }}
@@ -164,7 +164,7 @@ jobs:
 
       # Prepare
       - run: python -m pip install --upgrade wheel poetry poethepoet
-      - run: poetry install --no-root
+      - run: poetry install --no-root -E opentelemetry
 
       # Build and fix the wheel
       - run: poetry run cibuildwheel --output-dir dist --arch aarch64
@@ -175,4 +175,3 @@ jobs:
         with:
           name: packages-linux-aarch64
           path: dist
-

README.md

@@ -582,6 +582,18 @@ cancellation of all outstanding activities.
 The `shutdown()` invocation will wait on all activities to complete, so if a long-running activity does not at least
 respect cancellation, the shutdown may never complete.
 
+### OpenTelemetry Support
+
+OpenTelemetry support requires the optional `opentelemetry` dependencies which are part of the `opentelemetry` extra.
+When using `pip`, running
+
+    pip install temporalio[opentelemetry]
+
+will install needed dependencies. Then the `temporalio.contrib.opentelemetry.TracingInterceptor` can be created and set
+as an interceptor on the `interceptors` argument of `Client.connect`. When set, spans will be created for all client
+calls and for all activity and workflow invocations on the worker, spans will be created and properly serialized through
+the server to give one proper trace for a workflow execution.
+
 ## Development
 
 The Python SDK is built to work with Python 3.7 and newer. It is built using

poetry.lock

@@ -27,6 +27,8 @@ script = "build.py"
 [tool.poetry.dependencies]
 dacite = "^1.6.0"
 grpcio = "^1.47.0"
+opentelemetry-api = { version = "^1.11.1", optional = true }
+opentelemetry-sdk = { version = "^1.11.1", optional = true }
 protobuf = "^3.20.1"
 python = "^3.7"
 types-protobuf = "^3.19.21"
@@ -51,6 +53,9 @@ setuptools-rust = "^1.3.0"
 toml = "^0.10.2"
 twine = "^4.0.1"
 
+[tool.poetry.extras]
+opentelemetry = ["opentelemetry-api", "opentelemetry-sdk"]
+
 [tool.poe.tasks]
 build-develop = ["build-bridge-develop"]
 build-bridge-develop = "python scripts/setup_bridge.py develop"
@@ -67,7 +72,7 @@ lint = [
 # TODO(cretz): Why does pydocstyle complain about @overload missing docs after
 # https://github.com/PyCQA/pydocstyle/pull/511?
 lint-docs = "pydocstyle --ignore-decorators=overload"
-lint-types = "mypy ."
+lint-types = "mypy --namespace-packages ."
 test = "pytest"
 
 # Install local, run single pytest with env var, uninstall local
@@ -133,7 +138,11 @@ add_ignore = [
 add-package = ["temporalio"]
 docformat = "google"
 html-output = "build/apidocs"
-intersphinx = ["https://docs.python.org/3/objects.inv", "https://googleapis.dev/python/protobuf/latest/objects.inv"]
+intersphinx = [
+  "https://docs.python.org/3/objects.inv",
+  "https://googleapis.dev/python/protobuf/latest/objects.inv",
+  "https://opentelemetry-python.readthedocs.io/en/latest/objects.inv",
+]
 privacy = [
   "PRIVATE:temporalio.bridge",
   "PRIVATE:temporalio.types",

pyproject.toml

@@ -0,0 +1,17 @@
+from .message_pb2 import (
+    ClusterMember,
+    ClusterMetadata,
+    HostInfo,
+    IndexSearchAttributes,
+    MembershipInfo,
+    RingInfo,
+)
+
+__all__ = [
+    "ClusterMember",
+    "ClusterMetadata",
+    "HostInfo",
+    "IndexSearchAttributes",
+    "MembershipInfo",
+    "RingInfo",
+]