Skip to main content

aws logs dump and analytics tool

Project description

# Dumplogs

Dumplogs is a command line tool (python) for dumping the aws cloudwatch log streams into local files.

## Motivation

On AWS cloud, Users can get historical AWS cloudwatch logs by exporting the log group into S3 bucket. See [AWS logs S3 Export](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/S3Export.html) The exported file are all in gz format and are placed in separate directory. one way to download them into loacl machine is to use “aws s3 cp s3://WholeBucket LocalFolder –recursive” , and then unzip all the gz files. This operation on AWS is inevitable fussiness.

A more direct approach to dump the logs into local files is to use “aws logs” cli command. But aws-cli logs only allows max. 50 log streams to be retrieved at a time. In order to dump the whole logs streams from a log group, user need record the ‘next_token’ every time by himself.

Dumplogs is inspired by “aws logs” , it aims to dump (and filter) the whole log streams from a AWS log group to local text files.

## Installation

`bash pip3 install https://github.com/xinhuagu/dumplogs.git `

or

`bash python3 -m pip install https://github.com/xinhuagu/dumplogs.git `

## Usage

Make sure the AWS_PROFILE is set properly

`bash export AWS_PROFILE=my_profile `

`bash usage: dumplogs [-h] [--profile AWS_PROFILE] [-o OUTPUT] group_name `

  • -h –help help information

  • -o –output output directory, default: current directory

  • –profile aws profile, default: AWS_PROFILE env var

  • group_name aws log group name

## Example

`bash dumplogs /aws/lambda/dpa-kafka-logs -o test --profile DEV `

or

`bash dumplogs /aws/lambda/dpa-kafka-logs `

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[Revised BSD License](https://github.com/xinhuagu/dumplogs/blob/master/LICENSE.txt)

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

awsdumplogs-0.1.1-py3.9.egg (5.9 kB view hashes)

Uploaded Source

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