Конфигурация HTTP2Kafka

Конфигурация

Bases: BaseSettings

Data.Rentgen Http2Kafka settings.

Application can be configured in 2 ways:

By explicitly passing settings object as an argument to :obj:application_factory <data_rentgen.http2kafka.application_factory>
By setting up environment variables matching a specific key.

All environment variable names are written in uppercase and should be prefixed with DATA_RENTGEN__. Nested items are delimited with __.

More details can be found in Pydantic documentation <https://docs.pydantic.dev/latest/concepts/pydantic_settings/>_.

Examples

.. code-block:: bash

# same as settings.logging.preset = "json"
DATA_RENTGEN__LOGGING__PRESET=json

# same as settings.server.debug = True
DATA_RENTGEN__SERVER__DEBUG=True

# same as settings.kafka.bootstrap_servers = ["localhost:9092"]
DATA_RENTGEN__KAFKA__BOOTSTRAP_SERVERS=["localhost:9092"]

# same as settings.producer.main_topic = "input.runs"
DATA_RENTGEN__PRODUCER__MAIN_TOPIC="input.runs"

Source code in data_rentgen/http2kafka/settings.py

class Http2KafkaApplicationSettings(BaseSettings):
    """Data.Rentgen Http2Kafka settings.

    Application can be configured in 2 ways:

    * By explicitly passing ``settings`` object as an argument to :obj:`application_factory <data_rentgen.http2kafka.application_factory>`
    * By setting up environment variables matching a specific key.

      All environment variable names are written in uppercase and should be prefixed with ``DATA_RENTGEN__``.
      Nested items are delimited with ``__``.

    More details can be found in `Pydantic documentation <https://docs.pydantic.dev/latest/concepts/pydantic_settings/>`_.

    Examples
    --------

    .. code-block:: bash

        # same as settings.logging.preset = "json"
        DATA_RENTGEN__LOGGING__PRESET=json

        # same as settings.server.debug = True
        DATA_RENTGEN__SERVER__DEBUG=True

        # same as settings.kafka.bootstrap_servers = ["localhost:9092"]
        DATA_RENTGEN__KAFKA__BOOTSTRAP_SERVERS=["localhost:9092"]

        # same as settings.producer.main_topic = "input.runs"
        DATA_RENTGEN__PRODUCER__MAIN_TOPIC="input.runs"
    """  # noqa: E501

    auth: AuthSettings = Field(
        default_factory=AuthSettings,
        description=":ref:`Authentication settings <configuration-server-authentication>`",
    )
    database: DatabaseSettings = Field(
        default_factory=DatabaseSettings,  # type: ignore[arg-type]
        description=":ref:`Database settings <configuration-database>`",
    )
    logging: LoggingSettings = Field(
        default_factory=LoggingSettings,
        description=":ref:`Logging settings <configuration-server-logging>`",
    )
    server: ServerSettings = Field(
        default_factory=ServerSettings,
        description=":ref:`Server settings <configuration-server>`",
    )
    kafka: KafkaSettings = Field(
        default_factory=KafkaSettings,  # type: ignore[arg-type]
        description=":ref:`Kafka settings <configuration-kafka>`",
    )
    producer: ProducerSettings = Field(
        default_factory=ProducerSettings,
        description=":ref:`Producer settings <configuration-producer-specific>`",
    )

    model_config = SettingsConfigDict(env_prefix="DATA_RENTGEN__", env_nested_delimiter="__", extra="forbid")

Bases: BaseModel

Data.Rentgen REST API server-specific settings.

Examples

.. code-block:: bash

DATA_RENTGEN__SERVER__DEBUG=True
DATA_RENTGEN__SERVER__MONITORING__ENABLED=True
DATA_RENTGEN__SERVER__CORS__ENABLED=True
DATA_RENTGEN__SERVER__REQUEST_ID__ENABLED=True
DATA_RENTGEN__SERVER__OPENAPI__ENABLED=True
DATA_RENTGEN__SERVER__OPENAPI__SWAGGER__ENABLED=True
DATA_RENTGEN__SERVER__OPENAPI__REDOC__ENABLED=True

Source code in data_rentgen/server/settings/server.py

class ServerSettings(BaseModel):
    """Data.Rentgen REST API server-specific settings.

    Examples
    --------

    .. code-block:: bash

        DATA_RENTGEN__SERVER__DEBUG=True
        DATA_RENTGEN__SERVER__MONITORING__ENABLED=True
        DATA_RENTGEN__SERVER__CORS__ENABLED=True
        DATA_RENTGEN__SERVER__REQUEST_ID__ENABLED=True
        DATA_RENTGEN__SERVER__OPENAPI__ENABLED=True
        DATA_RENTGEN__SERVER__OPENAPI__SWAGGER__ENABLED=True
        DATA_RENTGEN__SERVER__OPENAPI__REDOC__ENABLED=True
    """

    debug: bool = Field(
        default=False,
        description=textwrap.dedent(
            """
            :ref:`Enable debug output in responses <configuration-server-debug>`.
            Do not use this on production!
            """,
        ),
    )
    cors: CORSSettings = Field(
        default_factory=CORSSettings,
        description=":ref:`CORS settings <configuration-server-cors>`",
    )
    monitoring: MonitoringSettings = Field(
        default_factory=MonitoringSettings,
        description=":ref:`Monitoring settings <configuration-server-monitoring>`",
    )
    request_id: RequestIDSettings = Field(
        default_factory=RequestIDSettings,
        description=":ref:`RequestID settings <configuration-server-debug>`",
    )
    application_version: ApplicationVersionSettings = Field(
        default_factory=ApplicationVersionSettings,
        description=":ref:`Application version settings <configuration-server-debug>`",
    )
    static_files: StaticFilesSettings = Field(
        default_factory=StaticFilesSettings,
        description=":ref:`Static files settings <configuration-server-static-files>`",
    )
    openapi: OpenAPISettings = Field(
        default_factory=OpenAPISettings,
        description=":ref:`OpenAPI.json settings <configuration-server-openapi>`",
    )
    session: SessionSettings = Field(
        default_factory=SessionSettings,  # type: ignore[arg-type]
        description=":ref:`Session settings <configuration-server-session>`",
    )