Skip to content
 
 

Latest commit

 

History

124 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Log Cache CLI

GoDoc travis slack.cloudfoundry.org

The Log Cache CLI can be installed and used in two ways.

  • Standalone CLI for Log Cache
  • Cloud Foundry CLI plugin for Log Cache

Cloud Foundry CLI plugin

The Log Cache CLI Plugin is a CF CLI plugin for the Log Cache system.

Plugin Demo

Installing Plugin

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

Usage

$ cf tail --help
NAME:
   tail - Output logs for a source-id/app

USAGE:
   tail [options] <source-id/app>

ENVIRONMENT VARIABLES:
   LOG_CACHE_ADDR       Overrides the default location of log-cache.
   LOG_CACHE_SKIP_AUTH  Set to 'true' to disable CF authentication.

OPTIONS:
   --follow, -f                 Output appended to stdout as logs are egressed.
   --gauge-name                 Gauge name filter (implies --envelope-type=gauge).
   --json                       Output envelopes in JSON format.
   --lines, -n                  Number of envelopes to return. Default is 10.
   --start-time                 Start of query range in UNIX nanoseconds.
   --counter-name               Counter name filter (implies --envelope-type=counter).
   --end-time                   End of query range in UNIX nanoseconds.
   --envelope-type, -type       Envelope type filter. Available filters: 'log', 'counter', 'gauge', 'timer', and 'event'.
$ cf log-meta --help
NAME:
   log-meta - Show all available meta information

USAGE:
   log-meta [options]

ENVIRONMENT VARIABLES:
   LOG_CACHE_ADDR       Overrides the default location of log-cache.
   LOG_CACHE_SKIP_AUTH  Set to 'true' to disable CF authentication.

OPTIONS:
   --guid              Display raw source GUIDs
   --noise             Fetch and display the rate of envelopes per minute for the last minute. WARNING: This is slow...
   --sort-by           Sort by specified column. Available: 'source-id', 'source', 'source-type', 'count', 'expired', 'cache-duration', and 'rate'.
   --source-type       Source type of information to show. Available: 'all', 'application', and 'platform'.

Stand alone CLI

Installing CLI

Run our install script:

curl -sS https://raw.githubusercontent.com/cloudfoundry/log-cache-cli/develop/scripts/install.sh | bash

Usage

  1. Target the Log Cache by setting the environment variable LOG_CACHE_ADDR.
  2. Simply run the log-cache command to view current metrics stored in Log Cache.
  3. Help can be accessed with the --help flag at any command level.
$ log-cache tail --help
Output logs and metrics for a given source-id

Usage:
  log-cache tail <source-id> [flags]

Flags:
  -f, --follow   Output appended to stdout as logs are egressed.
  -h, --help     help for tail

About

Better interactions with Cloudfoundry's Log Cache

Topics

Resources

Security policy

Stars

18 stars

Watchers

23 watching

Forks

Releases

Packages

Used by

Contributors

Languages