WattsonElkService

class wattson.services.monitoring.wattson_elk_service.WattsonElkService(service_configuration: ServiceConfiguration, network_node: WattsonNetworkNode)

Bases: WattsonService

Methods

get_stderr	returns: The file descriptor to use as stderr
get_stdout	returns: The file descriptor to use as stdout
start	Start the service.
stop	Stop the service.

Attributes

id
name

get_stderr()

Returns:

The file descriptor to use as stderr

get_stdout()

Returns:

The file descriptor to use as stdout

start(refresh_config: bool = False)

Start the service.

Parameters:

refresh_config (bool, optional) – Whether to refresh the config even if it already exists. (Default value = False)

Returns:

True iff the service has been started.

Return type:

bool

stop(wait_seconds: float = 5, auto_kill: bool = False, async_callback: Callable[[WattsonServiceInterface], None] | None = None) → bool

Stop the service.

Parameters:

• wait_seconds (float, optional) – Number of seconds to wait for the service to gracefully terminate. (Default value = 5)

• auto_kill (bool, optional) – Whether to kill the service automatically after the waiting timeout has been exceeded. (Default value = False)

• async_callback (Optional[Callable[['WattsonServiceInterface'], None]], optional) – An optional callback to call once the service has terminated. Makes the stop method return immediately. (Default value = None)

Returns:

None if an async_callback is given, else True iff the service has been terminated.

Return type:

bool