Skip to content
The best way to tail AWS CloudWatch Logs from your terminal
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci add CircleCI Mar 10, 2019
.github/ISSUE_TEMPLATE
cloudwatch event cache refactoring Feb 13, 2019
.gitignore
.goreleaser.yml
Gopkg.lock lock aws-sdk-go to specific version Jul 2, 2018
Gopkg.toml
LICENSE
README.md
_config.yml
coordinator.go refactor coordinator out in a seperate file Feb 1, 2019
go.mod Add explicit cleanup fo trigger channels on shutdown Jan 13, 2019
go.sum Add explicit cleanup fo trigger channels on shutdown Jan 13, 2019
main.go v3.2.0 prep Mar 10, 2019
main_test.go Support day format in human-friendly time formats Mar 10, 2019
snapcraft.yaml
versioncheck.go event cache refactoring Feb 13, 2019

README.md

cw

Release Software License Github All Releases CircleCI branch

The best way to tail AWS CloudWatch Logs from your terminal.

Author - Luca Grulla - https://www.lucagrulla.com

Features

  • No external dependencies (no pip, npm, rubygems) and easy installation.
    • cw is a native executable targeting your OS.
  • Fast. cw is written in golang and compiled against your architecture.
  • Flexible date and time parser.
    • You can work with either Local timezone or UTC (default).
    • Flexible parsing.
      • Human friendly formats, i.e. 2d1h20m to indicate 2 days, 1 hour and 20 minutes ago.
      • a specific hour, i.e. 13:10 to indicate 13:10 of today.
      • a full timestamp 2018-10-20T8:53.
  • multi log groups tailing tail multiple log groups in parallel: cw tail tail my-auth-service my-web.
  • Powerful built-in grep (--grep) and grepv (--grepv).
  • Pipe operator supported: echo my-group | cw tail and cat groups.txt | cw tail.
  • Redirection operator supported: cw tail -f my-stream >> myfile.txt.
  • Coloured output (--no-color flag to disable if needed).
  • Flexibile credentials control.
    • By default it uses the AWS .aws/credentials and .aws/profile files. Overrides can be done with the --profile and --region flags.

Installation

On Mac OSX using Homebrew

brew tap lucagrulla/tap
brew install cw

On Windows using Scoop.sh

scoop bucket add cw https://github.com/lucagrulla/cw-scoop-bucket.git
scoop install cw

On Linux using Snapcraft.io

snap install cw-sh
sudo snap alias cw-sh cw

Get it from the Snap Store

Using Go tools

go get github.com/lucagrulla/cw

Commands and options

Global flags

  • -p, --profile=profile-name Override the AWS profile used for connection
  • -r, --region=aws-region Override the target AWS region
  • -c, --no-color Disable coloured output

Commands

  • cw ls list all the log groups/log streams within a group
    usage: cw ls <command> [<args> ...]
    
    Show an entity
    
    Flags:
        --help             Show context-sensitive help (also try --help-long and --help-man).
    -p, --profile=PROFILE  The target AWS profile. By default cw will use the default profile defined in the .aws/credentials file.
    -r, --region=REGION    The target AWS region.. By default cw will use the default region defined in the .aws/credentials file.
    -c, --no-color         Disable coloured output.
        --version          Show application version.
    
    Subcommands:
    ls groups
        Show all groups.
    
    ls streams <group>
        Show all streams in a given log group.
  • cw tail tail a given log group/log stream
        usage: cw tail [<flags>] <groupName:logStreamPrefix...>...
    
        Tail log groups/streams.
    
        Flags:
            --help             Show context-sensitive help (also try --help-long and --help-man).
        -p, --profile=PROFILE  The target AWS profile. By default cw will use the default profile defined in the .aws/credentials file.
        -r, --region=REGION    The target AWS region. By default cw will use the default region defined in the .aws/credentials file.
        -c, --no-color         Disable coloured output.
            --version          Show application version.
        -f, --follow           Don't stop when the end of streams is reached, but rather wait for additional data to be appended.
        -t, --timestamp        Print the event timestamp.
        -i, --event-id         Print the event Id.
        -s, --stream-name      Print the log stream name this event belongs to.
        -n, --group-name       Print the log log group name this event belongs to.
        -b, --start="2018-12-25T09:34:45"
                               The UTC start time. Passed as either date/time or human-friendly format. The human-friendly format accepts the number of days, hours and minutes prior to the present. Denote days with
                               'd', hours with 'h' and minutes with 'm' i.e. 80m, 4h30m, 2d4h. If just time is used (format: hh[:mm]) it is expanded to today at the given time. Full available date/time format:
                               2017-02-27[T09[:00[:00]].
        -e, --end=""           The UTC end time. Passed as either date/time or human-friendly format. The human-friendly format accepts the number of days, hours and minutes prior to the present. Denote days with
                               'd', hours with 'h' and minutes with 'm' i.e. 80m, 4h30m, 2d4h. If just time is used (format: hh[:mm]) it is expanded to today at the given time. Full available date/time format:
                               2017-02-27[T09[:00[:00]].
        -l, --local            Treat date and time in Local timezone.
        -g, --grep=""          Pattern to filter logs by. See http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html for syntax.
        -v, --grepv=""         Equivalent of grep --invert-match. Invert match pattern to filter logs by.
    
        Args:
        <groupName:logStreamPrefix...>
            The log group and stream name, with group:prefix syntax.Stream name can be just the prefix. If no stream name is specified all stream names in the given group will be tailed.Multiple group/stream
            tuple can be passed. e.g. cw tail group1:prefix group2:prefix group3:prefix.     

Examples

  • list of the available log groups
    • cw ls groups
  • list of the log streams in a given log group
    • cw ls streams my-log-group
  • tail and follow given log groups/streams
    • cw tail -f my-log-group
    • cw tail -f my-log-group:my-log-stream-prefix
    • cw tail -f my-log-group:my-log-stream-prefix my-log-group2
    • cw tail -f my-log-group:my-log-stream-prefix -b2017-01-01T08:10:10 -e2017-01-01T08:05:00
    • cw tail -f my-log-group:my-log-stream-prefix -b7d to start from 7 days ago.
    • cw tail -f my-log-group:my-log-stream-prefix -b3h to start from 3 hours ago.
    • cw tail -f my-log-group:my-log-stream-prefix -b100m to start from 100 minutes ago.
    • cw tail -f my-log-group:my-log-stream-prefix -b2h30m to start from 2 hours and 30 minutes ago.
    • cw tail -f my-log-group -b9:00 -e9:01

Time and Dates

Time and dates are treated as UTC by default. If you prefer to use Local zone just set the --local flag.

AWS credentials and configuration

cw uses the default credentials profile (stored in ./aws/credentials) for authentication and shared config (.aws/config) for identifying the target AWS region. Both profile and region are overridable with the profile and region global flags.

Breaking changes notes

Read here

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.