https://github.com/paambaati/mae
🔥Mesos app exporter for Prometheus
https://github.com/paambaati/mae
marathon mesos prometheus prometheus-exporter prometheus-metrics python python2 python3
Last synced: 6 months ago
JSON representation
🔥Mesos app exporter for Prometheus
- Host: GitHub
- URL: https://github.com/paambaati/mae
- Owner: paambaati
- License: mit
- Created: 2018-12-27T06:06:08.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-01T23:00:46.000Z (almost 3 years ago)
- Last Synced: 2025-04-13T23:15:58.609Z (6 months ago)
- Topics: marathon, mesos, prometheus, prometheus-exporter, prometheus-metrics, python, python2, python3
- Language: Python
- Homepage: https://pypi.org/project/mae/
- Size: 68.4 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🔥 mae [](https://pypi.org/project/mae) [](https://pypi.org/project/mae) [](https://travis-ci.org/paambaati/mae) [](https://codeclimate.com/github/paambaati/mae/maintainability) [](https://codeclimate.com/github/paambaati/mae/test_coverage)
`mae` collects Prometheus metrics from your Mesos apps.
See [Deployment Strategy](#deployment-strategy) to learn how to set up `mae` on your Mesos cluster.
## Requirements
`mae` requires Python (>= 2.7), and supports Python 3 (>= 3.5).
## Installation
```
pip install mae
```
## Usage
```
$ mae --help
usage: mae [-h] app_port slave_address slave_port
positional arguments:
app_port Port on which this exporter will run on
slave_address Mesos slave address
slave_port Mesos slave port
```
The logging level of the CLI can also be configured with the `LOG_LEVEL` environment variable. Read the [`logging` library's levels](https://docs.python.org/2/library/logging.html#logging-levels) for all the available levels.
## Task Labels
Once `mae` is up and running, it will start collecting metrics from all apps that have the `prometheus.metrics.enabled` label. You can also customize how the metrics are collected —
| [Task Label](https://docs.mesosphere.com/1.7/usage/tutorials/task-labels/) | Description | Required? | Default |
|--------------------------------- |-------------------------------------------------------------------------------------------------------------------------- |----------- |------------ |
| `prometheus.metrics.enabled` | Enables metrics collection. If the label isn't found, the app's metrics are not collected. | Yes | |
| `prometheus.metrics.port_index` | The port index where your app is exposing its Prometheus metrics. This is useful for Mesos apps that use multiple ports. | No | `0` |
| `prometheus.metrics.endpoint` | The endpoint where your app is exposing its metrics. | No | `/metrics` |
## Deployment Strategy
`mae` is designed to be run as a daemon on all Mesos slave nodes. This ideally involves 2 steps —
1. [Install `mae`](#installation) as part of your base image/AMI or via [user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html).
2. Run `mae` as a daemon. For example, if your distro supports `systemd`, here's a sample script that runs the exporter on port `8888` —
```
# Save this to /etc/systemd/system/mae.service
[Unit]
Description=Mesos App Exporter
After=network.target
[Service]
Type=simple
Restart=on-failure
Environment="LOG_LEVEL=INFO"
ExecStart=/usr/local/bin/mae 8888 localhost 5051 # Assuming the Mesos slave process is running on port 5051
[Install]
WantedBy=multi-user.target
```