fastapi-factory-utilities 0.2.10__tar.gz → 0.2.12__tar.gz

{fastapi_factory_utilities-0.2.10 → fastapi_factory_utilities-0.2.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastapi_factory_utilities
-Version: 0.2.10
+Version: 0.2.12
 Summary: Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry.
 License: MIT
 Keywords: python,fastapi,beanie,httpx,opentelemetry,microservices

{fastapi_factory_utilities-0.2.10 → fastapi_factory_utilities-0.2.12}/pyproject.toml

@@ -3,7 +3,7 @@ name = "fastapi_factory_utilities"
 homepage = "https://github.com/miragecentury/fastapi_factory_utilities"
 repository = "https://github.com/miragecentury/fastapi_factory_utilities"
 keywords = ["python", "fastapi", "beanie", "httpx", "opentelemetry", "microservices"]
-version = "0.2.10"
+version = "0.2.12"
 description = "Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry."
 authors = ["miragecentury <victorien.vanroye@gmail.com>"]
 maintainers = ["miragecentury <victorien.vanroye@gmail.com>"]

{fastapi_factory_utilities-0.2.10 → fastapi_factory_utilities-0.2.12}/src/fastapi_factory_utilities/core/plugins/odm_plugin/repositories.py

@@ -6,7 +6,6 @@ from collections.abc import AsyncGenerator, Callable
 from contextlib import asynccontextmanager
 from typing import Any, Generic, TypeVar, get_args
 from uuid import UUID
-from venv import create
 
 from motor.motor_asyncio import AsyncIOMotorClientSession, AsyncIOMotorDatabase
 from pydantic import BaseModel
@@ -79,7 +78,7 @@ class AbstractRepository(ABC, Generic[DocumentGenericType, EntityGenericType]):
             UnableToCreateEntityDueToDuplicateKeyError: If the entity cannot be created due to a duplicate key error.
             OperationError: If the operation fails.
         """
-        insert_time: datetime.datetime = datetime.datetime.now(tz=datetime.timezone.utc)
+        insert_time: datetime.datetime = datetime.datetime.now(tz=datetime.UTC)
         try:
             entity_dump: dict[str, Any] = entity.model_dump()
             entity_dump["created_at"] = insert_time
@@ -120,7 +119,7 @@ class AbstractRepository(ABC, Generic[DocumentGenericType, EntityGenericType]):
             ValueError: If the entity cannot be created from the document.
             OperationError: If the operation fails.
         """
-        update_time: datetime.datetime = datetime.datetime.now(tz=datetime.timezone.utc)
+        update_time: datetime.datetime = datetime.datetime.now(tz=datetime.UTC)
         try:
             entity_dump: dict[str, Any] = entity.model_dump()
             entity_dump["updated_at"] = update_time

{fastapi_factory_utilities-0.2.10 → fastapi_factory_utilities-0.2.12}/src/fastapi_factory_utilities/core/plugins/opentelemetry_plugin/builder.py

@@ -1,9 +1,20 @@
 """Provides a factory function to build a objets for OpenTelemetry."""
 
 from typing import Any, Self
+from urllib.parse import ParseResult, urlparse
 
-from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import OTLPMetricExporter
-from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
+from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import (
+    OTLPMetricExporter as OTLPMetricExporterGRPC,
+)
+from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import (
+    OTLPSpanExporter as OTLPSpanExporterGRPC,
+)
+from opentelemetry.exporter.otlp.proto.http.metric_exporter import (
+    OTLPMetricExporter as OTLPMetricExporterHTTP,
+)
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import (
+    OTLPSpanExporter as OTLPSpanExporterHTTP,
+)
 from opentelemetry.metrics import set_meter_provider
 from opentelemetry.propagate import set_global_textmap
 from opentelemetry.propagators.b3 import B3MultiFormat
@@ -31,24 +42,30 @@ from fastapi_factory_utilities.core.utils.yaml_reader import (
     YamlFileReader,
 )
 
-from .configs import OpenTelemetryConfig
+from .configs import OpenTelemetryConfig, ProtocolEnum
 from .exceptions import OpenTelemetryPluginConfigError
 
+GRPC_PORT: int = 4317
+HTTP_PORT: int = 4318
+
 
 class OpenTelemetryPluginBuilder:
     """Configure the injection bindings for OpenTelemetryPlugin."""
 
-    def __init__(self, application: ApplicationAbstractProtocol) -> None:
+    def __init__(self, application: ApplicationAbstractProtocol, settings: OpenTelemetryConfig | None = None) -> None:
         """Instantiate the OpenTelemetryPluginFactory.
 
         Args:
             application (BaseApplicationProtocol): The application object.
+            settings (OpenTelemetryConfig | None): The OpenTelemetry configuration object.
         """
         self._application: ApplicationAbstractProtocol = application
         self._resource: Resource | None = None
-        self._config: OpenTelemetryConfig | None = None
+        self._config: OpenTelemetryConfig | None = settings
         self._meter_provider: MeterProvider | None = None
         self._tracer_provider: TracerProvider | None = None
+        self._trace_exporter: OTLPSpanExporterGRPC | OTLPSpanExporterHTTP | None = None
+        self._metric_exporter: OTLPMetricExporterGRPC | OTLPMetricExporterHTTP | None = None
 
     @property
     def resource(self) -> Resource | None:
@@ -161,11 +178,27 @@ class OpenTelemetryPluginBuilder:
 
             # TODO: Extract to a dedicated method for the exporter and period reader setup
 
+            url_parsed: ParseResult = urlparse(self._config.endpoint.unicode_string())
+
+            exporter: OTLPMetricExporterGRPC | OTLPMetricExporterHTTP
             # Setup the Exporter
-            exporter = OTLPMetricExporter(
-                endpoint=f"{self._config.endpoint.unicode_string()}v1/metrics",
-                timeout=self._config.timeout,
-            )
+            if url_parsed.port == GRPC_PORT or self._config.protocol == ProtocolEnum.OTLP_GRPC:
+                exporter = OTLPMetricExporterGRPC(
+                    endpoint=f"{self._config.endpoint.unicode_string()}",
+                    timeout=self._config.timeout,
+                    insecure=True if str(self._config.endpoint).startswith("http") else False,
+                )
+            elif url_parsed.port == HTTP_PORT or self._config.protocol == ProtocolEnum.OTLP_HTTP:
+                exporter = OTLPMetricExporterHTTP(
+                    endpoint=f"{self._config.endpoint.unicode_string()}/v1/metrics",
+                    timeout=self._config.timeout,
+                )
+            else:
+                raise OpenTelemetryPluginConfigError(
+                    "The endpoint port is not supported. Use 4317 for gRPC or 4318 for HTTP or set the protocol."
+                )
+
+            self._metric_exporter = exporter
 
             # Setup the Metric Reader
             meter_config: OpenTelemetryMeterConfig = self._config.meter_config
@@ -213,11 +246,28 @@ class OpenTelemetryPluginBuilder:
             if self._config.tracer_config is None:
                 raise OpenTelemetryPluginConfigError("The tracer configuration is missing.")
 
+            exporter: OTLPSpanExporterGRPC | OTLPSpanExporterHTTP
+            url_parsed: ParseResult = urlparse(self._config.endpoint.unicode_string())
             # Setup the Exporter
-            exporter = OTLPSpanExporter(
-                endpoint=f"{self._config.endpoint.unicode_string()}v1/traces",
-                timeout=self._config.timeout,
-            )
+            if url_parsed.port == GRPC_PORT or self._config.protocol == ProtocolEnum.OTLP_GRPC:
+                insecure: bool = False if str(self._config.endpoint).startswith("https") else True
+                endpoint: str = f"{self._config.endpoint.unicode_string()}"
+                exporter = OTLPSpanExporterGRPC(
+                    endpoint=endpoint,
+                    # timeout=self._config.timeout,
+                    insecure=insecure,
+                )
+            elif url_parsed.port == HTTP_PORT or self._config.protocol == ProtocolEnum.OTLP_HTTP:
+                exporter = OTLPSpanExporterHTTP(
+                    endpoint=f"{self._config.endpoint.unicode_string()}/v1/traces",
+                    # timeout=self._config.timeout,
+                )
+            else:
+                raise OpenTelemetryPluginConfigError(
+                    "The endpoint port is not supported. Use 4317 for gRPC or 4318 for HTTP or set the protocol."
+                )
+
+            self._trace_exporter = exporter
 
             # Setup the Span Processor
             tracer_config: OpenTelemetryTracerConfig = self._config.tracer_config
@@ -259,7 +309,8 @@ class OpenTelemetryPluginBuilder:
             Self: The OpenTelemetryPluginFactory object.
         """
         self.build_resource()
-        self.build_config()
+        if self._config is None:
+            self.build_config()
         self.build_meter_provider()
         self.build_tracer_provider()
 

{fastapi_factory_utilities-0.2.10 → fastapi_factory_utilities-0.2.12}/src/fastapi_factory_utilities/core/plugins/opentelemetry_plugin/configs.py

@@ -1,11 +1,19 @@
 """Provides the configuration model for the OpenTelemetry plugin."""
 
+from enum import StrEnum
 from typing import Annotated
 
 from pydantic import BaseModel, ConfigDict, Field, UrlConstraints
 from pydantic_core import Url
 
 
+class ProtocolEnum(StrEnum):
+    """Defines the protocol enum for OpenTelemetry."""
+
+    OTLP_GRPC = "otlp_grpc"
+    OTLP_HTTP = "otlp_http"
+
+
 class OpenTelemetryMeterConfig(BaseModel):
     """Provides the configuration model for the OpenTelemetry meter as sub-model."""
 
@@ -77,6 +85,11 @@ class OpenTelemetryConfig(BaseModel):
         description="The collector endpoint.",
     )
 
+    protocol: ProtocolEnum | None = Field(
+        default=None,
+        description="The protocol to use for the collector.",
+    )
+
     timeout: int = Field(
         default=TEN_SECONDS_IN_SECONDS,
         description="The timeout in seconds for the collector.",