https://github.com/rs/golp

Go panic logger
https://github.com/rs/golp

Last synced: about 1 year ago
JSON representation

Go panic logger

• Host: GitHub
• URL: https://github.com/rs/golp
• Owner: rs
• License: mit
• Created: 2017-01-08T11:46:35.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-12-17T20:46:16.000Z (over 7 years ago)
• Last Synced: 2025-03-28T21:12:27.781Z (about 1 year ago)
• Language: Go
• Size: 40 KB
• Stars: 26
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Go Log Panic

[![godoc](http://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/rs/golp) [![license](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/rs/golp/master/LICENSE) [![Build Status](https://travis-ci.org/rs/golp.svg?branch=master)](https://travis-ci.org/rs/golp) [![Coverage](http://gocover.io/_badge/github.com/rs/golp)](http://gocover.io/github.com/rs/golp)

Go programs sometime generate output you can't easily control like panics and `net/http` recovered panics. By default, those output contains multiple lines with stack traces. This does not play well with most logging systems that will generate one log event per outputed line.

The `golp` is a simple program that reads those kinds of log on its standard input, and merge all lines of a given panic or standard multi-lines Go log message into a single quoted line.

## Usage

Options:

    -allow-json

        Allow JSON input not to be escaped. When enabled, max-len is not efforced on JSON lines.

    -ctx value

        A key=value to add to the JSON output (can be repeated).

    -json

        Wrap messages to one JSON object per line.

    -json-key string

        The key name to use for the message in JSON mode. (default "message")

    -max-len int

        Strip messages to not exceed this length.

    -output string

        A file to append events to. Default output is stdout.

    -prefix string

        Go logger prefix set in the application if any.

    -strip

        Strip log line timestamps on output.

Send panics and other program panics to syslog:

    mygoprogram 2>&1 | golp | logger -t mygoprogram -p local7.err

    > Jan  8 16:59:26 host mygoprogram: panic: panic: test\n\ngoroutine 1 [running]:\npanic(0x…

Send panics as JSON:

    mygoprogram 2>&1 | golp --json | logger -t mygoprogram -p local7.err

    > Jan  8 16:59:26 host mygoprogram: {"message":"panic: panic: test\n\ngoroutine 1 [running]:\npanic(0x…

Add context:

    mygoprogram 2>&1 | golp --json --ctx level=error --ctx program=mygoprogram

    > {"level":"error","program":"mygoprogram","message":"panic: panic: test\n\ngoroutine 1 [running]:\npanic(0x…

## License

All source code is licensed under the [MIT License](https://raw.github.com/rs/golp/master/LICENSE).