Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: some improvements to readme #65

Merged
merged 2 commits into from
Jun 8, 2020
Merged

README: some improvements to readme #65

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59f6e22
README: simplify badges
squat Jun 8, 2020
b83d10f
README: basic documentation backends
squat Jun 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 40 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,45 @@
# observatorium
# Observatorium

[![semver](https://img.shields.io/badge/semver--0.0.0-blue.svg?cacheSeconds=2592000)](https://github.com/observatorium/observatorium/releases) [![Maintenance](https://img.shields.io/maintenance/yes/2020.svg)](https://github.com/observatorium/observatorium/commits/master) [![CircleCI](https://circleci.com/gh/observatorium/observatorium.svg?style=svg)](https://circleci.com/gh/observatorium/observatorium)[![Go Doc](https://godoc.org/github.com/observatorium/observatorium?status.svg)](http://godoc.org/github.com/observatorium/observatorium) [![Go Report Card](https://goreportcard.com/badge/github.com/observatorium/observatorium)](https://goreportcard.com/report/github.com/observatorium/observatorium)[![Docker Repository on Quay](https://quay.io/repository/observatorium/observatorium/status "Docker Repository on Quay")](https://quay.io/repository/observatorium/observatorium)
[![CircleCI](https://circleci.com/gh/observatorium/observatorium.svg?style=svg)](https://circleci.com/gh/observatorium/observatorium)
[![Go Doc](https://godoc.org/github.com/observatorium/observatorium?status.svg)](http://godoc.org/github.com/observatorium/observatorium)
[![Go Report Card](https://goreportcard.com/badge/github.com/observatorium/observatorium)](https://goreportcard.com/report/github.com/observatorium/observatorium)

Observatorium API
This project is an API server for Observatorium.
The API provides an authenticated and authorized, multi-tenant interface for writing and reading observability signals, i.e. metrics and logs.

## Backends

The Observatorium API server fulfills requests by proxying reads and writes to a backend for each type of observability signal.

### Metrics

The Observatorium API server can serve read and write requests for Prometheus metrics.
In order to handle requests for metrics, a compatible backend must be configured.

#### --metrics.read.endpoint

The backend from which to read metrics can be specified with the `--metrics.read.endpoint` flag.
Compatible backends must implement the Prometheus HTTP API, e.g. Prometheus, Thanos querier, Cortex, etc.

#### --metrics.write.endpoint

The backend to which to write metrics can be specified with the `--metrics.write.endpoint` flag.
Compatible backends must implement the Prometheus remote-write API, e.g. Thanos receiver, Cortex, etc.

### Logs

The Observatorium API server can serve read and write requests for logs.
In order to handle requests for logs, a compatible backend must be configured.

#### --logs.read.endpoint

The backend from which to read logs can be specified with the `--logs.read.endpoint` flag.
Compatible backends must implement the Loki read API, e.g. Loki.

#### --logs.write.endpoint

The backend to which to write logs can be specified with the `--logs.write.endpoint` flag.
Compatible backends must implement the Loki write API, e.g. Loki.

## Usage

Expand Down