pyinsights 0.3.1

AWS CloudWatch Logs Insights is wrapped by Python

PyInsights

A CLI tool To query CloudWatch Logs Insights.

ToC

• Usage
  • Write Configuration
  • Execute command
• Configuration
• CLI Options
• Environment Variable

Usage

Write Configuration

Write configuration to pyinsights.yml like:

version: '1.0'
log_group_name:
  - '/ecs/sample'
query_string: 'field @message | filter @message like /ERROR/'
duration: '30m'
limit: 10

I wrote examples, so see examples folder.

Execute command

pyinsights -c pyinsights.yml -p aws_profile -r region

Configuration

Parameter	Type	Required	Description
version	string	true	Choose configuration version from ['1.0']
log_group_name	array	true	Target log group names to query
query_string	string	true	Pattern to query
duration	string or object	true
	string		Specify hours, minutes or seconds from now Unit: hours = h, minutes = m, seconds = s, days = d, weeks = w
	object		Specify start_time and end_time Datetime format must be YYYY-MM-DD HH:MM:SS
limit	integer	false	The number of log to fetch

CLI Options

Option	Required	Description
-c, --config	true	Specify yaml configuration by absolute or relative path
-f, --format	false	Choose from json or table
-p, --profile	false	AWS profile name
-r, --region	false	AWS region
-v, --version	false	Show version

Environment Variable

If profile and region options are not specified, AWS Credentials must be set as environment variables.

• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY
• AWS_DEFAULT_REGION

Please see Environment Variable Configuration for the detail.