Skip to content

LoggerOptions

kedro_dagster.config.models.LoggerOptions

Bases: BaseModel

Options for defining Dagster loggers.

Parameters

Name Type Description Default
log_level LogLevel

Logging level (CRITICAL/ERROR/WARNING/INFO/DEBUG/NOTSET).

 required
handlers list[dict[str, Any]]

List of handler config dicts.

 required
formatters dict[str, dict[str, Any]]

Formatter configs, name to config.

 required
filters dict[str, dict[str, Any]]

Filter configs, name to config.

 required

See Also

kedro_dagster.dagster.LoggerCreator : Creates Dagster logger definitions from these options.

Source Code

View on GitHub

Show/Hide source 
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
class LoggerOptions(BaseModel):
    """Options for defining Dagster loggers.

    Parameters
    ----------
    log_level : LogLevel
        Logging level (CRITICAL/ERROR/WARNING/INFO/DEBUG/NOTSET).
    handlers : list[dict[str, Any]]
        List of handler config dicts.
    formatters : dict[str, dict[str, Any]]
        Formatter configs, name to config.
    filters : dict[str, dict[str, Any]]
        Filter configs, name to config.

    See Also
    --------
    `kedro_dagster.dagster.LoggerCreator` :
        Creates Dagster logger definitions from these options.
    """

    model_config = ConfigDict(validate_assignment=True, extra="forbid")

    log_level: LogLevel = Field(
        default="INFO",
        description="Python logging level (case-insensitive)",
    )
    handlers: list[dict[str, Any]] = Field(
        default=[],
        description="List of handler configurations",
    )
    formatters: dict[str, dict[str, Any]] = Field(
        default={},
        description="Formatter configurations mapped by name",
    )
    filters: dict[str, dict[str, Any]] = Field(
        default={},
        description="Filter configurations mapped by name",
    )

    @field_validator("log_level", mode="before")
    @classmethod
    def normalize_log_level(cls, v: str) -> str:
        """Normalize log level to uppercase for case-insensitive matching.

        Parameters
        ----------
        v : str
            Log level string to normalize.

        Returns
        -------
        str
            Normalized log level in uppercase.

        Raises
        ------
        ValueError
            If log level is not a valid string.
        """
        if not isinstance(v, str):
            raise ValueError("Log level must be a string")

        normalized = v.upper().strip()

        # Check if the normalized level is valid
        valid_levels = {"CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "NOTSET"}
        if normalized not in valid_levels:
            raise ValueError(
                f"Invalid log level '{v}'. Must be one of: {', '.join(sorted(valid_levels))} (case-insensitive)"
            )

        return normalized

    @field_validator("handlers")
    @classmethod
    def validate_handlers(cls, v: list[dict[str, Any]]) -> list[dict[str, Any]]:
        """Validate handler configurations.

        Parameters
        ----------
        v : list[dict[str, Any]]
            Handler configurations to validate.

        Returns
        -------
        list[dict[str, Any]]
            Validated handler configurations.

        Raises
        ------
        ValueError
            If handler configuration is invalid.
        """
        for i, handler in enumerate(v):
            if "class" not in handler:
                raise ValueError(f"Handler at index {i} must specify a 'class' field")

            if not isinstance(handler["class"], str):
                raise ValueError(f"Handler class at index {i} must be a string")

        return v

    @field_validator("formatters")
    @classmethod
    def validate_formatters(cls, v: dict[str, dict[str, Any]]) -> dict[str, dict[str, Any]]:
        """Validate formatter configurations.

        Parameters
        ----------
        v : dict[str, dict[str, Any]]
            Formatter configurations to validate.

        Returns
        -------
        dict[str, dict[str, Any]]
            Validated formatter configurations.

        Raises
        ------
        ValueError
            If formatter configuration is invalid.
        """
        for name, formatter in v.items():
            # Require either 'format' for standard formatter or '()' for custom class
            has_format = "format" in formatter
            has_callable = "()" in formatter

            if not (has_format or has_callable):
                raise ValueError(f"Formatter '{name}' must specify either 'format' field or '()' for custom class")

            # Type validation for keys when present
            if has_format and not isinstance(formatter["format"], str):
                raise ValueError(f"Formatter '{name}' 'format' must be a string")

            if has_callable and not isinstance(formatter["()"], str):
                raise ValueError(f"Formatter '{name}' '()' must be a string import path")

        return v

    @field_validator("filters")
    @classmethod
    def validate_filters(cls, v: dict[str, dict[str, Any]]) -> dict[str, dict[str, Any]]:
        """Validate filter configurations.

        Parameters
        ----------
        v : dict[str, dict[str, Any]]
            Filter configurations to validate.

        Returns
        -------
        dict[str, dict[str, Any]]
            Validated filter configurations.

        Raises
        ------
        ValueError
            If filter configuration is invalid.
        """
        for name, filter_config in v.items():
            # Require either custom callable/class path via '()' or a class path via 'class'
            has_callable = "()" in filter_config
            has_class = "class" in filter_config

            if not (has_callable or has_class):
                raise ValueError(
                    f"Filter '{name}' must specify either '()' for custom callable/class or 'class' for import path"
                )

            # Basic type checks for keys when present
            if has_callable and not isinstance(filter_config["()"], str):
                raise ValueError(f"Filter '{name}' '()' must be a string import path")

            if has_class and not isinstance(filter_config["class"], str):
                raise ValueError(f"Filter '{name}' class must be a string")

        return v

    @model_validator(mode="after")
    def validate_references(self) -> "LoggerOptions":
        """Validate that handler/formatter/filter references are consistent.

        Returns
        -------
        LoggerOptions
            Self after validation.

        Raises
        ------
        ValueError
            If there are inconsistent references.
        """
        # Collect available formatter and filter names
        available_formatters = set(self.formatters.keys()) if self.formatters else set()
        available_filters = set(self.filters.keys()) if self.filters else set()

        # Check handlers reference valid formatters/filters
        if self.handlers:
            for i, handler in enumerate(self.handlers):
                # Check formatter reference
                if "formatter" in handler:
                    formatter_name = handler["formatter"]
                    if formatter_name not in available_formatters:
                        raise ValueError(
                            f"Handler at index {i} references unknown formatter '{formatter_name}'. "
                            f"Available formatters: {sorted(available_formatters)}"
                        )

                # Check filter references
                if "filters" in handler:
                    handler_filters = handler["filters"]
                    if isinstance(handler_filters, list):
                        for filter_name in handler_filters:
                            if filter_name not in available_filters:
                                raise ValueError(
                                    f"Handler at index {i} references unknown filter '{filter_name}'. "
                                    f"Available filters: {sorted(available_filters)}"
                                )

        return self

Methods

normalize_log_level(v) classmethod

Normalize log level to uppercase for case-insensitive matching.

Parameters
Name Type Description Default
v str

Log level string to normalize.

 required
Returns
Type Description
str

Normalized log level in uppercase.
Raises
Type Description
ValueError

If log level is not a valid string.
Source Code

View on GitHub

Show/Hide source 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
@field_validator("log_level", mode="before")
@classmethod
def normalize_log_level(cls, v: str) -> str:
    """Normalize log level to uppercase for case-insensitive matching.

    Parameters
    ----------
    v : str
        Log level string to normalize.

    Returns
    -------
    str
        Normalized log level in uppercase.

    Raises
    ------
    ValueError
        If log level is not a valid string.
    """
    if not isinstance(v, str):
        raise ValueError("Log level must be a string")

    normalized = v.upper().strip()

    # Check if the normalized level is valid
    valid_levels = {"CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "NOTSET"}
    if normalized not in valid_levels:
        raise ValueError(
            f"Invalid log level '{v}'. Must be one of: {', '.join(sorted(valid_levels))} (case-insensitive)"
        )

    return normalized

validate_handlers(v) classmethod

Validate handler configurations.

Parameters
Name Type Description Default
v list[dict[str, Any]]

Handler configurations to validate.

 required
Returns
Type Description
list[dict[str, Any]]

Validated handler configurations.
Raises
Type Description
ValueError

If handler configuration is invalid.
Source Code

View on GitHub

Show/Hide source 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
@field_validator("handlers")
@classmethod
def validate_handlers(cls, v: list[dict[str, Any]]) -> list[dict[str, Any]]:
    """Validate handler configurations.

    Parameters
    ----------
    v : list[dict[str, Any]]
        Handler configurations to validate.

    Returns
    -------
    list[dict[str, Any]]
        Validated handler configurations.

    Raises
    ------
    ValueError
        If handler configuration is invalid.
    """
    for i, handler in enumerate(v):
        if "class" not in handler:
            raise ValueError(f"Handler at index {i} must specify a 'class' field")

        if not isinstance(handler["class"], str):
            raise ValueError(f"Handler class at index {i} must be a string")

    return v

validate_formatters(v) classmethod

Validate formatter configurations.

Parameters
Name Type Description Default
v dict[str, dict[str, Any]]

Formatter configurations to validate.

 required
Returns
Type Description
dict[str, dict[str, Any]]

Validated formatter configurations.
Raises
Type Description
ValueError

If formatter configuration is invalid.
Source Code

View on GitHub

Show/Hide source 
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
@field_validator("formatters")
@classmethod
def validate_formatters(cls, v: dict[str, dict[str, Any]]) -> dict[str, dict[str, Any]]:
    """Validate formatter configurations.

    Parameters
    ----------
    v : dict[str, dict[str, Any]]
        Formatter configurations to validate.

    Returns
    -------
    dict[str, dict[str, Any]]
        Validated formatter configurations.

    Raises
    ------
    ValueError
        If formatter configuration is invalid.
    """
    for name, formatter in v.items():
        # Require either 'format' for standard formatter or '()' for custom class
        has_format = "format" in formatter
        has_callable = "()" in formatter

        if not (has_format or has_callable):
            raise ValueError(f"Formatter '{name}' must specify either 'format' field or '()' for custom class")

        # Type validation for keys when present
        if has_format and not isinstance(formatter["format"], str):
            raise ValueError(f"Formatter '{name}' 'format' must be a string")

        if has_callable and not isinstance(formatter["()"], str):
            raise ValueError(f"Formatter '{name}' '()' must be a string import path")

    return v

validate_filters(v) classmethod

Validate filter configurations.

Parameters
Name Type Description Default
v dict[str, dict[str, Any]]

Filter configurations to validate.

 required
Returns
Type Description
dict[str, dict[str, Any]]

Validated filter configurations.
Raises
Type Description
ValueError

If filter configuration is invalid.
Source Code

View on GitHub

Show/Hide source 
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
@field_validator("filters")
@classmethod
def validate_filters(cls, v: dict[str, dict[str, Any]]) -> dict[str, dict[str, Any]]:
    """Validate filter configurations.

    Parameters
    ----------
    v : dict[str, dict[str, Any]]
        Filter configurations to validate.

    Returns
    -------
    dict[str, dict[str, Any]]
        Validated filter configurations.

    Raises
    ------
    ValueError
        If filter configuration is invalid.
    """
    for name, filter_config in v.items():
        # Require either custom callable/class path via '()' or a class path via 'class'
        has_callable = "()" in filter_config
        has_class = "class" in filter_config

        if not (has_callable or has_class):
            raise ValueError(
                f"Filter '{name}' must specify either '()' for custom callable/class or 'class' for import path"
            )

        # Basic type checks for keys when present
        if has_callable and not isinstance(filter_config["()"], str):
            raise ValueError(f"Filter '{name}' '()' must be a string import path")

        if has_class and not isinstance(filter_config["class"], str):
            raise ValueError(f"Filter '{name}' class must be a string")

    return v

validate_references()

Validate that handler/formatter/filter references are consistent.

Returns
Type Description
LoggerOptions

Self after validation.
Raises
Type Description
ValueError

If there are inconsistent references.
Source Code

View on GitHub

Show/Hide source 
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
@model_validator(mode="after")
def validate_references(self) -> "LoggerOptions":
    """Validate that handler/formatter/filter references are consistent.

    Returns
    -------
    LoggerOptions
        Self after validation.

    Raises
    ------
    ValueError
        If there are inconsistent references.
    """
    # Collect available formatter and filter names
    available_formatters = set(self.formatters.keys()) if self.formatters else set()
    available_filters = set(self.filters.keys()) if self.filters else set()

    # Check handlers reference valid formatters/filters
    if self.handlers:
        for i, handler in enumerate(self.handlers):
            # Check formatter reference
            if "formatter" in handler:
                formatter_name = handler["formatter"]
                if formatter_name not in available_formatters:
                    raise ValueError(
                        f"Handler at index {i} references unknown formatter '{formatter_name}'. "
                        f"Available formatters: {sorted(available_formatters)}"
                    )

            # Check filter references
            if "filters" in handler:
                handler_filters = handler["filters"]
                if isinstance(handler_filters, list):
                    for filter_name in handler_filters:
                        if filter_name not in available_filters:
                            raise ValueError(
                                f"Handler at index {i} references unknown filter '{filter_name}'. "
                                f"Available filters: {sorted(available_filters)}"
                            )

    return self