initial commit

Author: wyattwalter

.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Wyatt Walter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,2 @@
+# opentelemetry-instrumentation-arangodb
+Auto instrumentation for python-arango

example/application.py

@@ -0,0 +1,23 @@
+from arango import ArangoClient
+from opentelemetry import trace
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import (
+    BatchSpanProcessor,
+    ConsoleSpanExporter,
+)
+
+provider = TracerProvider()
+processor = BatchSpanProcessor(ConsoleSpanExporter())
+provider.add_span_processor(processor)
+
+# Sets the global default tracer provider
+trace.set_tracer_provider(provider)
+
+tracer = trace.get_tracer("example")
+
+client = ArangoClient()
+db = client.db("test", username="root", password="password")
+
+# Manually create a root span
+with tracer.start_as_current_span("root-span") as root_span:
+    ret = db.aql.execute("FOR doc IN test FILTER doc.test == true RETURN doc")

example/docker-compose.yaml

@@ -0,0 +1,13 @@
+version: '3'
+services:
+  arangodb:
+    image: arangodb
+    environment:
+      - ARANGO_ROOT_PASSWORD=password
+    ports:
+      - 8529:8529
+    volumes:
+      - arangodb_data:/var/lib/arangodb3
+
+volumes:
+  arangodb_data:

opentelemetry_instrumentation_arangodb/__init__.py

@@ -0,0 +1,54 @@
+import logging
+import functools
+from opentelemetry import trace
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from opentelemetry.instrumentation.utils import unwrap
+from opentelemetry.trace import SpanKind
+from arango.aql import AQL
+
+logging.basicConfig(level=logging.DEBUG)
+logger = logging.getLogger(__name__)
+
+class ArangoDBInstrumentor(BaseInstrumentor):
+    def instrumentation_dependencies(self):
+        return []
+
+    def _instrument(self, **kwargs):
+        tracer_provider = kwargs.get("tracer_provider", trace.get_tracer_provider())
+        self._tracer = trace.get_tracer(__name__, tracer_provider=tracer_provider)
+
+        if hasattr(AQL, "execute"):
+            logger.debug("Instrumenting AQL.execute")
+            self._original_method = getattr(AQL, "execute")
+            setattr(AQL, "execute", self._get_instrumented_execute())
+
+    def _uninstrument(self, **kwargs):
+        if hasattr(AQL, "execute"):
+            logger.debug("Uninstrumenting AQL.execute")
+            unwrap(AQL, "execute")
+
+    def _get_instrumented_execute(self):
+        tracer = self._tracer
+
+        @functools.wraps(self._original_method)
+        def instrumented_execute(*args, **kwargs):
+            query = args[1] if len(args) > 1 else kwargs.get('query', 'Unknown query')
+            with tracer.start_as_current_span("ArangoDB Execute", kind=SpanKind.CLIENT) as span:
+                span.set_attribute("db.system", "arangodb")
+                span.set_attribute("db.query", query)
+                if kwargs.get('bind_vars'):
+                    span.set_attribute("db.bind_vars", kwargs.get('bind_vars'))
+                result = self._original_method(*args, **kwargs)
+                span.set_attribute("db.cached", result.cached())
+                if result.count() is not None:
+                    span.set_attribute("db.count", result.count())
+                if result.statistics() is not None:
+                    for key, value in result.statistics().items():
+                        span.set_attribute("db." + key, value)
+                if result.warnings():
+                    span.set_attribute("db.warnings", result.warnings())
+                return result
+
+        return instrumented_execute
+
+arangodb_instrumentor = ArangoDBInstrumentor()

opentelemetry_instrumentation_arangodb/arangodb_instrumentor.py

@@ -0,0 +1,23 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="opentelemetry-instrumentation-arangodb",
+    version="0.1.0",
+    description="OpenTelemetry instrumentation for python-arango",
+    author="Wyatt Walter",
+    packages=find_packages(),
+    install_requires=[
+        "opentelemetry-api",
+        "opentelemetry-sdk",
+        "opentelemetry-instrumentation",
+        "python-arango"
+    ],
+    extras_require={
+        "instruments": []
+    },
+    entry_points={
+        "opentelemetry_instrumentor": [
+            "arangodb = opentelemetry_instrumentation_arangodb.arangodb_instrumentor:ArangoDBInstrumentor"
+        ]
+    },
+)