EventsConfiguration

pydantic settings safir.metrics.EventsConfiguration

Configuration for emitting events.

Parameters:

• _case_sensitive (Optional[bool], default: None)

• _nested_model_default_partial_update (Optional[bool], default: None)

• _env_prefix (Optional[str], default: None)

• _env_prefix_target (Optional[Literal['variable', 'alias', 'all']], default: None)

• _env_file (Union[Path, str, Sequence[Union[Path, str]], None], default: PosixPath('.'))

• _env_file_encoding (Optional[str], default: None)

• _env_ignore_empty (Optional[bool], default: None)

• _env_nested_delimiter (Optional[str], default: None)

• _env_nested_max_split (Optional[int], default: None)

• _env_parse_none_str (Optional[str], default: None)

• _env_parse_enums (Optional[bool], default: None)

• _cli_prog_name (Optional[str], default: None)

• _cli_parse_args (Union[bool, list[str], tuple[str, ...], None], default: None)

• _cli_settings_source (Optional[CliSettingsSource[Any]], default: None)

• _cli_parse_none_str (Optional[str], default: None)

• _cli_hide_none_type (Optional[bool], default: None)

• _cli_avoid_json (Optional[bool], default: None)

• _cli_enforce_required (Optional[bool], default: None)

• _cli_use_class_docs_for_groups (Optional[bool], default: None)

• _cli_exit_on_error (Optional[bool], default: None)

• _cli_prefix (Optional[str], default: None)

• _cli_flag_prefix_char (Optional[str], default: None)

• _cli_implicit_flags (Union[bool, Literal['dual', 'toggle'], None], default: None)

• _cli_ignore_unknown_args (Optional[bool], default: None)

• _cli_kebab_case (Union[bool, Literal['all', 'no_enums'], None], default: None)

• _cli_shortcuts (Optional[Mapping[str, Union[str, list[str]]]], default: None)

• _secrets_dir (Union[Path, str, Sequence[Union[Path, str]], None], default: None)

• _build_sources (Optional[tuple[tuple[PydanticBaseSettingsSource, ...], dict[str, Any]]], default: None)

• values (Any)

Show JSON schema

{
   "title": "EventsConfiguration",
   "description": "Configuration for emitting events.",
   "type": "object",
   "properties": {
      "topicPrefix": {
         "default": "lsst.square.metrics.events",
         "description": "You probably should use the default here. It could be useful in development scenarios to change this.",
         "title": "Metrics topic prefix",
         "type": "string"
      }
   },
   "additionalProperties": false
}

Config:

• env_prefix: str = METRICS_

• populate_by_name: bool = True

• validate_by_alias: bool = True

• validate_by_name: bool = True

Fields:

• topic_prefix (str)

field topic_prefix: str = 'lsst.square.metrics.events'

You probably should use the default here. It could be useful in development scenarios to change this.