honeycombio/honeyvent

CLI for sending individual events in to Honeycomb

honeyvent

STATUS: this project is being sunset. See #75

CLI for sending individual events in to Honeycomb

Installation

If you have a working go environment in your build, the easiest way to install honeyvent is via go get.

go get github.com/honeycombio/honeyvent/

If you're using go 1.17 or greater you should use go install instead, since go get is deprecated.

go install github.com/honeycombio/honeyvent@latest

Usage

Call with a collection of names and values to send an event from the command line:

honeyvent -k <writekey> -d <dataset> -n field -v val -n field -v val ...

If you are targeting a local instance of Honeycomb, use the api_host parameter, e.g: --api_host=http://localhost:8888

The tool will detect floats and ints and send them as numbers; everything else turns in to strings. Quote any values that have spaces.

honeyvent's Issues

api host should assume https if the protocol is absent

Invoking honeyvent with --api_host example.com yields an error unsupported protocol scheme ""]. Instead if the address passed to api_host is missing a protocol, HTTPS should be assumed.

Project is being sunset

See OSS lifecycle and practices

This project has outlived its useful lifespan, and will be archived in the future. If you are actively using it, please comment on this issue with your use case.

patch openSSL CVE

https://mta.openssl.org/pipermail/openssl-announce/2022-March/000219.html

• build artifacts: circleci/golang image is based on golang image which is based on alpine - waiting on the same update
  • use newer circle images cimg/go:1.18.1

Values of the string "NaN" get dropped from events

If you pass the string "NaN" as the value to a field, honeyvent will try to cast it to a float and succeed. The end result is that the field gets dropped when it shouldn't.

Using --help results in a error code != 0

honeyvent/main.go

Line 44 in d7a45bd

errAndExit("command line parsing error - call with --help for usage")

I use honeyvent --help in container builds to make sure the thing I just installed works. Well, I use it for everything else, but honeyvent says this is an error 1, and the container build fails. So I have no way to check if the binary I downloaded works or not.

Honeymarker got it right:

https://github.com/honeycombio/honeymarker/blob/main/main.go#L90-L94

I'ld do a PR, but I know zero Go :(

CLI does not print error on failure

Hi, I noticed that honeyvent will fail silently if the request failed. This is unexpected behaviour and can cause some confusing / frustration.

For example, the following command prints nothing and exits with 0.

$ honeyvent -k 123 -d test -n test -v 1

You have to set the verbose flag to see what is actually going on:

$ honeyvent -k 123 -d test -n test -v 1 -V
sending event &{123 test 1 https://api.honeycomb.io/ 2020-08-05 00:28:33.399661 +0200 CEST m=+0.001527713 <nil> {map[test:1] {{0 0} 0 0 0 0}} 0xc0000cc0f0 false {0 0}}
sent event map[body:{"error":"unknown API key - check your credentials"} duration:604.702ms error:<nil> status_code:401]

This example is pretty obvious, but in my case I was using an API key that did not have permission to send events. So it took a bit before I got what was going on...

Update to cimg/go image and go 1.16.x

GitHub Release v.1.1.1 only contains sources and linux-amd64 binary

So .. if version v1.1.1 intended to stop releasing binaries for darwin, linux-arm64 and linux-386, I certainly couldn't see it being mentioned in the changelog!

If this is intentional, of course please just close this :-)