Skip to content

Commit

Permalink
Merge pull request #356 from lsst-sqre/tickets/DM-48173
Browse files Browse the repository at this point in the history
DM-48173: Update metrics configuration documentation
  • Loading branch information
rra authored Dec 17, 2024
2 parents 3335dfa + 87eb5c5 commit d0f5849
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/user-guide/metrics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,24 +75,27 @@ See :ref:`configuration-details` for more info.
from pydantic import Field, HttpUrl
from pydantic_settings import BaseSettings, SettingsConfigDict
from safir.metrics import KafkaMetricsConfiguration, MetricsConfiguration
from safir.metrics import (
MetricsConfiguration,
metrics_configuration_factory,
)
class Config(BaseSettings):
model_config = SettingsConfigDict(
env_prefix="MYAPP_", case_sensitive=False
)
an_important_url: HttpUrl = Field(
...,
title="URL to something important",
)
metrics: MetricsConfiguration = Field(
default_factory=KafkaMetricsConfiguration,
default_factory=metrics_configuration_factory,
title="Metrics configuration",
)
model_config = SettingsConfigDict(
env_prefix="MYAPP_", case_sensitive=False
)
config = Config()
Expand Down Expand Up @@ -251,7 +254,6 @@ You can make assertions about these published events in your unit tests.
METRICS_APPLICATION=myapp
METRICS_ENABLED=false
METRICS_MOCK=true
METRICS_EVENTS_TOPIC_PREFIX=what.ever
.. code-block:: python
Expand Down

0 comments on commit d0f5849

Please sign in to comment.