ih_muse.config.config

Module for configuring ih_muse.

Module Contents

Classes

Config

Configuration class for the Muse client in Python.

API

class ih_muse.config.config.Config(endpoints: list[str], client_type: ih_muse.ih_muse.ClientType, default_resolution: ih_muse.ih_muse.TimestampResolution, element_kinds: list[ih_muse.proto.ElementKindRegistration], metric_definitions: list[ih_muse.proto.MetricDefinition], max_reg_elem_retries: int, recording_enabled: bool, recording_path: Optional[str] = None, recording_flush_interval: Optional[datetime.timedelta] = None, initialization_interval: Optional[datetime.timedelta] = None, cluster_monitor_interval: Optional[datetime.timedelta] = None)[source]

Configuration class for the Muse client in Python.

Parameters:

  • endpoints (list[str]) – List of endpoint URLs for the Muse client.

  • client_type (ClientType) – The type of client to use (ClientType.Poet or ClientType.Mock).

  • default_resolution (TimestampResolution) – Default timestamp resolution for metrics.

  • element_kinds (list[ElementKindRegistration]) – List of element kinds to register.

  • metric_definitions (list[MetricDefinition]) – List of metric definitions available for reporting.

  • max_reg_elem_retries (int) – Maximum number of retries for element registration.

  • recording_enabled (bool) – Enables event recording if set to True.

  • recording_path (Optional[str]) – File path for recording events (required if recording_enabled is True).

  • recording_flush_interval (Optional[timedelta]) – Interval to flush recordings (required if recording_enabled is True).

  • initialization_interval (Optional[timedelta]) – Interval for the muse initialization task.

  • cluster_monitor_interval (Optional[timedelta]) – Interval for the cluster monitoring task.

# Example usage:
from ih_muse import Config, ClientType, TimestampResolution
from ih_muse.proto import ElementKindRegistration, MetricDefinition

config = Config(
    endpoints=["http://localhost:8080"],
    client_type=ClientType.Poet,
    default_resolution=TimestampResolution.Milliseconds,
    element_kinds=[ElementKindRegistration("kind_code", "description")],
    metric_definitions=[MetricDefinition("metric_code", "description")],
    max_reg_elem_retries=3,
    recording_enabled=False,
)

Initialization

Initialize the Config instance.

_config: ih_muse.ih_muse.PyConfig

None