CLI for managing markers in your honeycomb datasets
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Godeps
pkg-test
vendor/github.com/jessevdk/go-flags
.gitignore
.travis.yml
LICENSE
README.md
add.go
build-pkg.sh
list.go
main.go
marker.go
rm.go
update.go

README.md

honeymarker

honeymarker provides a simple CRUD interface for dealing with per-dataset https://honeycomb.io/docs/guides/best-practices/#use-markers on https://honeycomb.io/.

Installation

$ go get github.com/honeycombio/honeymarker
$ honeymarker    # (if $GOPATH/bin is in your path.)

;)

Usage

$ honeymarker -k <your-writekey> -d <dataset> COMMAND [command-specific flags]

  • <your-writekey> can be found on https://ui.honeycomb.io/account
  • <dataset> is the name of one of the datasets associated with the team whose writekey you're using.
  • COMMAND see below

Available commands:

Command Description
add add a new marker
list list all markers
rm delete a marker
update update a marker

Adding markers (add)

Name Flag Description Required
Start Time -s <arg> / --start_time=<arg> start time for the marker in unix time (seconds since the epoch) No
End Time -e <arg> / --end_time=<arg> end time for the marker in unix time (seconds since the epoch) No
Message -m <arg> / --msg=<arg> message describing this specific marker No
URL -u <arg> / --url=<arg> URL associated with this marker No
Type -t <arg> / --type=<arg> identifies marker type No

All parameters to add are optional.

If start_time is missing, the marker will be assigned the current time.

It is highly recommended that you fill in either message or type. All markers of the same type will be shown with the same color in the UI. The message will be visible above an individual marker.

If a URL is specified along with a message, the message will be shown as a link in the UI, and clicking it will take you to the URL.

Example:

$ ./honeymarker -k $WRITE_KEY -d myservice add -t deploy -m "build 192837"
{"created_at":"2017-06-28T18:55:11Z","updated_at":"2017-06-28T18:55:11Z","start_time":1498676111,"message":"build 192837","type":"deploy","id":"n71R3zM1Tn3"}

$

Listing markers (list)

Name Flag Description Required
JSON --json Output the list as json instead of in tabular form No
Unix Timestamps --unix_time In table mode, format times as unit timestamps (seconds since the epoch) No

Example:

$ ./honeymarker -k $WRITE_KEY -d myservice list
| ID          |      Start Time |        End Time | Type         | Message      | URL |
+-------------+-----------------+-----------------+--------------+--------------+-----+
| n71R3zM1Tn3 | Jun 28 11:55:11 |                 | deploy       | build 192837 |     |

$

Updating markers (update)

Name Flag Description Required
Marker ID -i <arg> / --id=<arg> ID of the marker to update Yes
Start Time -s <arg> / --start_time=<arg> start time for the marker in unix time (seconds since the epoch) No
End Time -e <arg> / --end_time=<arg> end time for the marker in unix time (seconds since the epoch) No
Message -m <arg> / --msg=<arg> message describing this specific marker No
URL -u <arg> / --url=<arg> URL associated with this marker No
Type -t <arg> / --type=<arg> identifies marker type No

The marker ID is available from the list command, and is also output to the console by the add command.

Example:

$ ./honeymarker -k $WRITE_KEY -d myservice update -i n71R3zM1Tn3 -u "http://my.service.co/builds/192837"
{"created_at":"2017-06-28T18:55:11Z","updated_at":"2017-06-28T18:55:11Z","start_time":1498676111,"message":"build 192837","type":"deploy","url":"http://my.service.co/builds/192837","id":"n71R3zM1Tn3"}

$

Deleting markers (rm)

Name Flag Description Required
Marker ID -i <arg> / --id=<arg> ID of the marker to delete Yes

The marker ID is available from the list command, and is also output to the console by the add command.

Example:

$ ./honeymarker -k $WRITE_KEY -d myservice rm -i n71R3zM1Tn3
{"created_at":"2017-06-28T18:55:11Z","updated_at":"2017-06-28T18:57:47Z","start_time":1498676111,"message":"build 192837","type":"deploy","url":"http://my.service.co/builds/192837","id":"n71R3zM1Tn3"}

$ ./honeymarker -k $WRITE_KEY -d myservice list
| ID          |      Start Time |        End Time | Type         | Message | URL |
+-------------+-----------------+-----------------+--------------+---------+-----+
$