MetricsConfiguration

pydantic settings safir.metrics.MetricsConfiguration

Configuration for emitting metrics.

Parameters:

• _case_sensitive (bool | None, default: None)

• _nested_model_default_partial_update (bool | None, default: None)

• _env_prefix (str | None, default: None)

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

• _env_file_encoding (str | None, default: None)

• _env_ignore_empty (bool | None, default: None)

• _env_nested_delimiter (str | None, default: None)

• _env_parse_none_str (str | None, default: None)

• _env_parse_enums (bool | None, default: None)

• _cli_prog_name (str | None, default: None)

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

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

• _cli_parse_none_str (str | None, default: None)

• _cli_hide_none_type (bool | None, default: None)

• _cli_avoid_json (bool | None, default: None)

• _cli_enforce_required (bool | None, default: None)

• _cli_use_class_docs_for_groups (bool | None, default: None)

• _cli_exit_on_error (bool | None, default: None)

• _cli_prefix (str | None, default: None)

• _cli_implicit_flags (bool | None, default: None)

• _secrets_dir (Union[Path, str, List[Union[str, Path]], Tuple[Union[Path, str], ...], None], default: None)

• values (Any)

Show JSON schema

{
   "title": "MetricsConfiguration",
   "description": "Configuration for emitting metrics.",
   "type": "object",
   "properties": {
      "topic_prefix": {
         "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"
      },
      "app_name": {
         "description": "The name of the application that is emitting these metrics",
         "title": "Application name",
         "type": "string"
      },
      "disable": {
         "default": false,
         "description": "Set to \"True\" to prevent actually publishing metrics",
         "title": "Disable",
         "type": "boolean"
      }
   },
   "additionalProperties": false,
   "required": [
      "app_name"
   ]
}

Config:

• env_prefix: str = METRICS_

Fields:

• app_name (str)

• disable (bool)

• topic_prefix (str)

field app_name: str [Required]

The name of the application that is emitting these metrics

field disable: bool = False

Set to “True” to prevent actually publishing metrics

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.