Skip to content

Latest commit

 

History

History
120 lines (82 loc) · 3.79 KB

README.md

File metadata and controls

120 lines (82 loc) · 3.79 KB
Raw

Axiom Loki Multiplexer

Go Workflow Coverage Status Go Report Latest Release License Docker

Table of Contents

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

Introduction

Axiom Loki Multiplexer multiplexes logs you send to Loki using Loki HTTP API 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-loki-multiplexer

To update:

brew update
brew upgrade axiom-loki-multiplexer

Install using go get

go get -u github.com/axiomhq/axiom-loki-multiplexer/cmd/axiom-loki-multiplexer

Install from source

git clone https://github.com/axiomhq/axiom-loki-multiplexer.git
cd axiom-loki-multiplexer
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 API token. Can be created under Setting -> Profile or Settings -> API Tokens. For security reasons it is advised to use an API Token with minimal privileges only.
  • AXIOM_ORG_ID: The organization identifier of the organization to use (only required when a Personal Access token is used).

When using Axiom Selfhost:

  • AXIOM_TOKEN: Personal Access or API token. Can be created under Setting -> Profile or Settings -> API Tokens. For security reasons it is advised to use an API Token with minimal privileges only.
  • AXIOM_URL: URL of the Axiom deployment to use
  1. Run it: ./axiom-loki-multiplexer or using Docker:
docker run -p8080:8080/tcp \
  -e=AXIOM_TOKEN=<YOU_AXIOM_TOKEN> \
  axiomhq/axiom-loki-multiplexer

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.