gg

README

gg

A simple JSON logs parser for Kubernetes Operators designed for effective debugging.

Usage

A simple JSON logs parser for Kubernetes Operators designed for effective debugging.

Usage:
  gg [flags]
  gg [command]

Examples:
    The following examples make use of a basic.json file which contains JSON
    logs where each log line is a single JSON object. You can find the
    basic.json file in ./cmd/fixture/ along with other test fixtures used for
    golden file tests. Further note that you can configure flag defaults via a
    config file.

        ~/.config/gg/config.yaml

    Config file defaults are supported for the following flags.

        -c/--colour
        -g/--group
        -t/--time

    Select all logs where any key matches "obj" and its associated value matches
    "qihx8". This can be used to e.g. grep for all logs related to Tenant
    Cluster "qihx8".

        cat basic.json | gg -s obj:qihx8

    Select all logs like the example above but on top of that filter also for
    logs where any key matches "res" and its associated value matches "dra".
    This can be used to e.g. grep for all logs of the "drainer" and
    "drainfinisher" resource implementation.

        cat basic.json | gg -s obj:qihx8 -s res:dra

    Select all logs like the example above but on top of that only output
    key-value pairs of the logs where any key matches "ti" or "mes". This can be
    used to e.g. show only "time" and "message". Note that the order of fields
    given determines the output order. Here "ti,mes" makes it way easier to read
    the output since "time" is always consistently formatted, whereas "message"
    can be of almost arbitrary length.

        cat basic.json | gg -s obj:qihx8 -s res:dra -f tim,mes

    Select all logs like the example above but on top of that group output
    key-value pairs of the logs based on the common value of associated keys
    matching "lo". This can be used to e.g. group resource logs by their
    reconciliation "loop".

        cat basic.json | gg -s obj:qihx8 -s res:dra -f tim,mes -g loo

    Select all error logs and display their caller and stack.

        cat basic.json | gg -s lev:err -f cal,sta

    Select all logs of two different resource handlers. This is to show the
    s3object and tccpn resource handler logs together.

        cat basic.json | gg -s obj:8ztu4 -s con:plane -s res:s3obj -s res:tccpn\$ -f res,mes -g loo

    Display log messages of drainer resources and format their timestamp using
    to the given format.

        cat basic.json | gg -s obj:qihx8 -s res:dra -f res,mes,tim -t 15:04:05

Available Commands:
  help        Help about any command
  version     Print version information.

Flags:
  -c, --colour           Whether to colourize printed output or not.
  -f, --field strings    Fields the output lines should contain only.
  -g, --group string     Group logs by inserting an empty line after the group end.
  -h, --help             help for gg
  -s, --select strings   Select lines based on the given key:val regular expression.
  -t, --time string      Time format used to print timestamps.

Use "gg [command] --help" for more information about a command.