Send Syslog logs to Axiom

Logs are generated on all Network devices, Axiom Syslog Proxy ships logs to Axiom, acting as a Syslog server.

With Syslog logging system, you can monitor events on your devices and send them directly into Axiom, this also helps you retain your data logs.

The udp log messages is sent on UDP port 514 to the syslog server.

The tcp log messages is sent on TCP port 601 to the 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 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 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_ORG_ID: The organization identifier of the organization to use
• AXIOM_DATASET: Dataset to ship the logs to

When using Axiom Selfhost:

• AXIOM_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_URL: URL of the Axiom deployment to use
• AXIOM_DATASET: Dataset to ship the logs to

2. Run it: ./axiom-syslog-proxy or using Docker:

docker run -p601:601/tcp -p514:514/udp  \
  -e=AXIOM_TOKEN=<YOUR_AXIOM_TOKEN>     \
  -e=AXIOM_DATASET=<YOUR_AXIOM_DATASET> \
  axiomhq/axiom-syslog-proxy

3. Test it:

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

For more information on Axiom-syslog-proxy and how you can propose bug fix, report issues and submit PRs, kindly visit our repository on GitHub.