A service to make it easier to create Honeycomb spans in some restricted environments. Similar to buildevents but a simple RESTful server. This is useful when you can't execute a binary but need a way to open and close OpenTelemetry compatible spans. Low-code testing tools are a good use case.
testevents wraps the Honeycomb Create Events API with an in-memory store, keyed on trace_id and span_id. When you open a span you provide a TTL. If you don't close it in time, say your script crashed, it will "close" the span with an error stating that the TTL ran out.
testevents uses the OpenTelemetry library to create the trace_id and span_id ensuring downstream compatibility. A traceparent is returned from POST operations that can be used in subsequent http calls for distributed tracing.
Spans are "closed" with a DELETE to /{trace_id}/{span_id}/ - this creates the Honeycomb event with a calculated duration_ms from the "open" call.
PATCH to /{trace_id}/{span_id}/ can be used to merge a set of key-values into the "open" span. Existing keys will have their values overwritten. You can change the ttl to extend or shorten the time to expiry. e.g. patching 10000 to a span that has been running for 34125ms will set the ttl to 44125.
Follow the instructions on the release page. There are installers of pre-built binaries for popular OSes.
If you really want to build from source and not use a pre-built binary release then firstly you'll need a Rust installation to compile it:
git clone https://github.com/jerbly/testevents.git
cd testevents
cargo build --releaseYou must provide HONEYCOMB_API_KEY. This api key must have access to create datasets. An ingest key is ideal.
Provide TESTEVENTS_PORT to bind to an alternative from the default 3003.
Make a root span:
curl -i -X POST \
'http://127.0.0.1:3003/' \
-H 'Content-Type: application/json' \
-d '{"service.name":"jerbly-test",
"name":"test",
"hello":"world",
"ttl":600000}'
HTTP/1.1 200 OK
content-type: application/json
content-length: 148
date: Thu, 11 Jul 2024 11:05:55 GMT
{"span_id":"5370f70191c4b03c","trace_id":"4c278c122e123f87036b44772861b9f4","traceparent":"00-4c278c122e123f87036b44772861b9f4-5370f70191c4b03c-01"}Make a child span:
curl -i -X POST \
'http://127.0.0.1:3003/4c278c122e123f87036b44772861b9f4/5370f70191c4b03c/' \
-H 'Content-Type: application/json' \
-d '{"service.name":"jerbly-test",
"name":"test_child",
"hello":"child span",
"ttl":600000}'
HTTP/1.1 200 OK
content-type: application/json
content-length: 148
date: Thu, 11 Jul 2024 11:06:43 GMT
{"span_id":"a53924432a660874","trace_id":"4c278c122e123f87036b44772861b9f4","traceparent":"00-4c278c122e123f87036b44772861b9f4-a53924432a660874-01"}Close the child span:
curl -i -X DELETE \
'http://127.0.0.1:3003/4c278c122e123f87036b44772861b9f4/a53924432a660874/'
HTTP/1.1 200 OK
content-type: application/json
content-length: 16
date: Thu, 11 Jul 2024 11:07:20 GMT
{"message":"OK"}Close the root span:
curl -i -X DELETE \
'http://127.0.0.1:3003/4c278c122e123f87036b44772861b9f4/5370f70191c4b03c/'
HTTP/1.1 200 OK
content-type: application/json
content-length: 16
date: Thu, 11 Jul 2024 11:07:38 GMT
{"message":"OK"}Gives this trace:
