Skip to main content

🔥 mae Maintainability Test Coverage

mae collects Prometheus metrics from your Mesos apps.

See 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 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 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 as part of your base image/AMI or via user data.
  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
    

Metadata

Release files for mae 1.0.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mae 1.0.11
File Size Uploaded
mae-1.0.11.tar.gz 5.5 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for mae 1.0.11
File Interpreter ABI Platform
mae-1.0.11-py2.7.egg Legacy Egg format - - Details
mae-1.0.11-py2-none-any.whl Python 2 none any Details

Total release size: 21.5 kB

Release files / mae-1.0.11.tar.gz

Download URL mae-1.0.11.tar.gz
Size 5.5 kB
Tags Source
SHA-256 checksum
How to use checksums
139b689913fc8c0ae0d582924f8b6c28b2e09c370123520767d923a7d6ec2cf5
BLAKE2b-256 checksum
How to use checksums
a740fb49b0838d8d324be2fe474879881665131dd318a6a39ace0ae8e9f62c5b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.15

Release files / mae-1.0.11-py2.7.egg

Download URL mae-1.0.11-py2.7.egg
Size 9.6 kB
Tags Egg
SHA-256 checksum
How to use checksums
66461bb4b7a7bf059684a6b1d6a3727d7d53ebc5891cfb0497c576e3a3d936b9
BLAKE2b-256 checksum
How to use checksums
6d74a62cbdd1cc6816cf93f1ded219a5e05d96ac8a4b2553db759ff6920963b4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.15

Release files / mae-1.0.11-py2-none-any.whl

Download URL mae-1.0.11-py2-none-any.whl
Size 6.4 kB
Tags Python 2
SHA-256 checksum
How to use checksums
dfecd6c27563b59cd2d4ccdfb38d0cb3067ecaae1092a04610973040ae9b043d
BLAKE2b-256 checksum
How to use checksums
cea32e882ac8c8085364d2eccfb51b1e7c0f611ca3666f92766577cf57fcbcdf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.15

Release history Release notifications | RSS feed

This release

1.0.11 This release

3 release files

1.0.10

3 release files

1.0.9

3 release files

1.0.8

3 release files

1.0.7

3 release files

1.0.6

3 release files

1.0.5

3 release files

1.0.4

3 release files

1.0.3

3 release files

1.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page