Skip to main content
Learn how to use Honeytail to send JSON logs directly to Honeycomb.

​
Data Expectations

Honeycomb expects data with a flat structure. By default, any structure deeper than top level keys will be serialized and a string representation of the content will be used in the field. However, Honeycomb can automatically unpack nested JSON objects and flatten them into unique columns. This is a per-dataset setting, and it is off by default. You must be a team owner to change this setting. If you enable this setting, nested objects will be flattened with new fields and field names created based on the keys. For example, {"outer": {"inner": 42}} would become a field outer.inner with a value of 42. To tell Honeycomb to automatically unpack JSON objects:
  1. In the left navigation menu, select Manage Data.
  2. In the list, locate and select Datasets and select the dataset you want to configure.
  3. Select the Schema view.
  4. Enable the Automatically unpack non-OpenTelemetry nested JSON toggle.
  5. Select your preferred Maximum unpacking depth for your data.
Changes to this setting take effect within 60 seconds.
If your objects are deeply-nested, unpacking may result in a very large number of columns in Honeycomb. Consider unpacking only to the level of columns you will find useful. Any objects nested more deeply than the depth you select here will be converted to strings under the last unpacked column. In particular, if nested structures in your data can be created/added by your users (for example, HTTP headers), consider not unpacking them to that level.

​
Installation

Download and install the latest honeytail by running:
Download the honeytail_1.10.0_amd64.deb package.
wget -q https://honeycomb.io/download/honeytail/v1.10.0/honeytail_1.10.0_amd64.deb
Verify the package.
echo '3db441215f97eaed068aa0531c986cf5405957e3e8e26b22c16b571091caf917  honeytail_1.10.0_amd64.deb' | sha256sum -c
Install the package.
sudo dpkg -i honeytail_1.10.0_amd64.deb
The packages install honeytail, its config file /etc/honeytail/honeytail.conf, and some start scripts. Build honeytail from source if you need it in an unpackaged form or for ad-hoc use.
You should modify the config file and uncomment and set:
  • ParserName to json
  • WriteKey to your API key, available from the account page
  • LogFiles to the path for the log file you want to ingest, or - for stdin
  • Dataset to the name of the dataset you wish to create with this log file.

​
Launch the Agent

Start up a honeytail process using upstart or systemd or by launching the process by hand. This will tail the log file specified in the config and leave the process running as a daemon. 
sudo initctl start honeytail

​
Backfilling Archived Logs

To backfill existing data, run honeytail with --backfill the first time: 
honeytail -c /etc/honeytail/honeytail.conf \
  --file /var/log/myapp/log12.json \
  --backfill
This command can also be used at any point to backfill from older, rotated log files. You can read more about our backfill behavior here.
If you have chosen to backfill from old JSON logs, do not forget to transition into the default streaming behavior to stream live logs to Honeycomb!

​
Timestamp Parsing

Honeycomb expects all events to contain a timestamp field; if one is not provided, the server will associate the current time of ingest with the given payload. By default, we look for a few candidate fields based on name ("timestamp", "time") and handle the following time formats:
  • RFC3339 (2006-01-02T15:04:05Z07:00)
  • RFC3339 with nanoseconds (2006-01-02T15:04:05.999999999Z07:00)
  • Unix string representation (Mon Jan 2 15:04:05 MST 2006)
  • Ruby string representation (Mon Jan 02 15:04:05 -0700 2006)
  • Golang string representation (2006-01-02 15:04:05.999999999 -0700 MST)
If your timestamps are not correctly handled by the above formats, use the --json.timefield and --json.format flags to help honeytail understand where and how to extract the event’s timestamp. For example, given a JSON log file with events like the following: 
{"color":"orange","size":3,"server_time":"Aug 12 2016, 15:12:06 -0800"}
{"color":"blue","server_time":"Sep 01 2016, 06:10:32 -0800","size":4}
The command to consume those log lines (while retaining the "server_time" field as the event’s timestamp) would look something like: 
honeytail --writekey=YOUR_API_KEY --dataset="API Server Logs" --parser=json \
  --file=/var/log/api_server.log \
  --json.timefield="server_time" --json.format="%b %d %Y, %k:%M:%S %z"
The --json.timefield="server_time" argument tells honeytail to consider the "server_time" value to be the canonical timestamp for the events in the specified file. The --json.format argument specifies the timestamp format to be used while parsing. (It understands common strftime formats.) Ultimately, the above command would would produce events with the fields (note the times below are represented in UTC; Honeycomb parses time zone information if provided).