Add mariadb

.circleci/config.yml

@@ -625,6 +625,14 @@ jobs:
           pattern: "grpc"
           snapshot: true
 
+  mariadb:
+    <<: *machine_executor
+    steps:
+      - run_test:
+          pattern: 'mariadb$'
+          snapshot: true
+          docker_services: "mariadb"
+
   molten:
     <<: *contrib_job
     steps:
@@ -946,6 +954,7 @@ requires_tests: &requires_tests
     - jinja2
     - kombu
     - mako
+    - mariadb
     - molten
     - mongoengine
     - mysqlconnector
@@ -1027,6 +1036,7 @@ workflows:
       - jinja2: *requires_base_venvs
       - kombu: *requires_base_venvs
       - mako: *requires_base_venvs
+      - mariadb: *requires_base_venvs
       - molten: *requires_base_venvs
       - mongoengine: *requires_base_venvs
       - mysqlconnector: *requires_base_venvs

ddtrace/contrib/mariadb/__init__.py

@@ -0,0 +1,65 @@
+"""
+The MariaDB integration instruments the
+`MariaDB library <https://mariadb-corporation.github.io/mariadb-connector-python/usage.html>`_ to trace queries.
+
+
+Enabling
+~~~~~~~~
+
+The MariaDB integration is enabled automatically when using
+:ref:`ddtrace-run<ddtracerun>` or :ref:`patch_all()<patch_all>`.
+
+Or use :ref:`patch()<patch>` to manually enable the integration::
+
+    from ddtrace import patch
+    patch(mariadb=True)
+
+
+Global Configuration
+~~~~~~~~~~~~~~~~~~~~
+
+.. py:data:: ddtrace.config.mariadb["service"]
+
+   The service name reported by default for MariaDB spans.
+
+   This option can also be set with the ``DD_MARIADB_SERVICE`` environment
+   variable.
+
+   Default: ``"mariadb"``
+
+
+Instance Configuration
+~~~~~~~~~~~~~~~~~~~~~~
+
+To configure the mariadb integration on an per-connection basis use the
+``Pin`` API::
+
+    from ddtrace import Pin
+    from ddtrace import patch
+
+    # Make sure to patch before importing mariadb
+    patch(mariadb=True)
+
+    import mariadb.connector
+
+    # This will report a span with the default settings
+    conn = mariadb.connector.connect(user="alice", password="b0b", host="localhost", port=3306, database="test")
+
+    # Use a pin to override the service name for this connection.
+    Pin.override(conn, service="mariadb-users")
+
+    cursor = conn.cursor()
+    cursor.execute("SELECT 6*7 AS the_answer;")
+
+"""
+from ...utils.importlib import require_modules
+
+
+required_modules = ["mariadb"]
+
+with require_modules(required_modules) as missing_modules:
+    if not missing_modules:
+        from .patch import patch
+        from .patch import unpatch
+
+        __all__ = ["patch", "unpatch"]

ddtrace/contrib/mariadb/patch.py

@@ -0,0 +1,49 @@
+import mariadb
+
+from ddtrace import Pin
+from ddtrace import config
+from ddtrace.contrib.dbapi import TracedConnection
+from ddtrace.ext import db
+from ddtrace.ext import net
+from ddtrace.utils.formats import asbool
+from ddtrace.utils.formats import get_env
+from ddtrace.utils.wrappers import unwrap
+from ddtrace.vendor import wrapt
+
+
+config._add(
+    "mariadb",
+    dict(
+        trace_fetch_methods=asbool(get_env("mariadb", "trace_fetch_methods", default=False)),
+        _default_service="mariadb",
+    ),
+)
+
+
+def patch():
+    if getattr(mariadb, "_datadog_patch", False):
+        return
+    setattr(mariadb, "_datadog_patch", True)
+    wrapt.wrap_function_wrapper("mariadb", "connect", _connect)
+
+
+def unpatch():
+    if getattr(mariadb, "_datadog_patch", False):
+        setattr(mariadb, "_datadog_patch", False)
+        unwrap(mariadb, "connect")
+
+
+def _connect(func, instance, args, kwargs):
+    conn = func(*args, **kwargs)
+    tags = {
+        net.TARGET_HOST: kwargs["host"],
+        net.TARGET_PORT: kwargs["port"],
+        db.USER: kwargs["user"],
+        db.NAME: kwargs["database"],
+    }
+
+    pin = Pin(app="mariadb", tags=tags)
+
+    wrapped = TracedConnection(conn, pin=pin, cfg=config.mariadb)
+    pin.onto(wrapped)
+    return wrapped

ddtrace/monkey.py

@@ -43,6 +43,7 @@
     "mysql": True,
     "mysqldb": True,
     "pymysql": True,
+    "mariadb": True,
     "psycopg": True,
     "pylibmc": True,
     "pymemcache": True,

docker-compose.yml

@@ -25,6 +25,15 @@ services:
             - POSTGRES_DB=postgres
         ports:
             - "127.0.0.1:5432:5432"
+    mariadb:
+        image: mariadb
+        environment:
+            - MYSQL_ROOT_PASSWORD=example
+            - MYSQL_DATABASE=test
+            - MYSQL_USER=test
+            - MYSQL_PASSWORD=test
+        ports:
+            - "127.0.0.1:3306:3306"
     mysql:
         image: mysql:5.7
         environment:

docs/index.rst

@@ -90,6 +90,8 @@ contacting support.
 +--------------------------------------------------+---------------+----------------+
 | :ref:`mako`                                      | >= 0.1.0      | Yes            |
 +--------------------------------------------------+---------------+----------------+
+| :ref:`mariadb`                                   | >= 1.0.0      | Yes            |
++--------------------------------------------------+---------------+----------------+
 | :ref:`kombu`                                     | >= 4.0        | No             |
 +--------------------------------------------------+---------------+----------------+
 | :ref:`molten`                                    | >= 0.7.0      | Yes            |

docs/integrations.rst

@@ -193,6 +193,13 @@ Mako
 .. automodule:: ddtrace.contrib.mako
 
 
+.. _mariadb:
+
+MariaDB
+^^^^^^^
+.. automodule:: ddtrace.contrib.mariadb
+
+
 .. _molten:
 
 Molten

docs/spelling_wordlist.txt

@@ -72,6 +72,7 @@ kwarg
 lifecycle
 lookups
 mako
+mariadb
 memcached
 metadata
 microservices

releasenotes/notes/mariadb-8e7bc94a0d1b8f02.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Add MariaDB integration.

riotfile.py

@@ -862,6 +862,22 @@ def select_pys(min_version=MIN_PYTHON_VERSION, max_version=MAX_PYTHON_VERSION):
             pys=select_pys(min_version="3.6"),
             command="pytest {cmdargs} tests/contrib/asgi",
         ),
+        Venv(
+            name="mariadb",
+            command="pytest {cmdargs} tests/contrib/mariadb",
+            venvs=[
+                Venv(
+                    pys=select_pys(min_version="3.6"),
+                    pkgs={
+                        "mariadb": [
+                            "~=1.0.0",
+                            "~=1.0",
+                            latest,
+                        ],
+                    },
+                ),
+            ],
+        ),
         Venv(
             name="fastapi",
             command="pytest {cmdargs} tests/contrib/fastapi",

tests/contrib/config.py

@@ -40,6 +40,14 @@
     "database": os.getenv("TEST_MYSQL_DATABASE", "test"),
 }
 
+MARIADB_CONFIG = {
+    "host": "127.0.0.1",
+    "port": int(os.getenv("TEST_MARIADB_PORT", 3306)),
+    "user": os.getenv("TEST_MARIADB_USER", "test"),
+    "password": os.getenv("TEST_MARIADB_PASSWORD", "test"),
+    "database": os.getenv("TEST_MARIADB_DATABASE", "test"),
+}
+
 REDIS_CONFIG = {
     "port": int(os.getenv("TEST_REDIS_PORT", 6379)),
 }