Skip to main content

Search AWS CloudWatch Logs with Insights queries, flexible time ranges and wildcards in log group names from your command line.

Project description

qaws - Query AWS Logs

Command line utility for search in AWS CloudWatch Logs with Insights queries and flexible time ranges.

  1. Install latest via pip: https://pypi.org/project/qaws.
  2. You need Python 3.8 (you can try lower version - not tested)
  3. Ensure you have you Python's Bin directory in $PATH
  4. Execute "qaws" in your command line.

Status

Versions

  • Version 0.3 is stable, used by me on daily bases

Improvement proposals

  1. qaws should be able to list all groups in AWS
  2. qaws should be able to take group list as stdin parameter
  3. qaws could totaly neglect switchers like '-g', because each group starts with "/" and each query contains "fiELDs"
  4. So the result could be: 'qaws --groups | qaws "1y" "6mo" "fields @message"'

Manual

NAME
    qaws -- Query AWS CloudWatch logs
SYNOPSIS
    qaws    [-g groups...]
            [-t starttime | starttime endtime]
            [-q query]
DESCRIPTION
    -g --groups groups ...
        Specify 1 to N logging groups like "/ecs/someservice1". Wildcard * can be used like "*ecs*some*1". 
        If you specify only -g flag then it will print all groups in CloudWatch
    -t --time starttime | starttime endtime
        Specify starttime in history to more recent endtime in present.
        Possible formats for time specification is:
            ISO time:           "2000-01-01T00:00:00"
            Epoch in seconds:   "1590314700"
            Time relative to Now:      
                "1h"                    1 hour ago
                "1h 60m"                2 hours ago
                "1h 60m 3600s"          3 hours ago
                "3600s 60m 1h"          3 hours ago as well (order doesn't matter)
                "3600s 3600s 3600s"     3 hours ago as well (items are repeatable)
                "1y 1mo 1w 1d 1h 1m 1s" is possible as well
    -g --query query
        Query exactly as it is usually written in AWS CloudWatch Insights in Web Console:
            fields @timestamp, @message 
            | filter @message like 'event' 
            | limit 10"

    - It can take few minutes (~2 minutes) until logs appears in CloudWatch and therefore fetching logs 
        with '-t "1m"' may not return any results
    - Even if you set '|limit 1' in --query then CloudWatch will anyway search over entire specified e.g. '-t "10d"' 
        history which can take lot of time
    - When you use wildcard * in group names then it will take longer to finish query as all the log group names has to be fetched from AWS
EXAMPLES
    - Prints all log groups in CloudWatch:
        qaws \
            --groups
    - Prints all log groups in CloudWatch matching wildcard:
        qaws \
            --groups "*service*"
    - Basic querying:
        qaws \
            --groups      "/ecs/myservice0" \
            --time        "1h" \
            --query       "fields @message"
    - Multiple groups specified with one containing wildcard:
        qaws \ 
            --groups      "*ecs*service0" "/ecs/myservice1" "/ecs/myservice2" \
            --time        "1d 1h 30m 30s" \
            --query       "fields @message"
    - Query logs in between past 5 and 1 hour:
        qaws \
            --groups      "/ecs/*" \
            --time        "5h" "1h" \
            --query       "fields @timestamp @message | filter @message like 'event' | limit 15"
    - Query logs in between two ISO dates:
        qaws \
            --groups      "/ecs/*" \
            --time        "2020-05-24T00:00:00" "2020-05-24T12:00:00" \
            --query       "fields @message | filter @message like 'event'"
    - Combine relative time with ISO date:
        qaws \
            --groups      "/ecs/*" \
            --time        "1y" "2020-05-24T00:00:00" \
            --query       "fields @message | filter @message like 'event'"
AUTHORS
    Jiri Kacirek (kacirek.j@gmail.com) 2020
IMPLEMENTATION
    Python 3.8

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qaws-0.4.0.tar.gz (5.0 kB view hashes)

Uploaded Source

Built Distribution

qaws-0.4.0-py3-none-any.whl (6.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page