isabella232 / log-stream-cli

Cloud Foundry CLI plugin to consume logs and metrics from the RLP

Log Stream CLI Plugin

The Log Stream CLI Plugin is a CF CLI plugin to retrieve logs from a Loggregator V2 stream

Installing Plugin

From CF-Community

cf install-plugin -r CF-Community "log-stream"

From Binary Release

1. Download the binary for the latest release for your platform.
2. Install it into the cf cli:

cf install-plugin download/path/log-stream-cli

From Source Code

Make sure to have the latest Go toolchain installed.

go get code.cloudfoundry.org/log-stream-cli/cmd/log-stream-cli
cf install-plugin $GOPATH/bin/log-stream-cli

Usage

Log Stream

$ cf log-stream --help
NAME:
   log-stream - Stream all messages of all types from Loggregator

USAGE:
   log-stream <source-id> [<source-id>] [options]

OPTIONS:
   --shard-id       Distribute logs between multiple consumers
   --type, -t       Filter the streamed logs. Available: 'log','event','counter','gauge','timer'. Allows multiple.

The source-id can either be the application name, the application guid or the name of the component (e.g. doppler, uaa, gorouter...). You can provide as many source-ids as you want. If you are a platform admin (you have the the logs.admin scope from UAA), then you can also omit the source-id and you see all messages available in the RLP.