github.com/honeycombio/honeytail@v1.9.0/README.md (about) 1 # honeytail 2 3 [![OSS Lifecycle](https://img.shields.io/osslifecycle/honeycombio/honeytail?color=success)](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md) 4 [![CircleCI](https://circleci.com/gh/honeycombio/honeytail.svg?style=shield)](https://circleci.com/gh/honeycombio/honeytail) 5 6 `honeytail` is [Honeycomb](https://honeycomb.io)'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. 7 8 See [our documentation](https://honeycomb.io/docs/send-data/agent/) to read about how to configure and run `honeytail`, to find tips and best practices, and to download prebuilt versions. 9 10 ## Supported Parsers 11 12 `honeytail` supports reading files from `STDIN` as well as from a file on disk. 13 14 Our complete list of parsers can be found in the [`parsers/` directory](parsers/), but as of this writing, `honeytail` will support parsing logs generated by: 15 16 - [ArangoDB](parsers/arangodb/) 17 - [MongoDB](parsers/mongodb/) 18 - [MySQL](parsers/mysql/) 19 - [PostgreSQL](parsers/postgresql/) (Note: does not support quoted table or column names in queries.) 20 - [nginx](parsers/nginx/) 21 - [regex](parsers/regex/) 22 - [keyval](parsers/keyval/)([logfmt](https://brandur.org/logfmt)) 23 - [csv](parsers/csv/) 24 - [syslog](parsers/syslog/) 25 26 ## Installation 27 28 Install from source: 29 30 ``` 31 go install github.com/honeycombio/honeytail@latest 32 ``` 33 34 to install to a specific path: 35 36 ``` 37 GOPATH=/usr/local go install github.com/honeycombio/honeytail@latest 38 ``` 39 40 the binary will install to `/usr/local/bin/honeytail` 41 42 Use a prebuilt binary: find the latest version on [Honeycomb.io](https://honeycomb.io/docs/send-data/agent/) 43 44 ## Usage 45 46 Using command line arguments: 47 48 ```shell 49 honeytail --writekey=YOUR_WRITE_KEY --dataset='Best Data Ever' --parser=json --file=/var/log/api_server.log 50 ``` 51 52 Using a config file: 53 54 ```shell 55 honeytail --config honeytail-conf.ini 56 ``` 57 58 For more advanced usage, options, and the ability to scrub or drop specific fields, see [our documentation](https://honeycomb.io/docs/send-data/agent). 59 60 ## Related Work 61 62 We've extracted out some generic work for a particular log format: 63 64 - [mysqltools](https://github.com/honeycombio/mysqltools) contains logic specific to normalizing MySQL queries 65 66 ## Contributions 67 68 Features, bug fixes and other changes to honeytail are gladly accepted. Please 69 open issues or a pull request with your change. Remember to add your name to the 70 CONTRIBUTORS file! 71 72 All contributions will be released under the Apache License 2.0.