axiomsegmentwebhook

README

Axiom Segment Webhook

---

Table of Contents

1. Introduction
2. Usage
3. Contributing
4. License

Introduction

Axiom Segment Webhook provides a Segment compatible webhook that sends data to Axiom.

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-segment-webhook

To update:

brew update
brew upgrade axiom-segment-webhook

Install using go get

go get -u github.com/axiomhq/axiom-segment-webhook/cmd/axiom-segment-webhook

Install from source

git clone https://github.com/axiomhq/axiom-segment-webhook.git
cd axiom-segment-webhook
make install

Run the Docker image

Docker images are available on DockerHub.

Usage

1. Set the following environment variables to connect to Axiom Cloud:

• AXIOM_TOKEN: Personal Access token which can be created under Setting -> Profile.
• AXIOM_ORG_ID: The organization identifier of the organization to use.

When using Axiom Selfhost:

• AXIOM_TOKEN: Personal Access token which can be created under Setting -> Profile.
• AXIOM_URL: URL of the Axiom deployment to use.

1. Run it: ./axiom-segment-webhook or using Docker:

docker run -p8080:8080/tcp \
  -e=AXIOM_TOKEN=<YOU_AXIOM_TOKEN> \
  axiomhq/axiom-segment-webhook

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., 2022

Distributed under MIT License (The MIT License).

See LICENSE for more information.

Documentation

Overview

Package axiomsegmentwebhook implements a Segment (segment.io) compatible Webhook that sends logs to Axiom.