PHP 8.2.30
Preview: sqlalchemy.py Size: 4.24 KB
/opt/hc_python/lib64/python3.12/site-packages/sentry_sdk/integrations/sqlalchemy.py

from sentry_sdk.consts import SPANSTATUS, SPANDATA
from sentry_sdk.integrations import _check_minimum_version, Integration, DidNotEnable
from sentry_sdk.tracing_utils import add_query_source, record_sql_queries
from sentry_sdk.utils import (
    capture_internal_exceptions,
    ensure_integration_enabled,
    parse_version,
)

try:
    from sqlalchemy.engine import Engine  # type: ignore
    from sqlalchemy.event import listen  # type: ignore
    from sqlalchemy import __version__ as SQLALCHEMY_VERSION  # type: ignore
except ImportError:
    raise DidNotEnable("SQLAlchemy not installed.")

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from typing import Any
    from typing import ContextManager
    from typing import Optional

    from sentry_sdk.tracing import Span


class SqlalchemyIntegration(Integration):
    identifier = "sqlalchemy"
    origin = f"auto.db.{identifier}"

    @staticmethod
    def setup_once():
        # type: () -> None
        version = parse_version(SQLALCHEMY_VERSION)
        _check_minimum_version(SqlalchemyIntegration, version)

        listen(Engine, "before_cursor_execute", _before_cursor_execute)
        listen(Engine, "after_cursor_execute", _after_cursor_execute)
        listen(Engine, "handle_error", _handle_error)


@ensure_integration_enabled(SqlalchemyIntegration)
def _before_cursor_execute(
    conn, cursor, statement, parameters, context, executemany, *args
):
    # type: (Any, Any, Any, Any, Any, bool, *Any) -> None
    ctx_mgr = record_sql_queries(
        cursor,
        statement,
        parameters,
        paramstyle=context and context.dialect and context.dialect.paramstyle or None,
        executemany=executemany,
        span_origin=SqlalchemyIntegration.origin,
    )
    context._sentry_sql_span_manager = ctx_mgr

    span = ctx_mgr.__enter__()

    if span is not None:
        _set_db_data(span, conn)
        context._sentry_sql_span = span


@ensure_integration_enabled(SqlalchemyIntegration)
def _after_cursor_execute(conn, cursor, statement, parameters, context, *args):
    # type: (Any, Any, Any, Any, Any, *Any) -> None
    ctx_mgr = getattr(context, "_sentry_sql_span_manager", None)  # type: Optional[ContextManager[Any]]

    if ctx_mgr is not None:
        context._sentry_sql_span_manager = None
        ctx_mgr.__exit__(None, None, None)

    span = getattr(context, "_sentry_sql_span", None)  # type: Optional[Span]
    if span is not None:
        with capture_internal_exceptions():
            add_query_source(span)


def _handle_error(context, *args):
    # type: (Any, *Any) -> None
    execution_context = context.execution_context
    if execution_context is None:
        return

    span = getattr(execution_context, "_sentry_sql_span", None)  # type: Optional[Span]

    if span is not None:
        span.set_status(SPANSTATUS.INTERNAL_ERROR)

    # _after_cursor_execute does not get called for crashing SQL stmts. Judging
    # from SQLAlchemy codebase it does seem like any error coming into this
    # handler is going to be fatal.
    ctx_mgr = getattr(execution_context, "_sentry_sql_span_manager", None)  # type: Optional[ContextManager[Any]]

    if ctx_mgr is not None:
        execution_context._sentry_sql_span_manager = None
        ctx_mgr.__exit__(None, None, None)


# See: https://docs.sqlalchemy.org/en/20/dialects/index.html
def _get_db_system(name):
    # type: (str) -> Optional[str]
    name = str(name)

    if "sqlite" in name:
        return "sqlite"

    if "postgres" in name:
        return "postgresql"

    if "mariadb" in name:
        return "mariadb"

    if "mysql" in name:
        return "mysql"

    if "oracle" in name:
        return "oracle"

    return None


def _set_db_data(span, conn):
    # type: (Span, Any) -> None
    db_system = _get_db_system(conn.engine.name)
    if db_system is not None:
        span.set_data(SPANDATA.DB_SYSTEM, db_system)

    if conn.engine.url is None:
        return

    db_name = conn.engine.url.database
    if db_name is not None:
        span.set_data(SPANDATA.DB_NAME, db_name)

    server_address = conn.engine.url.host
    if server_address is not None:
        span.set_data(SPANDATA.SERVER_ADDRESS, server_address)

    server_port = conn.engine.url.port
    if server_port is not None:
        span.set_data(SPANDATA.SERVER_PORT, server_port)

Directory Contents

Dirs: 10 × Files: 70

Name Size Perms Modified Actions
celery DIR
- drwxr-xr-x 2025-12-03 08:02:53
Edit Download
django DIR
- drwxr-xr-x 2025-12-03 08:02:53
Edit Download
- drwxr-xr-x 2025-12-03 08:02:53
Edit Download
grpc DIR
- drwxr-xr-x 2025-12-03 08:02:53
Edit Download
- drwxr-xr-x 2025-12-03 08:02:53
Edit Download
- drwxr-xr-x 2025-12-03 08:02:53
Edit Download
- drwxr-xr-x 2025-12-03 08:02:53
Edit Download
redis DIR
- drwxr-xr-x 2025-12-03 08:02:53
Edit Download
spark DIR
- drwxr-xr-x 2025-12-03 08:02:53
Edit Download
- drwxr-xr-x 2025-12-03 08:02:53
Edit Download
12.70 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
14.17 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
911 B lrw-r--r-- 2025-12-03 08:02:53
Edit Download
5.70 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
7.70 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
12.50 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
4.50 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
6.37 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
1.61 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
17.65 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
5.06 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
4.31 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
6.46 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
4.59 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
5.96 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
7.60 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
9.18 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
1.93 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
7.28 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
2.35 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
1.95 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
9.28 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
4.48 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
8.54 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
8.26 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
2.75 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
4.69 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
4.92 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
5.94 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
5.32 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
14.60 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
39.02 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
11.56 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
1.89 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
9.99 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
11.55 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
13.57 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
6.38 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
19.58 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
820 B lrw-r--r-- 2025-12-03 08:02:53
Edit Download
24.54 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
1.10 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
3.06 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
4.50 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
6.23 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
7.19 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
7.24 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
5.20 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
5.18 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
8.87 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
12.66 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
1.76 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
3.09 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
4.24 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
25.62 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
10.31 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
1.20 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
8.76 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
13.82 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
2.43 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
6.94 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
7.04 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
1.61 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
1.77 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
1.03 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
1.71 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
10.56 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
3.11 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
7.38 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download
12.44 KB lrw-r--r-- 2025-12-03 08:02:53
Edit Download

If ZipArchive is unavailable, a .tar will be created (no compression).