axiom-loki-proxy

module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 18, 2021 License: MIT

README

Axiom Loki Proxy

Go Workflow Coverage Status Go Report Latest Release License Docker


Table of Contents

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

Introduction

Axiom Loki Proxy ships logs to Axiom, using Loki HTTP API.

Installation

Download the pre-compiled and archived binary manually

Binary releases are available on GitHub Releases.

Install from source

This project uses native go mod support.

$ git clone https://github.com/axiomhq/axiom-loki-proxy.git
$ cd axiom-loki-proxy
$ make build # Puts archive into ./dist/
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.
  2. Run it: ./axiom-loki-proxy or using docker: docker run -p3101:3101/tcp axiomhq/axiom-loki-proxy

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.

Directories

Path Synopsis
cmd
Package version provides variables which, when used correctly, provide build information about the application referencing this package.
Package version provides variables which, when used correctly, provide build information about the application referencing this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL