honeycombio/honeytail

Name: honeytail

Owner: Honeycomb

Description: Honeycomb's open-source agent. Contains various parsers for extracting structured data out of common log files.

Created: 2016-08-09 17:27:50.0

Updated: 2018-05-24 12:07:03.0

Pushed: 2018-05-10 20:35:50.0

Homepage: https://honeycomb.io/docs/send-data/agent/

Size: 1228

Language: Go

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

honeytail Build Status

honeytail is Honeycomb's agent for ingesting log file data into Honeycomb and making it available for exploration. Its favorite format is JSON, but understands how to parse a range of other well-known log formats.

See our documentation to read about how to configure and run honeytail, to find tips and best practices, and to download prebuilt versions.

Supported Parsers

honeytail supports reading files from STDIN as well as from a file on disk.

Our complete list of parsers can be found in the parsers/ directory, but as of this writing, honeytail will support parsing logs generated by:

Installation

Install from source:

et github.com/honeycombio/honeytail

to install to a specific path:

TH=/usr/local go get github.com/honeycombio/honeytail

the binary will install to /usr/local/bin/honeytail

Use a prebuilt binary: find the latest version on Honeycomb.io

Usage
ytail --writekey=YOUR_WRITE_KEY --dataset='Best Data Ever' --parser=json --file=/var/log/api_server.log

For more advanced usage, options, and the ability to scrub or drop specific fields, see our documentation.

Related Work

In some cases, we've extracted out some generic work for a particular log format

Contributions

Features, bug fixes and other changes to honeytail are gladly accepted. Please open issues or a pull request with your change. Remember to add your name to the CONTRIBUTORS file!

All contributions will be released under the Apache License 2.0.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.