axiom-syslog-proxy

README

Axiom Syslog Proxy

---

Table of Contents

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

Introduction

Axiom Syslog Proxy ships logs to Axiom, acting as a Syslog server.

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-syslog-proxy

To update:

$ brew update
$ brew upgrade axiom-syslog-proxy

Install using go get

$ go get -u github.com/axiomhq/axiom-syslog-proxy/cmd/axiom-syslog-proxy

Install from source

$ git clone https://github.com/axiomhq/axiom-syslog-proxy.git
$ cd axiom-syslog-proxy
$ make build

Run the Docker image

Docker images are available on DockerHub.

Usage

1. Set the following environment variables:

• AXIOM_DEPLOYMENT_URL: URL of the Axiom deployment to use
• AXIOM_ACCESS_TOKEN: Personal Access or Ingest token. Can be created under Profile or Settings > Ingest Tokens. For security reasons it is advised to use an Ingest Token with minimal privileges only.
• AXIOM_INGEST_DATASET: Dataset to ingest into

1. Run it: ./axiom-syslog-proxy or using docker:

$ docker run -p601:601/tcp -p514:514/udp  \
  -e=AXIOM_DEPLOYMENT_URL=<AXIOM_DEPLOYMENT_URL> \
  -e=AXIOM_ACCESS_TOKEN=<AXIOM_ACCESS_TOKEN> \
  -e=AXIOM_INGEST_DATASET=<AXIOM_INGEST_DATASET> \
  axiomhq/axiom-syslog-proxy

1. Test it:

$ echo -n "tcp message" | nc -w1 localhost 601
$ echo -n "udp message" | nc -u -w1 localhost 514

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.