lite-bootstrap 0.1.0__py3-none-any.whl

lite_bootstrap/fastapi_bootstrap.py

@@ -0,0 +1,34 @@
+import dataclasses
+
+import fastapi
+from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
+from sentry_sdk.integrations.asgi import SentryAsgiMiddleware
+
+from lite_bootstrap.opentelemetry_bootstrap import OpenTelemetryBootstrap
+from lite_bootstrap.sentry_bootstrap import SentryBootstrap
+
+
+@dataclasses.dataclass(kw_only=True, slots=True)
+class FastAPIBootstrap:
+    app: fastapi.FastAPI
+    opentelemetry: OpenTelemetryBootstrap
+    sentry: SentryBootstrap
+    opentelemetry_excluded_urls: list[str] = dataclasses.field(default_factory=list)
+
+    def bootstrap_init(self) -> None:
+        if self.sentry.sentry_dsn:
+            self.sentry.start_tracing()
+            self.app.add_middleware(SentryAsgiMiddleware)
+
+        self.opentelemetry.start_tracing()
+        if self.opentelemetry.endpoint:
+            FastAPIInstrumentor.instrument_app(
+                app=self.app,
+                tracer_provider=self.opentelemetry.tracer_provider,
+                excluded_urls=",".join(self.opentelemetry_excluded_urls),
+            )
+
+    def teardown(self) -> None:
+        self.opentelemetry.teardown()
+        if self.opentelemetry.endpoint:
+            FastAPIInstrumentor.uninstrument_app(self.app)

lite_bootstrap/opentelemetry_bootstrap.py

@@ -0,0 +1,46 @@
+import dataclasses
+
+from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor  # type: ignore[attr-defined]
+from opentelemetry.sdk import resources
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from opentelemetry.trace import set_tracer_provider
+
+
+@dataclasses.dataclass(kw_only=True, slots=True)
+class OpenTelemetryBootstrap:
+    endpoint: str
+    service_name: str
+    instruments: list[BaseInstrumentor] = dataclasses.field(default_factory=list)
+    tracer_provider: TracerProvider | None = dataclasses.field(init=False)
+
+    def start_tracing(self) -> None:
+        if not self.endpoint:
+            return
+
+        self.tracer_provider: TracerProvider = TracerProvider(
+            resource=resources.Resource.create({resources.SERVICE_NAME: self.service_name}),
+        )
+        self.tracer_provider.add_span_processor(
+            BatchSpanProcessor(
+                OTLPSpanExporter(
+                    endpoint=self.endpoint,
+                    insecure=True,
+                ),
+            ),
+        )
+
+        for instrument in self.instruments:
+            instrument.instrument(
+                tracer_provider=self.tracer_provider,
+            )
+
+        set_tracer_provider(self.tracer_provider)
+
+    def teardown(self) -> None:
+        if not self.endpoint:
+            return
+
+        for instrument in self.instruments:
+            instrument.uninstrument()

lite_bootstrap/sentry_bootstrap.py

@@ -0,0 +1,32 @@
+import dataclasses
+import typing
+
+import sentry_sdk
+
+
+@dataclasses.dataclass(kw_only=True, slots=True)
+class SentryBootstrap:
+    sentry_dsn: str
+    environment: str | None = None
+    release: str | None = None
+    max_breadcrumbs: int = 15
+    attach_stacktrace: bool = True
+    default_integrations: bool = True
+    sentry_params: dict[str, typing.Any] = dataclasses.field(default_factory=dict)
+    tags: dict[str, str] | None = None
+
+    def start_tracing(self) -> None:
+        if not self.sentry_dsn:
+            return
+
+        sentry_sdk.init(
+            dsn=self.sentry_dsn,
+            environment=self.environment,
+            max_breadcrumbs=self.max_breadcrumbs,
+            attach_stacktrace=self.attach_stacktrace,
+            default_integrations=self.default_integrations,
+            release=self.release,
+            **self.sentry_params,
+        )
+        tags: dict[str, str] = self.tags or {}
+        sentry_sdk.set_tags(tags)

lite_bootstrap-0.1.0.dist-info/METADATA

@@ -0,0 +1,46 @@
+Metadata-Version: 2.3
+Name: lite-bootstrap
+Version: 0.1.0
+Summary: Lite package for bootstrapping new microservices
+Project-URL: repository, https://github.com/modern-python/lite-bootstrap
+Author-email: Artur Shiriev <me@shiriev.ru>
+License-Expression: MIT
+Keywords: bootstrap,error-tracing,fastapi,microservice,opentelemetry,python,sentry
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: <4,>=3.10
+Provides-Extra: fastapi
+Requires-Dist: fastapi; extra == 'fastapi'
+Requires-Dist: opentelemetry-api; extra == 'fastapi'
+Requires-Dist: opentelemetry-exporter-otlp; extra == 'fastapi'
+Requires-Dist: opentelemetry-instrumentation; extra == 'fastapi'
+Requires-Dist: opentelemetry-instrumentation-fastapi; extra == 'fastapi'
+Requires-Dist: opentelemetry-sdk; extra == 'fastapi'
+Requires-Dist: sentry-sdk; extra == 'fastapi'
+Provides-Extra: tracing
+Requires-Dist: opentelemetry-api; extra == 'tracing'
+Requires-Dist: opentelemetry-exporter-otlp; extra == 'tracing'
+Requires-Dist: opentelemetry-instrumentation; extra == 'tracing'
+Requires-Dist: opentelemetry-sdk; extra == 'tracing'
+Requires-Dist: sentry-sdk; extra == 'tracing'
+Description-Content-Type: text/markdown
+
+Lite-Bootstrap package
+==
+[![Test Coverage](https://codecov.io/gh/modern-python/lite-bootstrap/branch/main/graph/badge.svg)](https://codecov.io/gh/modern-python/lite-bootstrap)
+[![MyPy Strict](https://img.shields.io/badge/mypy-strict-blue)](https://mypy.readthedocs.io/en/stable/getting_started.html#strict-mode-and-configuration)
+[![Supported versions](https://img.shields.io/pypi/pyversions/lite-bootstrap.svg)](https://pypi.python.org/pypi/lite-bootstrap)
+[![downloads](https://img.shields.io/pypi/dm/lite-bootstrap.svg)](https://pypistats.org/packages/lite-bootstrap)
+[![GitHub stars](https://img.shields.io/github/stars/modern-python/lite-bootstrap)](https://github.com/modern-python/lite-bootstrap/stargazers)
+
+This package helps to build new microservices
+
+## Quickstart:
+### Installation
+
+```shell
+$ pip install lite-bootstrap
+```

lite_bootstrap-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+lite_bootstrap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+lite_bootstrap/fastapi_bootstrap.py,sha256=0s8h9nPhevd2S0_chCi5UIXj5oWxwF1pj_qVpNePiaw,1217
+lite_bootstrap/opentelemetry_bootstrap.py,sha256=rBZmjdiScJ41bDEN5K4CTERETb1mY1d7W_yQQemBOBY,1544
+lite_bootstrap/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+lite_bootstrap/sentry_bootstrap.py,sha256=gM7E4kYYwhzm2iCwB7KKipAhTCFHUV3HIwggKr-qSUk,950
+lite_bootstrap-0.1.0.dist-info/METADATA,sha256=GFKHDR6pX4-xPN_HJN257EXjK14ZsB8EjOr_nGwHHUY,2207
+lite_bootstrap-0.1.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+lite_bootstrap-0.1.0.dist-info/RECORD,,

lite_bootstrap-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py3-none-any