Rename web framework packages from "ext" to "instrumentation" (#961)

open-telemetry · Aug 3, 2020 · 28d0cdf · 28d0cdf
1 parent 242d5a7
commit 28d0cdf
Show file tree

Hide file tree

Showing 146 changed files with 352 additions and 301 deletions.
diff --git a/docs-requirements.txt b/docs-requirements.txt
@@ -8,6 +8,7 @@ asyncpg>=0.12.0
 ddtrace>=0.34.0
 aiohttp~= 3.0
 aiopg>=0.13.0
+grpcio~=1.27
 Deprecated>=1.2.6
 django>=2.2
 PyMySQL~=0.9.3
@@ -29,5 +30,3 @@ boto~=2.0
 botocore~=1.0
 starlette~=0.13
 fastapi~=0.58.1
-opentelemetry-exporter-cloud-trace==0.10b0
-opentelemetry-exporter-cloud-monitoring==0.10b0
diff --git a/docs/conf.py b/docs/conf.py
@@ -43,7 +43,15 @@
     for f in listdir(ext)
     if isdir(join(ext, f))
 ]
-sys.path[:0] = source_dirs + exp_dirs + ext_dirs
+
+instr = "../instrumentation"
+instr_dirs = [
+    os.path.abspath("/".join(["../instrumentation", f, "src"]))
+    for f in listdir(instr)
+    if isdir(join(instr, f))
+]
+
+sys.path[:0] = source_dirs + exp_dirs + ext_dirs + instr_dirs
 
 # -- Project information -----------------------------------------------------
 

diff --git a/docs/examples/auto-instrumentation/README.rst b/docs/examples/auto-instrumentation/README.rst
@@ -73,7 +73,7 @@ Installation
 
     $ pip install opentelemetry-sdk
     $ pip install opentelemetry-instrumentation
-    $ pip install opentelemetry-ext-flask
+    $ pip install opentelemetry-instrumentation-flask
     $ pip install requests
 
 Execution

diff --git a/docs/examples/auto-instrumentation/server_instrumented.py b/docs/examples/auto-instrumentation/server_instrumented.py
@@ -15,7 +15,7 @@
 from flask import Flask, request
 
 from opentelemetry import propagators, trace
-from opentelemetry.ext.wsgi import collect_request_attributes
+from opentelemetry.instrumentation.wsgi import collect_request_attributes
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import (
     ConsoleSpanExporter,

diff --git a/docs/examples/datadog_exporter/README.rst b/docs/examples/datadog_exporter/README.rst
@@ -50,7 +50,7 @@ Distributed Example
     pip install opentelemetry-sdk
     pip install opentelemetry-exporter-datadog
     pip install opentelemetry-instrumentation
-    pip install opentelemetry-ext-flask
+    pip install opentelemetry-instrumentation-flask
     pip install flask
     pip install requests
 

diff --git a/docs/examples/django/README.rst b/docs/examples/django/README.rst
@@ -1,7 +1,7 @@
 OpenTelemetry Django Instrumentation Example
 ============================================
 
-This shows how to use ``opentelemetry-ext-django`` to automatically instrument a
+This shows how to use ``opentelemetry-instrumentation-django`` to automatically instrument a
 Django app.
 
 For more user convenience, a Django app is already provided in this directory.
@@ -24,7 +24,7 @@ Installation
 .. code-block::
 
     $ pip install opentelemetry-sdk
-    $ pip install opentelemetry-ext-django
+    $ pip install opentelemetry-instrumentation-django
     $ pip install requests
 
 
@@ -40,7 +40,7 @@ Set these environment variables first:
 #. ``export DJANGO_SETTINGS_MODULE=instrumentation_example.settings``
 
 The way to achieve OpenTelemetry instrumentation for your Django app is to use
-an ``opentelemetry.ext.django.DjangoInstrumentor`` to instrument the app.
+an ``opentelemetry.instrumentation.django.DjangoInstrumentor`` to instrument the app.
 
 Clone the ``opentelemetry-python`` repository and go to ``opentelemetry-python/docs/examples/django``.
 
@@ -105,4 +105,4 @@ References
 
 * `Django <https://djangoproject.com/>`_
 * `OpenTelemetry Project <https://opentelemetry.io/>`_
-* `OpenTelemetry Django extension <https://github.com/open-telemetry/opentelemetry-python/tree/master/ext/opentelemetry-ext-django>`_
+* `OpenTelemetry Django extension <https://github.com/open-telemetry/opentelemetry-python/tree/master/instrumentation/opentelemetry-instrumentation-django>`_
diff --git a/docs/examples/django/manage.py b/docs/examples/django/manage.py
@@ -17,7 +17,7 @@
 import os
 import sys
 
-from opentelemetry.ext.django import DjangoInstrumentor
+from opentelemetry.instrumentation.django import DjangoInstrumentor
 
 
 def main():

diff --git a/docs/examples/opentelemetry-example-app/setup.cfg b/docs/examples/opentelemetry-example-app/setup.cfg
@@ -45,8 +45,8 @@ install_requires =
     typing; python_version<'3.5'
     opentelemetry-api == 0.12.dev0
     opentelemetry-sdk == 0.12.dev0
-    opentelemetry-ext-requests == 0.12.dev0
-    opentelemetry-ext-flask == 0.12.dev0
+    opentelemetry-instrumentation-requests == 0.12.dev0
+    opentelemetry-instrumentation-flask == 0.12.dev0
     flask
     requests
     protobuf~=3.11

diff --git a/docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py b/docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py
@@ -19,9 +19,9 @@
 import flask
 import requests
 
-import opentelemetry.ext.requests
+import opentelemetry.instrumentation.requests
 from opentelemetry import trace
-from opentelemetry.ext.flask import FlaskInstrumentor
+from opentelemetry.instrumentation.flask import FlaskInstrumentor
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import (
     ConsoleSpanExporter,
@@ -33,7 +33,7 @@
 # It must be done before instrumenting any library
 trace.set_tracer_provider(TracerProvider())
 
-opentelemetry.ext.requests.RequestsInstrumentor().instrument()
+opentelemetry.instrumentation.requests.RequestsInstrumentor().instrument()
 
 trace.get_tracer_provider().add_span_processor(
     SimpleExportSpanProcessor(ConsoleSpanExporter())

diff --git a/docs/ext/aiohttp_client/aiohttp_client.rst b/docs/ext/aiohttp_client/aiohttp_client.rst
diff --git a/docs/ext/asgi/asgi.rst b/docs/ext/asgi/asgi.rst
diff --git a/docs/ext/flask/flask.rst b/docs/ext/flask/flask.rst
diff --git a/docs/ext/grpc/grpc.rst b/docs/ext/grpc/grpc.rst
@@ -1,5 +1,5 @@
-OpenTelemetry gRPC Integration
-==============================
+OpenTelemetry gRPC Instrumentation
+==================================
 
 Module contents
 ---------------

diff --git a/docs/ext/pyramid/pyramid.rst b/docs/ext/pyramid/pyramid.rst
diff --git a/docs/ext/wsgi/wsgi.rst b/docs/ext/wsgi/wsgi.rst
diff --git a/docs/getting-started.rst b/docs/getting-started.rst
@@ -156,8 +156,8 @@ We will now instrument a basic Flask application that uses the requests library
 
 .. code-block:: sh
 
-    pip install opentelemetry-ext-flask
-    pip install opentelemetry-ext-requests
+    pip install opentelemetry-instrumentation-flask
+    pip install opentelemetry-instrumentation-requests
 
 
 And let's write a small Flask application that sends an HTTP request, activating each instrumentation during the initialization:

diff --git a/docs/getting_started/flask_example.py b/docs/getting_started/flask_example.py
@@ -17,8 +17,8 @@
 import requests
 
 from opentelemetry import trace
-from opentelemetry.ext.flask import FlaskInstrumentor
-from opentelemetry.ext.requests import RequestsInstrumentor
+from opentelemetry.instrumentation.flask import FlaskInstrumentor
+from opentelemetry.instrumentation.requests import RequestsInstrumentor
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import (
     ConsoleSpanExporter,

diff --git a/docs/index.rst b/docs/index.rst
@@ -84,6 +84,14 @@ install <https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs>
     :name: Instrumentations
     :glob:
 
+    instrumentation/**
+
+.. toctree::
+    :maxdepth: 2
+    :caption: OpenTelemetry Integrations
+    :name: integrations
+    :glob:
+
     ext/**
 
 .. toctree::

diff --git a/docs/instrumentation/aiohttp_client/aiohttp_client.rst b/docs/instrumentation/aiohttp_client/aiohttp_client.rst
@@ -0,0 +1,7 @@
+OpenTelemetry aiohttp client Instrumentation
+============================================
+
+.. automodule:: opentelemetry.instrumentation.aiohttp_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/ext/aiopg/aiopg.rst → docs/instrumentation/aiopg/aiopg.rst b/docs/ext/aiopg/aiopg.rst → docs/instrumentation/aiopg/aiopg.rst
@@ -1,4 +1,4 @@
-OpenTelemetry aiopg instrumentation
+OpenTelemetry aiopg Instrumentation
 ===================================
 
 .. automodule:: opentelemetry.instrumentation.aiopg

diff --git a/docs/instrumentation/asgi/asgi.rst b/docs/instrumentation/asgi/asgi.rst
@@ -0,0 +1,10 @@
+OpenTelemetry asgi Instrumentation
+===================================
+
+Module contents
+---------------
+
+.. automodule:: opentelemetry.instrumentation.asgi
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/ext/django/django.rst → docs/instrumentation/django/django.rst b/docs/ext/django/django.rst → docs/instrumentation/django/django.rst
@@ -1,7 +1,7 @@
 OpenTelemetry Django Instrumentation
 ====================================
 
-.. automodule:: opentelemetry.ext.django
+.. automodule:: opentelemetry.instrumentation.django
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/docs/ext/fastapi/fastapi.rst → docs/instrumentation/fastapi/fastapi.rst b/docs/ext/fastapi/fastapi.rst → docs/instrumentation/fastapi/fastapi.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../ext/opentelemetry-instrumentation-fastapi/README.rst
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-fastapi/README.rst
 
 API
 ---

diff --git a/docs/instrumentation/flask/flask.rst b/docs/instrumentation/flask/flask.rst
@@ -0,0 +1,7 @@
+OpenTelemetry Flask Instrumentation
+===================================
+
+.. automodule:: opentelemetry.instrumentation.flask
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/instrumentation/instrumentation.rst b/docs/instrumentation/instrumentation.rst
@@ -1,5 +1,5 @@
-OpenTelemetry Python Instrumentation
-====================================
+OpenTelemetry Python Instrumentor
+=================================
 
 .. automodule:: opentelemetry.instrumentation
     :members:

diff --git a/docs/instrumentation/pyramid/pyramid.rst b/docs/instrumentation/pyramid/pyramid.rst
@@ -0,0 +1,7 @@
+OpenTelemetry Pyramid Instrumentation
+=====================================
+
+.. automodule:: opentelemetry.instrumentation.pyramid
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/instrumentation/requests/requests.rst b/docs/instrumentation/requests/requests.rst
@@ -0,0 +1,7 @@
+OpenTelemetry requests Instrumentation
+======================================
+
+.. automodule:: opentelemetry.instrumentation.requests
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/ext/starlette/starlette.rst → docs/instrumentation/starlette/starlette.rst b/docs/ext/starlette/starlette.rst → docs/instrumentation/starlette/starlette.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../ext/opentelemetry-instrumentation-starlette/README.rst
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-starlette/README.rst
 
 API
 ---

diff --git a/docs/ext/requests/requests.rst → docs/instrumentation/wsgi/wsgi.rst b/docs/ext/requests/requests.rst → docs/instrumentation/wsgi/wsgi.rst
@@ -1,7 +1,7 @@
-OpenTelemetry requests Integration
+OpenTelemetry WSGI Instrumentation
 ==================================
 
-.. automodule:: opentelemetry.ext.requests
+.. automodule:: opentelemetry.instrumentation.wsgi
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/eachdist.ini b/eachdist.ini
@@ -7,11 +7,12 @@ sortfirst=
     opentelemetry-instrumentation
     opentelemetry-proto
     tests/util
-    exporter/*
-    ext/opentelemetry-ext-wsgi
+    instrumentation/opentelemetry-instrumentation-wsgi
     ext/opentelemetry-ext-dbapi
-    ext/opentelemetry-ext-asgi
+    instrumentation/opentelemetry-instrumentation-asgi
     ext/opentelemetry-ext-botocore
+    instrumentation/*
+    exporter/*
     ext/*
 
 [lintroots]

diff --git a/exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/exporter.py b/exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/exporter.py
@@ -32,11 +32,11 @@
 
 DEFAULT_AGENT_URL = "http://localhost:8126"
 _INSTRUMENTATION_SPAN_TYPES = {
-    "opentelemetry.ext.aiohttp-client": DatadogSpanTypes.HTTP,
-    "opentelemetry.ext.asgi": DatadogSpanTypes.WEB,
+    "opentelemetry.instrumentation.aiohttp-client": DatadogSpanTypes.HTTP,
+    "opentelemetry.instrumentation.asgi": DatadogSpanTypes.WEB,
     "opentelemetry.ext.dbapi": DatadogSpanTypes.SQL,
-    "opentelemetry.ext.django": DatadogSpanTypes.WEB,
-    "opentelemetry.ext.flask": DatadogSpanTypes.WEB,
+    "opentelemetry.instrumentation.django": DatadogSpanTypes.WEB,
+    "opentelemetry.instrumentation.flask": DatadogSpanTypes.WEB,
     "opentelemetry.ext.grpc": DatadogSpanTypes.GRPC,
     "opentelemetry.ext.jinja2": DatadogSpanTypes.TEMPLATE,
     "opentelemetry.ext.mysql": DatadogSpanTypes.SQL,
@@ -45,9 +45,9 @@
     "opentelemetry.ext.pymongo": DatadogSpanTypes.MONGODB,
     "opentelemetry.ext.pymysql": DatadogSpanTypes.SQL,
     "opentelemetry.ext.redis": DatadogSpanTypes.REDIS,
-    "opentelemetry.ext.requests": DatadogSpanTypes.HTTP,
+    "opentelemetry.instrumentation.requests": DatadogSpanTypes.HTTP,
     "opentelemetry.ext.sqlalchemy": DatadogSpanTypes.SQL,
-    "opentelemetry.ext.wsgi": DatadogSpanTypes.WEB,
+    "opentelemetry.instrumentation.wsgi": DatadogSpanTypes.WEB,
 }
 
 

diff --git a/exporter/opentelemetry-exporter-datadog/tests/test_datadog_exporter.py b/exporter/opentelemetry-exporter-datadog/tests/test_datadog_exporter.py
@@ -290,20 +290,20 @@ def test_resources(self):
 
     def test_span_types(self):
         test_instrumentations = [
-            "opentelemetry.ext.aiohttp-client",
+            "opentelemetry.instrumentation.aiohttp-client",
             "opentelemetry.ext.dbapi",
-            "opentelemetry.ext.django",
-            "opentelemetry.ext.flask",
+            "opentelemetry.instrumentation.django",
+            "opentelemetry.instrumentation.flask",
             "opentelemetry.ext.grpc",
             "opentelemetry.ext.jinja2",
             "opentelemetry.ext.mysql",
             "opentelemetry.ext.psycopg2",
             "opentelemetry.ext.pymongo",
             "opentelemetry.ext.pymysql",
             "opentelemetry.ext.redis",
-            "opentelemetry.ext.requests",
+            "opentelemetry.instrumentation.requests",
             "opentelemetry.ext.sqlalchemy",
-            "opentelemetry.ext.wsgi",
+            "opentelemetry.instrumentation.wsgi",
         ]
 
         for index, instrumentation in enumerate(test_instrumentations):

diff --git a/ext/opentelemetry-ext-aiohttp-client/CHANGELOG.md b/ext/opentelemetry-ext-aiohttp-client/CHANGELOG.md
diff --git a/ext/opentelemetry-ext-grpc/setup.cfg b/ext/opentelemetry-ext-grpc/setup.cfg
@@ -14,7 +14,7 @@
 
 [metadata]
 name = opentelemetry-ext-grpc
-description = OpenTelemetry gRPC Integration
+description = OpenTelemetry gRPC instrumentation
 long_description = file: README.rst
 long_description_content_type = text/x-rst
 author = OpenTelemetry Authors