Skip to content

Queue

CustomMetricServerRecord

Source code in python/scouter/queue/_queue.pyi 
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
class CustomMetricServerRecord:
    def __init__(
        self,
        space: str,
        name: str,
        version: str,
        metric: str,
        value: float,
    ):
        """Initialize spc drift server record

        Args:
            space:
                Model space
            name:
                Model name
            version:
                Model version
            metric:
                Metric name
            value:
                Metric value
        """

    @property
    def created_at(self) -> datetime.datetime:
        """Return the created at timestamp."""

    @property
    def space(self) -> str:
        """Return the space."""

    @property
    def name(self) -> str:
        """Return the name."""

    @property
    def version(self) -> str:
        """Return the version."""

    @property
    def metric(self) -> str:
        """Return the metric name."""

    @property
    def value(self) -> float:
        """Return the metric value."""

    def __str__(self) -> str:
        """Return the string representation of the record."""

    def model_dump_json(self) -> str:
        """Return the json representation of the record."""

    def to_dict(self) -> Dict[str, str]:
        """Return the dictionary representation of the record."""

created_at property

Return the created at timestamp.

metric property

Return the metric name.

name property

Return the name.

space property

Return the space.

value property

Return the metric value.

version property

Return the version.

__init__(space, name, version, metric, value)

Initialize spc drift server record

Parameters:

Name Type Description Default
space str

Model space

 required
name str

Model name

 required
version str

Model version

 required
metric str

Metric name

 required
value float

Metric value

 required
Source code in python/scouter/queue/_queue.pyi 
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
def __init__(
    self,
    space: str,
    name: str,
    version: str,
    metric: str,
    value: float,
):
    """Initialize spc drift server record

    Args:
        space:
            Model space
        name:
            Model name
        version:
            Model version
        metric:
            Metric name
        value:
            Metric value
    """

__str__()

Return the string representation of the record.

Source code in python/scouter/queue/_queue.pyi 
359
360
def __str__(self) -> str:
    """Return the string representation of the record."""

model_dump_json()

Return the json representation of the record.

Source code in python/scouter/queue/_queue.pyi 
362
363
def model_dump_json(self) -> str:
    """Return the json representation of the record."""

to_dict()

Return the dictionary representation of the record.

Source code in python/scouter/queue/_queue.pyi 
365
366
def to_dict(self) -> Dict[str, str]:
    """Return the dictionary representation of the record."""

Feature

Source code in python/scouter/queue/_queue.pyi 
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
class Feature:
    @staticmethod
    def int(name: str, value: int) -> "Feature":
        """Create an integer feature

        Args:
            name:
                Name of the feature
            value:
                Value of the feature
        """

    @staticmethod
    def float(name: str, value: float) -> "Feature":
        """Create a float feature

        Args:
            name:
                Name of the feature
            value:
                Value of the feature
        """

    @staticmethod
    def string(name: str, value: str) -> "Feature":
        """Create a string feature

        Args:
            name:
                Name of the feature
            value:
                Value of the feature
        """

    @staticmethod
    def categorical(name: str, value: str) -> "Feature":
        """Create a categorical feature

        Args:
            name:
                Name of the feature
            value:
                Value of the feature
        """

categorical(name, value) staticmethod

Create a categorical feature

Parameters:

Name Type Description Default
name str

Name of the feature

 required
value str

Value of the feature

 required
Source code in python/scouter/queue/_queue.pyi 
402
403
404
405
406
407
408
409
410
411
@staticmethod
def categorical(name: str, value: str) -> "Feature":
    """Create a categorical feature

    Args:
        name:
            Name of the feature
        value:
            Value of the feature
    """

float(name, value) staticmethod

Create a float feature

Parameters:

Name Type Description Default
name str

Name of the feature

 required
value float

Value of the feature

 required
Source code in python/scouter/queue/_queue.pyi 
380
381
382
383
384
385
386
387
388
389
@staticmethod
def float(name: str, value: float) -> "Feature":
    """Create a float feature

    Args:
        name:
            Name of the feature
        value:
            Value of the feature
    """

int(name, value) staticmethod

Create an integer feature

Parameters:

Name Type Description Default
name str

Name of the feature

 required
value int

Value of the feature

 required
Source code in python/scouter/queue/_queue.pyi 
369
370
371
372
373
374
375
376
377
378
@staticmethod
def int(name: str, value: int) -> "Feature":
    """Create an integer feature

    Args:
        name:
            Name of the feature
        value:
            Value of the feature
    """

string(name, value) staticmethod

Create a string feature

Parameters:

Name Type Description Default
name str

Name of the feature

 required
value str

Value of the feature

 required
Source code in python/scouter/queue/_queue.pyi 
391
392
393
394
395
396
397
398
399
400
@staticmethod
def string(name: str, value: str) -> "Feature":
    """Create a string feature

    Args:
        name:
            Name of the feature
        value:
            Value of the feature
    """

Features

Source code in python/scouter/queue/_queue.pyi 
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
class Features:
    def __init__(self, features: List[Feature]) -> None:
        """Initialize features

        Args:
            features:
                List of features
        """

    def __str__(self) -> str:
        """Return the string representation of the features"""

    @property
    def features(self) -> List[Feature]:
        """Return the list of features"""

    @property
    def entity_type(self) -> EntityType:
        """Return the entity type"""

entity_type property

Return the entity type

features property

Return the list of features

__init__(features)

Initialize features

Parameters:

Name Type Description Default
features List[Feature]

List of features

 required
Source code in python/scouter/queue/_queue.pyi 
414
415
416
417
418
419
420
def __init__(self, features: List[Feature]) -> None:
    """Initialize features

    Args:
        features:
            List of features
    """

__str__()

Return the string representation of the features

Source code in python/scouter/queue/_queue.pyi 
422
423
def __str__(self) -> str:
    """Return the string representation of the features"""

KafkaConfig

Source code in python/scouter/queue/_queue.pyi 
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
class KafkaConfig:
    brokers: str
    topic: str
    compression_type: str
    message_timeout_ms: int
    message_max_bytes: int
    log_level: LogLevel
    config: Dict[str, str]
    max_retries: int
    transport_type: TransportType

    def __init__(
        self,
        brokers: Optional[str] = None,
        topic: Optional[str] = None,
        compression_type: Optional[str] = None,
        message_timeout_ms: int = 600_000,
        message_max_bytes: int = 2097164,
        log_level: LogLevel = LogLevel.Info,
        config: Dict[str, str] = {},
        max_retries: int = 3,
    ) -> None:
        """Kafka configuration to use with the KafkaProducer.

        Args:
            brokers:
                Comma-separated list of Kafka brokers.
                If not provided, the value of the KAFKA_BROKERS environment variable is used.

            topic:
                Kafka topic to publish messages to.
                If not provided, the value of the KAFKA_TOPIC environment variable is used.

            compression_type:
                Compression type to use for messages.
                Default is "gzip".

            message_timeout_ms:
                Message timeout in milliseconds.
                Default is 600_000.

            message_max_bytes:
                Maximum message size in bytes.
                Default is 2097164.

            log_level:
                Log level for the Kafka producer.
                Default is LogLevel.Info.

            config:
                Additional Kafka configuration options. These will be passed to the Kafka producer.
                See https://kafka.apache.org/documentation/#configuration.

            max_retries:
                Maximum number of retries to attempt when publishing messages.
                Default is 3.

        """

__init__(brokers=None, topic=None, compression_type=None, message_timeout_ms=600000, message_max_bytes=2097164, log_level=LogLevel.Info, config={}, max_retries=3)

Kafka configuration to use with the KafkaProducer.

Parameters:

Name Type Description Default
brokers Optional[str]

Comma-separated list of Kafka brokers. If not provided, the value of the KAFKA_BROKERS environment variable is used.

 None
topic Optional[str]

Kafka topic to publish messages to. If not provided, the value of the KAFKA_TOPIC environment variable is used.

 None
compression_type Optional[str]

Compression type to use for messages. Default is "gzip".

 None
message_timeout_ms int

Message timeout in milliseconds. Default is 600_000.

 600000
message_max_bytes int

Maximum message size in bytes. Default is 2097164.

 2097164
log_level LogLevel

Log level for the Kafka producer. Default is LogLevel.Info.

 Info
config Dict[str, str]

Additional Kafka configuration options. These will be passed to the Kafka producer. See https://kafka.apache.org/documentation/#configuration.

 {}
max_retries int

Maximum number of retries to attempt when publishing messages. Default is 3.

 3
Source code in python/scouter/queue/_queue.pyi 
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
def __init__(
    self,
    brokers: Optional[str] = None,
    topic: Optional[str] = None,
    compression_type: Optional[str] = None,
    message_timeout_ms: int = 600_000,
    message_max_bytes: int = 2097164,
    log_level: LogLevel = LogLevel.Info,
    config: Dict[str, str] = {},
    max_retries: int = 3,
) -> None:
    """Kafka configuration to use with the KafkaProducer.

    Args:
        brokers:
            Comma-separated list of Kafka brokers.
            If not provided, the value of the KAFKA_BROKERS environment variable is used.

        topic:
            Kafka topic to publish messages to.
            If not provided, the value of the KAFKA_TOPIC environment variable is used.

        compression_type:
            Compression type to use for messages.
            Default is "gzip".

        message_timeout_ms:
            Message timeout in milliseconds.
            Default is 600_000.

        message_max_bytes:
            Maximum message size in bytes.
            Default is 2097164.

        log_level:
            Log level for the Kafka producer.
            Default is LogLevel.Info.

        config:
            Additional Kafka configuration options. These will be passed to the Kafka producer.
            See https://kafka.apache.org/documentation/#configuration.

        max_retries:
            Maximum number of retries to attempt when publishing messages.
            Default is 3.

    """

Metric

Source code in python/scouter/queue/_queue.pyi 
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
class Metric:
    def __init__(self, name: str, value: float) -> None:
        """Initialize metric

        Args:
            name:
                Name of the metric
            value:
                Value to assign to the metric
        """

    def __str__(self) -> str:
        """Return the string representation of the metric"""

    @property
    def metrics(self) -> List[Metric]:
        """Return the list of metrics"""

    @property
    def entity_type(self) -> EntityType:
        """Return the entity type"""

entity_type property

Return the entity type

metrics property

Return the list of metrics

__init__(name, value)

Initialize metric

Parameters:

Name Type Description Default
name str

Name of the metric

 required
value float

Value to assign to the metric

 required
Source code in python/scouter/queue/_queue.pyi 
434
435
436
437
438
439
440
441
442
def __init__(self, name: str, value: float) -> None:
    """Initialize metric

    Args:
        name:
            Name of the metric
        value:
            Value to assign to the metric
    """

__str__()

Return the string representation of the metric

Source code in python/scouter/queue/_queue.pyi 
444
445
def __str__(self) -> str:
    """Return the string representation of the metric"""

Metrics

Source code in python/scouter/queue/_queue.pyi 
455
456
457
458
459
460
461
462
463
464
465
class Metrics:
    def __init__(self, metrics: List[Metric]) -> None:
        """Initialize metrics

        Args:
            metrics:
                List of metrics
        """

    def __str__(self) -> str:
        """Return the string representation of the metrics"""

__init__(metrics)

Initialize metrics

Parameters:

Name Type Description Default
metrics List[Metric]

List of metrics

 required
Source code in python/scouter/queue/_queue.pyi 
456
457
458
459
460
461
462
def __init__(self, metrics: List[Metric]) -> None:
    """Initialize metrics

    Args:
        metrics:
            List of metrics
    """

__str__()

Return the string representation of the metrics

Source code in python/scouter/queue/_queue.pyi 
464
465
def __str__(self) -> str:
    """Return the string representation of the metrics"""

PsiServerRecord

Source code in python/scouter/queue/_queue.pyi 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
class PsiServerRecord:
    def __init__(
        self,
        space: str,
        name: str,
        version: str,
        feature: str,
        bin_id: int,
        bin_count: int,
    ):
        """Initialize spc drift server record

        Args:
            space:
                Model space
            name:
                Model name
            version:
                Model version
            feature:
                Feature name
            bin_id:
                Bundle ID
            bin_count:
                Bundle ID
        """

    @property
    def created_at(self) -> datetime.datetime:
        """Return the created at timestamp."""

    @property
    def space(self) -> str:
        """Return the space."""

    @property
    def name(self) -> str:
        """Return the name."""

    @property
    def version(self) -> str:
        """Return the version."""

    @property
    def feature(self) -> str:
        """Return the feature."""

    @property
    def bin_id(self) -> int:
        """Return the bin id."""

    @property
    def bin_count(self) -> int:
        """Return the sample value."""

    def __str__(self) -> str:
        """Return the string representation of the record."""

    def model_dump_json(self) -> str:
        """Return the json representation of the record."""

    def to_dict(self) -> Dict[str, str]:
        """Return the dictionary representation of the record."""

bin_count property

Return the sample value.

bin_id property

Return the bin id.

created_at property

Return the created at timestamp.

feature property

Return the feature.

name property

Return the name.

space property

Return the space.

version property

Return the version.

__init__(space, name, version, feature, bin_id, bin_count)

Initialize spc drift server record

Parameters:

Name Type Description Default
space str

Model space

 required
name str

Model name

 required
version str

Model version

 required
feature str

Feature name

 required
bin_id int

Bundle ID

 required
bin_count int

Bundle ID

 required
Source code in python/scouter/queue/_queue.pyi 
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
def __init__(
    self,
    space: str,
    name: str,
    version: str,
    feature: str,
    bin_id: int,
    bin_count: int,
):
    """Initialize spc drift server record

    Args:
        space:
            Model space
        name:
            Model name
        version:
            Model version
        feature:
            Feature name
        bin_id:
            Bundle ID
        bin_count:
            Bundle ID
    """

__str__()

Return the string representation of the record.

Source code in python/scouter/queue/_queue.pyi 
302
303
def __str__(self) -> str:
    """Return the string representation of the record."""

model_dump_json()

Return the json representation of the record.

Source code in python/scouter/queue/_queue.pyi 
305
306
def model_dump_json(self) -> str:
    """Return the json representation of the record."""

to_dict()

Return the dictionary representation of the record.

Source code in python/scouter/queue/_queue.pyi 
308
309
def to_dict(self) -> Dict[str, str]:
    """Return the dictionary representation of the record."""

Queue

Individual queue associated with a drift profile

Source code in python/scouter/queue/_queue.pyi 
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
class Queue:
    """Individual queue associated with a drift profile"""

    def insert(self, entity: Union[Features, Metrics]) -> None:
        """Insert a record into the queue

        Args:
            entity:
                Entity to insert into the queue.
                Can be an instance for Features or Metrics

        Example:
            ```python
            features = Features(
                features=[
                    Feature.int("feature_1", 1),
                    Feature.float("feature_2", 2.0),
                    Feature.string("feature_3", "value"),
                ]
            )
            queue.insert(Features(features))
            ```
        """

insert(entity)

Insert a record into the queue

Parameters:

Name Type Description Default
entity Union[Features, Metrics]

Entity to insert into the queue. Can be an instance for Features or Metrics

 required
Example 
features = Features(
    features=[
        Feature.int("feature_1", 1),
        Feature.float("feature_2", 2.0),
        Feature.string("feature_3", "value"),
    ]
)
queue.insert(Features(features))
Source code in python/scouter/queue/_queue.pyi 
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
def insert(self, entity: Union[Features, Metrics]) -> None:
    """Insert a record into the queue

    Args:
        entity:
            Entity to insert into the queue.
            Can be an instance for Features or Metrics

    Example:
        ```python
        features = Features(
            features=[
                Feature.int("feature_1", 1),
                Feature.float("feature_2", 2.0),
                Feature.string("feature_3", "value"),
            ]
        )
        queue.insert(Features(features))
        ```
    """

RabbitMQConfig

Source code in python/scouter/queue/_queue.pyi 
 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
class RabbitMQConfig:
    address: str
    queue: str
    max_retries: int
    transport_type: TransportType

    def __init__(
        self,
        host: Optional[str] = None,
        port: Optional[int] = None,
        username: Optional[str] = None,
        password: Optional[str] = None,
        queue: Optional[str] = None,
        max_retries: int = 3,
    ) -> None:
        """RabbitMQ configuration to use with the RabbitMQProducer.

        Args:
            host:
                RabbitMQ host.
                If not provided, the value of the RABBITMQ_HOST environment variable is used.

            port:
                RabbitMQ port.
                If not provided, the value of the RABBITMQ_PORT environment variable is used.

            username:
                RabbitMQ username.
                If not provided, the value of the RABBITMQ_USERNAME environment variable is used.

            password:
                RabbitMQ password.
                If not provided, the value of the RABBITMQ_PASSWORD environment variable is used.

            queue:
                RabbitMQ queue to publish messages to.
                If not provided, the value of the RABBITMQ_QUEUE environment variable is used.

            max_retries:
                Maximum number of retries to attempt when publishing messages.
                Default is 3.
        """

__init__(host=None, port=None, username=None, password=None, queue=None, max_retries=3)

RabbitMQ configuration to use with the RabbitMQProducer.

Parameters:

Name Type Description Default
host Optional[str]

RabbitMQ host. If not provided, the value of the RABBITMQ_HOST environment variable is used.

 None
port Optional[int]

RabbitMQ port. If not provided, the value of the RABBITMQ_PORT environment variable is used.

 None
username Optional[str]

RabbitMQ username. If not provided, the value of the RABBITMQ_USERNAME environment variable is used.

 None
password Optional[str]

RabbitMQ password. If not provided, the value of the RABBITMQ_PASSWORD environment variable is used.

 None
queue Optional[str]

RabbitMQ queue to publish messages to. If not provided, the value of the RABBITMQ_QUEUE environment variable is used.

 None
max_retries int

Maximum number of retries to attempt when publishing messages. Default is 3.

 3
Source code in python/scouter/queue/_queue.pyi 
 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
def __init__(
    self,
    host: Optional[str] = None,
    port: Optional[int] = None,
    username: Optional[str] = None,
    password: Optional[str] = None,
    queue: Optional[str] = None,
    max_retries: int = 3,
) -> None:
    """RabbitMQ configuration to use with the RabbitMQProducer.

    Args:
        host:
            RabbitMQ host.
            If not provided, the value of the RABBITMQ_HOST environment variable is used.

        port:
            RabbitMQ port.
            If not provided, the value of the RABBITMQ_PORT environment variable is used.

        username:
            RabbitMQ username.
            If not provided, the value of the RABBITMQ_USERNAME environment variable is used.

        password:
            RabbitMQ password.
            If not provided, the value of the RABBITMQ_PASSWORD environment variable is used.

        queue:
            RabbitMQ queue to publish messages to.
            If not provided, the value of the RABBITMQ_QUEUE environment variable is used.

        max_retries:
            Maximum number of retries to attempt when publishing messages.
            Default is 3.
    """

RedisConfig

Source code in python/scouter/queue/_queue.pyi 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
class RedisConfig:
    address: str
    channel: str
    transport_type: TransportType

    def __init__(
        self,
        address: Optional[str] = None,
        chanel: Optional[str] = None,
    ) -> None:
        """Redis configuration to use with a Redis producer

        Args:
            address (str):
                Redis address.
                If not provided, the value of the REDIS_ADDR environment variable is used and defaults to "redis://localhost:6379".

            channel (str):
                Redis channel to publish messages to.
                If not provided, the value of the REDIS_CHANNEL environment variable is used and defaults to "scouter_monitoring".
        """

__init__(address=None, chanel=None)

Redis configuration to use with a Redis producer

Parameters:

Name Type Description Default
address str

Redis address. If not provided, the value of the REDIS_ADDR environment variable is used and defaults to "redis://localhost:6379".

 None
channel str

Redis channel to publish messages to. If not provided, the value of the REDIS_CHANNEL environment variable is used and defaults to "scouter_monitoring".

 required
Source code in python/scouter/queue/_queue.pyi 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def __init__(
    self,
    address: Optional[str] = None,
    chanel: Optional[str] = None,
) -> None:
    """Redis configuration to use with a Redis producer

    Args:
        address (str):
            Redis address.
            If not provided, the value of the REDIS_ADDR environment variable is used and defaults to "redis://localhost:6379".

        channel (str):
            Redis channel to publish messages to.
            If not provided, the value of the REDIS_CHANNEL environment variable is used and defaults to "scouter_monitoring".
    """

ScouterQueue

Main queue class for Scouter. Publishes drift records to the configured transport

Source code in python/scouter/queue/_queue.pyi 
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
class ScouterQueue:
    """Main queue class for Scouter. Publishes drift records to the configured transport"""

    @staticmethod
    def from_path(
        path: Dict[str, Path],
        transport_config: Union[
            KafkaConfig,
            RabbitMQConfig,
            RedisConfig,
            HTTPConfig,
        ],
    ) -> ScouterQueue:
        """Initializes Scouter queue from one or more drift profile paths

        Args:
            path (Dict[str, Path]):
                Dictionary of drift profile paths.
                Each key is a user-defined alias for accessing a queue
            transport_config (Union[KafkaConfig, RabbitMQConfig, RedisConfig, HTTPConfig]):
                Transport configuration for the queue publisher
                Can be KafkaConfig, RabbitMQConfig RedisConfig, or HTTPConfig

        Example:
            ```python
            queue = ScouterQueue(
                path={
                    "spc": Path("spc_profile.json"),
                    "psi": Path("psi_profile.json"),
                },
                transport_config=KafkaConfig(
                    brokers="localhost:9092",
                    topic="scouter_topic",
                ),
            )

            queue["psi"].insert(
                Features(
                    features=[
                        Feature.int("feature_1", 1),
                        Feature.float("feature_2", 2.0),
                        Feature.string("feature_3", "value"),
                    ]
                )
            )
            ```
        """

    def __getitem__(self, key: str) -> Queue:
        """Get the queue for the specified key

        Args:
            key (str):
                Key to get the queue for

        """

    def shutdown(self) -> None:
        """Shutdown the queue. This will close and flush all queues and transports"""

__getitem__(key)

Get the queue for the specified key

Parameters:

Name Type Description Default
key str

Key to get the queue for

 required
Source code in python/scouter/queue/_queue.pyi 
539
540
541
542
543
544
545
546
def __getitem__(self, key: str) -> Queue:
    """Get the queue for the specified key

    Args:
        key (str):
            Key to get the queue for

    """

from_path(path, transport_config) staticmethod

Initializes Scouter queue from one or more drift profile paths

Parameters:

Name Type Description Default
path Dict[str, Path]

Dictionary of drift profile paths. Each key is a user-defined alias for accessing a queue

 required
transport_config Union[KafkaConfig, RabbitMQConfig, RedisConfig, HTTPConfig]

Transport configuration for the queue publisher Can be KafkaConfig, RabbitMQConfig RedisConfig, or HTTPConfig

 required
Example 
queue = ScouterQueue(
    path={
        "spc": Path("spc_profile.json"),
        "psi": Path("psi_profile.json"),
    },
    transport_config=KafkaConfig(
        brokers="localhost:9092",
        topic="scouter_topic",
    ),
)

queue["psi"].insert(
    Features(
        features=[
            Feature.int("feature_1", 1),
            Feature.float("feature_2", 2.0),
            Feature.string("feature_3", "value"),
        ]
    )
)
Source code in python/scouter/queue/_queue.pyi 
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
@staticmethod
def from_path(
    path: Dict[str, Path],
    transport_config: Union[
        KafkaConfig,
        RabbitMQConfig,
        RedisConfig,
        HTTPConfig,
    ],
) -> ScouterQueue:
    """Initializes Scouter queue from one or more drift profile paths

    Args:
        path (Dict[str, Path]):
            Dictionary of drift profile paths.
            Each key is a user-defined alias for accessing a queue
        transport_config (Union[KafkaConfig, RabbitMQConfig, RedisConfig, HTTPConfig]):
            Transport configuration for the queue publisher
            Can be KafkaConfig, RabbitMQConfig RedisConfig, or HTTPConfig

    Example:
        ```python
        queue = ScouterQueue(
            path={
                "spc": Path("spc_profile.json"),
                "psi": Path("psi_profile.json"),
            },
            transport_config=KafkaConfig(
                brokers="localhost:9092",
                topic="scouter_topic",
            ),
        )

        queue["psi"].insert(
            Features(
                features=[
                    Feature.int("feature_1", 1),
                    Feature.float("feature_2", 2.0),
                    Feature.string("feature_3", "value"),
                ]
            )
        )
        ```
    """

shutdown()

Shutdown the queue. This will close and flush all queues and transports

Source code in python/scouter/queue/_queue.pyi 
548
549
def shutdown(self) -> None:
    """Shutdown the queue. This will close and flush all queues and transports"""

ServerRecord

Source code in python/scouter/queue/_queue.pyi 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
class ServerRecord:
    Spc: "ServerRecord"
    Psi: "ServerRecord"
    Custom: "ServerRecord"
    Observability: "ServerRecord"

    def __init__(self, record: Any) -> None:
        """Initialize server record

        Args:
            record:
                Server record to initialize
        """

    @property
    def record(
        self,
    ) -> Union[SpcServerRecord, PsiServerRecord, CustomMetricServerRecord, ObservabilityMetrics]:
        """Return the drift server record."""

record property

Return the drift server record.

__init__(record)

Initialize server record

Parameters:

Name Type Description Default
record Any

Server record to initialize

 required
Source code in python/scouter/queue/_queue.pyi 
157
158
159
160
161
162
163
def __init__(self, record: Any) -> None:
    """Initialize server record

    Args:
        record:
            Server record to initialize
    """

ServerRecords

Source code in python/scouter/queue/_queue.pyi 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
class ServerRecords:
    def __init__(self, records: List[ServerRecord]) -> None:
        """Initialize server records

        Args:
            records:
                List of server records
        """

    @property
    def records(self) -> List[ServerRecord]:
        """Return the drift server records."""

    def model_dump_json(self) -> str:
        """Return the json representation of the record."""

    def __str__(self) -> str:
        """Return the string representation of the record."""

records property

Return the drift server records.

__init__(records)

Initialize server records

Parameters:

Name Type Description Default
records List[ServerRecord]

List of server records

 required
Source code in python/scouter/queue/_queue.pyi 
172
173
174
175
176
177
178
def __init__(self, records: List[ServerRecord]) -> None:
    """Initialize server records

    Args:
        records:
            List of server records
    """

__str__()

Return the string representation of the record.

Source code in python/scouter/queue/_queue.pyi 
187
188
def __str__(self) -> str:
    """Return the string representation of the record."""

model_dump_json()

Return the json representation of the record.

Source code in python/scouter/queue/_queue.pyi 
184
185
def model_dump_json(self) -> str:
    """Return the json representation of the record."""

SpcServerRecord

Source code in python/scouter/queue/_queue.pyi 
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
243
244
245
class SpcServerRecord:
    def __init__(
        self,
        space: str,
        name: str,
        version: str,
        feature: str,
        value: float,
    ):
        """Initialize spc drift server record

        Args:
            space:
                Model space
            name:
                Model name
            version:
                Model version
            feature:
                Feature name
            value:
                Feature value
        """

    @property
    def created_at(self) -> datetime.datetime:
        """Return the created at timestamp."""

    @property
    def space(self) -> str:
        """Return the space."""

    @property
    def name(self) -> str:
        """Return the name."""

    @property
    def version(self) -> str:
        """Return the version."""

    @property
    def feature(self) -> str:
        """Return the feature."""

    @property
    def value(self) -> float:
        """Return the sample value."""

    def __str__(self) -> str:
        """Return the string representation of the record."""

    def model_dump_json(self) -> str:
        """Return the json representation of the record."""

    def to_dict(self) -> Dict[str, str]:
        """Return the dictionary representation of the record."""

created_at property

Return the created at timestamp.

feature property

Return the feature.

name property

Return the name.

space property

Return the space.

value property

Return the sample value.

version property

Return the version.

__init__(space, name, version, feature, value)

Initialize spc drift server record

Parameters:

Name Type Description Default
space str

Model space

 required
name str

Model name

 required
version str

Model version

 required
feature str

Feature name

 required
value float

Feature value

 required
Source code in python/scouter/queue/_queue.pyi 
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
def __init__(
    self,
    space: str,
    name: str,
    version: str,
    feature: str,
    value: float,
):
    """Initialize spc drift server record

    Args:
        space:
            Model space
        name:
            Model name
        version:
            Model version
        feature:
            Feature name
        value:
            Feature value
    """

__str__()

Return the string representation of the record.

Source code in python/scouter/queue/_queue.pyi 
238
239
def __str__(self) -> str:
    """Return the string representation of the record."""

model_dump_json()

Return the json representation of the record.

Source code in python/scouter/queue/_queue.pyi 
241
242
def model_dump_json(self) -> str:
    """Return the json representation of the record."""

to_dict()

Return the dictionary representation of the record.

Source code in python/scouter/queue/_queue.pyi 
244
245
def to_dict(self) -> Dict[str, str]:
    """Return the dictionary representation of the record."""