https://github.com/seeebiii/lambdalogs
A CLI tool to trace AWS Lambda calls over multiple CloudWatch log groups.
https://github.com/seeebiii/lambdalogs
aws aws-cloudwatch aws-lambda cli faas lambda logging node serverless
Last synced: 3 months ago
JSON representation
A CLI tool to trace AWS Lambda calls over multiple CloudWatch log groups.
- Host: GitHub
- URL: https://github.com/seeebiii/lambdalogs
- Owner: seeebiii
- License: mit
- Created: 2017-06-19T14:16:20.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T16:57:16.000Z (over 2 years ago)
- Last Synced: 2025-06-06T04:08:39.858Z (4 months ago)
- Topics: aws, aws-cloudwatch, aws-lambda, cli, faas, lambda, logging, node, serverless
- Language: JavaScript
- Homepage:
- Size: 40 KB
- Stars: 21
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lambdalogs
A CLI tool to trace [AWS Lambda](https://aws.amazon.com/lambda/) calls over multiple
[CloudWatch log groups](http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogsConcepts.html).
The Lambda functions are identified by searching your CloudFormation stack. You can use the existing CloudWatch filter patterns and also
human-friendly time formats for filtering the log events.
## Requirements
* It assumes you have [setup your AWS CLI](http://docs.aws.amazon.com/cli/latest/userguide/installing.html) correctly.
* You need to provide a CloudFormation stack name. Based on the stack, the Lambda functions and related log groups can be found and searched.
## Install
### npm
```
npm install -g lambdalogs
```
### yarn
```
yarn global add lambdalogs
```
## Usage
```
lambdalogs
--stack stackName
--filter pattern
[--region awsRegion]
[--colorPattern pattern]
[--color color]
[--start timestamp]
[--end timestamp]
[--msgLength messageLength]
[--poll pollDelay]
```
### Options
* **--stack** a CloudFormation stack name which contains lambda functions
* **--filter** a [CloudWatch filter pattern](http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). If you need to place your filter pattern into double quotes because of non alphanumeric or underscore characters, you have to enclose them by single quotes. Like this: `'"SPECIAL-CHAR"'`.
* **--region** optional: you can set the AWS region for your CloudFormation stack and CloudWatch logs. By default the region configured in your AWS CLI is used. As a fallback 'us-east-1' is used.
* **--colorPattern** optional: for a colored output, you can set a regex pattern which tries to match your messages and colors the matched output. By default only the timestamp of the log event is colored (see `--color`).
* **--color** optional: for a colored output, you can set the color of the matched pattern (see `--colorPattern`). The color must be supported by [cli-color](https://www.npmjs.com/package/cli-color).
* **--start** optional: you can set the start time to begin with the search for log events. By default the last 15 minutes from now will be searched, so `start` is equal to `Date.now() - 15*60*1000`. See also `--end`.
* **--end** optional: you can set the end time to stop with the search for log events. By default the last 15 minutes from now will be searched, so `end` is equal to `Date.now()`. See also `--start`.
* **--msgLength** optional: you can set a maximum length for the message output. This means only the first X characters will be printed. `0` means all characters of a message are printed. By default this limit is set to `350`. This is useful to keep an overview if your logs contain lots of data.
* **--poll** optional: set milliseconds to actively poll for new log events, e.g. `--poll 2000` to poll every 2 seconds. Be aware of the
[CloudWatch Logs limits](http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch_limits_cwl.html) for this approach and don't set a too low value!
I suggest a value `> 2000`, because it also takes some time that the logs arrive in CloudWatch.
#### Time Options
You can use a human-friendly time format for `--start` and `--end` for querying the log events, for example `--start 1h` or `--start 1w`.
* Seconds: `--start 15s` or `--end 15s`
* Minutes: `--start 15m` or `--end 15m`
* Hours: `--start 15h` or `--end 15h`
* Days: `--start 15d` or `--end 15d`
* Weeks: `--start 15w` or `--end 15w`
Make sure that you don't set the `--end` time before `--start`. I.e. this is not possible: `--start 1h --end 1d`, but `--start 1d --end 1h` would be OK.
## Examples
#### Search for logs which contain a certain log level
```
lambdalogs --stack your_stack_name --filter ERROR
```
#### Search for logs within the last 30 minutes
```
lambdalogs --stack your_stack_name --filter INFO --start 30m
```
#### Search for logs using a color pattern for a date format YYYY-MM-DD
```
lambdalogs --stack your_stack_name --filter INFO --colorPattern "[0-9]{4}-[0-9]{2}-[0-9]{2}"
```
#### Search for logs using a red color for the output
```
lambdalogs --stack your_stack_name --filter INFO --color red
```
#### Poll for logs every 5 seconds
```
lambdalogs --stack your_stack_name --filter INFO --poll 5000
```
## Author
[Sebastian Hesse](https://www.sebastianhesse.de)
## License
MIT License
Copyright (c) 2017 [Sebastian Hesse](https://www.sebastianhesse.de)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.