Skip to main content

ASGI middleware for logging traffic to a SQLite database

Project description

asgi-log-to-sqlite

PyPI CircleCI License

ASGI middleware for logging traffic to a SQLite database

See Logging to SQLite using ASGI middleware for background on this project.

Installation

pip install asgi-log-to-sqlite

Usage

from asgi_log_to_sqlite import AsgiLogToSqlite
from my_asgi_app import app


app = AsgiLogToSqlite(app, "/tmp/log.db")

Requests to your ASGI app will now be logged to the SQLite database file at /tmp/log.db.

Schema

The database used to log requests has one key table - requests - and 6 lookup tables: paths, user_agents, referers, accept_languages, content_types and query_strings.

The full schema is as follows:

CREATE TABLE [paths] (
   [id] INTEGER PRIMARY KEY,
   [name] TEXT
);
CREATE UNIQUE INDEX idx_paths_name
                ON paths (name);
CREATE TABLE [user_agents] (
   [id] INTEGER PRIMARY KEY,
   [name] TEXT
);
CREATE UNIQUE INDEX idx_user_agents_name
                ON user_agents (name);
CREATE TABLE [referers] (
   [id] INTEGER PRIMARY KEY,
   [name] TEXT
);
CREATE UNIQUE INDEX idx_referers_name
                ON referers (name);
CREATE TABLE [accept_languages] (
   [id] INTEGER PRIMARY KEY,
   [name] TEXT
);
CREATE UNIQUE INDEX idx_accept_languages_name
                ON accept_languages (name);
CREATE TABLE [content_types] (
   [id] INTEGER PRIMARY KEY,
   [name] TEXT
);
CREATE UNIQUE INDEX idx_content_types_name
                ON content_types (name);
CREATE TABLE [query_strings] (
   [id] INTEGER PRIMARY KEY,
   [name] TEXT
);
CREATE UNIQUE INDEX idx_query_strings_name
                ON query_strings (name);
CREATE TABLE [requests] (
   [start] FLOAT,
   [method] TEXT,
   [path] INTEGER REFERENCES [paths]([id]),
   [query_string] INTEGER REFERENCES [query_strings]([id]),
   [user_agent] INTEGER REFERENCES [user_agents]([id]),
   [referer] INTEGER REFERENCES [referers]([id]),
   [accept_language] INTEGER REFERENCES [accept_languages]([id]),
   [http_status] INTEGER,
   [content_type] INTEGER REFERENCES [content_types]([id]),
   [client_ip] TEXT,
   [duration] FLOAT,
   [body_size] INTEGER
);

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Built Distribution

asgi_log_to_sqlite-0.1.1-py3-none-any.whl (7.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page