Skip to main content

Get, sort and analyse AWS CloudWatch logs from multiple log groups using AWS CloudWatch Insights service

Project description

awsinsights

Get and filter logs from multiple log groups of AWS CloudWatch and filter CloudWatch logs using predefined regular expressions.

This script uses AWS CloudWatch Insights service.

Install

awsinsights is released to public PyPI - awsinsights. It can be installed using this command:

pip install awsinsights

Basic Usage

  1. Set up AWS Credentials.

  2. Define apps (sets of CloudWatch log groups assigned to app name) in $HOME/.awsinsights.json file. See example file below.

  3. Get all logs from the simplebook app (2 log groups pre-defined) since last 30 minutes:

awsinsights --timedelta 30m --appname simplebook
  1. Filter logs from simplebook app since last 7d containing words 'Monday' or 'Tuesday' (you can use any Regular Expression)
awsinsights --timedelta 7d --appname simplebook --filter "Monday|Tuesday"

Advanced Usage

  1. Get logs from simplebook from 1 Jan 2021 10:00am to 2 Jan 2021 9:00am which contain 'Exception' or 'ERROR' on PROD environment
awsinsights --env prod --start "2021-01-01 10:00:00" --end "2021-01-02 09:00:00" --appname simplebook --filter "Exception|ERROR"
  1. Get all logs from CloudWatch log groups group-one-dev and /aws/lambda/group-two-dev since last 2 hours:
awsinsights --timedelta 2h --log_groups "group-one-dev" "/aws/lambda/group-two-dev"
  1. Custom CloudWatch Insights query (override the default filter-based query):
awsinsights --appname simplebook --timedelta 2h --query "fields @timestamp, @message | filter @message not like /INFO/ | sort @timestamp"

Glob Patterns for Log Groups

Log group names in config and --log_groups support * and ? glob wildcards. Patterns are resolved at runtime using the CloudWatch describe_log_groups API.

This is useful when log group names vary by environment or region:

{
    "myapp": [
        "/aws/lambda/my-function-*",
        "/aws/lambda/api-$ENV-??"
    ]
}

For example, /aws/lambda/my-function-* will match:

  • /aws/lambda/my-function-dev-eu-central-1
  • /aws/lambda/my-function-dev-us-east-1
  • /aws/lambda/my-function-dev-ap-southeast-1

Log groups without glob characters are passed through unchanged (no extra API calls).

Show Log Source

When querying multiple log groups, use these flags to identify which source produced each log line:

--show_log_group

Include the CloudWatch log group name in brackets before each message:

awsinsights --appname myapp --show_log_group --timedelta 2h --filter "ERROR"

Output:

2026-04-01 02:57:19 [/aws-glue/jobs/DataLake] java.lang.OutOfMemoryError: GC overhead limit exceeded
2026-04-01 23:00:10 [/aws/lambda/refresh_metrics_views] [ERROR] UndefinedTable: relation "mv_live_calendar_metrics" does not exist

--show_log_stream

Include the CloudWatch log stream name in brackets:

awsinsights --appname myapp --show_log_stream --timedelta 2h --filter "ERROR"

--show_resource

Extract and display the AWS resource name (Lambda function, Glue job, RDS cluster, etc.) in parentheses. The resource name is extracted from the log group path and/or log stream:

awsinsights --appname myapp --show_resource --timedelta 2h --filter "ERROR"

Output:

2026-04-01 02:57:19 [/aws-glue/jobs/DataLake] [jr_abc123] (jr_abc123) java.lang.OutOfMemoryError...
2026-04-01 23:00:10 [/aws/lambda/refresh_metrics_views] (refresh_metrics_views) [ERROR] UndefinedTable...

Supported resource extraction patterns:

Log Group Pattern Extracted Resource
/aws/lambda/{function} Lambda function name
/aws/kinesisfirehose/{stream} Firehose delivery stream name
/aws/rds/cluster/{cluster}/... RDS cluster name
/aws/apigateway/{api} API Gateway name
/aws/codebuild/{project} CodeBuild project name
/aws/elasticbeanstalk/{env}/... Elastic Beanstalk environment
/ecs/{service} ECS service name
/aws-glue/jobs/{group} Glue job run ID (from log stream)
Custom paths Last path segment

All three flags can be combined:

awsinsights --appname myapp --show_log_group --show_log_stream --show_resource --filter "ERROR"

Tail mode

awsinsights allows to listen CloudWatch in live mode which is called tail mode.

It can be activated using --tail option.

Example - listening for ERRORs and Exceptions in tail mode:

awsinsights --timedelta 30m --appname simplebook --filter "ERROR|Exception" --tail

NOTE: Please notice that there might be few mins delay between the time when log really happened and the time when it will appear in output of awsinsights' tail mode.

Example of config file

Config file should be placed in $HOME/.awsinsights.json

This example file contains 3 apps: simplebook, secondapp, and datalake. Each app consists of CloudWatch log groups. Glob patterns (*, ?) are supported.

{
    "simplebook": [
        "/aws/lambda/simple-books-catalog-api-$ENV",
        "/aws/lambda/api-task-2-ad"
    ],
    "secondapp": [
        "first-log-group",
        "/aws/lambda/second-log-group"
    ],
    "datalake": [
        "/aws-glue/jobs/DataLake",
        "/aws/lambda/Lambda_Run_*",
        "/aws/lambda/oreo_*",
        "/aws/lambda/copy_data_to_rds",
        "/aws/lambda/refresh_metrics_views"
    ]
}

The $ENV variable is replaced with the --env value (default: dev). Glob patterns (*, ?) are resolved at runtime against actual CloudWatch log groups.

Output file

Logs will be written to output file. Output file will be:

  • /tmp/{appname}.log if app name is defined using --appname option OR
  • /tmp/awsinsights.log if app name is NOT defined

Help

awsinsights [-h] [--timedelta TIMEDELTA] [--start START] [--end END]
                   [--filter FILTER]
                   (--appname APPNAME | --log_groups LOG_GROUPS [LOG_GROUPS ...])
                   [--env ENV] [--query QUERY] [--wait WAIT] [--tail]
                   [--show_log_group] [--show_log_stream] [--show_resource]

optional arguments:
  -h, --help            show this help message and exit
  --timedelta TIMEDELTA
                        delta time since now when logs should be filtered ex.
                        120m, 3h, 2d. Default: 60m
  --start START         start time of grabbing logs. Format: YYYY-MM-DD
                        HH:MM:SS
  --end END             end time of grabbing logs. Format: YYYY-MM-DD HH:MM:SS
  --filter FILTER       Regular expression for filtering logs
  --appname APPNAME     name of the app which logs should be analysed. App
                        names should have logs groups configured in
                        .awsinsights.json file. See README.md file.
  --log_groups LOG_GROUPS [LOG_GROUPS ...]
                        list of the log groups to analyse (up to 20).
                        Supports glob patterns (* and ?)
  --env ENV             env name. It can replace "$ENV" phrase in log groups
                        names. Default: dev
  --query QUERY         Custom full AWS CloudWatch Insights query. Default:
                        fields @timestamp, @message | filter @message like //
                        | sort @timestamp
  --wait WAIT           wait time for single AWS Insights Query results in
                        seconds. Default: 10
  --tail                TAIL MODE. Listen for live logs forever
  --show_log_group      Include log group name in output before each log
                        message
  --show_log_stream     Include log stream name in output before each log
                        message
  --show_resource       Include AWS resource name (Lambda function, Glue job,
                        etc.) extracted from log group/stream in output

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

awsinsights-1.0.10.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

awsinsights-1.0.10-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file awsinsights-1.0.10.tar.gz.

File metadata

  • Download URL: awsinsights-1.0.10.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for awsinsights-1.0.10.tar.gz
Algorithm Hash digest
SHA256 c4c983df239a941bc6dcf9e17f751c01cc5e1af8742ad62f25d102ca1ca0e504
MD5 e19875f523dfab34a208488c2fc950d2
BLAKE2b-256 4f875ae293f4289db9f1d93fce200c255bbab2a88a4e43ba8bf30372f7299324

See more details on using hashes here.

File details

Details for the file awsinsights-1.0.10-py3-none-any.whl.

File metadata

  • Download URL: awsinsights-1.0.10-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for awsinsights-1.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 0e7090c5575ba00399076aa6331756897972d3c15608f4972f6c12431c731389
MD5 c31f0ffc58b1b50e54a20fd5ffda9987
BLAKE2b-256 ecff6eb7ef22ef373d975eef66fce5de53a7a80681d2c5d67eaef31239cc232b

See more details on using hashes here.

Supported by

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