Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axiomhq/axiom-loki-multiplexer
A push interface to Axiom via Loki endpoint.
https://github.com/axiomhq/axiom-loki-multiplexer
axiom grafana loki promtail
Last synced: about 1 month ago
JSON representation
A push interface to Axiom via Loki endpoint.
- Host: GitHub
- URL: https://github.com/axiomhq/axiom-loki-multiplexer
- Owner: axiomhq
- License: mit
- Created: 2021-01-06T17:01:34.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T02:10:28.000Z (almost 2 years ago)
- Last Synced: 2024-06-19T10:10:46.643Z (6 months ago)
- Topics: axiom, grafana, loki, promtail
- Language: Go
- Homepage: https://axiom.co
- Size: 1.09 MB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: Contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Axiom Loki Multiplexer
[![Go Workflow][go_workflow_badge]][go_workflow]
[![Coverage Status][coverage_badge]][coverage]
[![Go Report][report_badge]][report]
[![Latest Release][release_badge]][release]
[![License][license_badge]][license]
[![Docker][docker_badge]][docker]
---
## Table of Contents
1. [Introduction](#introduction)
1. [Usage](#usage)
1. [Contributing](#contributing)
1. [License](#license)
## Introduction
_Axiom Loki Multiplexer_ multiplexes logs you send to Loki using [Loki HTTP API][1] to Axiom.
[1]: https://grafana.com/docs/loki/latest/api/#post-lokiapiv1push
## Installation
### Download the pre-compiled and archived binary manually
Binary releases are available on [GitHub Releases][2].
[2]: https://github.com/axiomhq/axiom-loki-multiplexer/releases/latest
### Install using [Homebrew](https://brew.sh)
```shell
brew tap axiomhq/tap
brew install axiom-loki-multiplexer
```
To update:
```shell
brew update
brew upgrade axiom-loki-multiplexer
```
### Install using `go get`
```shell
go get -u github.com/axiomhq/axiom-loki-multiplexer/cmd/axiom-loki-multiplexer
```
### Install from source
```shell
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][docker].
## 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
2. Run it: `./axiom-loki-multiplexer` or using Docker:
```shell
docker run -p8080:8080/tcp \
-e=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](Contributing.md) 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](LICENSE) for more information.
[go_workflow]: https://github.com/axiomhq/axiom-loki-multiplexer/actions/workflows/push.yml
[go_workflow_badge]: https://img.shields.io/github/workflow/status/axiomhq/axiom-loki-multiplexer/Push?style=flat-square&ghcache=unused
[coverage]: https://codecov.io/gh/axiomhq/axiom-loki-multiplexer
[coverage_badge]: https://img.shields.io/codecov/c/github/axiomhq/axiom-loki-multiplexer.svg?style=flat-square&ghcache=unused
[report]: https://goreportcard.com/report/github.com/axiomhq/axiom-loki-multiplexer
[report_badge]: https://goreportcard.com/badge/github.com/axiomhq/axiom-loki-multiplexer?style=flat-square&ghcache=unused
[release]: https://github.com/axiomhq/axiom-loki-multiplexer/releases/latest
[release_badge]: https://img.shields.io/github/release/axiomhq/axiom-loki-multiplexer.svg?style=flat-square&ghcache=unused
[license]: https://opensource.org/licenses/MIT
[license_badge]: https://img.shields.io/github/license/axiomhq/axiom-loki-multiplexer.svg?color=blue&style=flat-square&ghcache=unused
[docker]: https://hub.docker.com/r/axiomhq/axiom-loki-multiplexer
[docker_badge]: https://img.shields.io/docker/pulls/axiomhq/axiom-loki-multiplexer.svg?style=flat-square&ghcache=unused