Settings

Configuration for Foreman.

CLASS	DESCRIPTION
`AppSettings`	Configuration storage for Foreman.

Classes¶

Bases: BaseSettings

Configuration storage for Foreman.

PARAMETER	DESCRIPTION
`name`	Name and version of the application. TYPE: `str` DEFAULT: `'Foreman (0.3.0)'`
`environment`	Environment we're running in (dev/prod/...). TYPE: `str` DEFAULT: `'dev'`
`log_level`	The logging level of the application. TYPE: `str` DEFAULT: `'INFO'`
`otel_connection_string`	The connection string used to connect to application insights. Additional configuration can be provided with https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/ TYPE: `str \| None` DEFAULT: `None`
`otel_debug`	Enables debug logging to the console for OpenTelemetry. TYPE: `bool` DEFAULT: `False`

ATTRIBUTE	DESCRIPTION
`environment`	Environment we're running in (dev/prod/...). TYPE: `str`
`is_production`	Return True if we are in production. TYPE: `bool`
`log_level`	The logging level of the application. TYPE: `str`
`name`	Name and version of the application. TYPE: `str`
`otel_connection_string`	The connection string used to connect to application insights. TYPE: `str \| None`
`otel_debug`	Enables debug logging to the console for OpenTelemetry. TYPE: `bool`

environment: str = 'dev'

Environment we're running in (dev/prod/...).

is_production: bool

Return True if we are in production.

log_level: str = 'INFO'

The logging level of the application.

name: str = f'Foreman ({__version__})'

Name and version of the application.

otel_connection_string: str | None = Field(default=None)

The connection string used to connect to application insights. Additional configuration can be provided with https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/

otel_debug: bool = False

Enables debug logging to the console for OpenTelemetry.