globocom / prettylog Goto Github PK

View Code? Open in Web Editor NEW

64.0 14.0 25.0 9.74 MB

Logs for human beings

License: MIT License

Makefile 1.60% Go 94.22% Shell 4.19%

golang logs command-line-tool json go

prettylog's Introduction

Prettylog

Command line tool that displays JSON logs in a human-friendly format.

Installation

Go 1.17+:

go install github.com/globocom/prettylog@latest

Go 1.16 or older:

curl https://github.com/globocom/prettylog/raw/master/install.sh | sh

Prettylog will be installed to $GOPATH/bin. Make sure to add it to your PATH so you can run prettylog anywhere.

How it works

Prettylog parses log messages that contain an arbitrary number of fields and generates a nice output in the following format:

<TIMESTAMP> <LOGGER> <CALLER> <LEVEL> <MESSAGE> <FIELD1>=<VALUE> <FIELD2>=<VALUE> ...

Non-existent fields will be ignored and messages not encoded as JSON will be printed as is.

Usage

Simply pipe the stdout of an application that outputs structured log messages into prettylog:

app | prettylog

You might need to redirect stderr to stdout if the application doesn't log to the standard output:

app 2>&1 | prettylog

Configuration

You can configure how Prettylog works by creating a .prettylog.yml file either locally (per directory) or globally (in $HOME):

timestamp:
  key:     <string>
  visible: <bool>
  color:   <list of int>
  format:  <string>

logger:
  key:     <string>
  visible: <bool>
  padding: <int>
  color:   <list of int>

caller:
  key:     <string>
  visible: <bool>
  padding: <int>
  color:   <list of int>

level:
  key:     <string>
  visible: <bool>
  padding: <int>
  colors:
    debug: <list of int>
    info:  <list of int>
    warn:  <list of int>
    error: <list of int>
    fatal: <list of int>

message:
  key:     <string>
  padding: <int>
  color:   <list of int>

Each field has its own key and the following properties are available:

Name	Description
key	Field name.
visible	Flag indicating whether the field will be printed.
padding	Number of whitespaces that will be added to the right of the field.
color/colors	Color attributes. Up to 3 values can be used (fg, bg and effects). More information here.
format	(timestamp field only) Layout that will be used to print timestamp values. It must follow the rules of the time package.

Using with other tools

Prettylog can be used along with other command line tools. Just make sure no buffer is enabled. For instance, grep has a --line-buffered flag:

app | grep --line-buffered -v debug | prettylog

If the tool you want to use buffers its output and does not offer such a flag, you can try stdbuff.

prettylog's People

Contributors

Stargazers

Watchers

prettylog's Issues

Fix "LOW" vulnerabilities found via huskyCI

Hey! I have just ran huskyCI and a few low vulnerabilities were found in prettylog. All of them are related to Errors unhandled:

[HUSKYCI][!] Language: Go
[HUSKYCI][!] Tool: GoSec
[HUSKYCI][!] Severity: LOW
[HUSKYCI][!] Confidence: HIGH
[HUSKYCI][!] Details: Errors unhandled.
[HUSKYCI][!] File: /go/src/code/main.go
[HUSKYCI][!] Line: 54
[HUSKYCI][!] Code: app.Run(os.Args)

[HUSKYCI][!] Language: Go
[HUSKYCI][!] Tool: GoSec
[HUSKYCI][!] Severity: LOW
[HUSKYCI][!] Confidence: HIGH
[HUSKYCI][!] Details: Errors unhandled.
[HUSKYCI][!] File: /go/src/code/main.go
[HUSKYCI][!] Line: 59
[HUSKYCI][!] Code: cli.ShowAppHelp(ctx)

[HUSKYCI][!] Language: Go
[HUSKYCI][!] Tool: GoSec
[HUSKYCI][!] Severity: LOW
[HUSKYCI][!] Confidence: HIGH
[HUSKYCI][!] Details: Errors unhandled.
[HUSKYCI][!] File: /go/src/code/prettifiers/default.go
[HUSKYCI][!] Line: 54
[HUSKYCI][!] Code: buffer.WriteString(value)

[HUSKYCI][!] Language: Go
[HUSKYCI][!] Tool: GoSec
[HUSKYCI][!] Severity: LOW
[HUSKYCI][!] Confidence: HIGH
[HUSKYCI][!] Details: Errors unhandled.
[HUSKYCI][!] File: /go/src/code/prettifiers/default.go
[HUSKYCI][!] Line: 55
[HUSKYCI][!] Code: buffer.WriteString(SEPARATOR)

[HUSKYCI][!] Language: Go
[HUSKYCI][!] Tool: GoSec
[HUSKYCI][!] Severity: LOW
[HUSKYCI][!] Confidence: HIGH
[HUSKYCI][!] Details: Errors unhandled.
[HUSKYCI][!] File: /go/src/code/prettifiers/default.go
[HUSKYCI][!] Line: 63
[HUSKYCI][!] Code: buffer.WriteString(color.Sprint(field[0]))

[HUSKYCI][!] Language: Go
[HUSKYCI][!] Tool: GoSec
[HUSKYCI][!] Severity: LOW
[HUSKYCI][!] Confidence: HIGH
[HUSKYCI][!] Details: Errors unhandled.
[HUSKYCI][!] File: /go/src/code/prettifiers/default.go
[HUSKYCI][!] Line: 65
[HUSKYCI][!] Code: buffer.WriteString(field[0])

[HUSKYCI][!] Language: Go
[HUSKYCI][!] Tool: GoSec
[HUSKYCI][!] Severity: LOW
[HUSKYCI][!] Confidence: HIGH
[HUSKYCI][!] Details: Errors unhandled.
[HUSKYCI][!] File: /go/src/code/prettifiers/default.go
[HUSKYCI][!] Line: 67
[HUSKYCI][!] Code: buffer.WriteString(FIELD_SEPARATOR)

[HUSKYCI][!] Language: Go
[HUSKYCI][!] Tool: GoSec
[HUSKYCI][!] Severity: LOW
[HUSKYCI][!] Confidence: HIGH
[HUSKYCI][!] Details: Errors unhandled.
[HUSKYCI][!] File: /go/src/code/prettifiers/default.go
[HUSKYCI][!] Line: 68
[HUSKYCI][!] Code: buffer.WriteString(field[1])

[HUSKYCI][!] Language: Go
[HUSKYCI][!] Tool: GoSec
[HUSKYCI][!] Severity: LOW
[HUSKYCI][!] Confidence: HIGH
[HUSKYCI][!] Details: Errors unhandled.
[HUSKYCI][!] File: /go/src/code/prettifiers/default.go
[HUSKYCI][!] Line: 69
[HUSKYCI][!] Code: buffer.WriteString(SEPARATOR)

[HUSKYCI][SUMMARY] Go -> huskyci/gosec:2.0.0
[HUSKYCI][SUMMARY] High: 0
[HUSKYCI][SUMMARY] Medium: 0
[HUSKYCI][SUMMARY] Low: 9

[HUSKYCI][SUMMARY] Total
[HUSKYCI][SUMMARY] High: 0
[HUSKYCI][SUMMARY] Medium: 0
[HUSKYCI][SUMMARY] Low: 9
[HUSKYCI][SUMMARY] NoSecHusky: 0

[HUSKYCI][*] Some LOW/INFO issues were found :|

Do you think it would be a good idea to consider them? Just let me know if you would like to receive a PR fixing these issues! 🙃

Switch between the different README translations

Would it be okay if we could, in the README file, have some way to switch between the different translations?

If this is a good idea, could you assign me to this task?

Add custom format support to the timestamp field

The timestamp field is currently output as is. It would be nice if a custom format could be used.

Surround fields containing spaces with quotes

Field values containing spaces should be surrounded with quotes so it's clear they are one single unit. For instance:

field1=one field2=one two three

should render as

field1=one field2="one two three"