monitor_schema.models.analyzer.analyzer#

Schema for analyses.

Module Contents#

Classes#

Analyzer

Configuration for running an analysis.
class monitor_schema.models.analyzer.analyzer.Analyzer(**data: Any)[source]#

Bases: monitor_schema.models.commons.NoExtrasBaseModel

Configuration for running an analysis.

An analysis targets a metric (note that a metric could be a complex object) for one or multiple fields in one or multiple segments. The output is a list of ‘anomalies’ that might show issues with data.

class Config[source]#

Updates JSON schema anyOf to oneOf.

static schema_extra(schema: Dict[str, Any], model: pydantic.BaseModel) → None[source]#

Update specific fields here (for Union type, specifically).

metadata :Optional[monitor_schema.models.commons.Metadata]#
id :str#
displayName :Optional[str]#
tags :Optional[List[constr(min_length=3, max_length=32, regex='[0-9a-zA-Z\\-_]')]]#
schedule :Optional[Union[monitor_schema.models.commons.CronSchedule, monitor_schema.models.commons.FixedCadenceSchedule]]#
disabled :Optional[bool]#
targetMatrix :Union[monitor_schema.models.analyzer.targets.ColumnMatrix, monitor_schema.models.analyzer.targets.DatasetMatrix]#
dataReadinessDuration :Optional[str]#
batchCoolDownPeriod :Optional[str]#
backfillGracePeriodDuration :Optional[str]#
config :Union[monitor_schema.models.analyzer.algorithms.DiffConfig, monitor_schema.models.analyzer.algorithms.ComparisonConfig, monitor_schema.models.analyzer.algorithms.ListComparisonConfig, monitor_schema.models.analyzer.algorithms.ColumnListChangeConfig, monitor_schema.models.analyzer.algorithms.FixedThresholdsConfig, monitor_schema.models.analyzer.algorithms.StddevConfig, monitor_schema.models.analyzer.algorithms.DriftConfig, monitor_schema.models.analyzer.algorithms.ExperimentalConfig, monitor_schema.models.analyzer.algorithms.SeasonalConfig]#