flagsmith-common 3.8.0__tar.gz → 3.8.2__tar.gz

{flagsmith_common-3.8.0 → flagsmith_common-3.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flagsmith-common
-Version: 3.8.0
+Version: 3.8.2
 Summary: Flagsmith's common library
 Author: Matthew Elwell, Gagan Trivedi, Kim Gustyr, Zach Aysan, Francesco Lo Franco, Rodrigo López Dato, Evandro Myller, Wadii Zaim
 License-Expression: BSD-3-Clause

{flagsmith_common-3.8.0 → flagsmith_common-3.8.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flagsmith-common"
-version = "3.8.0"
+version = "3.8.2"
 description = "Flagsmith's common library"
 requires-python = ">=3.11,<4.0"
 dependencies = []
@@ -87,8 +87,8 @@ dev = [
     "pre-commit",
     "pydantic>=2.12.5",
     "pyfakefs (>=5.7.4, <6.0.0)",
-    "pytest (>=8.3.4, <9.0.0)",
-    "pytest-asyncio (>=0.25.3, <1.0.0)",
+    "pytest (>=9.0.3, <9.1.0)",
+    "pytest-asyncio (>=1.0.0, <2.0.0)",
     "pytest-cov (>=6.0.0, <7.0.0)",
     "pytest-django (>=4.10.0, <5.0.0)",
     "pytest-freezegun (>=0.4.2, <1.0.0)",

{flagsmith_common-3.8.0 → flagsmith_common-3.8.2}/src/common/core/docgen/events.py

@@ -4,6 +4,8 @@ from dataclasses import dataclass, field
 from pathlib import Path
 from typing import Iterable, Iterator
 
+from common.core.otel import get_otel_event_name
+
 
 class DocgenEventsWarning(UserWarning):
     """Raised by the events scanner when a call site can't be resolved."""
@@ -317,9 +319,11 @@ def _build_entry_from_emit_call(
         )
         return None
     attributes = scope.bound_attrs | _kwargs_as_attributes(node.keywords)
-    name = f"{scope.domain}.{event_arg.value}" if scope.domain else event_arg.value
     return EventEntry(
-        name=name,
+        name=get_otel_event_name(
+            logger_name=scope.domain or None,
+            body=event_arg.value,
+        ),
         level=func.attr,
         attributes=attributes,
         locations=[SourceLocation(path=path, line=node.lineno)],

{flagsmith_common-3.8.0 → flagsmith_common-3.8.2}/src/common/core/otel.py

@@ -54,6 +54,19 @@ _RESERVED_KEYS = frozenset(
 )
 
 
+def get_otel_event_name(*, logger_name: str | None, body: str) -> str:
+    """Build the event name that reaches OTel from a structlog `(logger, event)`.
+
+    The body is normalised via `inflection.underscore` so hyphens and CamelCase
+    collapse to snake_case. Empty bodies fall back to ``"unknown"``. The logger
+    name, when present, is prefixed verbatim.
+    """
+    normalised = inflection.underscore(body) if body else "unknown"
+    if logger_name:
+        return f"{logger_name}.{normalised}"
+    return normalised
+
+
 def add_otel_trace_context(
     logger: structlog.types.WrappedLogger,
     method_name: str,
@@ -95,10 +108,10 @@ def make_structlog_otel_processor(logger_provider: LoggerProvider) -> Processor:
             attributes[key] = str(value)
 
         body = event_dict.get("event", "")
-        logger_name = event_dict.get("logger")
-        event_name = inflection.underscore(body) if body else "unknown"
-        if logger_name:
-            event_name = f"{logger_name}.{event_name}"
+        event_name = get_otel_event_name(
+            logger_name=event_dict.get("logger"),
+            body=body,
+        )
 
         # Some observability platforms don't surface OTel's EventName.
         # Keep a custom attribute for better visibility.

flagsmith_common-3.8.2/src/common/core/templates/docgen-events.md

@@ -0,0 +1,9 @@
+{% for event in flagsmith_events %}
+### `{{ event.name }}`
+
+Logged at `{{ event.level }}` from:
+{% for location in event.locations %} - `{{ location.path }}:{{ location.line }}`
+{% endfor %}
+Attributes:
+{% for attr in event.attributes %} - `{{ attr }}`
+{% endfor %}{% endfor %}

flagsmith_common-3.8.2/src/common/core/templates/docgen-metrics.md

@@ -0,0 +1,10 @@
+{% for metric in flagsmith_metrics %}
+### `{{ metric.name }}`
+
+{{ metric.type|title }}.
+
+{{ metric.documentation }}
+
+Labels:
+{% for label in metric.labels %} - `{{ label }}`
+{% endfor %}{% endfor %}

flagsmith_common-3.8.0/src/common/core/templates/docgen-events.md

@@ -1,20 +0,0 @@
----
-title: Events
-sidebar_label: Events
-sidebar_position: 30
----
-
-Flagsmith backend emits [OpenTelemetry events](https://opentelemetry.io/docs/specs/otel/logs/data-model/#events)
-that can be ingested to downstream observability systems and/or a data warehouse of your choice via OTLP.
-To learn how to configure this, see [OpenTelemetry](deployment-self-hosting/scaling-and-performance/opentelemetry).
-
-## Event catalogue
-{% for event in flagsmith_events %}
-### `{{ event.name }}`
-
-Logged at `{{ event.level }}` from:
-{% for location in event.locations %} - `{{ location.path }}:{{ location.line }}`
-{% endfor %}
-Attributes:
-{% for attr in event.attributes %} - `{{ attr }}`
-{% endfor %}{% endfor %}

flagsmith_common-3.8.0/src/common/core/templates/docgen-metrics.md

@@ -1,24 +0,0 @@
----
-title: Metrics
-sidebar_label: Metrics
-sidebar_position: 20
----
-
-## Prometheus
-
-To enable the Prometheus `/metrics` endpoint, set the `PROMETHEUS_ENABLED` environment variable to `true`.
-
-When enabled, Flagsmith serves the `/metrics` endpoint on port 9100.
-
-The metrics provided by Flagsmith are described below.
-
-{% for metric in flagsmith_metrics %}
-### `{{ metric.name }}`
-
-{{ metric.type|title }}.
-
-{{ metric.documentation }}
-
-Labels:
-{% for label in metric.labels %} - `{{ label }}`
-{% endfor %}{% endfor %}