bufferlog 0.1.0__py3-none-any.whl

bufferlog-0.1.0.dist-info/METADATA

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: bufferlog
+Version: 0.1.0
+Summary: BufferLog — Buffer logs in memory, flush only on errors. Save 90%+ on APM costs.
+Author: BufferLog.io
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/lehan0328/bufferlog
+Project-URL: Repository, https://github.com/lehan0328/bufferlog
+Project-URL: Issues, https://github.com/lehan0328/bufferlog/issues
+Keywords: logging,apm,buffer,datadog,splunk,observability,cost-reduction
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: flask
+Requires-Dist: flask>=2.0; extra == "flask"
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.100; extra == "fastapi"
+Requires-Dist: starlette>=0.27; extra == "fastapi"
+Provides-Extra: django
+Requires-Dist: django>=4.0; extra == "django"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: flask>=2.0; extra == "dev"
+Requires-Dist: fastapi>=0.100; extra == "dev"
+Requires-Dist: starlette>=0.27; extra == "dev"
+Requires-Dist: httpx>=0.24; extra == "dev"
+Requires-Dist: uvicorn>=0.20; extra == "dev"
+
+# bufferlog
+
+Buffer logs in memory per-request. Flush only on errors. Save 90%+ on APM costs.
+
+## Table of Contents
+
+- [Install](#install)
+- [Usage](#usage)
+  - [Flask](#flask)
+  - [FastAPI](#fastapi)
+  - [Django](#django)
+- [Configuration](#configuration)
+- [Control Plane](#control-plane)
+- [Metrics](#metrics)
+- [Shutdown](#shutdown)
+- [License](#license)
+
+## Install
+
+```bash
+pip install bufferlog
+```
+
+With framework extras:
+
+```bash
+pip install bufferlog[flask]
+pip install bufferlog[fastapi]
+pip install bufferlog[django]
+```
+
+## Usage
+
+### Flask
+
+```python
+import logging
+from flask import Flask
+from bufferlog import BufferLog
+from bufferlog.adapters import StdOutAdapter
+
+app = Flask(__name__)
+bl = BufferLog(adapters=[StdOutAdapter(pretty=True)])
+bl.init_flask(app)
+
+logger = logging.getLogger("myapp")
+logger.addHandler(bl.logging_handler())
+logger.setLevel(logging.DEBUG)
+
+@app.route("/")
+def index():
+    logger.info("Processing request")   # Buffered (discarded on 200)
+    logger.debug("SQL: SELECT * ...")    # Buffered (discarded on 200)
+    return "OK"                          # 200 → logs discarded ($0)
+
+@app.route("/fail")
+def fail():
+    logger.info("Starting transaction")
+    logger.error("Connection lost")      # Triggers flush
+    return "Error", 500                  # 500 → context sent to APM
+```
+
+### FastAPI
+
+```python
+import logging
+from fastapi import FastAPI
+from bufferlog import BufferLog
+from bufferlog.adapters import StdOutAdapter
+from bufferlog.middleware.fastapi_mw import BufferLogMiddleware
+
+app = FastAPI()
+bl = BufferLog(adapters=[StdOutAdapter()])
+app.add_middleware(BufferLogMiddleware, **bl.asgi_kwargs())
+
+logger = logging.getLogger("myapp")
+logger.addHandler(bl.logging_handler())
+logger.setLevel(logging.DEBUG)
+
+@app.get("/")
+async def index():
+    logger.info("Handling request")
+    return {"ok": True}
+```
+
+### Django
+
+```python
+# settings.py
+MIDDLEWARE = [
+    "bufferlog.middleware.django_mw.BufferLogDjangoMiddleware",
+    # ... other middleware
+]
+
+# apps.py or wsgi.py
+from bufferlog import BufferLog
+from bufferlog.adapters import StdOutAdapter
+
+bl = BufferLog(adapters=[StdOutAdapter()])
+bl.init_django()
+```
+
+## Configuration
+
+```python
+from bufferlog import BufferLog, BufferLogConfig
+from bufferlog.adapters import DatadogAdapter, SplunkAdapter, StdOutAdapter
+
+bl = BufferLog(config=BufferLogConfig(
+    # Max logs per request buffer. Oldest overwritten when full.
+    buffer_capacity=100,
+
+    # Log levels that trigger immediate flush.
+    flush_on_levels=["error", "critical"],
+
+    # HTTP status codes that trigger flush.
+    flush_on_status_codes=[500, 501, 502, 503, 504],
+
+    # Downstream targets for flushed logs.
+    adapters=[
+        DatadogAdapter(api_key="your-key"),
+        SplunkAdapter(token="your-token", url="https://splunk.example.com"),
+        StdOutAdapter(),
+    ],
+
+    # Enable/disable buffering.
+    enabled=True,
+
+    # If True, logs fall through to stderr on adapter failure.
+    fail_open=True,
+
+    # Scrub PII before logs enter the buffer.
+    scrubber=lambda msg, meta: (msg.replace("password", "***"), meta),
+))
+```
+
+## Control Plane
+
+Connect to the BufferLog Control Plane for remote policy management and usage tracking.
+
+```python
+from bufferlog import BufferLog, ControlPlaneConfig
+
+bl = BufferLog(
+    control_plane=ControlPlaneConfig(
+        url="https://control.bufferlog.io",
+        api_key="bl_sk_your_key",
+        poll_interval_s=60,
+        telemetry_interval_s=60,
+    )
+)
+```
+
+When connected:
+- **Poll for policy updates** — buffer capacity, sampling rate, flush triggers, and bypass rules can all be changed remotely.
+- **Push usage metrics** — counters (never log data) are sent to power the ROI dashboard.
+
+If the control plane is unreachable, the SDK continues with its last known configuration.
+
+## Metrics
+
+```python
+metrics = bl.get_metrics()
+# {
+#   "buffers":  {"created": 1000, "discarded": 995, "flushed": 5, "active": 0},
+#   "flash":    {"flush_count": 5, "events_flushed": 45, "adapter_errors": 0}
+# }
+```
+
+## Shutdown
+
+Stop background threads and send a final telemetry report.
+
+```python
+import atexit
+
+atexit.register(bl.shutdown)
+```
+
+## License
+
+[MIT](LICENSE)

bufferlog-0.1.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+bufferlog/__init__.py,sha256=vxExPhcvEmVVdql1FS5cuYsJMvp9GBu4dcxoE6_hspQ,5643
+bufferlog/buffer_manager.py,sha256=IGo1jkJFqrf2zT3EspzGXZIMY6OsETUg0LZfUY2HviA,2738
+bufferlog/config.py,sha256=V0ah8pDRA-KPEfUwgyC3ZhxTjBPo_6euqtLpXrvlus8,1288
+bufferlog/context.py,sha256=kfXTsLG6xILIJpUcg31k0ulrAP4jQyIUe8lbRvjaCuk,1361
+bufferlog/flash_controller.py,sha256=FerOwB-4qKlPNa1lXJtBB07yhVRoFjk47OppKITE0pw,2180
+bufferlog/log_event.py,sha256=JG7l_DKxn7iepTrBUI2FBTypUkUL_TgLsbojai59tPI,1206
+bufferlog/ring_buffer.py,sha256=hMfyLtlYmPfrioBbWjKaElQ3Lx2S9UwPEQFkL8TIsSM,2849
+bufferlog/adapters/__init__.py,sha256=HEPhucFuimbNPZe3sDvZevuh-KmbmfoPGRZawK_DC_U,195
+bufferlog/adapters/base.py,sha256=XOXI4k-O7PBjLyMVWzaRifv4OufKyEUsZdlQhBJqwjk,438
+bufferlog/adapters/datadog.py,sha256=k7TlvbfTjFlGqRIJrGe26Ye7sawB8QZIV8MyKPQKFoo,1681
+bufferlog/adapters/splunk.py,sha256=iujBjgF4nqv1iYuytJCFJUBVIQObWnRfzOsczrjqm1o,1587
+bufferlog/adapters/stdout.py,sha256=jKwPIJx9CbPKiRfoA9ZQgSoRUxpqpusoptpW17VHdi8,714
+bufferlog/control_plane/__init__.py,sha256=_ievQvidVIdygvZRSFwm_5pb2KAdKzbDTaH5pV1yAkU,39
+bufferlog/control_plane/policy_fetcher.py,sha256=VapZQBkPCn0DsYyzHxEbxjvfBmKU8YPrrVDUy5E_63I,3185
+bufferlog/control_plane/telemetry_reporter.py,sha256=Vcneilcficiqb0gEe8ef_QPfTRwDb9P70ZN3wPCR_EY,3256
+bufferlog/integrations/__init__.py,sha256=oKywGBNAEoPiSVRGBxCoq76BEVRf1q1eHqQ2-ZPlTZo,2394
+bufferlog/middleware/__init__.py,sha256=jKaAZI9aHMEFD-6CW0fMJOC70MFXeUCUfGp4J5Cp9cw,36
+bufferlog/middleware/django_mw.py,sha256=q_eYEffK8iWb2rMSCqHw1SUXy0Y-Ymlu_0dnQ_JbwZM,2924
+bufferlog/middleware/fastapi_mw.py,sha256=MRFdb0cWj9khAEESI-qmK3Tk1ejDZUhFFa6S-m0p2mg,3090
+bufferlog/middleware/flask_mw.py,sha256=IYkBjM-2Y6j8f5MEaAUUN9gVXxC28GKGfqjRvKj7cA8,2253
+bufferlog-0.1.0.dist-info/METADATA,sha256=tN5yJ0_WQWZH-FpyEA7axqgrzeScsS_9zA2Kigb7wtk,5751
+bufferlog-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+bufferlog-0.1.0.dist-info/top_level.txt,sha256=gzYBsdusu9nk0_u7pIGk4EXW-akvM1BAi6BQKDH9m78,10
+bufferlog-0.1.0.dist-info/RECORD,,

bufferlog-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

bufferlog-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+bufferlog