Skip to content

Cloudwatch Logs

Botree AWS Logs utilities.

Classes

botree.logs.Logs(session)

AWS CloudWatch Logs operations.

Logs class init.

Parameters:

  • session (boto3.Session) –

    The authenticated session to be used for CloudWatch Logs operations.

Source code in botree/logs.py 
 7
 8
 9
10
11
12
13
14
15
16
17
def __init__(self, session):
    """
    Logs class init.

    Parameters
    ----------
    session : boto3.Session
        The authenticated session to be used for CloudWatch Logs operations.
    """
    self.session = session
    self.client = self.session.client(service_name="logs")

Functions

execute_query(log_group_names, query_string, start_time, end_time, **kwargs)

Execute a query to retrieve logs and get the query results.

Parameters:

  • log_group_names (list) –

    The list of log group names to query.

query_string : str The query string to search logs.

start_time : int The start time of the logs to query (in milliseconds).

end_time : int The end time of the logs to query (in milliseconds).

kwargs : dict, optional Additional optional parameters to be passed to the start_query method.

Returns:

  • dict –

    The response containing the query results.

Source code in botree/logs.py 
19
20
21
22
23
24
25
26
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
def execute_query(
    self, log_group_names, query_string, start_time, end_time, **kwargs
):
    """
    Execute a query to retrieve logs and get the query results.

    Parameters
    ----------
    log_group_names : list
        The list of log group names to query.

    query_string : str
        The query string to search logs.

    start_time : int
        The start time of the logs to query (in milliseconds).

    end_time : int
        The end time of the logs to query (in milliseconds).

    kwargs : dict, optional
        Additional optional parameters to be passed to the `start_query` method.

    Returns
    -------
    dict
        The response containing the query results.
    """
    response = self.client.start_query(
        logGroupNames=log_group_names,
        queryString=query_string,
        startTime=start_time,
        endTime=end_time,
        **kwargs,
    )
    query_id = response["queryId"]

    while True:
        response = self.client.get_query_results(queryId=query_id)
        status_response = response["status"]
        if status_response == "Complete":
            break
        elif status_response == "Failed" or status_response == "Cancelled":
            raise Exception(
                f"Query execution failed or was cancelled. Status: {status_response}"
            )

    return response