[
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"content": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: bug\nassignees: ''\n\n---\n\n**Describe the bug**\nA clear and concise description of what the bug is.\n\n**To Reproduce**\nSteps to reproduce the behavior:\n1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'\n4. See error\n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Screenshots**\nIf applicable, add screenshots to help explain your problem.\n\n**System information**\nOutput of `python -c 'from flower.utils import bugreport; print(bugreport())'` command\n"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.md",
"content": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: ''\nlabels: enhancement\nassignees: ''\n\n---\n\n**Is your feature request related to a problem? Please describe.**\nA clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n\n**Describe the solution you'd like**\nA clear and concise description of what you want to happen.\n"
},
{
"path": ".github/dependabot.yml",
"content": "# Keep GitHub Actions up to date with GitHub's Dependabot...\n# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot\n# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem\nversion: 2\nupdates:\n - package-ecosystem: github-actions\n directory: /\n groups:\n github-actions:\n patterns:\n - \"*\" # Group all Actions updates into a single larger pull request\n schedule:\n interval: weekly\n"
},
{
"path": ".github/workflows/build.yml",
"content": "name: Build\n\non: [push, pull_request]\n\njobs:\n build:\n runs-on: ubuntu-latest\n\n strategy:\n fail-fast: false\n matrix:\n python-version: ['3.9', '3.10', '3.11', '3.12']\n celery-version: ['5.2.*', '5.3.*', '5.4.*', '5.5.*']\n tornado-version: ['6.0']\n exclude: # https://docs.celeryq.dev/en/v5.2.7/whatsnew-5.2.html#step-5-upgrade-to-celery-5-2\n - python-version: '3.12'\n celery-version: '5.2.*'\n\n steps:\n - uses: actions/checkout@v6\n\n - name: Set up python\n uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n\n - name: Install dependencies\n run: |\n python -m pip install --upgrade pip\n pip install celery==${{ matrix.celery-version }} \\\n tornado==${{ matrix.tornado-version }} \\\n -r requirements/dev.txt\n\n\n - name: Run unit tests\n run: |\n python -m flower --version\n python -m tests.unit\n\n - name: Lint with pylint\n run: |\n pylint flower --rcfile .pylintrc\n\n"
},
{
"path": ".github/workflows/docker.yml",
"content": "name: docker\n\non:\n push:\n branches:\n - master\n tags:\n - '*'\n pull_request:\n branches:\n - master\n\njobs:\n docker:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - uses: docker/setup-qemu-action@v4\n\n - uses: docker/setup-buildx-action@v4\n\n - id: meta\n uses: docker/metadata-action@v6\n with:\n images: mher/flower\n tags: |\n type=ref,event=branch\n type=ref,event=pr\n type=semver,pattern={{version}}\n type=semver,pattern={{major}}.{{minor}}\n\n - uses: docker/login-action@v4\n if: github.event_name != 'pull_request'\n with:\n username: ${{ secrets.DOCKERHUB_USERNAME }}\n password: ${{ secrets.DOCKERHUB_TOKEN }}\n\n - uses: docker/build-push-action@v7\n with:\n context: .\n platforms: linux/amd64,linux/arm64\n push: ${{ github.event_name != 'pull_request' }}\n tags: ${{ steps.meta.outputs.tags }}\n labels: ${{ steps.meta.outputs.labels }}\n"
},
{
"path": ".gitignore",
"content": ".DS_Store\n*.pyc\n*$py.class\n*~\n.*.sw[po]\ndist/\n*.egg-info\n*.egg\n*.egg/\n*.eggs\ndoc/__build/*\nbuild/\n.build/\npip-log.txt\n.directory\nerl_crash.dump\n*.db\nDocumentation/\n.tox/\n.ropeproject/\n.project\n.pydevproject\n.idea\n.vagrant\nenv\nvenv\n*.retry\n.cache/\n.mypy_cache/\nPipfile*\n.vscode/\ndata/\n.python-version\n"
},
{
"path": ".pylintrc",
"content": "[MASTER]\ndisable=\n C0114, # missing-module-docstring\n C0115, # missing-class-docstring\n C0116, # missing-function-docstring\n C0301, # line-too-long\n W0223, # abstract-method\n R0903, # too-few-public-methods\n R0902, # too-many-instance-attributes\n W0622, # redefined-builtin\n C0415, # import-outside-toplevel\n W0718, # broad-exception-caught\n R1735, # use-dict-literal\n R0917, # too-many-positional-arguments\n\n[BASIC]\ngood-names=i,e,n,x,logger,tz,db,dt\n"
},
{
"path": ".readthedocs.yaml",
"content": "# .readthedocs.yaml\n# Read the Docs configuration file\n\nversion: 2\n\nbuild:\n os: ubuntu-22.04\n tools:\n python: \"3.11\"\n\nsphinx:\n configuration: docs/conf.py\n\npython:\n install:\n - requirements: requirements/docs.txt\n"
},
{
"path": "CONTRIBUTORS",
"content": "======================================\n Contributors (in chronological order)\n======================================\n\nMher Movsisyan\nAsk Solem\nLukasz Marcin Dobrzanski\nAlexander Koshelev\nGary Linscott\nTommaso Barbugli\nMiguel Gaiowski\nMatt Hughes\nRomain Commandé\nAndres Riancho\nJet Zheung\nAudrius Butkevicius\nYulian Slobodyan\nRob O'Dwyer\nHorace Thomas\nKit Sunde\nAdam Greig\nLuciano Pacheco\nMiki Tebeka\nMichael J. Schultz\nTJ Kells\nGeoff Jukes\nPeter De Vries\nLisa Chung\nSabeel Saif Hakim\nGaurav Dadhania\nCharlie Marshall\nBenjamin Drung\nDavid Thorman\nHong Minhee\nJohn Costa\nIuri de Silvio\nBalthazar Rouberol\nAlexandre Ferland\nFlorian Glesser\nTomasz Pazurkiewicz\nBenjamin Toueg\nRob Hoelz\nTadej Janež\nCorey Farwell\nThomas Grainger\nTom Mortimer-Jones\nKonstantinos Koukopoulos\nSamuel Cormier-Iijima\nDavid Matson\nPaulo SantAnna\nSanchit Arora\nIlya Lebedev\nWendy Liu\nMike Helmick\nIlya Georgievsky\nRaghuram Onti Srinivasan\nMichael Kahn\nGaurav Kumar\nSimon Westphahl\nPedro Ferreira\nDanilo Resende\nKevin Wu\nVinay Karanam\nRodrigo Pinheiro Matias\nThomas Boquet\nMisha Behersky\nSebastian Kalinowski\nJingyu Zhou\nMaxim Krivodaev\nAlli Witheford\nAlexander Zaitsev\nAnton Prokhorov\nSharang Phadke\nMoinuddin Quadri\nJohn Arnold\nScott Kruger\nDavid Schneider\nS M Ahasanul Haque\nLeo Singer\nPavel Savchenko\nBhargav Srinivasan\nJosiah Berkebile\nDeniz Dogan\nAliaksei Urbanski\nMike Dearman\nFrancisco J. Capdevila\nScott Allen\nJohan Adami\nRay Marc Marcellones\nWen YE\nWaleed Darwish\nBjorn Stiel\nFabio Todaro\nSimon Gurcke\nJason Held\nLukas Matta\nTomasz Kluczkowski\nAlexey Nikitenko\nSergey Klyuykov\nLouis Frament"
},
{
"path": "Dockerfile",
"content": "FROM python:alpine\n\n# Get latest root certificates and update openssl to fix vulnerabilities\nRUN apk add --no-cache ca-certificates tzdata && \\\n apk upgrade --no-cache openssl && \\\n update-ca-certificates\n\n# Install the required packages\nRUN pip install --no-cache-dir redis flower\n\n# PYTHONUNBUFFERED: Force stdin, stdout and stderr to be totally unbuffered. (equivalent to `python -u`)\n# PYTHONHASHSEED: Enable hash randomization (equivalent to `python -R`)\n# PYTHONDONTWRITEBYTECODE: Do not write byte files to disk, since we maintain it as readonly. (equivalent to `python -B`)\nENV PYTHONUNBUFFERED=1 PYTHONHASHSEED=random PYTHONDONTWRITEBYTECODE=1\n\n# Default port\nEXPOSE 5555\n\nENV FLOWER_DATA_DIR /data\nENV PYTHONPATH ${FLOWER_DATA_DIR}\n\nWORKDIR $FLOWER_DATA_DIR\n\n# Add a user with an explicit UID/GID and create necessary directories\nRUN set -eux; \\\n addgroup -g 1000 flower; \\\n adduser -u 1000 -G flower flower -D; \\\n mkdir -p \"$FLOWER_DATA_DIR\"; \\\n chown flower:flower \"$FLOWER_DATA_DIR\"\nUSER flower\n\nVOLUME $FLOWER_DATA_DIR\n\nCMD [\"celery\", \"flower\"]\n"
},
{
"path": "LICENSE",
"content": "Copyright (c) 2012, Mher Movsisyan and individual contributors.\nAll rights reserved. \n\nRedistribution and use in source and binary forms, with or without \nmodification, are permitted provided that the following conditions are met: \n\n * Redistributions of source code must retain the above copyright notice, \n this list of conditions and the following disclaimer. \n\n * Redistributions in binary form must reproduce the above copyright \n notice, this list of conditions and the following disclaimer in the \n documentation and/or other materials provided with the distribution. \n\n * Neither the name of the Celery Flower nor the names of its contributors \n may be used to endorse or promote products derived from this software\n without specific prior written permission. \n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" \nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE \nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE \nARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE \nLIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR \nCONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF \nSUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS \nINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN \nCONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) \nARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE \nPOSSIBILITY OF SUCH DAMAGE.\n"
},
{
"path": "MANIFEST.in",
"content": "include AUTHORS\ninclude CHANGES\ninclude LICENSE\ninclude MANIFEST.in\ninclude README.rst\nrecursive-include docs *\nrecursive-include flower/static *\nrecursive-include flower/templates *\nrecursive-include tests *\nrecursive-include requirements *.txt\n"
},
{
"path": "README.rst",
"content": "Flower\n======\n\n.. image:: https://img.shields.io/pypi/dm/flower.svg\n :target: https://pypistats.org/packages/flower\n :alt: PyPI - Downloads\n.. image:: https://img.shields.io/docker/pulls/mher/flower.svg\n :target: https://hub.docker.com/r/mher/flower\n :alt: Docker Pulls\n.. image:: https://github.com/mher/flower/workflows/Build/badge.svg\n :target: https://github.com/mher/flower/actions\n.. image:: https://img.shields.io/pypi/v/flower.svg\n :target: https://pypi.python.org/pypi/flower\n\nFlower is an open-source web application for monitoring and managing Celery clusters.\nIt provides real-time information about the status of Celery workers and tasks.\n\nFeatures\n--------\n\n- Real-time monitoring using Celery Events\n - View task progress and history\n - View task details (arguments, start time, runtime, and more)\n- Remote Control\n - View worker status and statistics\n - Shutdown and restart worker instances\n - Control worker pool size and autoscale settings\n - View and modify the queues a worker instance consumes from\n - View currently running tasks\n - View scheduled tasks (ETA/countdown)\n - View reserved and revoked tasks\n - Apply time and rate limits\n - Revoke or terminate tasks\n- Broker monitoring\n - View statistics for all Celery queues\n- HTTP Basic Auth, Google, Github, Gitlab and Okta OAuth\n- Prometheus integration\n- API\n\nInstallation\n------------\n\nInstalling `flower` with `pip `_ is simple ::\n\n $ pip install flower\n\nThe development version can be installed from Github ::\n\n $ pip install https://github.com/mher/flower/zipball/master#egg=flower\n\nUsage\n-----\n\nTo run Flower, you need to provide the broker URL ::\n\n $ celery --broker=amqp://guest:guest@localhost:5672// flower\n\nOr use the configuration of `celery application `_ ::\n\n $ celery -A tasks.app flower\n\nBy default, flower runs on port 5555, which can be modified with the `port` option ::\n\n $ celery -A tasks.app flower --port=5001\n\nYou can also run Flower using the docker image ::\n\n $ docker run -v examples:/data -p 5555:5555 mher/flower celery --app=tasks.app flower\n\nIn this example, Flower is using the `tasks.app` defined in the `examples/tasks.py `_ file\n\nAPI\n---\n\nFlower API enables to manage the cluster via HTTP `REST API`.\n\nFor example you can restart worker's pool by: ::\n\n $ curl -X POST http://localhost:5555/api/worker/pool/restart/myworker\n\nOr call a task by: ::\n\n $ curl -X POST -d '{\"args\":[1,2]}' http://localhost:5555/api/task/async-apply/tasks.add\n\nOr terminate executing task by: ::\n\n $ curl -X POST -d 'terminate=True' http://localhost:5555/api/task/revoke/8a4da87b-e12b-4547-b89a-e92e4d1f8efd\n\nFor more info checkout `API Reference`_\n\n.. _API Reference: https://flower.readthedocs.io/en/latest/api.html\n\nDocumentation\n-------------\n\nDocumentation is available at `Read the Docs`_\n\n.. _Read the Docs: https://flower.readthedocs.io\n\nLicense\n-------\n\nFlower is licensed under BSD 3-Clause License.\nSee the `License`_ file for the full license text.\n\n.. _`License`: https://github.com/mher/flower/blob/master/LICENSE\n"
},
{
"path": "docker-compose.yml",
"content": "version: '3'\nservices:\n redis:\n image: redis:alpine\n ports:\n - 6379:6379\n prometheus:\n image: prom/prometheus\n volumes:\n - ./prometheus.yml:/etc/prometheus/prometheus.yml\n ports:\n - 9090:9090\n grafana:\n image: grafana/grafana\n depends_on:\n - prometheus\n ports:\n - 3000:3000\n worker:\n build: ./\n entrypoint: celery\n command: -A tasks worker -l info -E\n user: nobody\n volumes:\n - ./examples:/data\n environment:\n CELERY_BROKER_URL: redis://redis\n CELERY_RESULT_BACKEND: redis://redis\n PYTHONPATH: /data\n depends_on:\n - redis\n flower:\n build: ./\n command: celery -A tasks flower\n volumes:\n - ./examples:/data\n working_dir: /data\n ports:\n - 5555:5555\n environment:\n CELERY_BROKER_URL: redis://redis\n CELERY_RESULT_BACKEND: redis://redis\n depends_on:\n - worker\n - redis"
},
{
"path": "docs/Makefile",
"content": "# Makefile for Sphinx documentation\n#\n\n# You can set these variables from the command line.\nSPHINXOPTS =\nSPHINXBUILD = sphinx-build\nPAPER =\nBUILDDIR = .build\n\n# User-friendly check for sphinx-build\nifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)\n$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)\nendif\n\n# Internal variables.\nPAPEROPT_a4 = -D latex_paper_size=a4\nPAPEROPT_letter = -D latex_paper_size=letter\nALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n# the i18n builder cannot share the environment and doctrees with the others\nI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .\n\n.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext\n\nhelp:\n\t@echo \"Please use \\`make ' where is one of\"\n\t@echo \" html to make standalone HTML files\"\n\t@echo \" dirhtml to make HTML files named index.html in directories\"\n\t@echo \" singlehtml to make a single large HTML file\"\n\t@echo \" pickle to make pickle files\"\n\t@echo \" json to make JSON files\"\n\t@echo \" htmlhelp to make HTML files and a HTML help project\"\n\t@echo \" qthelp to make HTML files and a qthelp project\"\n\t@echo \" devhelp to make HTML files and a Devhelp project\"\n\t@echo \" epub to make an epub\"\n\t@echo \" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\"\n\t@echo \" latexpdf to make LaTeX files and run them through pdflatex\"\n\t@echo \" latexpdfja to make LaTeX files and run them through platex/dvipdfmx\"\n\t@echo \" text to make text files\"\n\t@echo \" man to make manual pages\"\n\t@echo \" texinfo to make Texinfo files\"\n\t@echo \" info to make Texinfo files and run them through makeinfo\"\n\t@echo \" gettext to make PO message catalogs\"\n\t@echo \" changes to make an overview of all changed/added/deprecated items\"\n\t@echo \" xml to make Docutils-native XML files\"\n\t@echo \" pseudoxml to make pseudoxml-XML files for display purposes\"\n\t@echo \" linkcheck to check all external links for integrity\"\n\t@echo \" doctest to run all doctests embedded in the documentation (if enabled)\"\n\nclean:\n\trm -rf $(BUILDDIR)/*\n\nhtml:\n\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/html.\"\n\ndirhtml:\n\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml\n\t@echo\n\t@echo \"Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.\"\n\nsinglehtml:\n\t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml\n\t@echo\n\t@echo \"Build finished. The HTML page is in $(BUILDDIR)/singlehtml.\"\n\npickle:\n\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle\n\t@echo\n\t@echo \"Build finished; now you can process the pickle files.\"\n\njson:\n\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json\n\t@echo\n\t@echo \"Build finished; now you can process the JSON files.\"\n\nhtmlhelp:\n\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp\n\t@echo\n\t@echo \"Build finished; now you can run HTML Help Workshop with the\" \\\n\t \".hhp project file in $(BUILDDIR)/htmlhelp.\"\n\nqthelp:\n\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp\n\t@echo\n\t@echo \"Build finished; now you can run \"qcollectiongenerator\" with the\" \\\n\t \".qhcp project file in $(BUILDDIR)/qthelp, like this:\"\n\t@echo \"# qcollectiongenerator $(BUILDDIR)/qthelp/flower.qhcp\"\n\t@echo \"To view the help file:\"\n\t@echo \"# assistant -collectionFile $(BUILDDIR)/qthelp/flower.qhc\"\n\ndevhelp:\n\t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp\n\t@echo\n\t@echo \"Build finished.\"\n\t@echo \"To view the help file:\"\n\t@echo \"# mkdir -p $$HOME/.local/share/devhelp/flower\"\n\t@echo \"# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/flower\"\n\t@echo \"# devhelp\"\n\nepub:\n\t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub\n\t@echo\n\t@echo \"Build finished. The epub file is in $(BUILDDIR)/epub.\"\n\nlatex:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo\n\t@echo \"Build finished; the LaTeX files are in $(BUILDDIR)/latex.\"\n\t@echo \"Run \\`make' in that directory to run these through (pdf)latex\" \\\n\t \"(use \\`make latexpdf' here to do that automatically).\"\n\nlatexpdf:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through pdflatex...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\nlatexpdfja:\n\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex\n\t@echo \"Running LaTeX files through platex and dvipdfmx...\"\n\t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja\n\t@echo \"pdflatex finished; the PDF files are in $(BUILDDIR)/latex.\"\n\ntext:\n\t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text\n\t@echo\n\t@echo \"Build finished. The text files are in $(BUILDDIR)/text.\"\n\nman:\n\t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man\n\t@echo\n\t@echo \"Build finished. The manual pages are in $(BUILDDIR)/man.\"\n\ntexinfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo\n\t@echo \"Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.\"\n\t@echo \"Run \\`make' in that directory to run these through makeinfo\" \\\n\t \"(use \\`make info' here to do that automatically).\"\n\ninfo:\n\t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo\n\t@echo \"Running Texinfo files through makeinfo...\"\n\tmake -C $(BUILDDIR)/texinfo info\n\t@echo \"makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.\"\n\ngettext:\n\t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale\n\t@echo\n\t@echo \"Build finished. The message catalogs are in $(BUILDDIR)/locale.\"\n\nchanges:\n\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes\n\t@echo\n\t@echo \"The overview file is in $(BUILDDIR)/changes.\"\n\nlinkcheck:\n\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck\n\t@echo\n\t@echo \"Link check complete; look for any errors in the above output \" \\\n\t \"or in $(BUILDDIR)/linkcheck/output.txt.\"\n\ndoctest:\n\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest\n\t@echo \"Testing of doctests in the sources finished, look at the \" \\\n\t \"results in $(BUILDDIR)/doctest/output.txt.\"\n\nxml:\n\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml\n\t@echo\n\t@echo \"Build finished. The XML files are in $(BUILDDIR)/xml.\"\n\npseudoxml:\n\t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml\n\t@echo\n\t@echo \"Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml.\"\n"
},
{
"path": "docs/_static/.keep",
"content": ""
},
{
"path": "docs/_templates/localtoc.html",
"content": "{%- if display_toc %}\n
\n"
},
{
"path": "docs/_theme/celery/static/celery.css_t",
"content": "/*\n * celery.css_t\n * ~~~~~~~~~~~~\n *\n * :copyright: Copyright 2010 by Armin Ronacher.\n * :license: BSD, see LICENSE for details.\n */\n\n{% set page_width = 940 %}\n{% set sidebar_width = 220 %}\n{% set body_font_stack = 'Optima, Segoe, \"Segoe UI\", Candara, Calibri, Arial, sans-serif' %}\n{% set headline_font_stack = 'Futura, \"Trebuchet MS\", Arial, sans-serif' %}\n{% set code_font_stack = \"'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace\" %}\n\n@import url(\"basic.css\");\n\n/* -- page layout ----------------------------------------------------------- */\n\nbody {\n font-family: {{ body_font_stack }};\n font-size: 17px;\n background-color: white;\n color: #000;\n margin: 30px 0 0 0;\n padding: 0;\n}\n\ndiv.document {\n width: {{ page_width }}px;\n margin: 0 auto;\n}\n\ndiv.deck {\n font-size: 18px;\n}\n\np.developmentversion {\n color: red;\n}\n\ndiv.related {\n width: {{ page_width - 20 }}px;\n padding: 5px 10px;\n background: #F2FCEE;\n margin: 15px auto 15px auto;\n}\n\ndiv.documentwrapper {\n float: left;\n width: 100%;\n}\n\ndiv.bodywrapper {\n margin: 0 0 0 {{ sidebar_width }}px;\n}\n\ndiv.sphinxsidebar {\n width: {{ sidebar_width }}px;\n}\n\nhr {\n border: 1px solid #B1B4B6;\n}\n\ndiv.body {\n background-color: #ffffff;\n color: #3E4349;\n padding: 0 30px 0 30px;\n}\n\nimg.celerylogo {\n padding: 0 0 10px 10px;\n float: right;\n}\n\ndiv.footer {\n width: {{ page_width - 15 }}px;\n margin: 10px auto 30px auto;\n padding-right: 15px;\n font-size: 14px;\n color: #888;\n text-align: right;\n}\n\ndiv.footer a {\n color: #888;\n}\n\ndiv.sphinxsidebar a {\n color: #444;\n text-decoration: none;\n border-bottom: 1px dashed #DCF0D5;\n}\n\ndiv.sphinxsidebar a:hover {\n border-bottom: 1px solid #999;\n}\n\ndiv.sphinxsidebar {\n font-size: 14px;\n line-height: 1.5;\n}\n\ndiv.sphinxsidebarwrapper {\n padding: 7px 10px;\n}\n\ndiv.sphinxsidebarwrapper p.logo {\n padding: 0 0 20px 0;\n margin: 0;\n}\n\ndiv.sphinxsidebar h3,\ndiv.sphinxsidebar h4 {\n font-family: {{ headline_font_stack }};\n color: #444;\n font-size: 24px;\n font-weight: normal;\n margin: 0 0 5px 0;\n padding: 0;\n}\n\ndiv.sphinxsidebar h4 {\n font-size: 20px;\n}\n\ndiv.sphinxsidebar h3 a {\n color: #444;\n}\n\ndiv.sphinxsidebar p.logo a,\ndiv.sphinxsidebar h3 a,\ndiv.sphinxsidebar p.logo a:hover,\ndiv.sphinxsidebar h3 a:hover {\n border: none;\n}\n\ndiv.sphinxsidebar p {\n color: #555;\n margin: 10px 0;\n}\n\ndiv.sphinxsidebar ul {\n margin: 10px 0;\n padding: 0;\n color: #000;\n}\n\ndiv.sphinxsidebar input {\n border: 1px solid #ccc;\n font-family: {{ body_font_stack }};\n font-size: 1em;\n}\n\n/* -- body styles ----------------------------------------------------------- */\n\na {\n color: #348613;\n text-decoration: underline;\n}\n\na:hover {\n color: #59B833;\n text-decoration: underline;\n}\n\ndiv.body h1,\ndiv.body h2,\ndiv.body h3,\ndiv.body h4,\ndiv.body h5,\ndiv.body h6 {\n font-family: {{ headline_font_stack }};\n font-weight: normal;\n margin: 30px 0px 10px 0px;\n padding: 0;\n}\n\ndiv.body h1 { margin-top: 0; padding-top: 0; font-size: 200%; }\ndiv.body h2 { font-size: 180%; }\ndiv.body h3 { font-size: 150%; }\ndiv.body h4 { font-size: 130%; }\ndiv.body h5 { font-size: 100%; }\ndiv.body h6 { font-size: 100%; }\n\ndiv.body h1 a.toc-backref,\ndiv.body h2 a.toc-backref,\ndiv.body h3 a.toc-backref,\ndiv.body h4 a.toc-backref,\ndiv.body h5 a.toc-backref,\ndiv.body h6 a.toc-backref {\n color: inherit!important;\n text-decoration: none;\n}\n\na.headerlink {\n color: #ddd;\n padding: 0 4px;\n text-decoration: none;\n}\n\na.headerlink:hover {\n color: #444;\n background: #eaeaea;\n}\n\ndiv.body p, div.body dd, div.body li {\n line-height: 1.4em;\n}\n\ndiv.admonition {\n background: #fafafa;\n margin: 20px -30px;\n padding: 10px 30px;\n border-top: 1px solid #ccc;\n border-bottom: 1px solid #ccc;\n}\n\ndiv.admonition p.admonition-title {\n font-family: {{ headline_font_stack }};\n font-weight: normal;\n font-size: 24px;\n margin: 0 0 10px 0;\n padding: 0;\n line-height: 1;\n}\n\ndiv.admonition p.last {\n margin-bottom: 0;\n}\n\ndiv.highlight{\n background-color: white;\n}\n\ndt:target, .highlight {\n background: #FAF3E8;\n}\n\ndiv.note {\n background-color: #eee;\n border: 1px solid #ccc;\n}\n\ndiv.seealso {\n background-color: #ffc;\n border: 1px solid #ff6;\n}\n\ndiv.topic {\n background-color: #eee;\n}\n\ndiv.warning {\n background-color: #ffe4e4;\n border: 1px solid #f66;\n}\n\np.admonition-title {\n display: inline;\n}\n\np.admonition-title:after {\n content: \":\";\n}\n\npre, tt {\n font-family: {{ code_font_stack }};\n font-size: 0.9em;\n}\n\nimg.screenshot {\n}\n\ntt.descname, tt.descclassname {\n font-size: 0.95em;\n}\n\ntt.descname {\n padding-right: 0.08em;\n}\n\nimg.screenshot {\n -moz-box-shadow: 2px 2px 4px #eee;\n -webkit-box-shadow: 2px 2px 4px #eee;\n box-shadow: 2px 2px 4px #eee;\n}\n\ntable.docutils {\n border: 1px solid #888;\n -moz-box-shadow: 2px 2px 4px #eee;\n -webkit-box-shadow: 2px 2px 4px #eee;\n box-shadow: 2px 2px 4px #eee;\n}\n\ntable.docutils td, table.docutils th {\n border: 1px solid #888;\n padding: 0.25em 0.7em;\n}\n\ntable.field-list, table.footnote {\n border: none;\n -moz-box-shadow: none;\n -webkit-box-shadow: none;\n box-shadow: none;\n}\n\ntable.footnote {\n margin: 15px 0;\n width: 100%;\n border: 1px solid #eee;\n background: #fdfdfd;\n font-size: 0.9em;\n}\n\ntable.footnote + table.footnote {\n margin-top: -15px;\n border-top: none;\n}\n\ntable.field-list th {\n padding: 0 0.8em 0 0;\n}\n\ntable.field-list td {\n padding: 0;\n}\n\ntable.footnote td.label {\n width: 0px;\n padding: 0.3em 0 0.3em 0.5em;\n}\n\ntable.footnote td {\n padding: 0.3em 0.5em;\n}\n\ndl {\n margin: 0;\n padding: 0;\n}\n\ndl dd {\n margin-left: 30px;\n}\n\nblockquote {\n margin: 0 0 0 30px;\n padding: 0;\n}\n\nul {\n margin: 10px 0 10px 30px;\n padding: 0;\n}\n\npre {\n background: #F0FFEB;\n padding: 7px 10px;\n margin: 15px 0;\n border: 1px solid #C7ECB8;\n border-radius: 2px;\n -moz-border-radius: 2px;\n -webkit-border-radius: 2px;\n line-height: 1.3em;\n}\n\ntt {\n background: #F0FFEB;\n color: #222;\n /* padding: 1px 2px; */\n}\n\ntt.xref, a tt {\n background: #F0FFEB;\n border-bottom: 1px solid white;\n}\n\na.reference {\n text-decoration: none;\n border-bottom: 1px dashed #DCF0D5;\n}\n\na.reference:hover {\n border-bottom: 1px solid #6D4100;\n}\n\na.footnote-reference {\n text-decoration: none;\n font-size: 0.7em;\n vertical-align: top;\n border-bottom: 1px dashed #DCF0D5;\n}\n\na.footnote-reference:hover {\n border-bottom: 1px solid #6D4100;\n}\n\na:hover tt {\n background: #EEE;\n}\n"
},
{
"path": "docs/_theme/celery/theme.conf",
"content": "[theme]\ninherit = basic\nstylesheet = celery.css\n\n[options]\n"
},
{
"path": "docs/api.ipynb",
"content": "{\n \"cells\": [\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"# flower REST API\\n\",\n \"\\n\",\n \"This document shows how to use the flower [REST API](https://github.com/mher/flower#api). \\n\",\n \"\\n\",\n \"We will use [requests](http://www.python-requests.org/en/latest/) for accessing the API. (See [here](http://www.python-requests.org/en/latest/user/install/) on how to install it.) \"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"# Code\\n\",\n \"We'll use the following code throughout the documentation.\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## tasks.py\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 43,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [],\n \"source\": [\n \"from celery import Celery\\n\",\n \"from time import sleep\\n\",\n \"\\n\",\n \"celery = Celery()\\n\",\n \"celery.config_from_object({\\n\",\n \" 'BROKER_URL': 'amqp://localhost',\\n\",\n \" 'CELERY_RESULT_BACKEND': 'amqp://',\\n\",\n \" 'CELERYD_POOL_RESTARTS': True, # Required for /worker/pool/restart API\\n\",\n \"})\\n\",\n \"\\n\",\n \"\\n\",\n \"@celery.task\\n\",\n \"def add(x, y):\\n\",\n \" return x + y\\n\",\n \"\\n\",\n \"\\n\",\n \"@celery.task\\n\",\n \"def sub(x, y):\\n\",\n \" sleep(30) # Simulate work\\n\",\n \" return x - y\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## Running\\n\",\n \"You'll need a celery worker instance and a flower instance running. In one terminal window run\\n\",\n \"\\n\",\n \" celery worker --loglevel INFO -A proj -E --autoscale 10,3\\n\",\n \"\\n\",\n \"and in another terminal run\\n\",\n \"\\n\",\n \" celery flower -A proj\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"# Tasks API\\n\",\n \"The tasks API is *async*, meaning calls will return immediately and you'll need to poll on task status.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 3,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [],\n \"source\": [\n \"# Done once for the whole docs\\n\",\n \"import requests, json\\n\",\n \"api_root = 'http://localhost:5555/api'\\n\",\n \"task_api = '{}/task'.format(api_root)\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## async-apply\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 6,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/task/async-apply/tasks.add\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'state': u'PENDING', u'task-id': u'f4a53407-30f3-42af-869f-b7f8f4fbd684'}\"\n ]\n },\n \"execution_count\": 6,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"args = {'args': [1, 2]}\\n\",\n \"url = '{}/async-apply/tasks.add'.format(task_api)\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url, data=json.dumps(args))\\n\",\n \"reply = resp.json()\\n\",\n \"reply\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"We can see that we created a new task and it's pending. Note that the API is *async*, meaning it won't wait until the task finish.\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## apply\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"For create task and wait results you can use 'apply' API.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 7,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/task/apply/tasks.add\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'result': 3,\\n\",\n \" u'state': u'SUCCESS',\\n\",\n \" u'task-id': u'ced6fd57-419e-4b8e-8d99-0770be717cb4'}\"\n ]\n },\n \"execution_count\": 7,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"args = {'args': [1, 2]}\\n\",\n \"url = '{}/apply/tasks.add'.format(task_api)\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url, data=json.dumps(args))\\n\",\n \"reply = resp.json()\\n\",\n \"reply\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## result\\n\",\n \"Gets the task result. This is *async* and will return immediately even if the task didn't finish (with state 'PENDING')\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 5,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/task/result/ced6fd57-419e-4b8e-8d99-0770be717cb4\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'result': 3,\\n\",\n \" u'state': u'SUCCESS',\\n\",\n \" u'task-id': u'ced6fd57-419e-4b8e-8d99-0770be717cb4'}\"\n ]\n },\n \"execution_count\": 5,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"url = '{}/result/{}'.format(task_api, reply['task-id'])\\n\",\n \"print(url)\\n\",\n \"resp = requests.get(url)\\n\",\n \"resp.json()\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## revoke\\n\",\n \"Revoke a running task.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 7,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/task/revoke/bcb4ac2e-cb2d-4a4b-a402-8eb3a3b0c8e8\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'message': u\\\"Revoked 'bcb4ac2e-cb2d-4a4b-a402-8eb3a3b0c8e8'\\\"}\"\n ]\n },\n \"execution_count\": 7,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"# Run a task\\n\",\n \"args = {'args': [1, 2]}\\n\",\n \"resp = requests.post('{}/async-apply/tasks.sub'.format(task_api), data=json.dumps(args))\\n\",\n \"reply = resp.json()\\n\",\n \"\\n\",\n \"# Now revoke it\\n\",\n \"url = '{}/revoke/{}'.format(task_api, reply['task-id'])\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url, data='terminate=True')\\n\",\n \"resp.json()\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## rate-limit\\n\",\n \"Update [rate limit](https://docs.celeryq.dev/en/latest/userguide/tasks.html#Task.rate_limit) for a task.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 20,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/task/rate-limit/miki-manjaro\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'message': u'new rate limit set successfully'}\"\n ]\n },\n \"execution_count\": 20,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"worker = 'miki-manjaro' # You'll need to get the worker name from the worker API (seel below)\\n\",\n \"url = '{}/rate-limit/{}'.format(task_api, worker)\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url, params={'taskname': 'tasks.add', 'ratelimit': '10'})\\n\",\n \"resp.json()\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## timeout\\n\",\n \"Set timeout (both [hard](https://docs.celeryq.dev/en/latest/userguide/tasks.html#Task.time_limit) and [soft](https://docs.celeryq.dev/en/latest/userguide/tasks.html#Task.soft_time_limit)) for a task.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 22,\n \"metadata\": {\n \"collapsed\": false,\n \"scrolled\": true\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/task/timeout/miki-manjaro\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'message': u'time limits set successfully'}\"\n ]\n },\n \"execution_count\": 22,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"url = '{}/timeout/{}'.format(task_api, worker)\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url, params={'taskname': 'tasks.add', 'hard': '3.14', 'soft': '3'}) # You can omit soft or hard\\n\",\n \"resp.json()\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"# Worker API\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 55,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [],\n \"source\": [\n \"# Once for the documentation\\n\",\n \"worker_api = '{}/worker'.format(api_root)\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## workers\\n\",\n \"List workers.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 25,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/workers\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'miki-manjaro': {u'completed_tasks': 0,\\n\",\n \" u'concurrency': 1,\\n\",\n \" u'queues': [u'celery'],\\n\",\n \" u'running_tasks': 0,\\n\",\n \" u'status': True}}\"\n ]\n },\n \"execution_count\": 25,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"url = '{}/workers'.format(api_root) # Only one not under /worker\\n\",\n \"print(url)\\n\",\n \"resp = requests.get(url)\\n\",\n \"workers = resp.json()\\n\",\n \"workers\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## pool/shutdown\\n\",\n \"Shutdown a worker.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 30,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/worker/shutdown/miki-manjaro\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'message': u'Shutting down!'}\"\n ]\n },\n \"execution_count\": 30,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"worker = workers.keys()[0]\\n\",\n \"url = '{}/shutdown/{}'.format(worker_api, worker)\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url)\\n\",\n \"resp.json()\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## pool/restart\\n\",\n \"Restart a worker pool, you need to have [CELERYD_POOL_RESTARTS](https://docs.celeryq.dev/en/latest/configuration.html#std:setting-CELERYD_POOL_RESTARTS) enabled in your configuration).\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 43,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/worker/pool/restart/miki-manjaro\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'message': u\\\"Restarting 'miki-manjaro' worker's pool\\\"}\"\n ]\n },\n \"execution_count\": 43,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"pool_api = '{}/pool'.format(worker_api)\\n\",\n \"url = '{}/restart/{}'.format(pool_api, worker)\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url)\\n\",\n \"resp.json()\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## pool/grow\\n\",\n \"Grows worker pool.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 53,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/worker/pool/grow/miki-manjaro\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'message': u\\\"Growing 'miki-manjaro' worker's pool\\\"}\"\n ]\n },\n \"execution_count\": 53,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"url = '{}/grow/{}'.format(pool_api, worker)\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url, params={'n': '10'})\\n\",\n \"resp.json()\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## pool/shrink\\n\",\n \"Shrink worker pool.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 54,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/worker/pool/shrink/miki-manjaro\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'message': u\\\"Shrinking 'miki-manjaro' worker's pool\\\"}\"\n ]\n },\n \"execution_count\": 54,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"url = '{}/shrink/{}'.format(pool_api, worker)\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url, params={'n': '3'})\\n\",\n \"resp.json()\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## pool/autoscale\\n\",\n \"[Autoscale](https://docs.celeryq.dev/en/latest/userguide/workers.html#autoscaling) a pool.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 58,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/worker/pool/autoscale/miki-manjaro\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'message': u\\\"Autoscaling 'miki-manjaro' worker\\\"}\"\n ]\n },\n \"execution_count\": 58,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"url = '{}/autoscale/{}'.format(pool_api, worker)\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url, params={'min': '3', 'max': '10'})\\n\",\n \"resp.json()\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## queue/add-consumer\\n\",\n \"[Add a consumer](https://docs.celeryq.dev/en/latest/userguide/workers.html#std:control-add_consumer) to a queue.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 62,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/worker/queue/add-consumer/miki-manjaro\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'message': u\\\"add consumer u'jokes'\\\"}\"\n ]\n },\n \"execution_count\": 62,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"queue_api = '{}/queue'.format(worker_api)\\n\",\n \"url = '{}/add-consumer/{}'.format(queue_api, worker)\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url, params={'queue': 'jokes'})\\n\",\n \"resp.json()\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"## queue/cancel-consumer\\n\",\n \"[Cancel a consumer](https://docs.celeryq.dev/en/latest/userguide/workers.html#queues-cancelling-consumers) queue.\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 63,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/worker/queue/cancel-consumer/miki-manjaro\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'message': u'no longer consuming from jokes'}\"\n ]\n },\n \"execution_count\": 63,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"url = '{}/cancel-consumer/{}'.format(queue_api, worker)\\n\",\n \"print(url)\\n\",\n \"resp = requests.post(url, params={'queue': 'jokes'})\\n\",\n \"resp.json()\"\n ]\n },\n {\n \"cell_type\": \"markdown\",\n \"metadata\": {},\n \"source\": [\n \"# Queue API\\n\",\n \"\\n\",\n \"We assume that we've two queues; the default one 'celery' and 'all'\"\n ]\n },\n {\n \"cell_type\": \"code\",\n \"execution_count\": 7,\n \"metadata\": {\n \"collapsed\": false\n },\n \"outputs\": [\n {\n \"name\": \"stdout\",\n \"output_type\": \"stream\",\n \"text\": [\n \"http://localhost:5555/api/queues/length\\n\"\n ]\n },\n {\n \"data\": {\n \"text/plain\": [\n \"{u'active_queues': [{u'messages': 2, u'name': u'all'},\\n\",\n \" {u'messages': 1, u'name': u'celery'}]}\"\n ]\n },\n \"execution_count\": 7,\n \"metadata\": {},\n \"output_type\": \"execute_result\"\n }\n ],\n \"source\": [\n \"url = '{}/queues/length'.format(api_root)\\n\",\n \"print(url)\\n\",\n \"resp = requests.get(url)\\n\",\n \"resp.json()\"\n ]\n }\n ],\n \"metadata\": {\n \"kernelspec\": {\n \"display_name\": \"Python 2\",\n \"language\": \"python\",\n \"name\": \"python2\"\n },\n \"language_info\": {\n \"codemirror_mode\": {\n \"name\": \"ipython\",\n \"version\": 2\n },\n \"file_extension\": \".py\",\n \"mimetype\": \"text/x-python\",\n \"name\": \"python\",\n \"nbconvert_exporter\": \"python\",\n \"pygments_lexer\": \"ipython2\",\n \"version\": \"2.7.6\"\n }\n },\n \"nbformat\": 4,\n \"nbformat_minor\": 0\n}\n"
},
{
"path": "docs/api.rst",
"content": "API Reference\n=============\n\nFor security reasons, the Flower API is disabled by default when authentication is not enabled.\nTo enable the API for unauthenticated environments, you can set the FLOWER_UNAUTHENTICATED_API\nenvironment variable to true.\n\n.. autotornado:: flower.app:Flower()\n"
},
{
"path": "docs/auth.rst",
"content": ".. _authentication:\n\nAuthentication\n==============\n\nFlower supports a variety of authentication methods, including Basic Authentication, Google, GitHub,\nGitLab, and Okta OAuth. You can also customize and use your own authentication method.\n\nThe following endpoints are exempt from authentication:\n\n- /healthcheck\n- /metrics\n\n.. _basic-authentication:\n\nHTTP Basic Authentication\n-------------------------\n\nFlower supports Basic Authentication as a built-in authentication method, allowing you to secure access to the\nFlower using simple username and password credentials. This authentication method is commonly used for\nstraightforward authentication requirements.\n\nTo enable basic authentication, use :ref:`basic_auth` option. This option allows you to specify a list of\nusername and password pairs for authentication.\n\nFor example, running Flower with the following :ref:`basic_auth` option will protect the Flower UI and\nonly allow access to users providing the username user and the password pswd::\n\n $ celery flower --basic-auth=user:pswd\n\nSee also :ref:`reverse-proxy`\n\n.. _google-oauth:\n\nGoogle OAuth\n------------\n\nFlower provides authentication support using Google OAuth, enabling you to authenticate users through their Google accounts.\nThis integration simplifies the authentication process and offers a seamless experience for users who are already logged into Google.\n\nFollow the steps below to configure and use Google OAuth authentication:\n\n1. Go to the `Google Developer Console`_\n2. Select a project, or create a new one.\n3. In the sidebar on the left, select Credentials.\n4. Click CREATE CREDENTIALS and click OAuth client ID.\n5. Under Application type, select Web application.\n6. Name OAuth 2.0 client and click Create.\n7. Copy the \"Client secret\" and \"Client ID\"\n8. Add redirect URI to the list of Authorized redirect URIs\n\nHere's an example configuration file with the Google OAuth options:\n\n.. code-block:: python\n\n auth_provider=\"flower.views.auth.GoogleAuth2LoginHandler\"\n auth=\"allowed-emails.*@gmail.com\"\n oauth2_key=\"\"\n oauth2_secret=\"\"\n oauth2_redirect_uri=\"http://localhost:5555/login\"\n\nReplace `` and `` with the actual Client ID and secret obtained from\nthe Google Developer Console.\n\n.. _Google Developer Console: https://console.developers.google.com\n\n.. _github-oauth:\n\nGitHub OAuth\n------------\n\nFlower also supports GitHub OAuth. Before getting started, Flower should be registered in\n`Github Settings`_.\n\nGithub OAuth is activated by setting :ref:`auth_provider` to `flower.views.auth.GithubLoginHandler`.\nHere's an example configuration file with the Github OAuth options:\n\n.. code-block:: python\n\n auth_provider=\"flower.views.auth.GithubLoginHandler\"\n auth=\"allowed-emails.*@gmail.com\"\n oauth2_key=\"\"\n oauth2_secret=\"\"\n oauth2_redirect_uri=\"http://localhost:5555/login\"\n\nReplace `` and `` with the actual Client ID and secret obtained from\nthe Github Settings.\n\nSee `GitHub OAuth API`_ docs for more info.\n\n.. _Github Settings: https://github.com/settings/applications/new\n.. _GitHub OAuth API: https://developer.github.com/v3/oauth/\n\n.. _okta-oauth:\n\nOkta OAuth\n----------\n\nFlower also supports Okta OAuth. Before getting started, you need to register Flower in `Okta`_.\nOkta OAuth is activated by setting :ref:`auth_provider` option to `flower.views.auth.OktaLoginHandler`.\n\nOkta OAuth requires `oauth2_key`, `oauth2_secret` and `oauth2_redirect_uri` options which should be obtained from Okta.\nOkta OAuth also uses `FLOWER_OAUTH2_OKTA_BASE_URL` environment variable.\n\nSee Okta `Okta OAuth API`_ docs for more info.\n\n.. _Okta: https://developer.okta.com/docs/guides/add-an-external-idp/openidconnect/main/\n.. _Okta OAuth API: https://developer.okta.com/docs/reference/api/oidc/\n\n.. _gitlab-oauth:\n\nGitLab OAuth\n------------\n\nFlower also supports GitLab OAuth for authentication. To enable GitLab OAuth, follow the steps below:\n\n1. Register Flower as an application at GitLab. You can refer to the `GitLab OAuth documentation`_ for detailed instructions on how to do this.\n2. Once registered, you will obtain the credentials for Flower configuration.\n3. In your Flower configuration, set the following options to activate GitLab OAuth:\n - :ref:`auth_provider` to `flower.views.auth.GitLabLoginHandler`.\n - :ref:`oauth2_key` to the \"Application ID\" obtained from GitLab.\n - :ref:`oauth2_secret` to the \"Secret\" obtained from GitLab.\n - :ref:`oauth2_redirect_uri`: Set this to the redirect URI configured in GitLab.\n4. (Optional) To restrict access to specific GitLab groups, you can utilize the `FLOWER_GITLAB_AUTH_ALLOWED_GROUPS` environment variable. Set it to a comma-separated list of allowed groups. You can include subgroups by using the `/` character. For example: `group1,group2/subgroup`.\n5. (Optional) The default minimum required group access level can be adjusted using the `FLOWER_GITLAB_MIN_ACCESS_LEVEL` environment variable.\n6. (Optional) The custom GitHub Domain can be adjusted using the `FLOWER_GITLAB_OAUTH_DOMAIN` environment variable.\n\nFor further details on GitLab OAuth and its implementation, refer to the `Group and project members API`_ documentation.\nIt provides comprehensive information and guidelines on working with GitLab's OAuth functionality.\n\nSee also `GitLab OAuth2 API`_ documentation for more info.\n\n.. _GitLab OAuth documentation: https://docs.gitlab.com/ee/integration/oauth_provider.htm\n.. _GitLab OAuth2 API: https://docs.gitlab.com/ee/api/oauth2.html\n.. _Group and project members API: https://docs.gitlab.com/ee/api/members.html\n"
},
{
"path": "docs/conf.py",
"content": "# -*- coding: utf-8 -*-\n#\n# flower documentation build configuration file, created by\n# sphinx-quickstart on Fri Apr 11 17:26:01 2014.\n#\n# This file is execfile()d with the current directory set to its\n# containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport sys\nimport os\n\nsys.path.insert(0, os.path.abspath('..'))\nimport flower # noqa: E402\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\n# sys.path.insert(0, os.path.abspath('.'))\n\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n# needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'sphinx.ext.intersphinx',\n 'sphinxcontrib.httpdomain',\n 'sphinxcontrib.autohttp.tornado',\n 'sphinxcontrib.redoc',\n]\n\ntemplates_path = ['_templates']\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n# source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = 'Flower'\ncopyright = '2023, Mher Movsisyan'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = '.'.join(map(str, flower.VERSION[0:2]))\n# The full version, including alpha/beta/rc tags.\nrelease = flower.__version__.rstrip('-dev')\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n# language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n# today = ''\n# Else, today_fmt is used as the format for a strftime call.\n# today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = ['.build']\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents.\n# default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n# add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n# add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n# show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n# modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n# keep_warnings = False\n\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\nhtml_theme = 'celery'\nhtml_theme_path = ['_theme']\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n# html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n# html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \" v documentation\".\n# html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n# html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n# html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n# html_favicon = None\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# Add any extra paths that contain custom files (such as robots.txt or\n# .htaccess) here, relative to this directory. These files are copied\n# directly to the root of the documentation.\n# html_extra_path = []\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n# html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n# html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\nhtml_sidebars = {\n 'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'],\n '**': ['sidebarlogo.html', 'localtoc.html', 'relations.html',\n 'sourcelink.html', 'searchbox.html']\n}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n# html_additional_pages = {}\n\n# If false, no module index is generated.\nhtml_domain_indices = False\n\n# If false, no index is generated.\nhtml_use_index = False\n\n# If true, the index is split into individual pages for each letter.\n# html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\nhtml_show_sourcelink = False\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\nhtml_show_sphinx = False\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n# html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n# html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n# html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'flowerdoc'\n\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n # The paper size ('letterpaper' or 'a4paper').\n # 'papersize': 'letterpaper',\n\n # The font size ('10pt', '11pt' or '12pt').\n # ' pointsize': '10pt',\n\n # Additional stuff for the LaTeX preamble.\n # 'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n (\n 'index',\n 'flower.tex',\n 'flower Documentation',\n 'Mher Movsisyan',\n 'manual'\n ),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n# latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n# latex_use_parts = False\n\n# If true, show page references after internal links.\n# latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n# latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n# latex_appendices = []\n\n# If false, no module index is generated.\n# latex_domain_indices = True\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n ('man', 'flower', 'flower Documentation',\n ['Mher Movsisyan'], 1)\n]\n\n# If true, show URL addresses after external links.\n# man_show_urls = False\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n (\n 'index',\n 'flower',\n 'flower Documentation',\n 'Mher Movsisyan',\n 'flower',\n 'One line description of project.',\n 'Miscellaneous'\n ),\n]\n\n# Documents to append as an appendix to all manuals.\n# texinfo_appendices = []\n\n# If false, no module index is generated.\n# texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n# texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n# texinfo_no_detailmenu = False\n\n\n# Example configuration for intersphinx: refer to the Python standard library.\nintersphinx_mapping = {'http://docs.python.org/': None}\n\n"
},
{
"path": "docs/config.rst",
"content": ":tocdepth: 2\n\nConfiguration\n=============\n\nFlower is highly customizable. You can pass configuration options through the command line,\nconfiguration file, or environment variables. For a full list of options, see the `Option Reference`_ section.\n\nCommand line\n------------\n\nFlower operates as a sub-command of Celery, allowing you to pass both Celery and Flower\nconfiguration options from the command line. The template for this is as follows ::\n\n celery [celery options] flower [flower options]\n\nCelery options should be specified after the celery command, while Flower options\nshould be specified after the flower sub-command.\n\nFor example ::\n\n $ celery --broker=redis:// flower --unix-socket=/tmp/flower.sock\n\nSee `Celery Configuration reference`_ for a comprehensive listing of all available settings\nand their default values.\n\n.. _`Celery Configuration reference`: https://docs.celeryq.dev/en/latest/userguide/configuration.html\n\nConfiguration file\n------------------\n\nFlower tries to load configuration from the :file:`flowerconfig.py` file by default.\nYou can override the name of the configuration file with the `conf`_ option.\nThe configuration file is a simple Python file that contains key-value pairs:\n\n.. code-block:: python\n\n # Set RabbitMQ management api\n broker_api = 'http://guest:guest@localhost:15672/api/'\n\n # Enable debug logging\n logging = 'DEBUG'\n\nEnvironment variables\n---------------------\n\nFlower configuration options can also be passed through environment variables.\nAll Flower options must be prefixed with `FLOWER_`.\nFor example, to set the basic_auth option to foo:bar, you would set the\n`FLOWER_BASIC_AUTH` environment variable to `foo:bar` ::\n\n export FLOWER_BASIC_AUTH=foo:bar\n celery flower\n\n.. _options_referance:\n\nOption Reference\n-----------------\n\n.. contents::\n :local:\n :depth: 1\n\n.. _address:\n\naddress\n~~~~~~~\n\nDefault: '' (empty string)\n\nSets the address on which the Flower HTTP server should listen.\nThe address may be either an IP address or a hostname. If a hostname is provided,\nthe server will listen on all IP addresses associated with that name.\nTo listen on all available interfaces, set the address to an empty string.\n\nExample:\n\nListen on all available interfaces::\n\n $ celery flower --address='0.0.0.0'\n\nListen only on the loopback interface::\n\n $ celery flower --address='localhost'\n\nListen on all IP addresses associated with 'example.com'::\n\n $ celery flower --address='example.com'\n\n\n.. _auth:\n\nauth\n~~~~\n\nDefault: '' (empty string)\n\nEnables authentication. `auth` is a regular expression of emails to grant access.\n\nThe `auth` option allows you to enable authentication in Flower. By default, the `auth` option is set to an empty string, indicating that authentication is disabled.\n\nTo enable authentication and restrict access to specific email addresses, set the `auth` option to a regular expression pattern that matches the desired email addresses. The `auth` option supports a basic regex syntax, including:\n\n - Single email: Use a single email address, such as `user@example.com`.\n - Wildcard: Use a wildcard pattern with `.*` to match multiple email addresses with the same domain, such as `.*@example.com`.\n - List of emails: Use a list of emails separated by pipes (`|`), such as `one@example.com|two@example.com`.\n\nPlease note that for security reasons, the `auth` option only supports a basic regex syntax and does not provide advanced regex features.\n\nFor more information and detailed usage examples, refer to the :ref:`Authentication` section of the Flower documentation.\n\n.. _auto_refresh:\n\nauto_refresh\n~~~~~~~~~~~~\n\nDefault: True\n\nEnables automatic refresh for the Workers view.\nBy default, the Workers view automatically refreshes at regular intervals to provide up-to-date\ninformation about the workers. Set this option to `False` to disable automatic refreshing.\n\n.. _basic_auth:\n\nbasic_auth\n~~~~~~~~~~\n\nDefault: None\n\nEnables HTTP Basic authentication. It accepts a comma-separated list of `username:password` pairs.\nEach pair represents a valid username and password combination for authentication.\n\nExample:\n\nEnable HTTP Basic authentication with multiple users::\n\n $ celery flower --basic-auth=\"user1:password1,user2:password2\"\n\nSee :ref:`basic-authentication` for more information.\n\n.. _broker_api:\n\nbroker_api\n~~~~~~~~~~\n\nDefault: None\n\nThe URL of the broker API used by Flower to retrieve information about queues.\n\nFlower uses the RabbitMQ Management Plugin to gather information about queues.\nThe `broker_api` option should be set to the URL of the RabbitMQ HTTP API, including user credentials if required.\n\nExample::\n\n $ celery flower broker-api=\"http://username:password@rabbitmq-server-name:15672/api/\"\n\n.. Note:: By default, the RabbitMQ Management Plugin is not enabled. To enable it, run the following command::\n\n $ rabbitmq-plugins enable rabbitmq_management\n\n.. Note:: The port number for RabbitMQ versions prior to 3.0 is 55672.\n\nFor more information refer to the `RabbitMQ Management Plugin`_ documentation.\n\n.. _`RabbitMQ Management Plugin`: https://www.rabbitmq.com/management.html\n\n.. _ca_certs:\n\nca_certs\n~~~~~~~~\n\nDefault: None\n\nSets the path to the `ca_certs` file containing a set of concatenated \"certification authority\" certificates.\n\nThe `ca_certs` file is used to validate certificates received from the other end of the connection.\nIt contains a collection of trusted root certificates. Set the `ca_certs` option to the path of the `ca_certs` file.\nIf not specified, certificate validation will not be performed.\n\nFor more information about certificate validation in Python, refer to the `Python SSL`_ documentation.\n\n.. _`Python SSL`: https://docs.python.org/3/library/ssl.html\n\n.. _certfile:\n\ncertfile\n~~~~~~~~\n\nDefault: None\n\nSets the path to the SSL certificate file.\n\nThe `certfile` option specifies the path to the SSL certificate file used for SSL/TLS encryption.\nThe certificate file contains the public key certificate for the Flower server.\nIf not specified, SSL/TLS encryption will not be used.\n\n.. _conf:\n\nconf\n~~~~\n\nDefault: flowerconfig.py\n\nSets the configuration file to be used by Flower.\n\nExample::\n\n $ celery flower --conf=\"./examples/celeryconfig.py\"\n\n.. _db:\n\ndb\n~~\n\nDefault: flower\n\nSets the database file to use if persistent mode is enabled.\n\nIf the `persistent`_ mode is enabled, the `db` option specifies the database file\nto be used by Flower for storing task results, events, or other persistent data.\n\nExample::\n\n $ celery flower --persistent=True --db=\"flower_db\"\n\n.. _debug:\n\ndebug\n~~~~~\n\nDefault: False\n\nEnables the debug mode\n\n.. Note:: When debug mode is enabled, Flower may print sensitive information\n\n.. _enable_events:\n\nenable_events\n~~~~~~~~~~~~~\n\nDefault: True\n\nWhen enabled, Flower periodically sends Celery `enable_events` commands to all workers.\nEnabling Celery events allows Flower to receive real-time updates about task events\nfrom the Celery workers.\n\nYou can also enable events directly when running Celery workers by using the `-E` flag.\nFor more information, refer to the `Celery documentation `_:\n\n.. _format_task:\n\nformat_task\n~~~~~~~~~~~\n\nDefault: None\n\nModifies the default task formatting.\n\nThe `format_task` function allows to modify the default formatting of tasks.\nBy defining the `format_task` function in the `flowerconfig.py` configuration file,\nyou can customize the task object before it is displayed. The `format_task` function accepts a task object\nas a parameter and should return the modified version of the task.\n\nThis function is particularly useful for filtering out sensitive information or limiting display lengths of task arguments, kwargs, or results.\n\nThe example below shows how to filter arguments and limit display lengths:\n\n.. code-block:: python\n\n from flower.utils.template import humanize\n\n def format_task(task):\n task.args = humanize(task.args, length=10)\n task.kwargs.pop('credit_card_number')\n task.result = humanize(task.result, length=20)\n return task\n\n.. _inspect_timeout:\n\ninspect_timeout\n~~~~~~~~~~~~~~~\n\nDefault: 1000\n\nSets the timeout for the worker inspect commands in milliseconds.\n\nWorker inspection involves retrieving information about the workers, such as their current status, tasks, and resource usage.\n\n.. _keyfile:\n\nkeyfile\n~~~~~~~\n\nDefault: None\n\nSets the path to the SSL key file.\n\nThe key file contains the private key corresponding to the SSL certificate.\nIf not specified, or set to `None`, SSL/TLS encryption will not be used.\n\n.. _max_workers:\n\nmax_workers\n~~~~~~~~~~~\n\nDefault: 5000\n\nSets the maximum number of workers to keep in memory\n\n.. _max_tasks:\n\nmax_tasks\n~~~~~~~~~\n\nDefault: 100000\n\nSets the maximum number of tasks to keep in memory\n\n.. _natural_time:\n\nnatural_time\n~~~~~~~~~~~~\n\nDefault: False\n\nEnables showing time relative to the page refresh time in a more human-readable format.\n\nWhen enabled, timestamps will be shown as relative time such as \"2 minutes ago\" or \"1 hour ago\" instead of the exact timestamp.\n\n.. _persistent:\n\npersistent\n~~~~~~~~~~\n\nDefault: False\n\nEnables persistent mode in Flower.\n\nWhen persistent mode is enabled, Flower saves its current state and reloads it upon restart.\nThis ensures that Flower retains its state and configuration across restarts.\nFlower stores its state in a database file specified by the `db`_ option.\n\n.. _port:\n\nport\n~~~~\n\nDefault: 5555\n\nSets the port number for running the Flower HTTP server.\n\n.. _state_save_interval:\n\nstate_save_interval\n~~~~~~~~~~~~~~~~~~~\n\nDefault: 0\n\nSets the interval for saving the Flower state.\n\nFlower state includes information about workers, tasks. The state is saved periodically to ensure data persistence and recovery upon restart.\n\nBy default, periodic saving is disabled. Flower will not automatically save its state at regular intervals.\nIf you want to enable periodic state saving, set the `state_save_interval` option to a positive integer value representing the interval in milliseconds.\n\n.. _xheaders:\n\nxheaders\n~~~~~~~~\n\nDefault: False\n\nEnables support for `X-Real-Ip` and `X-Scheme` headers.\n\nThe `xheaders` option allows Flower to enable support for `X-Real-Ip` and `X-Scheme` headers.\nThese headers are commonly used in proxy or load balancer configurations to preserve the original client IP address and scheme.\n\n.. _tasks_columns:\n\ntasks_columns\n~~~~~~~~~~~~~\n\nDefault: name,uuid,state,args,kwargs,result,received,started,runtime,worker\n\nSpecifies the list of comma-delimited columns to display on the `/tasks` page.\n\nThe `tasks_columns` option allows you to customize the columns displayed on the `/tasks` page in Flower.\nBy default, the specified columns are: name, uuid, state, args, kwargs, result, received, started, runtime, and worker.\n\nAvailable columns are:\n\n - `name`\n - `uuid`\n - `state`\n - `args`\n - `kwargs`\n - `result`\n - `received`\n - `started`\n - `runtime`\n - `worker`\n - `retries`\n - `revoked`\n - `exception`\n - `expires`\n - `eta`\n\nExample::\n\n $ celery flower --tasks-columns='name,uuid,state,args,kwargs,result,received,started,runtime,worker,retries,revoked,exception,expires,eta'\n\nIn the above example, all available columns are displayed.\n\n.. _url_prefix:\n\nurl_prefix\n~~~~~~~~~~\n\nDefault: '' (empty string)\n\nEnables deploying Flower on a non-root URL.\n\nThe `url_prefix` option allows you to deploy Flower on a non-root URL.\nBy default, Flower is deployed on the root URL. However, if you need to run Flower on a specific path,\nsuch as `http://example.com/flower`, you can specify the desired URL prefix using the `url_prefix` option.\n\n.. _unix_socket:\n\nunix_socket\n~~~~~~~~~~~\n\nDefault: '' (empty string)\n\nRuns Flower using a UNIX socket file.\n\nThe `unix_socket` option allows you to run Flower using a UNIX socket file instead of a network port.\nBy default, the `unix_socket` option is set to an empty string, indicating that Flower should not use a UNIX socket.\n\nTo run Flower using a UNIX socket file, set the `unix_socket` option to the desired path of the UNIX socket file.\nFlower will then bind to the specified socket file instead of a network port.\n\nExample::\n\n $ celery flower --unix-socket='/var/run/flower.sock'\n\n.. _cookie_secret:\n\ncookie_secret\n~~~~~~~~~~~~~\n\nDefault: token_urlsafe(64) (random string)\n\nSets a secret key for signing cookies.\n\nThe `cookie_secret` option allows you to set a secret key used for signing cookies in Flower.\n\nBy default, the `cookie_secret` option is set to 'token_urlsafe(64)', which generates a random string of length 64 characters as the secret key.\nThis provides a good level of security for signing cookies. If you want to specify a custom secret key, you can set the `cookie_secret` option to the desired string.\n\n.. _auth_provider:\n\nauth_provider\n~~~~~~~~~~~~~\n\nDefault: None\n\nSets the authentication provider for Flower.\n\nThe `auth_provider` option allows you to set the authentication provider for Flower.\nBy default, the `auth_provider` option is set to `None`, indicating that no authentication provider is configured.\n\nTo enable authentication and specify an authentication provider, set the `auth_provider` option to one of the following values:\n\n - Google `flower.views.auth.GoogleAuth2LoginHandler`\n - GitHub `flower.views.auth.GithubLoginHandler`\n - GitLab `flower.views.auth.GitLabLoginHandler`\n - Okta `flower.views.auth.OktaLoginHandler`\n\nSee also :ref:`Authentication` for usage examples\n\n.. _purge_offline_workers:\n\npurge_offline_workers\n~~~~~~~~~~~~~~~~~~~~~\n\nDefault: None\n\nTime (in seconds) after which offline workers are automatically removed from the Workers view.\nBy default, offline workers will remain on the dashboard indefinitely.\n\n.. _task_runtime_metric_buckets:\n\ntask_runtime_metric_buckets\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDefault: 'Histogram.DEFAULT_BUCKETS' (default prometheus buckets)\n\nSets the task runtime latency buckets.\n\nYou can provide the `buckets` value as a comma-separated list of values.\n\nExample::\n\n $ celery flower --task-runtime-metric-buckets=1,5,10,inf\n\nThe buckets represent the upper bounds of the latency intervals.\nYou can specify them as integer or float values. The `inf` value represents positive infinity, indicating\nthat the last bucket captures all values greater than or equal to the previous bucket.\n\n.. _oauth2_key:\n\noauth2_key\n~~~~~~~~~~\n\nDefault: None\n\nSets the OAuth 2.0 key (client ID) issued by the OAuth 2.0 provider\n\n`oauth2_key` option should be used with :ref:`auth`, :ref:`auth_provider`, :ref:`oauth2_redirect_uri` and :ref:`oauth2_secret` options.\n\n.. _oauth2_secret:\n\noauth2_secret\n~~~~~~~~~~~~~\n\nDefault: None\n\nSets the OAuth 2.0 secret issued by the OAuth 2.0 provider\n\n`oauth2_secret` option should be used with :ref:`auth`, :ref:`auth_provider`, :ref:`oauth2_redirect_uri` and :ref:`oauth2_key` options.\n\n.. _oauth2_redirect_uri:\n\noauth2_redirect_uri\n~~~~~~~~~~~~~~~~~~~\n\nDefault: None\n\nSets the URI to which an OAuth 2.0 server redirects the user after successful authentication and authorization.\n\n`oauth2_redirect_uri` option should be used with :ref:`auth`, :ref:`auth_provider`, :ref:`oauth2_key` and :ref:`oauth2_secret` options.\n"
},
{
"path": "docs/features.rst",
"content": "Features\n--------\n\n- Real-time monitoring using Celery Events\n - View task progress and history\n - View task details (arguments, start time, runtime, and more)\n\n- Remote Control\n - View worker status and statistics\n - Shutdown and restart worker instances\n - Control worker pool size and autoscale settings\n - View and modify the queues a worker instance consumes from\n - View currently running tasks\n - View scheduled tasks (ETA/countdown)\n - View reserved and revoked tasks\n - Apply time and rate limits\n - Revoke or terminate tasks\n\n- Broker monitoring\n - View statistics for all Celery queues\n\n- HTTP Basic Auth, Google, Github, Gitlab and Okta OAuth\n\n- Prometheus integration\n\n- API\n"
},
{
"path": "docs/index.rst",
"content": "======\nFlower\n======\n\nFlower is an open-source web application for monitoring and managing `Celery`_ clusters.\nIt provides real-time information about the status of Celery workers and tasks.\n\n.. _Celery: https://docs.celeryq.dev/en/stable/#\n\nContents\n========\n\n.. toctree::\n\n features\n install\n config\n tasks_filter\n auth\n reverse-proxy\n prometheus-integration\n api\n\nFlower is licensed under BSD 3-Clause License.\nSee the `License`_ file for the full license text.\n\nFlower development and support is provided through its GitHub `repository`_.\n\n.. _`License`: https://github.com/mher/flower/blob/master/LICENSE\n.. _`repository`: https://github.com/mher/flower\n"
},
{
"path": "docs/install.rst",
"content": "Getting started\n===============\n\nInstallation\n------------\n\nInstalling `flower` with `pip `_ is simple ::\n\n $ pip install flower\n\nThe development version can be installed from Github ::\n\n $ pip install https://github.com/mher/flower/zipball/master#egg=flower\n\nUsage\n-----\n\nTo run Flower, you need to provide the broker URL ::\n\n $ celery --broker=amqp://guest:guest@localhost:5672// flower\n\nOr use the configuration of `celery application `_ ::\n\n $ celery -A tasks.app flower\n\nBy default, flower runs on port 5555, which can be modified with the :ref:`port` option ::\n\n $ celery -A tasks.app flower --port=5001\n\nYou can also run Flower using the docker image ::\n\n $ docker run -v examples:/data -p 5555:5555 mher/flower celery --app=tasks.app flower\n\nIn this example, Flower is using the `tasks.app` defined in the `examples/tasks.py `_ file\n"
},
{
"path": "docs/man.rst",
"content": "========\n flower\n========\n\nSYNOPSIS\n========\n\n``flower`` [*OPTIONS*]\n\nDESCRIPTION\n===========\n\nFlower is a web based tool for monitoring and administrating Celery clusters.\nIt has these features:\n\n- Real-time monitoring using Celery Events\n\n - Task progress and history\n - Ability to show task details (arguments, start time, runtime, and more)\n - Graphs and statistics\n\n- Remote Control\n\n - View worker status and statistics\n - Shutdown and restart worker instances\n - Control worker pool size and autoscale settings\n - View and modify the queues a worker instance consumes from\n - View currently running tasks\n - View scheduled tasks (ETA/countdown)\n - View reserved and revoked tasks\n - Apply time and rate limits\n - Configuration viewer\n - Revoke or terminate tasks\n\n- Broker monitoring\n\n - View statistics for all Celery queues\n - Queue length graphs\n\n- HTTP API\n- Basic Auth and Google OpenID authentication\n- Prometheus integration\n\n\nOPTIONS\n=======\n\n --address run on the given address\n --auth regexp of emails to grant access\n --auth_provider sets authentication provider class\n --auto_refresh refresh workers automatically (default *True*)\n --basic_auth colon separated user-password to enable\n basic auth\n --broker_api inspect broker e.g.\n http://guest:guest@localhost:15672/api/\n --ca_certs path to SSL certificate authority (CA) file\n --certfile path to SSL certificate file\n --conf flower configuration file path (default *flowerconfig.py*)\n --cookie_secret secure cookie secret\n --db flower database file (default *flower*)\n --debug run in debug mode (default *False*)\n --enable_events periodically enable Celery events (default *True*)\n --format_task use custom task formatter\n --help show this help information\n --inspect inspect workers (default *True*)\n --inspect_timeout inspect timeout (in milliseconds) (default\n *1000*)\n --keyfile path to SSL key file\n --max_workers maximum number of workers to keep in memory\n (default *5000*)\n --max_tasks maximum number of tasks to keep in memory\n (default *10000*)\n --natural_time show time in relative format (default *False*)\n --persistent enable persistent mode (default *False*)\n --port run on the given port (default *5555*)\n --purge_offline_workers time (in seconds) after which offline workers are purged\n from workers\n --state_save_interval state save interval (in milliseconds) (default *0*)\n --tasks_columns slugs of columns on /tasks/ page, delimited by comma\n (default *name,uuid,state,args,kwargs,result,received,started,runtime,worker*)\n --unix_socket path to unix socket to bind flower server to\n --url_prefix base url prefix\n --xheaders enable support for the 'X-Real-Ip' and\n 'X-Scheme' headers. (default *False*)\n --task_runtime_metric_buckets task runtime prometheus latency metric buckets (default prometheus latency buckets)\n\nTORNADO OPTIONS\n===============\n\n --log_file_max_size max size of log files before rollover\n (default *100000000*)\n --log_file_num_backups number of log files to keep (default *10*)\n --log_file_prefix=PATH Path prefix for log files. Note that if you\n are running multiple tornado processes,\n log_file_prefix must be different for each\n of them (e.g. include the port number)\n --log_to_stderr Send log output to stderr (colorized if\n possible). By default use stderr if\n ``--log_file_prefix`` is not set and no other\n logging is configured.\n --logging=debug|info|warning|error|none\n Set the Python log level. If *none*, tornado\n won't touch the logging configuration.\n (default *info*)\n\nUSAGE\n=====\n\nLaunch the Flower server at specified port other than default 5555 (open the UI at http://localhost:5566): ::\n\n $ celery flower --port=5566\n\nSpecify Celery application path with address and port for Flower: ::\n\n $ celery -A proj flower --address=127.0.0.6 --port=5566\n\nBroker URL and other configuration options can be passed through the standard Celery options (notice that they are after\nCelery command and before Flower sub-command): ::\n\n $ celery -A proj --broker=amqp://guest:guest@localhost:5672// flower\n"
},
{
"path": "docs/prometheus-integration.rst",
"content": "Prometheus Integration\n======================\n\nFlower exports several celery worker and task metrics in Prometheus' format.\nThe ``/metrics`` endpoint is available from the get go after you have installed Flower.\n\nBy default on your local machine Flower's metrics are available at: ``localhost:5555/metrics``.\n\nRead further for more information about configuration and available metrics please.\n\nComplete guide on integration of Celery, Flower, Prometheus and Grafana is here: `Grafana Integration Guide`_.\n\nConfigure Prometheus to scrape Flower metrics\n---------------------------------------------\n\nTo integrate with Prometheus you have to add Flower as the target in Prometheus's configuration.\nIn this example we are assuming your Flower and Prometheus are installed on your local machine\nwith their defaults and available at ``localhost:``.\n\nTo add Flower's metrics to Prometheus go to its config file ``prometheus.yml`` which initially\nwill look like this:\n\n.. code-block:: yaml\n\n global:\n scrape_interval: 15s\n evaluation_interval: 15s\n\n scrape_configs:\n - job_name: prometheus\n static_configs:\n - targets: ['localhost:9090']\n\nand alter the ``scrape_configs`` definition to be:\n\n.. code-block:: yaml\n\n scrape_configs:\n - job_name: prometheus\n static_configs:\n - targets: ['localhost:9090']\n - job_name: flower\n static_configs:\n - targets: ['localhost:5555']\n\nYou can also just point Prometheus at the example ``prometheus.yml`` file in the root of the `Flower repository `\nwhen you start it from the command line (note that you would have to set ``flower`` to point at ``localhost`` in your ``etc/hosts`` config for the DNS to resolve correctly)::\n\n ./prometheus --config.file=prometheus.yml\n\nAvailable Metrics\n-----------------\n\nBelow you will find a table of available Prometheus metrics exposed by Flower.\n\n+---------------------------------------------------+----------------------------------------------------------------------+--------------------+-----------------+\n| Name | Description | Labels | Instrument Type |\n+===================================================+======================================================================+====================+=================+\n| flower_events_total | Number of times a celery task event was registered by Flower. | task, type, worker | counter |\n+---------------------------------------------------+----------------------------------------------------------------------+--------------------+-----------------+\n| flower_task_prefetch_time_seconds | The time the task spent waiting at the celery worker to be executed. | task, worker | gauge |\n+---------------------------------------------------+----------------------------------------------------------------------+--------------------+-----------------+\n| flower_worker_prefetched_tasks | Number of tasks of given type prefetched at a worker. | task, worker | gauge |\n+---------------------------------------------------+----------------------------------------------------------------------+--------------------+-----------------+\n| flower_task_runtime_seconds | The time it took to run the task. | task, worker | histogram |\n+---------------------------------------------------+----------------------------------------------------------------------+--------------------+-----------------+\n| flower_worker_online | Shows celery worker's online status. | worker | gauge |\n+---------------------------------------------------+----------------------------------------------------------------------+--------------------+-----------------+\n| flower_worker_number_of_currently_executing_tasks | Number of tasks currently executing at this worker. | worker | gauge |\n+---------------------------------------------------+----------------------------------------------------------------------+--------------------+-----------------+\n\nUsing Metric Labels\n-------------------\n\nYou can filter received data in prometheus using ``promql`` syntax to present information only for selected labels.\nWe have the following labels available:\n\n* **task** - task name, i.e. ``tasks.add``, ``tasks.multiply``.\n* **type** - task event type, i.e. ``task-started``, ``task-succeeded``. Note that worker related events **will not be counted**.\n For more info on task event types see: `task events in celery `_.\n* **worker** - celery worker name, i.e ``celery@``.\n\nExample Prometheus Alerts\n-------------------------\n\nSee example `Prometheus alerts `_.\nAdd the rules to your ``alertmanager.yml`` config as in the `alert manager's documentation `_.\n\n\nExample Grafana Dashboard\n-------------------------\n\nSee example `Grafana dashboard `_.\nYou can import it easily in Grafana.\nHover over the + button in the side bar menu -> Import -> Upload JSON file.\nThe dashboard should give you a nice starting point for monitoring of your celery cluster.\n\nGrafana Integration Guide\n=========================\n\nIn this guide you will learn how to setup each part of the stack to make it talk to the next one and achieve Celery\nmonitoring solution with help of Flower.\n\nSame as above we assume localhost usage and for ease of deployment I will use Pycharm configurations to start docker\ncontainers with necessary images. If you do not have docker installed on your system: `download and install it please `_.\n\nStart Celery Broker\n-------------------\n\nEasiest is to use `Redis Pycharm run configuration `_.\n\nOr run::\n\n docker run --name redis -d -p 6379:6379 redis\n\n\nSet Up Your Celery Application\n-------------------------------\n\nWe are assuming that your Celery application has tasks in `tasks.py` file. The `-E` argument makes Celery send events\nwhich are required to produce Prometheus metrics.\n\nCreate `celeryconfig.py` in root of your Celery app. We are setting Celery to use Redis DB as the broker/backend in this\nexample. Skip this if you configure your broker/backend already in another way (make sure to adjust further steps to that).\n\n.. code-block:: python\n\n broker_url = 'redis://localhost:6379/0'\n celery_result_backend = 'redis://localhost:6379/0'\n\nOr download it from `here `_.\n\nStart your Celery app::\n\n celery -A tasks worker -l INFO -E\n\nWhen the app starts you should see this line::\n\n -- ******* ---- .> task events: ON\n\n\nStart Flower Monitoring\n-----------------------\n\nIn your Celery application folder run this command (Flower needs to be installed)::\n\n celery -A tasks --broker=redis://localhost:6379/0 flower\n\nConfigure and Start Prometheus\n------------------------------\n\nCreate `prometheus.yml` file. Note its absolute path - we will use it to start the Prometheus docker image.\nFor ease of use put it in the root of your Celery project (so that you can use Pycharm configuration below without any changes).\n\n.. code-block:: yaml\n\n global:\n scrape_interval: 15s\n evaluation_interval: 15s\n\n scrape_configs:\n - job_name: prometheus\n static_configs:\n - targets: ['localhost:9090']\n - job_name: flower\n static_configs:\n - targets: ['localhost:5555']\n\nRun Prometheus inside docker:\n\nYou can use `Prometheus Pycharm run configuration `_ (may need to adjust the `prometheus.yml` path if it is not in root of your Celery project).\n\nOr just start it via command line::\n\n docker run --name Prometheus -v :/etc/prometheus/prometheus.yml -p 9090:9090 --network host prom/prometheus\n\n\nNow go to `localhost:9090` and check that Prometheus is running.\nIf everything so far was set up and started correctly, you should be able to see metrics provided by Flower in your\nPrometheus's GUI. Go to `Graph` tab and start typing `flower` - the autocomplete should show you all available metrics.\n\n.. image:: screenshots/flower-metrics-in-prometheus.png\n :width: 100%\n\nStart Grafana\n-------------\n\nYou can use `Grafana Pycharm run configuration `_.\n\nOr run it from the terminal::\n\n docker run --name Grafana -d -v grafana-storage:/var/lib/grafana -p 3000:3000 --network host grafana/grafana\n\ntry to access its web GUI now by going to `localhost:3000`, use `admin/admin` for credentials. It will ask you to set up\na new password - you may click skip for now.\n\n\nAdd Prometheus As a Data Source In Grafana\n------------------------------------------\n\nClick `Configuration` (settings icon) in the left side-bar. Then the blue `Add data source` button.\n\n.. image:: screenshots/grafana-add-data-source.png\n :width: 100%\n\nSearch for Prometheus data source and click it (it should be at the top).\n\n.. image:: screenshots/grafana-add-prometheus-data-source.png\n :width: 100%\n\nOnce in Prometheus data source configuration, use all defaults and enter the HTTP/URL parameter as below (which is the placeholder by the way)::\n\n http://localhost:9090\n\n.. image:: screenshots/grafana-configure-prometheus-data-source.png\n :width: 100%\n\nScroll down and click `Save & Test`, if all is good a green banner will pop up saying `Data source is working`\n\n.. image:: screenshots/grafana-test-prometheus-data-source.png\n :width: 100%\n\n\nImport The Celery Monitoring Dashboard In Grafana\n-------------------------------------------------\n\nDownload `Grafana dashboard `_.\n\nHover over the `+` icon in the left side-bar and click `Import` button.\n\n.. image:: screenshots/grafana-import-dashboard.png\n :width: 30%\n\nClick `Upload JSON file` button and select the `celery-monitoring-grafana-dashboard.json` you have just downloaded.\n\n.. image:: screenshots/grafana-import-celery-monitoring-dashboard.png\n :width: 100%\n\nClick on the `Prometheus` field and select a Prometheus data source.\n\n.. image:: screenshots/grafana-configure-imported-dashboard.png\n :width: 100%\n\nClick `Import` to finish the process.\n\nYou should see a dashboard as on the image below. Congratulations!\n\n.. image:: screenshots/grafana-dashboard.png\n :width: 100%\n"
},
{
"path": "docs/reverse-proxy.rst",
"content": ".. _reverse-proxy:\n\nRunning behind reverse proxy\n============================\n\nTo run `Flower` behind a reverse proxy, remember to set the correct `Host` \nheader to the request to make sure Flower can generate correct URLs.\n\nThe following block represents the minimal `nginx` configuration:\n\n.. code-block:: nginx\n\n server {\n listen 80;\n server_name flower.example.com;\n\n location / {\n proxy_pass http://localhost:5555;\n }\n }\n\nIf you run Flower behind custom location, make sure :ref:`url_prefix` option\nvalue equals to the location path.\n\nYou have to use either environment variable `FLOWER_URL_PREFIX=flower`\nor command parameter `--url_prefix=flower` when you run it\nvia `celery`. With that being set you need the following `nginx` configuration:\n\n.. code-block:: nginx\n\n server {\n listen 80;\n server_name example.com;\n\n location /flower/ {\n proxy_pass http://localhost:5555/flower/;\n }\n }\n\nwithout `url_prefix` Flower frontend won't be able to generate\ncorrect static links, and without `/flower/` at the end of `proxy_pass`\nparameter, the browser will lead you to 404.\n\nNote that you should not expose this site to the public internet without\nany sort of authentication! If you have a `htpasswd` file with user\ncredentials you can make `nginx` use this file by adding the following\nlines to the location block:\n\n.. code-block:: nginx\n\n auth_basic \"Restricted\";\n auth_basic_user_file htpasswd;\n"
},
{
"path": "docs/tasks.py",
"content": "from celery import Celery\nfrom time import sleep\n\ncelery = Celery()\ncelery.config_from_object({\n 'BROKER_URL': 'amqp://10.0.2.2',\n 'CELERY_RESULT_BACKEND': 'amqp://',\n 'CELERYD_POOL_RESTARTS': True,\n})\n\n\n@celery.task\ndef add(x, y):\n return x + y\n\n\n@celery.task\ndef sub(x, y):\n sleep(30) # Simulate work\n return x - y\n"
},
{
"path": "docs/tasks_filter.rst",
"content": "Tasks filtering\n===============\n\nBy now, tasks can be filtered by worker, type, state, received and started datetime.\nAlso, filtering by args/kwargs/result/state value available.\n\nFlower uses github-style syntax for args/kwargs/result filtering.\n\n - `foo` find all tasks containing foo in args, kwargs or result\n - `args:foo` find all tasks containing foo in arguments\n - `kwargs:foo=bar` find all tasks containing foo=bar keyword\n - `result:foo` find all tasks containing foo in result\n - `state:FAILURE` find all failed tasks\n\nIf the search term contains spaces it should be enclosed in \" (e.g. `args:\"hello world\"`).\n\nFor examples, see `tests/utils/test_search.py`.\n"
},
{
"path": "examples/celery-monitoring-grafana-dashboard.json",
"content": "{\n \"__inputs\": [\n {\n \"name\": \"DS_PROMETHEUS\",\n \"label\": \"Prometheus\",\n \"description\": \"\",\n \"type\": \"datasource\",\n \"pluginId\": \"prometheus\",\n \"pluginName\": \"Prometheus\"\n }\n ],\n \"__requires\": [\n {\n \"type\": \"grafana\",\n \"id\": \"grafana\",\n \"name\": \"Grafana\",\n \"version\": \"7.5.2\"\n },\n {\n \"type\": \"panel\",\n \"id\": \"graph\",\n \"name\": \"Graph\",\n \"version\": \"\"\n },\n {\n \"type\": \"datasource\",\n \"id\": \"prometheus\",\n \"name\": \"Prometheus\",\n \"version\": \"1.0.0\"\n }\n ],\n \"annotations\": {\n \"list\": [\n {\n \"builtIn\": 1,\n \"datasource\": \"-- Grafana --\",\n \"enable\": true,\n \"hide\": true,\n \"iconColor\": \"rgba(0, 211, 255, 1)\",\n \"name\": \"Annotations & Alerts\",\n \"type\": \"dashboard\"\n }\n ]\n },\n \"description\": \"Basic celery monitoring example\",\n \"editable\": true,\n \"gnetId\": null,\n \"graphTooltip\": 0,\n \"id\": null,\n \"links\": [],\n \"panels\": [\n {\n \"aliasColors\": {},\n \"bars\": false,\n \"dashLength\": 10,\n \"dashes\": false,\n \"datasource\": \"${DS_PROMETHEUS}\",\n \"description\": \"This panel shows status of celery workers. 1 = online, 0 = offline.\",\n \"fieldConfig\": {\n \"defaults\": {},\n \"overrides\": []\n },\n \"fill\": 1,\n \"fillGradient\": 0,\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 0,\n \"y\": 0\n },\n \"hiddenSeries\": false,\n \"id\": 4,\n \"legend\": {\n \"avg\": false,\n \"current\": false,\n \"max\": false,\n \"min\": false,\n \"show\": true,\n \"total\": false,\n \"values\": false\n },\n \"lines\": true,\n \"linewidth\": 1,\n \"nullPointMode\": \"null\",\n \"options\": {\n \"alertThreshold\": true\n },\n \"percentage\": false,\n \"pluginVersion\": \"7.5.2\",\n \"pointradius\": 2,\n \"points\": false,\n \"renderer\": \"flot\",\n \"seriesOverrides\": [],\n \"spaceLength\": 10,\n \"stack\": false,\n \"steppedLine\": false,\n \"targets\": [\n {\n \"exemplar\": true,\n \"expr\": \"flower_worker_online\",\n \"interval\": \"\",\n \"legendFormat\": \"{{ worker }}\",\n \"refId\": \"A\"\n }\n ],\n \"thresholds\": [],\n \"timeFrom\": null,\n \"timeRegions\": [],\n \"timeShift\": null,\n \"title\": \"Celery Worker Status\",\n \"tooltip\": {\n \"shared\": true,\n \"sort\": 0,\n \"value_type\": \"individual\"\n },\n \"type\": \"graph\",\n \"xaxis\": {\n \"buckets\": null,\n \"mode\": \"time\",\n \"name\": null,\n \"show\": true,\n \"values\": []\n },\n \"yaxes\": [\n {\n \"$$hashKey\": \"object:150\",\n \"format\": \"short\",\n \"label\": \"\",\n \"logBase\": 1,\n \"max\": \"1\",\n \"min\": \"0\",\n \"show\": true\n },\n {\n \"$$hashKey\": \"object:151\",\n \"decimals\": null,\n \"format\": \"short\",\n \"label\": null,\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": false\n }\n ],\n \"yaxis\": {\n \"align\": false,\n \"alignLevel\": null\n }\n },\n {\n \"aliasColors\": {},\n \"bars\": false,\n \"dashLength\": 10,\n \"dashes\": false,\n \"datasource\": \"${DS_PROMETHEUS}\",\n \"description\": \"This panel shows number of tasks currently executing at worker.\",\n \"fieldConfig\": {\n \"defaults\": {},\n \"overrides\": []\n },\n \"fill\": 1,\n \"fillGradient\": 0,\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 12,\n \"y\": 0\n },\n \"hiddenSeries\": false,\n \"id\": 9,\n \"legend\": {\n \"alignAsTable\": true,\n \"avg\": true,\n \"current\": true,\n \"max\": true,\n \"min\": true,\n \"show\": true,\n \"total\": false,\n \"values\": true\n },\n \"lines\": true,\n \"linewidth\": 1,\n \"nullPointMode\": \"null\",\n \"options\": {\n \"alertThreshold\": true\n },\n \"percentage\": false,\n \"pluginVersion\": \"7.5.2\",\n \"pointradius\": 2,\n \"points\": false,\n \"renderer\": \"flot\",\n \"seriesOverrides\": [],\n \"spaceLength\": 10,\n \"stack\": false,\n \"steppedLine\": false,\n \"targets\": [\n {\n \"exemplar\": true,\n \"expr\": \"flower_worker_number_of_currently_executing_tasks\",\n \"interval\": \"\",\n \"legendFormat\": \"{{worker}}\",\n \"refId\": \"A\"\n }\n ],\n \"thresholds\": [],\n \"timeFrom\": null,\n \"timeRegions\": [],\n \"timeShift\": null,\n \"title\": \"Number of Tasks Currently Executing at Worker\",\n \"tooltip\": {\n \"shared\": true,\n \"sort\": 0,\n \"value_type\": \"individual\"\n },\n \"type\": \"graph\",\n \"xaxis\": {\n \"buckets\": null,\n \"mode\": \"time\",\n \"name\": null,\n \"show\": true,\n \"values\": []\n },\n \"yaxes\": [\n {\n \"$$hashKey\": \"object:79\",\n \"format\": \"short\",\n \"label\": null,\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": true\n },\n {\n \"$$hashKey\": \"object:80\",\n \"format\": \"short\",\n \"label\": null,\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": false\n }\n ],\n \"yaxis\": {\n \"align\": false,\n \"alignLevel\": null\n }\n },\n {\n \"aliasColors\": {},\n \"bars\": false,\n \"dashLength\": 10,\n \"dashes\": false,\n \"datasource\": \"${DS_PROMETHEUS}\",\n \"description\": \"This panel shows average task runtime at worker by worker and task name.\",\n \"fieldConfig\": {\n \"defaults\": {},\n \"overrides\": []\n },\n \"fill\": 1,\n \"fillGradient\": 0,\n \"gridPos\": {\n \"h\": 9,\n \"w\": 24,\n \"x\": 0,\n \"y\": 8\n },\n \"hiddenSeries\": false,\n \"id\": 11,\n \"legend\": {\n \"alignAsTable\": true,\n \"avg\": true,\n \"current\": true,\n \"max\": true,\n \"min\": true,\n \"show\": true,\n \"total\": false,\n \"values\": true\n },\n \"lines\": true,\n \"linewidth\": 1,\n \"nullPointMode\": \"null\",\n \"options\": {\n \"alertThreshold\": true\n },\n \"percentage\": false,\n \"pluginVersion\": \"7.5.2\",\n \"pointradius\": 2,\n \"points\": false,\n \"renderer\": \"flot\",\n \"seriesOverrides\": [],\n \"spaceLength\": 10,\n \"stack\": false,\n \"steppedLine\": false,\n \"targets\": [\n {\n \"exemplar\": true,\n \"expr\": \"rate(flower_task_runtime_seconds_sum[5m]) / rate(flower_task_runtime_seconds_count[5m])\",\n \"interval\": \"\",\n \"legendFormat\": \"{{task}}, {{worker}}\",\n \"refId\": \"A\"\n }\n ],\n \"thresholds\": [],\n \"timeFrom\": null,\n \"timeRegions\": [],\n \"timeShift\": null,\n \"title\": \"Average Task Runtime at Worker\",\n \"tooltip\": {\n \"shared\": true,\n \"sort\": 0,\n \"value_type\": \"individual\"\n },\n \"type\": \"graph\",\n \"xaxis\": {\n \"buckets\": null,\n \"mode\": \"time\",\n \"name\": null,\n \"show\": true,\n \"values\": []\n },\n \"yaxes\": [\n {\n \"$$hashKey\": \"object:337\",\n \"format\": \"s\",\n \"label\": \"\",\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": true\n },\n {\n \"$$hashKey\": \"object:338\",\n \"format\": \"short\",\n \"label\": null,\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": false\n }\n ],\n \"yaxis\": {\n \"align\": false,\n \"alignLevel\": null\n }\n },\n {\n \"aliasColors\": {},\n \"bars\": false,\n \"dashLength\": 10,\n \"dashes\": false,\n \"datasource\": \"${DS_PROMETHEUS}\",\n \"description\": \"This panel shows task prefetch time at worker by worker and task name.\",\n \"fieldConfig\": {\n \"defaults\": {},\n \"overrides\": []\n },\n \"fill\": 1,\n \"fillGradient\": 0,\n \"gridPos\": {\n \"h\": 9,\n \"w\": 24,\n \"x\": 0,\n \"y\": 17\n },\n \"hiddenSeries\": false,\n \"id\": 12,\n \"legend\": {\n \"alignAsTable\": true,\n \"avg\": true,\n \"current\": true,\n \"max\": true,\n \"min\": true,\n \"show\": true,\n \"total\": false,\n \"values\": true\n },\n \"lines\": true,\n \"linewidth\": 1,\n \"nullPointMode\": \"null\",\n \"options\": {\n \"alertThreshold\": true\n },\n \"percentage\": false,\n \"pluginVersion\": \"7.5.2\",\n \"pointradius\": 2,\n \"points\": false,\n \"renderer\": \"flot\",\n \"seriesOverrides\": [],\n \"spaceLength\": 10,\n \"stack\": false,\n \"steppedLine\": false,\n \"targets\": [\n {\n \"exemplar\": true,\n \"expr\": \"flower_task_prefetch_time_seconds\",\n \"interval\": \"\",\n \"legendFormat\": \"{{task}}, {{worker}}\",\n \"refId\": \"A\"\n }\n ],\n \"thresholds\": [],\n \"timeFrom\": null,\n \"timeRegions\": [],\n \"timeShift\": null,\n \"title\": \"Task Prefetch Time at Worker\",\n \"tooltip\": {\n \"shared\": true,\n \"sort\": 0,\n \"value_type\": \"individual\"\n },\n \"type\": \"graph\",\n \"xaxis\": {\n \"buckets\": null,\n \"mode\": \"time\",\n \"name\": null,\n \"show\": true,\n \"values\": []\n },\n \"yaxes\": [\n {\n \"$$hashKey\": \"object:337\",\n \"format\": \"s\",\n \"label\": \"\",\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": true\n },\n {\n \"$$hashKey\": \"object:338\",\n \"format\": \"short\",\n \"label\": null,\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": false\n }\n ],\n \"yaxis\": {\n \"align\": false,\n \"alignLevel\": null\n }\n },\n {\n \"aliasColors\": {},\n \"bars\": false,\n \"dashLength\": 10,\n \"dashes\": false,\n \"datasource\": \"${DS_PROMETHEUS}\",\n \"description\": \"This panel shows number of tasks prefetched at worker by task and worker name.\",\n \"fieldConfig\": {\n \"defaults\": {},\n \"overrides\": []\n },\n \"fill\": 1,\n \"fillGradient\": 0,\n \"gridPos\": {\n \"h\": 9,\n \"w\": 24,\n \"x\": 0,\n \"y\": 26\n },\n \"hiddenSeries\": false,\n \"id\": 10,\n \"legend\": {\n \"alignAsTable\": true,\n \"avg\": true,\n \"current\": true,\n \"max\": true,\n \"min\": true,\n \"show\": true,\n \"total\": false,\n \"values\": true\n },\n \"lines\": true,\n \"linewidth\": 1,\n \"nullPointMode\": \"null\",\n \"options\": {\n \"alertThreshold\": true\n },\n \"percentage\": false,\n \"pluginVersion\": \"7.5.2\",\n \"pointradius\": 2,\n \"points\": false,\n \"renderer\": \"flot\",\n \"seriesOverrides\": [],\n \"spaceLength\": 10,\n \"stack\": false,\n \"steppedLine\": false,\n \"targets\": [\n {\n \"exemplar\": true,\n \"expr\": \"flower_worker_prefetched_tasks\",\n \"interval\": \"\",\n \"legendFormat\": \"{{task}}, {{worker}}\",\n \"refId\": \"A\"\n }\n ],\n \"thresholds\": [],\n \"timeFrom\": null,\n \"timeRegions\": [],\n \"timeShift\": null,\n \"title\": \"Number of Tasks Prefetched At Worker\",\n \"tooltip\": {\n \"shared\": true,\n \"sort\": 0,\n \"value_type\": \"individual\"\n },\n \"type\": \"graph\",\n \"xaxis\": {\n \"buckets\": null,\n \"mode\": \"time\",\n \"name\": null,\n \"show\": true,\n \"values\": []\n },\n \"yaxes\": [\n {\n \"$$hashKey\": \"object:337\",\n \"format\": \"short\",\n \"label\": \"\",\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": true\n },\n {\n \"$$hashKey\": \"object:338\",\n \"format\": \"short\",\n \"label\": null,\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": false\n }\n ],\n \"yaxis\": {\n \"align\": false,\n \"alignLevel\": null\n }\n },\n {\n \"aliasColors\": {},\n \"bars\": false,\n \"dashLength\": 10,\n \"dashes\": false,\n \"datasource\": \"${DS_PROMETHEUS}\",\n \"description\": \"This panel presents average task success ratio over time by task name.\",\n \"fieldConfig\": {\n \"defaults\": {},\n \"overrides\": []\n },\n \"fill\": 1,\n \"fillGradient\": 0,\n \"gridPos\": {\n \"h\": 7,\n \"w\": 12,\n \"x\": 0,\n \"y\": 35\n },\n \"hiddenSeries\": false,\n \"id\": 2,\n \"legend\": {\n \"alignAsTable\": true,\n \"avg\": false,\n \"current\": true,\n \"max\": true,\n \"min\": true,\n \"show\": true,\n \"total\": false,\n \"values\": true\n },\n \"lines\": true,\n \"linewidth\": 1,\n \"nullPointMode\": \"null\",\n \"options\": {\n \"alertThreshold\": true\n },\n \"percentage\": false,\n \"pluginVersion\": \"7.5.2\",\n \"pointradius\": 2,\n \"points\": false,\n \"renderer\": \"flot\",\n \"seriesOverrides\": [],\n \"spaceLength\": 10,\n \"stack\": false,\n \"steppedLine\": false,\n \"targets\": [\n {\n \"exemplar\": true,\n \"expr\": \"(sum(avg_over_time(flower_events_total{type=\\\"task-succeeded\\\"}[15m])) by (task) / sum(avg_over_time(flower_events_total{type=~\\\"task-failed|task-succeeded\\\"}[15m])) by (task)) * 100\",\n \"interval\": \"\",\n \"legendFormat\": \"{{ task }}\",\n \"refId\": \"A\"\n }\n ],\n \"thresholds\": [],\n \"timeFrom\": null,\n \"timeRegions\": [],\n \"timeShift\": null,\n \"title\": \"Task Success Ratio\",\n \"tooltip\": {\n \"shared\": true,\n \"sort\": 0,\n \"value_type\": \"individual\"\n },\n \"type\": \"graph\",\n \"xaxis\": {\n \"buckets\": null,\n \"mode\": \"time\",\n \"name\": null,\n \"show\": true,\n \"values\": []\n },\n \"yaxes\": [\n {\n \"$$hashKey\": \"object:63\",\n \"format\": \"percent\",\n \"label\": null,\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": true\n },\n {\n \"$$hashKey\": \"object:64\",\n \"format\": \"short\",\n \"label\": null,\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": false\n }\n ],\n \"yaxis\": {\n \"align\": false,\n \"alignLevel\": null\n }\n },\n {\n \"aliasColors\": {},\n \"bars\": false,\n \"dashLength\": 10,\n \"dashes\": false,\n \"datasource\": \"${DS_PROMETHEUS}\",\n \"description\": \"This panel presents average task failure ratio over time by task name.\",\n \"fieldConfig\": {\n \"defaults\": {},\n \"overrides\": []\n },\n \"fill\": 1,\n \"fillGradient\": 0,\n \"gridPos\": {\n \"h\": 7,\n \"w\": 12,\n \"x\": 12,\n \"y\": 35\n },\n \"hiddenSeries\": false,\n \"id\": 7,\n \"legend\": {\n \"alignAsTable\": true,\n \"avg\": false,\n \"current\": true,\n \"max\": true,\n \"min\": true,\n \"show\": true,\n \"total\": false,\n \"values\": true\n },\n \"lines\": true,\n \"linewidth\": 1,\n \"nullPointMode\": \"null\",\n \"options\": {\n \"alertThreshold\": true\n },\n \"percentage\": false,\n \"pluginVersion\": \"7.5.2\",\n \"pointradius\": 2,\n \"points\": false,\n \"renderer\": \"flot\",\n \"seriesOverrides\": [],\n \"spaceLength\": 10,\n \"stack\": false,\n \"steppedLine\": false,\n \"targets\": [\n {\n \"exemplar\": true,\n \"expr\": \"(sum(avg_over_time(flower_events_total{type=\\\"task-failed\\\"}[15m])) by (task) / sum(avg_over_time(flower_events_total{type=~\\\"task-failed|task-succeeded\\\"}[15m])) by (task)) * 100\",\n \"interval\": \"\",\n \"legendFormat\": \"{{ task }}\",\n \"refId\": \"A\"\n }\n ],\n \"thresholds\": [],\n \"timeFrom\": null,\n \"timeRegions\": [],\n \"timeShift\": null,\n \"title\": \"Task Failure Ratio\",\n \"tooltip\": {\n \"shared\": true,\n \"sort\": 0,\n \"value_type\": \"individual\"\n },\n \"type\": \"graph\",\n \"xaxis\": {\n \"buckets\": null,\n \"mode\": \"time\",\n \"name\": null,\n \"show\": true,\n \"values\": []\n },\n \"yaxes\": [\n {\n \"$$hashKey\": \"object:63\",\n \"format\": \"percent\",\n \"label\": null,\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": true\n },\n {\n \"$$hashKey\": \"object:64\",\n \"format\": \"short\",\n \"label\": null,\n \"logBase\": 1,\n \"max\": null,\n \"min\": null,\n \"show\": false\n }\n ],\n \"yaxis\": {\n \"align\": false,\n \"alignLevel\": null\n }\n }\n ],\n \"refresh\": \"10s\",\n \"schemaVersion\": 27,\n \"style\": \"dark\",\n \"tags\": [\n \"celery\",\n \"monitoring\",\n \"flower\"\n ],\n \"templating\": {\n \"list\": []\n },\n \"time\": {\n \"from\": \"now-15m\",\n \"to\": \"now\"\n },\n \"timepicker\": {},\n \"timezone\": \"\",\n \"title\": \"Celery Monitoring\",\n \"uid\": \"3OBI1flGz\",\n \"version\": 9\n}"
},
{
"path": "examples/celeryconfig.py",
"content": "broker_url = 'redis://localhost:6379/0'\ncelery_result_backend = 'redis://localhost:6379/0'\ntask_send_sent_event = False\n"
},
{
"path": "examples/nginx.conf",
"content": "server {\n listen 80;\n\n # with url_prefix=`flower`\n location /flower/ {\n proxy_pass http://localhost:5555;\n }\n}\n"
},
{
"path": "examples/prometheus-alerts.yaml",
"content": "- alert: CeleryWorkerOffline\n expr: flower_worker_online == 0\n for: 2m\n labels:\n severity: critical\n context: celery-worker\n annotations:\n summary: Celery worker offline\n description: Celery worker {{ $labels.worker }} has been offline for more than 2 minutes.\n\n- alert: TaskFailureRatioTooHigh\n expr: (sum(avg_over_time(flower_events_total{type=\"task-failed\"}[15m])) by (task) / sum(avg_over_time(flower_events_total{type=~\"task-failed|task-succeeded\"}[15m])) by (task)) * 100 > 1\n for: 5m\n labels:\n severity: critical\n context: celery-task\n annotations:\n summary: Task Failure Ratio Too High.\n description: Average task failure ratio for task {{ $labels.task }} is {{ $value }}.\n\n- alert: TaskPrefetchTimeTooHigh\n expr: sum(avg_over_time(flower_task_prefetch_time_seconds[15m])) by (task, worker) > 1\n for: 5m\n labels:\n severity: critical\n context: celery-task\n annotations:\n summary: Average Task Prefetch Time Too High.\n description: Average task prefetch time at worker for task {{ $labels.task }} and worker {{ $labels.worker }} is {{ $value }}.\n"
},
{
"path": "examples/pycharm-configurations/Grafana.run.xml",
"content": "\n \n \n \n \n \n \n \n \n \n \n \n \n"
},
{
"path": "examples/pycharm-configurations/Prometheus.run.xml",
"content": "\n \n \n \n \n \n \n \n \n \n \n \n \n"
},
{
"path": "examples/pycharm-configurations/Redis.run.xml",
"content": "\n \n \n \n \n \n \n \n \n \n \n \n \n"
},
{
"path": "examples/tasks.py",
"content": "import os\nimport time\nfrom datetime import datetime\n\nfrom celery import Celery\n\n\napp = Celery(\"tasks\",\n broker=os.environ.get('CELERY_BROKER_URL', 'redis://'),\n backend=os.environ.get('CELERY_RESULT_BACKEND', 'redis'))\napp.conf.accept_content = ['pickle', 'json', 'msgpack', 'yaml']\napp.conf.worker_send_task_events = True\n\n\n@app.task\ndef add(x, y):\n return x + y\n\n\n@app.task\ndef sleep(seconds):\n time.sleep(seconds)\n\n\n@app.task\ndef echo(msg, timestamp=False):\n return \"%s: %s\" % (datetime.now(), msg) if timestamp else msg\n\n\n@app.task\ndef error(msg):\n raise Exception(msg)\n\n\nif __name__ == \"__main__\":\n app.start()\n"
},
{
"path": "flower/__init__.py",
"content": "VERSION = (2, 0, 0)\n__version__ = '.'.join(map(str, VERSION)) + '-dev'\n"
},
{
"path": "flower/__main__.py",
"content": "import sys\nfrom celery.bin.celery import main as _main, celery\nfrom flower.command import flower\n\n\ndef main():\n celery.add_command(flower)\n sys.exit(_main())\n\n\nif __name__ == \"__main__\":\n main()\n"
},
{
"path": "flower/api/__init__.py",
"content": "import os\n\nimport tornado.web\n\nfrom ..utils import strtobool\nfrom ..views import BaseHandler\n\n\nclass BaseApiHandler(BaseHandler):\n def prepare(self):\n enable_api = strtobool(os.environ.get(\n 'FLOWER_UNAUTHENTICATED_API') or \"false\")\n if not (self.application.options.basic_auth or self.application.options.auth) and not enable_api:\n raise tornado.web.HTTPError(\n 401, \"FLOWER_UNAUTHENTICATED_API environment variable is required to enable API without authentication\")\n\n def write_error(self, status_code, **kwargs):\n exc_info = kwargs.get('exc_info')\n log_message = exc_info[1].log_message\n if log_message:\n self.write(log_message)\n self.set_status(status_code)\n self.finish()\n"
},
{
"path": "flower/api/control.py",
"content": "import logging\n\nfrom tornado import web\n\nfrom . import BaseApiHandler\n\nlogger = logging.getLogger(__name__)\n\n\nclass ControlHandler(BaseApiHandler):\n def is_worker(self, workername):\n return workername and workername in self.application.workers\n\n def error_reason(self, workername, response):\n \"extracts error message from response\"\n for res in response:\n try:\n return res[workername].get('error', 'Unknown reason')\n except KeyError:\n pass\n logger.error(\"Failed to extract error reason from '%s'\", response)\n return 'Unknown reason'\n\n\nclass WorkerShutDown(ControlHandler):\n @web.authenticated\n def post(self, workername):\n \"\"\"\nShut down a worker\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/worker/shutdown/celery@worker2 HTTP/1.1\n Content-Length: 0\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json; charset=UTF-8\n\n {\n \"message\": \"Shutting down!\"\n }\n\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 404: unknown worker\n \"\"\"\n if not self.is_worker(workername):\n raise web.HTTPError(404, f\"Unknown worker '{workername}'\")\n\n logger.info(\"Shutting down '%s' worker\", workername)\n self.capp.control.broadcast('shutdown', destination=[workername])\n self.write(dict(message=\"Shutting down!\"))\n\n\nclass WorkerPoolRestart(ControlHandler):\n @web.authenticated\n def post(self, workername):\n \"\"\"\nRestart worker's pool\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/worker/pool/restart/celery@worker2 HTTP/1.1\n Content-Length: 0\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 56\n Content-Type: application/json; charset=UTF-8\n\n {\n \"message\": \"Restarting 'celery@worker2' worker's pool\"\n }\n\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 403: pool restart is not enabled (see CELERYD_POOL_RESTARTS)\n:statuscode 404: unknown worker\n \"\"\"\n if not self.is_worker(workername):\n raise web.HTTPError(404, f\"Unknown worker '{workername}'\")\n\n logger.info(\"Restarting '%s' worker's pool\", workername)\n response = self.capp.control.broadcast(\n 'pool_restart', arguments={'reload': False},\n destination=[workername], reply=True)\n if response and 'ok' in response[0][workername]:\n self.write(dict(message=f\"Restarting '{workername}' worker's pool\"))\n else:\n logger.error(response)\n self.set_status(403)\n reason = self.error_reason(workername, response)\n self.write(f\"Failed to restart the '{workername}' pool: {reason}\")\n\n\nclass WorkerPoolGrow(ControlHandler):\n @web.authenticated\n def post(self, workername):\n \"\"\"\nGrow worker's pool\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/worker/pool/grow/celery@worker2?n=3 HTTP/1.1\n Content-Length: 0\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 58\n Content-Type: application/json; charset=UTF-8\n\n {\n \"message\": \"Growing 'celery@worker2' worker's pool by 3\"\n }\n\n:query n: number of pool processes to grow, default is 1\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 403: failed to grow\n:statuscode 404: unknown worker\n \"\"\"\n\n if not self.is_worker(workername):\n raise web.HTTPError(404, f\"Unknown worker '{workername}'\")\n\n n = self.get_argument('n', default=1, type=int)\n\n logger.info(\"Growing '%s' worker's pool by '%s'\", workername, n)\n response = self.capp.control.pool_grow(\n n=n, reply=True, destination=[workername])\n if response and 'ok' in response[0][workername]:\n self.write(dict(message=f\"Growing '{workername}' worker's pool by {n}\"))\n else:\n logger.error(response)\n self.set_status(403)\n reason = self.error_reason(workername, response)\n self.write(f\"Failed to grow '{workername}' worker's pool: {reason}\")\n\n\nclass WorkerPoolShrink(ControlHandler):\n @web.authenticated\n def post(self, workername):\n \"\"\"\nShrink worker's pool\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/worker/pool/shrink/celery@worker2 HTTP/1.1\n Content-Length: 0\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 60\n Content-Type: application/json; charset=UTF-8\n\n {\n \"message\": \"Shrinking 'celery@worker2' worker's pool by 1\"\n }\n\n:query n: number of pool processes to shrink, default is 1\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 403: failed to shrink\n:statuscode 404: unknown worker\n \"\"\"\n\n if not self.is_worker(workername):\n raise web.HTTPError(404, f\"Unknown worker '{workername}'\")\n\n n = self.get_argument('n', default=1, type=int)\n\n logger.info(\"Shrinking '%s' worker's pool by '%s'\", workername, n)\n response = self.capp.control.pool_shrink(\n n=n, reply=True, destination=[workername])\n if response and 'ok' in response[0][workername]:\n self.write(dict(message=f\"Shrinking '{workername}' worker's pool by {n}\"))\n else:\n logger.error(response)\n self.set_status(403)\n reason = self.error_reason(workername, response)\n self.write(f\"Failed to shrink '{workername}' worker's pool: {reason}\")\n\n\nclass WorkerPoolAutoscale(ControlHandler):\n @web.authenticated\n def post(self, workername):\n \"\"\"\nAutoscale worker pool\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/worker/pool/autoscale/celery@worker2?min=3&max=10 HTTP/1.1\n Content-Length: 0\n Content-Type: application/x-www-form-urlencoded; charset=utf-8\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 66\n Content-Type: application/json; charset=UTF-8\n\n {\n \"message\": \"Autoscaling 'celery@worker2' worker (min=3, max=10)\"\n }\n\n:query min: minimum number of pool processes\n:query max: maximum number of pool processes\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 403: autoscaling is not enabled (see CELERYD_AUTOSCALER)\n:statuscode 404: unknown worker\n \"\"\"\n\n if not self.is_worker(workername):\n raise web.HTTPError(404, f\"Unknown worker '{workername}'\")\n\n min = self.get_argument('min', type=int)\n max = self.get_argument('max', type=int)\n\n logger.info(\"Autoscaling '%s' worker by '%s'\",\n workername, (min, max))\n response = self.capp.control.broadcast(\n 'autoscale', arguments={'min': min, 'max': max},\n destination=[workername], reply=True)\n if response and 'ok' in response[0][workername]:\n self.write(dict(message=f\"Autoscaling '{workername}' worker \"\n \"(min={min}, max={max})\"))\n else:\n logger.error(response)\n self.set_status(403)\n reason = self.error_reason(workername, response)\n self.write(f\"Failed to autoscale '{workername}' worker: {reason}\")\n\n\nclass WorkerQueueAddConsumer(ControlHandler):\n @web.authenticated\n def post(self, workername):\n \"\"\"\nStart consuming from a queue\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/worker/queue/add-consumer/celery@worker2?queue=sample-queue\n Content-Length: 0\n Content-Type: application/x-www-form-urlencoded; charset=utf-8\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 40\n Content-Type: application/json; charset=UTF-8\n\n {\n \"message\": \"add consumer sample-queue\"\n }\n\n:query queue: the name of a new queue\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 403: failed to add consumer\n:statuscode 404: unknown worker\n \"\"\"\n if not self.is_worker(workername):\n raise web.HTTPError(404, f\"Unknown worker '{workername}'\")\n\n queue = self.get_argument('queue')\n\n logger.info(\"Adding consumer '%s' to worker '%s'\",\n queue, workername)\n response = self.capp.control.broadcast(\n 'add_consumer', arguments={'queue': queue},\n destination=[workername], reply=True)\n if response and 'ok' in response[0][workername]:\n self.write(dict(message=response[0][workername]['ok']))\n else:\n logger.error(response)\n self.set_status(403)\n reason = self.error_reason(workername, response)\n self.write(f\"Failed to add '{queue}' consumer to '{workername}' worker: {reason}\")\n\n\nclass WorkerQueueCancelConsumer(ControlHandler):\n @web.authenticated\n def post(self, workername):\n \"\"\"\nStop consuming from a queue\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/worker/queue/cancel-consumer/celery@worker2?queue=sample-queue\n Content-Length: 0\n Content-Type: application/x-www-form-urlencoded; charset=utf-8\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 52\n Content-Type: application/json; charset=UTF-8\n\n {\n \"message\": \"no longer consuming from sample-queue\"\n }\n\n:query queue: the name of queue\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 403: failed to cancel consumer\n:statuscode 404: unknown worker\n \"\"\"\n if not self.is_worker(workername):\n raise web.HTTPError(404, f\"Unknown worker '{workername}'\")\n\n queue = self.get_argument('queue')\n\n logger.info(\"Canceling consumer '%s' from worker '%s'\",\n queue, workername)\n response = self.capp.control.broadcast(\n 'cancel_consumer', arguments={'queue': queue},\n destination=[workername], reply=True)\n if response and 'ok' in response[0][workername]:\n self.write(dict(message=response[0][workername]['ok']))\n else:\n logger.error(response)\n self.set_status(403)\n reason = self.error_reason(workername, response)\n self.write(f\"Failed to cancel '{queue}' consumer from '{workername}' worker: {reason}\")\n\n\nclass TaskRevoke(ControlHandler):\n @web.authenticated\n def post(self, taskid):\n \"\"\"\nRevoke a task\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/task/revoke/1480b55c-b8b2-462c-985e-24af3e9158f9?terminate=true\n Content-Length: 0\n Content-Type: application/x-www-form-urlencoded; charset=utf-8\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 61\n Content-Type: application/json; charset=UTF-8\n\n {\n \"message\": \"Revoked '1480b55c-b8b2-462c-985e-24af3e9158f9'\"\n }\n\n:query terminate: terminate the task if it is running\n:query signal: name of signal to send to process if terminate (default: 'SIGTERM')\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n \"\"\"\n logger.info(\"Revoking task '%s'\", taskid)\n terminate = self.get_argument('terminate', default=False, type=bool)\n signal = self.get_argument('signal', default='SIGTERM', type=str)\n self.capp.control.revoke(taskid, terminate=terminate, signal=signal)\n self.write(dict(message=f\"Revoked '{taskid}'\"))\n\n\nclass TaskTimout(ControlHandler):\n @web.authenticated\n def post(self, taskname):\n \"\"\"\nChange soft and hard time limits for a task\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/task/timeout/tasks.sleep HTTP/1.1\n Content-Length: 44\n Content-Type: application/x-www-form-urlencoded; charset=utf-8\n Host: localhost:5555\n\n soft=30&hard=100&workername=celery%40worker1\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 46\n Content-Type: application/json; charset=UTF-8\n\n {\n \"message\": \"time limits set successfully\"\n }\n\n:query workername: worker name\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 404: unknown task/worker\n \"\"\"\n workername = self.get_argument('workername')\n hard = self.get_argument('hard', default=None, type=float)\n soft = self.get_argument('soft', default=None, type=float)\n\n if taskname not in self.capp.tasks:\n raise web.HTTPError(404, f\"Unknown task '{taskname}'\")\n if workername is not None and not self.is_worker(workername):\n raise web.HTTPError(404, f\"Unknown worker '{workername}'\")\n\n logger.info(\"Setting timeouts for '%s' task (%s, %s)\",\n taskname, soft, hard)\n destination = [workername] if workername is not None else None\n response = self.capp.control.time_limit(\n taskname, reply=True, hard=hard, soft=soft,\n destination=destination)\n\n if response and 'ok' in response[0][workername]:\n self.write(dict(message=response[0][workername]['ok']))\n else:\n logger.error(response)\n self.set_status(403)\n reason = self.error_reason(taskname, response)\n self.write(f\"Failed to set timeouts: '{reason}'\")\n\n\nclass TaskRateLimit(ControlHandler):\n @web.authenticated\n def post(self, taskname):\n \"\"\"\nChange rate limit for a task\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/task/rate-limit/tasks.sleep HTTP/1.1\n Content-Length: 41\n Content-Type: application/x-www-form-urlencoded; charset=utf-8\n Host: localhost:5555\n\n ratelimit=200&workername=celery%40worker1\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 61\n Content-Type: application/json; charset=UTF-8\n\n {\n \"message\": \"new rate limit set successfully\"\n }\n\n:query workername: worker name\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 404: unknown task/worker\n \"\"\"\n workername = self.get_argument('workername')\n ratelimit = self.get_argument('ratelimit')\n\n if taskname not in self.capp.tasks:\n raise web.HTTPError(404, f\"Unknown task '{taskname}'\")\n if workername is not None and not self.is_worker(workername):\n raise web.HTTPError(404, f\"Unknown worker '{workername}'\")\n\n logger.info(\"Setting '%s' rate limit for '%s' task\",\n ratelimit, taskname)\n destination = [workername] if workername is not None else None\n response = self.capp.control.rate_limit(\n taskname, ratelimit, reply=True, destination=destination)\n if response and 'ok' in response[0][workername]:\n self.write(dict(message=response[0][workername]['ok']))\n else:\n logger.error(response)\n self.set_status(403)\n reason = self.error_reason(taskname, response)\n self.write(f\"Failed to set rate limit: '{reason}'\")\n"
},
{
"path": "flower/api/tasks.py",
"content": "import json\nimport logging\nfrom collections import OrderedDict\nfrom datetime import datetime\n\nfrom celery import states\nfrom celery.backends.base import DisabledBackend\nfrom celery.contrib.abortable import AbortableAsyncResult\nfrom celery.result import AsyncResult\nfrom tornado import web\nfrom tornado.escape import json_decode\nfrom tornado.ioloop import IOLoop\nfrom tornado.web import HTTPError\n\nfrom ..utils import tasks\nfrom ..utils.broker import Broker\nfrom . import BaseApiHandler\n\nlogger = logging.getLogger(__name__)\n\n\nclass BaseTaskHandler(BaseApiHandler):\n DATE_FORMAT = '%Y-%m-%d %H:%M:%S.%f'\n\n def get_task_args(self):\n try:\n body = self.request.body\n options = json_decode(body) if body else {}\n except ValueError as e:\n raise HTTPError(400, str(e)) from e\n\n if not isinstance(options, dict):\n raise HTTPError(400, 'invalid options')\n\n args = options.pop('args', [])\n kwargs = options.pop('kwargs', {})\n\n if not isinstance(args, (list, tuple)):\n raise HTTPError(400, 'args must be an array')\n\n return args, kwargs, options\n\n @staticmethod\n def backend_configured(result):\n return not isinstance(result.backend, DisabledBackend)\n\n def write_error(self, status_code, **kwargs):\n self.set_status(status_code)\n\n def update_response_result(self, response, result):\n if result.state == states.FAILURE:\n response.update({'result': self.safe_result(result.result),\n 'traceback': result.traceback})\n else:\n response.update({'result': self.safe_result(result.result)})\n\n def normalize_options(self, options):\n if 'eta' in options:\n options['eta'] = datetime.strptime(options['eta'],\n self.DATE_FORMAT)\n if 'countdown' in options:\n options['countdown'] = float(options['countdown'])\n if 'expires' in options:\n expires = options['expires']\n try:\n expires = float(expires)\n except ValueError:\n expires = datetime.strptime(expires, self.DATE_FORMAT)\n options['expires'] = expires\n\n def safe_result(self, result):\n \"returns json encodable result\"\n try:\n json.dumps(result)\n except TypeError:\n return repr(result)\n return result\n\n\nclass TaskApply(BaseTaskHandler):\n @web.authenticated\n async def post(self, taskname):\n \"\"\"\nExecute a task by name and wait results\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/task/apply/tasks.add HTTP/1.1\n Accept: application/json\n Accept-Encoding: gzip, deflate, compress\n Content-Length: 16\n Content-Type: application/json; charset=utf-8\n Host: localhost:5555\n\n {\n \"args\": [1, 2]\n }\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 71\n Content-Type: application/json; charset=UTF-8\n\n {\n \"state\": \"SUCCESS\",\n \"task-id\": \"c60be250-fe52-48df-befb-ac66174076e6\",\n \"result\": 3\n }\n\n:query args: a list of arguments\n:query kwargs: a dictionary of arguments\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 404: unknown task\n \"\"\"\n args, kwargs, options = self.get_task_args()\n logger.debug(\"Invoking a task '%s' with '%s' and '%s'\",\n taskname, args, kwargs)\n\n try:\n task = self.capp.tasks[taskname]\n except KeyError as exc:\n raise HTTPError(404, f\"Unknown task '{taskname}'\") from exc\n\n try:\n self.normalize_options(options)\n except ValueError as exc:\n raise HTTPError(400, 'Invalid option') from exc\n\n result = task.apply_async(args=args, kwargs=kwargs, **options)\n response = {'task-id': result.task_id}\n\n response = await IOLoop.current().run_in_executor(\n None, self.wait_results, result, response)\n self.write(response)\n\n def wait_results(self, result, response):\n # Wait until task finished and do not raise anything\n result.get(propagate=False)\n # Write results and finish async function\n self.update_response_result(response, result)\n if self.backend_configured(result):\n response.update(state=result.state)\n return response\n\n\nclass TaskAsyncApply(BaseTaskHandler):\n\n @web.authenticated\n def post(self, taskname):\n \"\"\"\nExecute a task\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/task/async-apply/tasks.add HTTP/1.1\n Accept: application/json\n Accept-Encoding: gzip, deflate, compress\n Content-Length: 16\n Content-Type: application/json; charset=utf-8\n Host: localhost:5555\n\n {\n \"args\": [1, 2]\n }\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 71\n Content-Type: application/json; charset=UTF-8\n Date: Sun, 13 Apr 2014 15:55:00 GMT\n\n {\n \"state\": \"PENDING\",\n \"task-id\": \"abc300c7-2922-4069-97b6-a635cc2ac47c\"\n }\n\n:query args: a list of arguments\n:query kwargs: a dictionary of arguments\n:query options: a dictionary of `apply_async` keyword arguments\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 404: unknown task\n \"\"\"\n args, kwargs, options = self.get_task_args()\n logger.debug(\"Invoking a task '%s' with '%s' and '%s'\",\n taskname, args, kwargs)\n\n try:\n task = self.capp.tasks[taskname]\n except KeyError as exc:\n raise HTTPError(404, f\"Unknown task '{taskname}'\") from exc\n\n try:\n self.normalize_options(options)\n except ValueError as exc:\n raise HTTPError(400, 'Invalid option') from exc\n\n result = task.apply_async(args=args, kwargs=kwargs, **options)\n response = {'task-id': result.task_id}\n if self.backend_configured(result):\n response.update(state=result.state)\n self.write(response)\n\n\nclass TaskSend(BaseTaskHandler):\n @web.authenticated\n def post(self, taskname):\n \"\"\"\nExecute a task by name (doesn't require task sources)\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/task/send-task/tasks.add HTTP/1.1\n Accept: application/json\n Accept-Encoding: gzip, deflate, compress\n Content-Length: 16\n Content-Type: application/json; charset=utf-8\n Host: localhost:5555\n\n {\n \"args\": [1, 2]\n }\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 71\n Content-Type: application/json; charset=UTF-8\n\n {\n \"state\": \"SUCCESS\",\n \"task-id\": \"c60be250-fe52-48df-befb-ac66174076e6\"\n }\n\n:query args: a list of arguments\n:query kwargs: a dictionary of arguments\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 404: unknown task\n \"\"\"\n args, kwargs, options = self.get_task_args()\n logger.debug(\"Invoking task '%s' with '%s' and '%s'\",\n taskname, args, kwargs)\n result = self.capp.send_task(\n taskname, args=args, kwargs=kwargs, **options)\n response = {'task-id': result.task_id}\n if self.backend_configured(result):\n response.update(state=result.state)\n self.write(response)\n\n\nclass TaskResult(BaseTaskHandler):\n @web.authenticated\n def get(self, taskid):\n \"\"\"\nGet a task result\n\n**Example request**:\n\n.. sourcecode:: http\n\n GET /api/task/result/c60be250-fe52-48df-befb-ac66174076e6 HTTP/1.1\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 84\n Content-Type: application/json; charset=UTF-8\n\n {\n \"result\": 3,\n \"state\": \"SUCCESS\",\n \"task-id\": \"c60be250-fe52-48df-befb-ac66174076e6\"\n }\n\n:query timeout: how long to wait, in seconds, before the operation times out\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 503: result backend is not configured\n \"\"\"\n timeout = self.get_argument('timeout', None)\n timeout = float(timeout) if timeout is not None else None\n\n result = AsyncResult(taskid)\n if not self.backend_configured(result):\n raise HTTPError(503)\n response = {'task-id': taskid, 'state': result.state}\n\n if timeout:\n result.get(timeout=timeout, propagate=False)\n self.update_response_result(response, result)\n elif result.ready():\n self.update_response_result(response, result)\n self.write(response)\n\n\nclass TaskAbort(BaseTaskHandler):\n @web.authenticated\n def post(self, taskid):\n \"\"\"\nAbort a running task\n\n**Example request**:\n\n.. sourcecode:: http\n\n POST /api/task/abort/c60be250-fe52-48df-befb-ac66174076e6 HTTP/1.1\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 61\n Content-Type: application/json; charset=UTF-8\n\n {\n \"message\": \"Aborted '1480b55c-b8b2-462c-985e-24af3e9158f9'\"\n }\n\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 503: result backend is not configured\n \"\"\"\n logger.info(\"Aborting task '%s'\", taskid)\n\n result = AbortableAsyncResult(taskid)\n if not self.backend_configured(result):\n raise HTTPError(503)\n\n result.abort()\n\n self.write(dict(message=f\"Aborted '{taskid}'\"))\n\n\nclass GetQueueLengths(BaseTaskHandler):\n @web.authenticated\n async def get(self):\n \"\"\"\nReturn length of all active queues\n\n**Example request**:\n\n.. sourcecode:: http\n\n GET /api/queues/length\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 94\n Content-Type: application/json; charset=UTF-8\n\n {\n \"active_queues\": [\n {\"name\": \"celery\", \"messages\": 0},\n {\"name\": \"video-queue\", \"messages\": 5}\n ]\n }\n\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 503: result backend is not configured\n \"\"\"\n app = self.application\n\n http_api = None\n if app.transport == 'amqp' and app.options.broker_api:\n http_api = app.options.broker_api\n\n broker = Broker(app.capp.connection().as_uri(include_password=True),\n http_api=http_api, broker_options=self.capp.conf.broker_transport_options,\n broker_use_ssl=self.capp.conf.broker_use_ssl)\n\n queues = await broker.queues(self.get_active_queue_names())\n self.write({'active_queues': queues})\n\n\nclass ListTasks(BaseTaskHandler):\n @web.authenticated\n def get(self):\n \"\"\"\nList tasks\n\n**Example request**:\n\n.. sourcecode:: http\n\n GET /api/tasks HTTP/1.1\n Host: localhost:5555\n User-Agent: HTTPie/0.8.0\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 1109\n Content-Type: application/json; charset=UTF-8\n Etag: \"b2478118015c8b825f7b88ce6b660e5449746c37\"\n Server: TornadoServer/3.1.1\n\n {\n \"e42ceb2d-8730-47b5-8b4d-8e0d2a1ef7c9\": {\n \"args\": \"[3, 4]\",\n \"client\": null,\n \"clock\": 1079,\n \"eta\": null,\n \"exception\": null,\n \"exchange\": null,\n \"expires\": null,\n \"failed\": null,\n \"kwargs\": \"{}\",\n \"name\": \"tasks.add\",\n \"received\": 1398505411.107885,\n \"result\": \"'7'\",\n \"retried\": null,\n \"retries\": 0,\n \"revoked\": null,\n \"routing_key\": null,\n \"runtime\": 0.01610181899741292,\n \"sent\": null,\n \"started\": 1398505411.108985,\n \"state\": \"SUCCESS\",\n \"succeeded\": 1398505411.124802,\n \"timestamp\": 1398505411.124802,\n \"traceback\": null,\n \"uuid\": \"e42ceb2d-8730-47b5-8b4d-8e0d2a1ef7c9\",\n \"worker\": \"celery@worker1\"\n },\n \"f67ea225-ae9e-42a8-90b0-5de0b24507e0\": {\n \"args\": \"[1, 2]\",\n \"client\": null,\n \"clock\": 1042,\n \"eta\": null,\n \"exception\": null,\n \"exchange\": null,\n \"expires\": null,\n \"failed\": null,\n \"kwargs\": \"{}\",\n \"name\": \"tasks.add\",\n \"received\": 1398505395.327208,\n \"result\": \"'3'\",\n \"retried\": null,\n \"retries\": 0,\n \"revoked\": null,\n \"routing_key\": null,\n \"runtime\": 0.012884548006695695,\n \"sent\": null,\n \"started\": 1398505395.3289,\n \"state\": \"SUCCESS\",\n \"succeeded\": 1398505395.341089,\n \"timestamp\": 1398505395.341089,\n \"traceback\": null,\n \"uuid\": \"f67ea225-ae9e-42a8-90b0-5de0b24507e0\",\n \"worker\": \"celery@worker1\"\n }\n }\n\n:query limit: maximum number of tasks\n:query offset: skip first n tasks\n:query sort_by: sort tasks by attribute (name, state, received, started)\n:query workername: filter task by workername\n:query taskname: filter tasks by taskname\n:query state: filter tasks by state\n:query received_start: filter tasks by received date (must be greater than) format %Y-%m-%d %H:%M\n:query received_end: filter tasks by received date (must be less than) format %Y-%m-%d %H:%M\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n \"\"\"\n app = self.application\n limit = self.get_argument('limit', None)\n offset = self.get_argument('offset', default=0, type=int)\n worker = self.get_argument('workername', None)\n type = self.get_argument('taskname', None)\n state = self.get_argument('state', None)\n received_start = self.get_argument('received_start', None)\n received_end = self.get_argument('received_end', None)\n sort_by = self.get_argument('sort_by', None)\n search = self.get_argument('search', None)\n\n limit = limit and int(limit)\n offset = max(offset, 0)\n worker = worker if worker != 'All' else None\n type = type if type != 'All' else None\n state = state if state != 'All' else None\n\n result = []\n for task_id, task in tasks.iter_tasks(\n app.events, limit=limit, offset=offset, sort_by=sort_by, type=type,\n worker=worker, state=state,\n received_start=received_start,\n received_end=received_end,\n search=search\n ):\n task = tasks.as_dict(task)\n worker = task.pop('worker', None)\n if worker is not None:\n task['worker'] = worker.hostname\n result.append((task_id, task))\n self.write(OrderedDict(result))\n\n\nclass ListTaskTypes(BaseTaskHandler):\n @web.authenticated\n def get(self):\n \"\"\"\nList (seen) task types\n\n**Example request**:\n\n.. sourcecode:: http\n\n GET /api/task/types HTTP/1.1\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 44\n Content-Type: application/json; charset=UTF-8\n\n {\n \"task-types\": [\n \"tasks.add\",\n \"tasks.sleep\"\n ]\n }\n\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n \"\"\"\n seen_task_types = self.application.events.state.task_types()\n\n response = {}\n response['task-types'] = seen_task_types\n self.write(response)\n\n\nclass TaskInfo(BaseTaskHandler):\n @web.authenticated\n def get(self, taskid):\n \"\"\"\nGet a task info\n\n**Example request**:\n\n.. sourcecode:: http\n\n GET /api/task/info/91396550-c228-4111-9da4-9d88cfd5ddc6 HTTP/1.1\n Accept: */*\n Accept-Encoding: gzip, deflate, compress\n Host: localhost:5555\n\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 575\n Content-Type: application/json; charset=UTF-8\n\n {\n \"args\": \"[2, 2]\",\n \"client\": null,\n \"clock\": 25,\n \"eta\": null,\n \"exception\": null,\n \"exchange\": null,\n \"expires\": null,\n \"failed\": null,\n \"kwargs\": \"{}\",\n \"name\": \"tasks.add\",\n \"received\": 1400806241.970742,\n \"result\": \"'4'\",\n \"retried\": null,\n \"retries\": null,\n \"revoked\": null,\n \"routing_key\": null,\n \"runtime\": 2.0037889280356467,\n \"sent\": null,\n \"started\": 1400806241.972624,\n \"state\": \"SUCCESS\",\n \"succeeded\": 1400806243.975336,\n \"task-id\": \"91396550-c228-4111-9da4-9d88cfd5ddc6\",\n \"timestamp\": 1400806243.975336,\n \"traceback\": null,\n \"worker\": \"celery@worker1\"\n }\n\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n:statuscode 404: unknown task\n \"\"\"\n\n task = tasks.get_task_by_id(self.application.events, taskid)\n if not task:\n raise HTTPError(404, f\"Unknown task '{taskid}'\")\n\n response = task.as_dict()\n if task.worker is not None:\n response['worker'] = task.worker.hostname\n\n self.write(response)\n"
},
{
"path": "flower/api/workers.py",
"content": "import asyncio\nimport logging\n\nfrom tornado import web\n\nfrom .control import ControlHandler\n\nlogger = logging.getLogger(__name__)\n\n\nclass ListWorkers(ControlHandler):\n @web.authenticated\n async def get(self):\n \"\"\"\nList workers\n\n**Example request**:\n\n.. sourcecode:: http\n\n GET /api/workers HTTP/1.1\n Host: localhost:5555\n\n**Example response**:\n\n.. sourcecode:: http\n\n HTTP/1.1 200 OK\n Content-Length: 1526\n Content-Type: application/json; charset=UTF-8\n Date: Tue, 28 Jul 2015 01:32:38 GMT\n Etag: \"fcdd75d85a82b4052275e28871d199aac1ece21c\"\n Server: TornadoServer/4.0.2\n\n {\n \"celery@worker1\": {\n \"active_queues\": [\n {\n \"alias\": null,\n \"auto_delete\": false,\n \"binding_arguments\": null,\n \"bindings\": [],\n \"durable\": true,\n \"exchange\": {\n \"arguments\": null,\n \"auto_delete\": false,\n \"delivery_mode\": 2,\n \"durable\": true,\n \"name\": \"celery\",\n \"passive\": false,\n \"type\": \"direct\"\n },\n \"exclusive\": false,\n \"name\": \"celery\",\n \"no_ack\": false,\n \"queue_arguments\": null,\n \"routing_key\": \"celery\"\n }\n ],\n \"conf\": {\n \"CELERYBEAT_SCHEDULE\": {},\n \"CELERY_INCLUDE\": [\n \"celery.app.builtins\",\n \"__main__\"\n ],\n \"CELERY_SEND_TASK_SENT_EVENT\": true,\n \"CELERY_TIMEZONE\": \"UTC\"\n },\n \"registered\": [\n \"tasks.add\",\n \"tasks.echo\",\n \"tasks.error\",\n \"tasks.retry\",\n \"tasks.sleep\"\n ],\n \"stats\": {\n \"broker\": {\n \"alternates\": [],\n \"connect_timeout\": 4,\n \"heartbeat\": null,\n \"hostname\": \"127.0.0.1\",\n \"insist\": false,\n \"login_method\": \"AMQPLAIN\",\n \"port\": 5672,\n \"ssl\": false,\n \"transport\": \"amqp\",\n \"transport_options\": {},\n \"uri_prefix\": null,\n \"userid\": \"guest\",\n \"virtual_host\": \"/\"\n },\n \"clock\": \"918\",\n \"pid\": 90494,\n \"pool\": {\n \"max-concurrency\": 4,\n \"max-tasks-per-child\": \"N/A\",\n \"processes\": [\n 90499,\n 90500,\n 90501,\n 90502\n ],\n \"put-guarded-by-semaphore\": false,\n \"timeouts\": [\n 0,\n 0\n ],\n \"writes\": {\n \"all\": \"100.00%\",\n \"avg\": \"100.00%\",\n \"inqueues\": {\n \"active\": 0,\n \"total\": 4\n },\n \"raw\": \"1\",\n \"total\": 1\n }\n },\n \"prefetch_count\": 16,\n \"rusage\": {\n \"idrss\": 0,\n \"inblock\": 211,\n \"isrss\": 0,\n \"ixrss\": 0,\n \"majflt\": 6,\n \"maxrss\": 26996736,\n \"minflt\": 11450,\n \"msgrcv\": 4968,\n \"msgsnd\": 1227,\n \"nivcsw\": 1367,\n \"nsignals\": 0,\n \"nswap\": 0,\n \"nvcsw\": 1855,\n \"oublock\": 93,\n \"stime\": 0.414564,\n \"utime\": 0.975726\n },\n \"total\": {\n \"tasks.add\": 1\n }\n },\n \"timestamp\": 1438049312.073402\n }\n }\n\n:query refresh: run inspect to get updated list of workers\n:query workername: get info for workername\n:query status: only get worker status info\n:reqheader Authorization: optional OAuth token to authenticate\n:statuscode 200: no error\n:statuscode 401: unauthorized request\n \"\"\"\n refresh = self.get_argument('refresh', default=False, type=bool)\n status = self.get_argument('status', default=False, type=bool)\n workername = self.get_argument('workername', default=None)\n\n if refresh:\n try:\n await asyncio.wait(self.application.update_workers(workername=workername))\n except Exception as e:\n msg = f\"Failed to update workers: {e}\"\n logger.error(msg)\n raise web.HTTPError(503, msg)\n\n if status:\n info = {}\n for name, worker in self.application.events.state.workers.items():\n info[name] = worker.alive\n self.write(info)\n return\n\n if self.application.workers and not refresh and\\\n workername in self.application.workers:\n self.write({workername: self.application.workers[workername]})\n return\n\n if workername and not self.is_worker(workername):\n raise web.HTTPError(404, f\"Unknown worker '{workername}'\")\n\n if workername:\n self.write({workername: self.application.workers[workername]})\n else:\n self.write(self.application.workers)\n"
},
{
"path": "flower/app.py",
"content": "import sys\nimport logging\n\nfrom concurrent.futures import ThreadPoolExecutor\n\nimport celery\nimport tornado.web\n\nfrom tornado import ioloop\nfrom tornado.httpserver import HTTPServer\nfrom tornado.web import url\n\nfrom .urls import handlers as default_handlers\nfrom .events import Events\nfrom .inspector import Inspector\nfrom .options import default_options\n\n\nlogger = logging.getLogger(__name__)\n\n\nif sys.version_info[0] == 3 and sys.version_info[1] >= 8 and sys.platform.startswith('win'):\n import asyncio\n asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())\n\n# pylint: disable=consider-using-f-string\ndef rewrite_handler(handler, url_prefix):\n if isinstance(handler, url):\n return url(\"/{}{}\".format(url_prefix.strip(\"/\"), handler.regex.pattern),\n handler.handler_class, handler.kwargs, handler.name)\n return (\"/{}{}\".format(url_prefix.strip(\"/\"), handler[0]), handler[1])\n\n\nclass Flower(tornado.web.Application):\n pool_executor_cls = ThreadPoolExecutor\n max_workers = None\n\n def __init__(self, options=None, capp=None, events=None,\n io_loop=None, **kwargs):\n handlers = default_handlers\n if options is not None and options.url_prefix:\n handlers = [rewrite_handler(h, options.url_prefix) for h in handlers]\n kwargs.update(handlers=handlers)\n super().__init__(**kwargs)\n self.options = options or default_options\n self.io_loop = io_loop or ioloop.IOLoop.instance()\n self.ssl_options = kwargs.get('ssl_options', None)\n\n self.capp = capp or celery.Celery()\n self.capp.loader.import_default_modules()\n\n self.executor = self.pool_executor_cls(max_workers=self.max_workers)\n self.io_loop.set_default_executor(self.executor)\n\n self.inspector = Inspector(self.io_loop, self.capp, self.options.inspect_timeout / 1000.0)\n\n self.events = events or Events(\n self.capp,\n db=self.options.db,\n persistent=self.options.persistent,\n state_save_interval=self.options.state_save_interval,\n enable_events=self.options.enable_events,\n io_loop=self.io_loop,\n max_workers_in_memory=self.options.max_workers,\n max_tasks_in_memory=self.options.max_tasks)\n self.started = False\n\n def start(self):\n self.events.start()\n\n if not self.options.unix_socket:\n self.listen(self.options.port, address=self.options.address,\n ssl_options=self.ssl_options,\n xheaders=self.options.xheaders)\n else:\n from tornado.netutil import bind_unix_socket\n server = HTTPServer(self)\n socket = bind_unix_socket(self.options.unix_socket, mode=0o777)\n server.add_socket(socket)\n\n self.started = True\n self.update_workers()\n self.io_loop.start()\n\n def stop(self):\n if self.started:\n self.events.stop()\n logging.debug(\"Stopping executors...\")\n self.executor.shutdown(wait=False)\n logging.debug(\"Stopping event loop...\")\n self.io_loop.stop()\n self.started = False\n\n @property\n def transport(self):\n return getattr(self.capp.connection().transport, 'driver_type', None)\n\n @property\n def workers(self):\n return self.inspector.workers\n\n def update_workers(self, workername=None):\n return self.inspector.inspect(workername)\n"
},
{
"path": "flower/command.py",
"content": "import os\nimport sys\nimport atexit\nimport signal\nimport logging\n\nfrom pprint import pformat\n\nfrom logging import NullHandler\n\nimport click\nfrom tornado.options import options\nfrom tornado.options import parse_command_line, parse_config_file\nfrom tornado.log import enable_pretty_logging\nfrom celery.bin.base import CeleryCommand\n\nfrom .app import Flower\nfrom .urls import settings\nfrom .utils import abs_path, prepend_url, strtobool\nfrom .options import DEFAULT_CONFIG_FILE, default_options\nfrom .views.auth import validate_auth_option\n\nlogger = logging.getLogger(__name__)\nENV_VAR_PREFIX = 'FLOWER_'\n\n\ndef sigterm_handler(signum, _):\n logger.info('%s detected, shutting down', signum)\n sys.exit(0)\n\n\n@click.command(cls=CeleryCommand,\n context_settings={\n 'ignore_unknown_options': True\n })\n@click.argument(\"tornado_argv\", nargs=-1, type=click.UNPROCESSED)\n@click.pass_context\ndef flower(ctx, tornado_argv):\n \"\"\"Web based tool for monitoring and administrating Celery clusters.\"\"\"\n warn_about_celery_args_used_in_flower_command(ctx, tornado_argv)\n apply_env_options()\n apply_options(sys.argv[0], tornado_argv)\n\n extract_settings()\n setup_logging()\n\n app = ctx.obj.app\n flower_app = Flower(capp=app, options=options, **settings)\n\n atexit.register(flower_app.stop)\n signal.signal(signal.SIGTERM, sigterm_handler)\n\n if not ctx.obj.quiet:\n print_banner(app, 'ssl_options' in settings)\n\n try:\n flower_app.start()\n except (KeyboardInterrupt, SystemExit):\n pass\n\n\ndef apply_env_options():\n \"apply options passed through environment variables\"\n env_options = filter(is_flower_envvar, os.environ)\n for env_var_name in env_options:\n name = env_var_name.replace(ENV_VAR_PREFIX, '', 1).lower()\n value = os.environ[env_var_name]\n try:\n option = options._options[name] # pylint: disable=protected-access\n except KeyError:\n option = options._options[name.replace('_', '-')] # pylint: disable=protected-access\n if option.multiple:\n value = [option.type(i) for i in value.split(',')]\n else:\n if option.type is bool:\n value = bool(strtobool(value))\n else:\n value = option.type(value)\n setattr(options, name, value)\n\n\ndef apply_options(prog_name, argv):\n \"apply options passed through the configuration file\"\n argv = list(filter(is_flower_option, argv))\n # parse the command line to get --conf option\n parse_command_line([prog_name] + argv)\n try:\n parse_config_file(os.path.abspath(options.conf), final=False)\n parse_command_line([prog_name] + argv)\n except IOError:\n if os.path.basename(options.conf) != DEFAULT_CONFIG_FILE:\n raise\n\n\ndef warn_about_celery_args_used_in_flower_command(ctx, flower_args):\n celery_options = [option for param in ctx.parent.command.params for option in param.opts]\n\n incorrectly_used_args = []\n for arg in flower_args:\n arg_name, _, _ = arg.partition(\"=\")\n if arg_name in celery_options:\n incorrectly_used_args.append(arg_name)\n\n if incorrectly_used_args:\n logger.warning(\n 'You have incorrectly specified the following celery arguments after flower command:'\n ' %s. '\n 'Please specify them after celery command instead following this template: '\n 'celery [celery args] flower [flower args].', incorrectly_used_args\n )\n\n\ndef setup_logging():\n if options.debug and options.logging == 'info':\n options.logging = 'debug'\n enable_pretty_logging()\n else:\n logging.getLogger(\"tornado.access\").addHandler(NullHandler())\n logging.getLogger(\"tornado.access\").propagate = False\n\n\ndef extract_settings():\n settings['debug'] = options.debug\n\n if options.cookie_secret:\n settings['cookie_secret'] = options.cookie_secret\n\n if options.url_prefix:\n for name in ['login_url', 'static_url_prefix']:\n settings[name] = prepend_url(settings[name], options.url_prefix)\n\n if options.auth:\n settings['oauth'] = {\n 'key': options.oauth2_key or os.environ.get('FLOWER_OAUTH2_KEY'),\n 'secret': options.oauth2_secret or os.environ.get('FLOWER_OAUTH2_SECRET'),\n 'redirect_uri': options.oauth2_redirect_uri or os.environ.get('FLOWER_OAUTH2_REDIRECT_URI'),\n }\n\n if options.certfile and options.keyfile:\n settings['ssl_options'] = dict(certfile=abs_path(options.certfile),\n keyfile=abs_path(options.keyfile))\n if options.ca_certs:\n settings['ssl_options']['ca_certs'] = abs_path(options.ca_certs)\n\n if options.auth and not validate_auth_option(options.auth):\n logger.error(\"Invalid '--auth' option: %s\", options.auth)\n sys.exit(1)\n\n\ndef is_flower_option(arg):\n name, _, _ = arg.lstrip('-').partition(\"=\")\n name = name.replace('-', '_')\n return hasattr(options, name)\n\n\ndef is_flower_envvar(name):\n return name.startswith(ENV_VAR_PREFIX) and \\\n name[len(ENV_VAR_PREFIX):].lower() in default_options\n\n\ndef print_banner(app, ssl):\n if not options.unix_socket:\n if options.url_prefix:\n prefix_str = f'/{options.url_prefix}/'\n else:\n prefix_str = ''\n\n logger.info(\n \"Visit me at http%s://%s:%s%s\", 's' if ssl else '',\n options.address or '0.0.0.0', options.port,\n prefix_str\n )\n else:\n logger.info(\"Visit me via unix socket file: %s\", options.unix_socket)\n\n logger.info('Broker: %s', app.connection().as_uri())\n logger.info(\n 'Registered tasks: \\n%s',\n pformat(sorted(app.tasks.keys()))\n )\n logger.debug('Settings: %s', pformat(settings))\n"
},
{
"path": "flower/events.py",
"content": "import collections\nimport logging\nimport shelve\nimport threading\nimport time\nfrom collections import Counter\nfrom functools import partial\n\nfrom celery.events import EventReceiver\nfrom celery.events.state import State\nfrom prometheus_client import Counter as PrometheusCounter\nfrom prometheus_client import Gauge, Histogram\nfrom tornado.ioloop import PeriodicCallback\nfrom tornado.options import options\n\nlogger = logging.getLogger(__name__)\n\nPROMETHEUS_METRICS = None\n\n\ndef get_prometheus_metrics():\n global PROMETHEUS_METRICS # pylint: disable=global-statement\n if PROMETHEUS_METRICS is None:\n PROMETHEUS_METRICS = PrometheusMetrics()\n\n return PROMETHEUS_METRICS\n\n\nclass PrometheusMetrics:\n def __init__(self):\n self.events = PrometheusCounter('flower_events_total', \"Number of events\", ['worker', 'type', 'task'])\n\n self.runtime = Histogram(\n 'flower_task_runtime_seconds',\n \"Task runtime\",\n ['worker', 'task'],\n buckets=options.task_runtime_metric_buckets\n )\n self.prefetch_time = Gauge(\n 'flower_task_prefetch_time_seconds',\n \"The time the task spent waiting at the celery worker to be executed.\",\n ['worker', 'task']\n )\n self.number_of_prefetched_tasks = Gauge(\n 'flower_worker_prefetched_tasks',\n 'Number of tasks of given type prefetched at a worker',\n ['worker', 'task']\n )\n self.worker_online = Gauge('flower_worker_online', \"Worker online status\", ['worker'])\n self.worker_number_of_currently_executing_tasks = Gauge(\n 'flower_worker_number_of_currently_executing_tasks',\n \"Number of tasks currently executing at a worker\",\n ['worker']\n )\n\n\nclass EventsState(State):\n # EventsState object is created and accessed only from ioloop thread\n\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.counter = collections.defaultdict(Counter)\n self.metrics = get_prometheus_metrics()\n\n def event(self, event):\n # Save the event\n super().event(event)\n\n worker_name = event['hostname']\n event_type = event['type']\n\n self.counter[worker_name][event_type] += 1\n\n if event_type.startswith('task-'):\n task_id = event['uuid']\n task = self.tasks.get(task_id)\n task_name = event.get('name', '')\n if not task_name and task_id in self.tasks:\n task_name = task.name or ''\n self.metrics.events.labels(worker_name, event_type, task_name).inc()\n\n runtime = event.get('runtime', 0)\n if runtime:\n self.metrics.runtime.labels(worker_name, task_name).observe(runtime)\n\n task_started = task.started\n task_received = task.received\n\n if event_type == 'task-received' and not task.eta and task_received:\n self.metrics.number_of_prefetched_tasks.labels(worker_name, task_name).inc()\n\n if event_type == 'task-started' and not task.eta and task_started and task_received:\n self.metrics.prefetch_time.labels(worker_name, task_name).set(task_started - task_received)\n self.metrics.number_of_prefetched_tasks.labels(worker_name, task_name).dec()\n\n if event_type in ['task-succeeded', 'task-failed'] and not task.eta and task_started and task_received:\n self.metrics.prefetch_time.labels(worker_name, task_name).set(0)\n\n if event_type == 'worker-online':\n self.metrics.worker_online.labels(worker_name).set(1)\n\n if event_type == 'worker-heartbeat':\n self.metrics.worker_online.labels(worker_name).set(1)\n\n num_executing_tasks = event.get('active')\n if num_executing_tasks is not None:\n self.metrics.worker_number_of_currently_executing_tasks.labels(worker_name).set(num_executing_tasks)\n\n if event_type == 'worker-offline':\n self.metrics.worker_online.labels(worker_name).set(0)\n\n\nclass Events(threading.Thread):\n events_enable_interval = 5000\n\n # pylint: disable=too-many-arguments\n def __init__(self, capp, io_loop, db=None, persistent=False,\n enable_events=True, state_save_interval=0,\n **kwargs):\n threading.Thread.__init__(self)\n self.daemon = True\n\n self.io_loop = io_loop\n self.capp = capp\n\n self.db = db\n self.persistent = persistent\n self.enable_events = enable_events\n self.state = None\n self.state_save_timer = None\n\n if self.persistent:\n logger.debug(\"Loading state from '%s'...\", self.db)\n state = shelve.open(self.db)\n if state:\n self.state = state['events']\n state.close()\n\n if state_save_interval:\n self.state_save_timer = PeriodicCallback(self.save_state,\n state_save_interval)\n\n if not self.state:\n self.state = EventsState(**kwargs)\n\n self.timer = PeriodicCallback(self.on_enable_events,\n self.events_enable_interval)\n\n def start(self):\n threading.Thread.start(self)\n if self.enable_events:\n logger.debug(\"Starting enable events timer...\")\n self.timer.start()\n\n if self.state_save_timer:\n logger.debug(\"Starting state save timer...\")\n self.state_save_timer.start()\n\n def stop(self):\n if self.enable_events:\n logger.debug(\"Stopping enable events timer...\")\n self.timer.stop()\n\n if self.state_save_timer:\n logger.debug(\"Stopping state save timer...\")\n self.state_save_timer.stop()\n\n if self.persistent:\n self.save_state()\n\n def run(self):\n try_interval = 1\n while True:\n try:\n try_interval *= 2\n\n with self.capp.connection() as conn:\n recv = EventReceiver(conn,\n handlers={\"*\": self.on_event},\n app=self.capp)\n try_interval = 1\n logger.debug(\"Capturing events...\")\n recv.capture(limit=None, timeout=None, wakeup=True)\n except (KeyboardInterrupt, SystemExit):\n try:\n import _thread as thread\n except ImportError:\n import thread\n thread.interrupt_main()\n except Exception as e:\n logger.error(\"Failed to capture events: '%s', \"\n \"trying again in %s seconds.\",\n e, try_interval)\n logger.debug(e, exc_info=True)\n time.sleep(try_interval)\n\n def save_state(self):\n logger.debug(\"Saving state to '%s'...\", self.db)\n state = shelve.open(self.db, flag='n')\n state['events'] = self.state\n state.close()\n\n def on_enable_events(self):\n # Periodically enable events for workers\n # launched after flower\n self.io_loop.run_in_executor(None, self.capp.control.enable_events)\n\n def on_event(self, event):\n # Call EventsState.event in ioloop thread to avoid synchronization\n self.io_loop.add_callback(partial(self.state.event, event))\n"
},
{
"path": "flower/inspector.py",
"content": "import collections\nimport logging\nimport time\nfrom functools import partial\n\nlogger = logging.getLogger(__name__)\n\n\nclass Inspector:\n methods = ('stats', 'active_queues', 'registered', 'scheduled',\n 'active', 'reserved', 'revoked', 'conf')\n\n def __init__(self, io_loop, capp, timeout):\n self.io_loop = io_loop\n self.capp = capp\n self.timeout = timeout\n self.workers = collections.defaultdict(dict)\n\n def inspect(self, workername=None):\n feutures = []\n for method in self.methods:\n feutures.append(self.io_loop.run_in_executor(None, partial(self._inspect, method, workername)))\n return feutures\n\n def _on_update(self, workername, method, response):\n info = self.workers[workername]\n info[method] = response\n info['timestamp'] = time.time()\n\n def _inspect(self, method, workername):\n destination = [workername] if workername else None\n inspect = self.capp.control.inspect(timeout=self.timeout, destination=destination)\n\n logger.debug('Sending %s inspect command', method)\n start = time.time()\n result = (\n getattr(inspect, method)()\n if method != 'active'\n else getattr(inspect, method)(safe=True)\n )\n logger.debug(\"Inspect command %s took %.2fs to complete\", method, time.time() - start)\n\n if result is None or 'error' in result:\n logger.warning(\"Inspect method %s failed\", method)\n return\n for worker, response in result.items():\n if response is not None:\n self.io_loop.add_callback(partial(self._on_update, worker, method, response))\n"
},
{
"path": "flower/options.py",
"content": "import types\nfrom secrets import token_urlsafe\n\nfrom prometheus_client import Histogram\nfrom tornado.options import define, options\n\nDEFAULT_CONFIG_FILE = 'flowerconfig.py'\n\n\ndefine(\"port\", default=5555,\n help=\"run on the given port\", type=int)\ndefine(\"address\", default='',\n help=\"run on the given address\", type=str)\ndefine(\"unix_socket\", default='',\n help=\"path to unix socket to bind\", type=str)\ndefine(\"debug\", default=False,\n help=\"run in debug mode\", type=bool)\ndefine(\"inspect_timeout\", default=1000.0, type=float,\n help=\"inspect timeout (in milliseconds)\")\ndefine(\"auth\", default='', type=str,\n help=\"regexp of emails to grant access\")\ndefine(\"basic_auth\", type=str, default=None, multiple=True,\n help=\"enable http basic authentication\")\ndefine(\"oauth2_key\", type=str, default=None,\n help=\"OAuth2 key (requires --auth)\")\ndefine(\"oauth2_secret\", type=str, default=None,\n help=\"OAuth2 secret (requires --auth)\")\ndefine(\"oauth2_redirect_uri\", type=str, default=None,\n help=\"OAuth2 redirect uri (requires --auth)\")\ndefine(\"max_workers\", type=int, default=5000,\n help=\"maximum number of workers to keep in memory\")\ndefine(\"max_tasks\", type=int, default=100000,\n help=\"maximum number of tasks to keep in memory\")\ndefine(\"db\", type=str, default='flower',\n help=\"flower database file\")\ndefine(\"persistent\", type=bool, default=False,\n help=\"enable persistent mode\")\ndefine(\"state_save_interval\", type=int, default=0,\n help=\"state save interval (in milliseconds)\")\ndefine(\"broker_api\", type=str, default=None,\n help=\"inspect broker e.g. http://guest:guest@localhost:15672/api/\")\ndefine(\"ca_certs\", type=str, default=None,\n help=\"SSL certificate authority (CA) file\")\ndefine(\"certfile\", type=str, default=None,\n help=\"SSL certificate file\")\ndefine(\"keyfile\", type=str, default=None,\n help=\"SSL key file\")\ndefine(\"xheaders\", type=bool, default=False,\n help=\"enable support for the 'X-Real-Ip' and 'X-Scheme' headers.\")\ndefine(\"auto_refresh\", default=True,\n help=\"refresh workerss\", type=bool)\ndefine(\"purge_offline_workers\", default=None, type=int,\n help=\"time (in seconds) after which offline workers are purged from workers\")\ndefine(\"cookie_secret\", type=str, default=token_urlsafe(64),\n help=\"secure cookie secret\")\ndefine(\"conf\", default=DEFAULT_CONFIG_FILE,\n help=\"configuration file\")\ndefine(\"enable_events\", type=bool, default=True,\n help=\"periodically enable Celery events\")\ndefine(\"format_task\", type=types.FunctionType, default=None,\n help=\"use custom task formatter\")\ndefine(\"natural_time\", type=bool, default=False,\n help=\"show time in relative format\")\ndefine(\"tasks_columns\", type=str,\n default=\"name,uuid,state,args,kwargs,result,received,started,runtime,worker\",\n help=\"slugs of columns on /tasks/ page, delimited by comma\")\ndefine(\"auth_provider\", default=None, type=str, help=\"auth handler class\")\ndefine(\"url_prefix\", type=str, help=\"base url prefix\")\ndefine(\"task_runtime_metric_buckets\", type=float, default=Histogram.DEFAULT_BUCKETS,\n multiple=True, help=\"histogram latency bucket value\")\n\n\ndefault_options = options\n"
},
{
"path": "flower/static/css/flower.css",
"content": ".bg-green {\n background-color: #f0ffeb;\n}\n\n.dataTables_wrapper {\n border: 1px solid #c7ecb8;\n}\n\n.dataTables_filter input {\n width: 50%;\n text-indent: 5px;\n}\n\n.dataTables_length {\n margin: 10px;\n}\n\ndiv.dataTables_wrapper .dataTables_filter input {\n width: 100%;\n margin: 10px;\n border: 1px solid #c7ecb8;\n}\n\n.dataTables_info {\n padding: 5px;\n}\n\n@media (min-width: 768px) {\n div.dataTables_wrapper .dataTables_filter input {\n width: 500px;\n }\n}\n\n.overflow-auto {\n max-width: 400px;\n text-overflow: ellipsis;\n}\n\n.overflow-auto::-webkit-scrollbar {\n display: none;\n}\n"
},
{
"path": "flower/static/js/flower.js",
"content": "/*jslint browser: true */\n/*global $, WebSocket, jQuery */\n\nvar flower = (function () {\n \"use strict\";\n\n var alertContainer = document.getElementById('alert-container');\n function show_alert(message, type) {\n var wrapper = document.createElement('div');\n wrapper.innerHTML = `\n
\n {% for name in task._fields %}\n {% if name not in ['name', 'uuid', 'state', 'args', 'kwargs', 'result'] and getattr(task, name, None) is not None %}\n
\n
{{ humanize(name) }}
\n
\n {% if name in ['sent', 'received', 'started', 'succeeded', 'retried', 'timestamp', 'failed', 'revoked'] %}\n {{ humanize(getattr(task, name, None), type='time') }}\n {% elif name == 'worker' %}\n {{ task.worker.hostname }}\n {% elif name == 'traceback' %}\n
{{ getattr(task, name, None) }}
\n {% elif name in ['parent_id', 'root_id'] %}\n {{ getattr(task, name, None) }}\n {% elif name == 'children' %}\n {% for child in getattr(task, name, {}) %}\n {{ child.id }}\n \n {% end %}\n {% else %}\n {{ getattr(task, name, None) }}\n {% end %}\n
\n {% if task.timestamp and task.started %}\n {{ '%.2f' % humanize(task.timestamp - task.started) }} sec\n {% end %}\n
\n
{{ task.worker }}
\n
{{ task.exchange }}
\n
{{ task.routing_key }}
\n
{{ task.retries }}
\n
{{ humanize(task.revoked, type='time') }}
\n
{{ task.exception }}
\n
{{ task.expires }}
\n
{{ task.eta }}
\n
\n {% end %}\n \n
\n
\n{% end %}\n"
},
{
"path": "flower/templates/worker.html",
"content": "{% extends \"base.html\" %}\n\n{% block navbar %}\n{% module Template(\"navbar.html\", active_tab=\"workers\") %}\n{% end %}\n\n{% block container %}\n\n{% set other = {key: value for key, value in worker['stats'].items() if key not in\n'pool pid prefetch_count autoscaler consumer broker clock total rusage'.split()} %}\n\n