https://github.com/sapcc/maia

Prometheus dressed as OpenStack service
https://github.com/sapcc/maia

metrics monitoring monitoring-as-a-service openstack openstack-monitoring openstack-services prometheus prometheus-proxy

Last synced: about 2 months ago
JSON representation

Prometheus dressed as OpenStack service

• Host: GitHub
• URL: https://github.com/sapcc/maia
• Owner: sapcc
• License: apache-2.0
• Created: 2017-05-21T20:48:49.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-08T22:39:43.000Z (about 2 months ago)
• Last Synced: 2024-11-08T23:26:41.101Z (about 2 months ago)
• Topics: metrics, monitoring, monitoring-as-a-service, openstack, openstack-monitoring, openstack-services, prometheus, prometheus-proxy
• Language: Go
• Homepage:
• Size: 10.3 MB
• Stars: 12
• Watchers: 42
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Maia

[![CI](https://github.com/sapcc/maia/actions/workflows/ci.yaml/badge.svg)](https://github.com/sapcc/maia/actions/workflows/ci.yaml)

Maia is a multi-tenant OpenStack-service for accessing metrics and alarms collected through Prometheus. It offers 

a [Prometheus-compatible](https://prometheus.io/docs/querying/api/) API and supports federation.

At SAP we use it to share tenant-specific metrics from our Converged Cloud platform

with our users. For their convenience we included a CLI, so that metrics can be discovered and

retrieved from shell scripts.

If you don't use OpenStack, you can still use Maia CLI as a feature-complete shell client for Prometheus. 

## Features

[Maia Service](docs/operators-guide.md)

* OpenStack Identity v3 authentication and authorization

* Project- and domain-level access control (scoping)

* Compatible to Grafana's Prometheus data source 

* Compatible to Prometheus API (read-only)

* Supports secure federation to additional Prometheus instances

[Maia UI](docs/users-guide.md#using-the-maia-ui)

* Prometheus expression browser adapted to Maia

* Browse projects and metrics

* Perform ad-hoc PromQL queries

* Graph metrics

 

[Maia CLI](docs/users-guide.md#using-the-maia-client)

* Feature-complete CLI supporting all API operations

* JSON and Go-template-based output for reliable automation

* Works with Prometheus, too (no OpenStack required)

# Installation

Maia can be built with Go 1.20. Older versions are not supported. Newer versions are not tested.

## Binary Releases

Binary releases for Linux and MacOS can be downloaded from the GitHub _releases_ area.

## Installation with make

* `make` to compile and run the binaries from the `build/` directory

* `make && make install` to install to `/usr`

* `make && make install PREFIX=/some/path` to install to `/some/path`

* `make docker` to build the Docker image (set image name and tag with the `DOCKER_IMAGE` and `DOCKER_TAG` variables)

# Using Maia

Maia can be used via Web-UI or CLI.

Enter `maia --help` to see a list of commands and options.

Please refer to the [Maia user guide](./docs/users-guide.md) for more instructions.

# Operating Maia

The easiest way to deploy Maia as a service is Kubernetes.

Feel free to reuse our [Maia helm chart](https://github.com/sapcc/helm-charts/tree/master/openstack/maia)

which includes Maia, Prometheus and Thanos.

Follow the [Maia operators guide](./docs/operators-guide.md) to learn how to setup the 

Maia service from scratch and integrate with Prometheus.

# Integrating and Extending Maia

The [Maia developers guide](./docs/developers-guide.md) describes how to use the Maia API. Also

it contains information how to contribute to the Maia development.