Axiom Honeycomb Proxy
Table of Contents
Introduction
Axiom Honeycomb Proxy ships logs to Axiom and Honeycomb simultaneously.
Installation
Download the pre-compiled and archived binary manually
Binary releases are available on GitHub Releases.
Install using Homebrew
brew tap axiomhq/tap
brew install axiom-honeycomb-proxy
To update:
brew update
brew upgrade axiom-honeycomb-proxy
Install using go get
go get -u github.com/axiomhq/axiom-honeycomb-proxy/cmd/axiom-honeycomb-proxy
Install from source
git clone https://github.com/axiomhq/axiom-honeycomb-proxy.git
cd axiom-honeycomb-proxy
make install
Run the Docker image
Docker images are available on DockerHub.
Usage
- Set the following environment variables:
AXIOM_TOKEN: Personal Access or Ingest token. Can be created underProfileorSettings > Ingest Tokens. For security reasons it is advised to use an Ingest Token with minimal privileges only.
When using Axiom Selfhost:
AXIOM_URL: URL of the Axiom deployment to use.
- Run it:
./axiom-honeycomb-proxyor using Docker:
docker run -p8080:8080/tcp \
-e=AXIOM_TOKEN=<YOUR_AXIOM_TOKEN> \
axiomhq/axiom-honeycomb-proxy
- Point all Honeycomb related tools at the proxy deployment.
Request format
Single event requests
" \
-H "X-Honeycomb-Event-Time: 2018-02-09T02:01:23.115Z" \
-d '{"method":"GET","endpoint":"/foo","shard":"users","dur_ms":32}'
">
curl http://localhost:3111/honeycomb/v1/events/<DATASET> -X POST \ -H "X-Honeycomb-Team:" \ -H "X-Honeycomb-Event-Time: 2018-02-09T02:01:23.115Z" \ -d '{"method":"GET","endpoint":"/foo","shard":"users","dur_ms":32}'
Event batch requests
" \
-d '[
{
"time":"2018-02-09T02:01:23.115Z",
"data":{"key1":"val1","key2":"val2"}
},
{
"data":{"key3":"val3"}
}
]'
">
curl http://localhost:3111/honeycomb/v1/batch/<DATASET> -X POST \ -H "X-Honeycomb-Team:" \ -d '[ { "time":"2018-02-09T02:01:23.115Z", "data":{"key1":"val1","key2":"val2"} }, { "data":{"key3":"val3"} } ]'
Note
Honeycomb creates datasets when you push data to them. Axiom does not support that (yet). Make sure you create the matching datasets on the Axiom side, first.
Contributing
Feel free to submit PRs or to fill issues. Every kind of help is appreciated.
Before committing, make should run without any issues.
Kindly check our Contributing guide on how to propose bugfixes and improvements, and submitting pull requests to the project.
License
© Axiom, Inc., 2021
Distributed under MIT License (The MIT License).
See LICENSE for more information.
