Log Campaign

This module defines the LogCampaignResponse and LogQueue classes for handling log campaigns in the Ankaios system.

Classes

• LogCampaignResponse:

  Represents the response for a log campaign, containing the queue of received messages and the accepted workload names.

• LogQueue:

  Represents a queue of received messages through the log campaign.

Usage

• Check the valid workload names:

  log_campaign: LogCampaignResponse
  valid_workload_names: list = log_campaign.accepted_workload_names
  

• Get logs out of the queue:

  log = log_campaign.queue.get()
  

LogCampaignResponse Class

class ankaios_sdk._components.log_campaign.LogCampaignResponse(queue, accepted_workload_names)

Represents the response for a log campaign, containing the queue of received messages and the accepted workload names.

__init__(queue, accepted_workload_names)

Initializes the LogCampaignResponse with the given queue and accepted workload names.

Parameters:

• queue (LogQueue) – The queue containing the log messages.

• accepted_workload_names (list[WorkloadInstanceName]) – The list of workload instance names for which logs have been accepted.

LogQueue Class

class ankaios_sdk._components.log_campaign.LogQueue(request)

Bases: Queue

Represents a queue of received messages through the log campaign. Inherits from the standard Queue class. All objects in this queue are of type LogResponse.

__init__(request)

Initializes the LogQueue with the given parameters.

Parameters:

request (LogsRequest) – The request object containing the log campaign parameters.

empty()

Return True if the queue is empty, False otherwise (not reliable!).

This method is likely to be removed at some point. Use qsize() == 0 as a direct substitute, but be aware that either approach risks a race condition where a queue can grow before the result of empty() or qsize() can be used.

To create code that needs to wait for all queued tasks to be completed, the preferred technique is to use the join() method.

full()

Return True if the queue is full, False otherwise (not reliable!).

This method is likely to be removed at some point. Use qsize() >= n as a direct substitute, but be aware that either approach risks a race condition where a queue can shrink before the result of full() or qsize() can be used.

get(block=True, timeout=None)

Remove and return an item from the queue.

If optional args ‘block’ is true and ‘timeout’ is None (the default), block if necessary until an item is available. If ‘timeout’ is a non-negative number, it blocks at most ‘timeout’ seconds and raises the Empty exception if no item was available within that time. Otherwise (‘block’ is false), return an item if one is immediately available, else raise the Empty exception (‘timeout’ is ignored in that case).

get_nowait()

Remove and return an item from the queue without blocking.

Only get an item if one is immediately available. Otherwise raise the Empty exception.

join()

Blocks until all items in the Queue have been gotten and processed.

The count of unfinished tasks goes up whenever an item is added to the queue. The count goes down whenever a consumer thread calls task_done() to indicate the item was retrieved and all work on it is complete.

When the count of unfinished tasks drops to zero, join() unblocks.

put(item, block=True, timeout=None)

Put an item into the queue.

If optional args ‘block’ is true and ‘timeout’ is None (the default), block if necessary until a free slot is available. If ‘timeout’ is a non-negative number, it blocks at most ‘timeout’ seconds and raises the Full exception if no free slot was available within that time. Otherwise (‘block’ is false), put an item on the queue if a free slot is immediately available, else raise the Full exception (‘timeout’ is ignored in that case).

put_nowait(item)

Put an item into the queue without blocking.

Only enqueue the item if a free slot is immediately available. Otherwise raise the Full exception.

qsize()

Return the approximate size of the queue (not reliable!).

task_done()

Indicate that a formerly enqueued task is complete.

Used by Queue consumer threads. For each get() used to fetch a task, a subsequent call to task_done() tells the queue that the processing on the task is complete.

If a join() is currently blocking, it will resume when all items have been processed (meaning that a task_done() call was received for every item that had been put() into the queue).

Raises a ValueError if called more times than there were items placed in the queue.