{"id":19911330,"url":"https://github.com/adtech-labs/yarnitor","last_synced_at":"2025-05-03T03:31:11.956Z","repository":{"id":78005294,"uuid":"79875549","full_name":"adtech-labs/yarnitor","owner":"adtech-labs","description":"Yarnitor is a pluggable YARN monitoring API and web frontend","archived":false,"fork":false,"pushed_at":"2020-02-27T20:37:47.000Z","size":929,"stargazers_count":6,"open_issues_count":1,"forks_count":8,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-07T11:01:26.933Z","etag":null,"topics":["docker","monitoring","team-platform","yarn"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adtech-labs.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-24T03:38:57.000Z","updated_at":"2024-09-14T10:32:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"6a0a6398-6e42-4b82-86cd-bf96916bff7a","html_url":"https://github.com/adtech-labs/yarnitor","commit_stats":null,"previous_names":["adtech-labs/yarnitor"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adtech-labs%2Fyarnitor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adtech-labs%2Fyarnitor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adtech-labs%2Fyarnitor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adtech-labs%2Fyarnitor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adtech-labs","download_url":"https://codeload.github.com/adtech-labs/yarnitor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252137539,"owners_count":21700235,"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":["docker","monitoring","team-platform","yarn"],"created_at":"2024-11-12T21:24:52.050Z","updated_at":"2025-05-03T03:31:11.950Z","avatar_url":"https://github.com/adtech-labs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yarnitor\n\n[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n[![TravisCI badge](https://travis-ci.org/Valassis-Digital-Media/yarnitor.svg?branch=master)](https://travis-ci.org/Valassis-Digital-Media/yarnitor)\n\nYarnitor is a pluggable YARN monitoring API and web frontend.\n\n![Yarnitor screenshot](./screenshot.png)\n\n## Requirements\n\nYarnitor relies on multiple processes, and is therefore best run using the\nprovided Docker configuration. You can install Docker on\n[Windows](https://docs.docker.com/docker-for-windows/),\n[OSX](https://docs.docker.com/docker-for-mac/), or\n[Linux](https://docs.docker.com/engine/installation/linux/). You will also need\nto install [docker-compose](https://docs.docker.com/compose/install/). You'll\nspecifically need:\n\n* docker\u003e=1.10\n* docker-compose\u003e=1.10\n\n## Configure\n\nYou must set two environment variables before starting yarnitor.\n\n1. Set `YARN_ENDPOINT` to one (or more, comma separated, if running in a HA\n   configuration) YARN ResourceManager URLs.\n2. Set `EXPOSED_PORT` to the port on which yarnitor serve its UI.\n\nFor example:\n\n```bash\nexport YARN_ENDPOINT=http://yarn-resource-manager.mydomain.tld:8088\nexport EXPOSED_PORT=8080\n```\n\n## Run\n\nTo launch the yarnitor web app, background YARN polling process, and Redis in\nlinked Docker containers, run the following:\n\n```bash\ndocker-compose up\n```\n\n## Configure Multiple Clusters\n\nYou can modify the `docker-compose.yml` to launch multiple background worker\ncontainers that poll YARN ResourceManagers on different clusters. Configure each\ncontainer with a different `YARN_ENDPOINT` value and set `REDIS_KEY` to some\nunique identifier for the cluster (e.g., `cluster-a`, `cluster-b`). When\nvisiting the Yarnitor web application, information about apps on `cluster-a`\nwill be visible under path `http://your-yarnitor-host/cluster-a` and likewise\nfor `cluster-b`. Set variable `DEFAULT_CLUSTER_KEY` to one of your configured\ncluster identifiers to determine stats about which cluster, if any, appear when\nthe user visits `/` in the web application.\n\n## Develop\n\nTo run the yarnitor web app with Flask debugging enabled, the YARN collector\nprocess, and Redis in linked Docker containers, execute the following:\n\n```bash\nmake dev\n```\n\nIf you don't have make, run what make would by hand instead:\n\n```bash\ndocker-compose build\ndocker-compose run --rm \\\n    -e FLASK_APP=yarnitor \\\n    -e FLASK_DEBUG=1 \\\n    -p 5000:5000 \\\n    web \\\n    flask run -h 0.0.0.0\n```\n\n## Test\n\nTo run a headless end-to-end smoke test from a mock YARN ResourceManager to the\nfrontend API (but not UI), execute:\n\n```bash\nmake test\n```\n\nOr the long-hand equivalent:\n\n```bash\ndocker-compose -f docker-compose.test.yml up -d --build\nsleep 5 # to get services time to populate data\ndocker-compose -f docker-compose.test.yml run --rm test pytest\n```\n\n## Credits\n\n[Nanumo Park](https://www.linkedin.com/in/nanumo-park-8b3ba713) created the\nYarnitor logo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadtech-labs%2Fyarnitor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadtech-labs%2Fyarnitor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadtech-labs%2Fyarnitor/lists"}