{"id":15297391,"url":"https://github.com/paambaati/mae","last_synced_at":"2025-04-13T23:16:27.279Z","repository":{"id":44654421,"uuid":"163254173","full_name":"paambaati/mae","owner":"paambaati","description":"🔥Mesos app exporter for Prometheus","archived":false,"fork":false,"pushed_at":"2023-01-01T23:00:46.000Z","size":70,"stargazers_count":1,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-13T23:15:58.609Z","etag":null,"topics":["marathon","mesos","prometheus","prometheus-exporter","prometheus-metrics","python","python2","python3"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/mae/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/paambaati.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-27T06:06:08.000Z","updated_at":"2021-04-30T06:18:48.000Z","dependencies_parsed_at":"2023-02-01T01:10:18.738Z","dependency_job_id":null,"html_url":"https://github.com/paambaati/mae","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paambaati%2Fmae","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paambaati%2Fmae/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paambaati%2Fmae/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paambaati%2Fmae/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paambaati","download_url":"https://codeload.github.com/paambaati/mae/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248794569,"owners_count":21162615,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["marathon","mesos","prometheus","prometheus-exporter","prometheus-metrics","python","python2","python3"],"created_at":"2024-09-30T19:17:02.590Z","updated_at":"2025-04-13T23:16:26.977Z","avatar_url":"https://github.com/paambaati.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🔥 mae [![](https://img.shields.io/pypi/v/mae.svg)](https://pypi.org/project/mae) [![](https://img.shields.io/pypi/pyversions/mae.svg)](https://pypi.org/project/mae) [![](https://travis-ci.org/paambaati/mae.svg?branch=master)](https://travis-ci.org/paambaati/mae) [![Maintainability](https://api.codeclimate.com/v1/badges/87b24e61fd1c6a998254/maintainability)](https://codeclimate.com/github/paambaati/mae/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/87b24e61fd1c6a998254/test_coverage)](https://codeclimate.com/github/paambaati/mae/test_coverage)\n\n`mae` collects Prometheus metrics from your Mesos apps.\n\nSee [Deployment Strategy](#deployment-strategy) to learn how to set up `mae` on your Mesos cluster.\n\n## Requirements\n\n`mae` requires Python (\u003e= 2.7), and supports Python 3 (\u003e= 3.5).\n\n## Installation\n\n```\npip install mae\n```\n\n## Usage\n```\n$ mae --help\n\nusage: mae [-h] app_port slave_address slave_port\n\npositional arguments:\n  app_port       Port on which this exporter will run on\n  slave_address  Mesos slave address\n  slave_port     Mesos slave port\n```\nThe 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.\n\n## Task Labels\n\nOnce `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  —\n\n| [Task Label](https://docs.mesosphere.com/1.7/usage/tutorials/task-labels/)                           \t| Description                                                                                                              \t| Required? \t| Default    \t|\n|---------------------------------\t|--------------------------------------------------------------------------------------------------------------------------\t|-----------\t|------------\t|\n| `prometheus.metrics.enabled`    \t| Enables metrics collection. If the label isn't found, the app's metrics are not collected.                               \t| Yes       \t|            \t|\n| `prometheus.metrics.port_index` \t| The port index where your app is exposing its Prometheus metrics. This is useful for Mesos apps that use multiple ports. \t| No        \t| `0`        \t|\n| `prometheus.metrics.endpoint`   \t| The endpoint where your app is exposing its metrics.                                                                     \t| No        \t| `/metrics` \t|\n\n## Deployment Strategy\n\n`mae` is designed to be run as a daemon on all Mesos slave nodes. This ideally involves 2 steps —\n\n1. [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).\n2. Run `mae` as a daemon. For example, if your distro supports `systemd`, here's a sample script that runs the exporter on port `8888` —\n    ```\n    # Save this to /etc/systemd/system/mae.service\n    [Unit]\n    Description=Mesos App Exporter\n    After=network.target\n\n    [Service]\n    Type=simple\n    Restart=on-failure\n    Environment=\"LOG_LEVEL=INFO\"\n    ExecStart=/usr/local/bin/mae 8888 localhost 5051 # Assuming the Mesos slave process is running on port 5051\n\n    [Install]\n    WantedBy=multi-user.target\n    ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaambaati%2Fmae","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaambaati%2Fmae","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaambaati%2Fmae/lists"}