{ "info": { "author": "Hirad Yazdanpanah", "author_email": "hirad.y@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: POSIX", "Programming Language :: Python :: 2.7" ], "description": "NGINX Amplify Agent Health Check\n================================\n\n|PyPI version| |Python versions| |License|\n\n|CircleCI| |Coverage Status| |Code Health| |Requirements Status|\n\nSetup\n-----\n\n.. code:: console\n\n pip install nginx-amplify-agent-health-check\n\ncustom config file (in ini format):\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n.. code:: ini\n\n [options]\n heading=Amplify Agent Health Check Analysis\n\n # Amplify\n amplify_agent_path=/opt/nginx-amplify-agent\n amplify_reqs_file=/packages/nginx-amplify-agent/requirements\n amplify_conf_file=/etc/amplify-agent/agent.conf\n amplify_log_file=/var/log/amplify-agent/agent.log\n amplify_pid_file=/var/run/amplify-agent/amplify-agent.pid\n\n # Nginx\n nginx_all_confs_path=/etc/nginx\n nginx_conf_file=/etc/nginx/nginx.conf\n nginx_status_conf_file=/etc/nginx/conf.d/stub_status.conf\n nginx_sites_available_conf_files=/etc/nginx/sites-available/*.conf\n nginx_sites_enabled_conf_files=/etc/nginx/sites-enabled/*.conf\n nginx_mime_types_file=/etc/nginx/mime.types\n nginx_log_files=/var/log/nginx/*.log\n nginx_pid_file=/var/run/nginx.pid\n nginx_additional_metrics=[\n 'sn=\"$server_name\"',\n 'rt=$request_time',\n 'ua=\"$upstream_addr\"',\n 'us=\"$upstream_status\"',\n 'ut=\"$upstream_response_time\"',\n 'ul=\"$upstream_response_length\"',\n 'cs=$upstream_cache_status'\n ]\n\n # System\n system_packages=[\n 'python', 'python-dev',\n 'git',\n 'util-linux', 'procps',\n 'curl', # 'wget',\n 'gcc', 'musl-dev', 'linux-headers'\n ]\n system_find_package_command=['apk', 'info']\n system_time_diff_max_allowance=80\n\n**Note**: custom config file doesn't need to have all the attributes of\nthe original config file as it will only override the specified\nattributes. But it has to follow the ini formatting.\n\nUsage\n-----\n\nvia cli interface:\n^^^^^^^^^^^^^^^^^^\n\n.. code:: console\n\n amphc\n\ncli options\n'''''''''''\n\n.. code:: console\n\n usage: amphc [-h] [-V] [-v] [-d] [-c CONFIG_FILE]\n [-x SKIP_METHODS [SKIP_METHODS ...] | -m METHODS [METHODS ...]]\n\n Static and Dynamic Analysis for nginx-amplify-agent Health Status\n\n optional arguments:\n -h, --help show this help message and exit\n -V, --version show program's version information and exit\n -v, --verbose show all check logs\n -d, --plain suppress decorating logs\n -c CONFIG_FILE, --config CONFIG_FILE\n set configuration file path (i.e. in ini format)\n -x SKIP_METHODS [SKIP_METHODS ...], --skip SKIP_METHODS [SKIP_METHODS ...]\n specify methods to skip running\n -m METHODS [METHODS ...], --methods METHODS [METHODS ...]\n specify methods to run\n\n verification methods:\n ---------------------\n 1) verify_agent_log\n 2) verify_agent_ps\n 3) verify_agent_user\n 4) verify_all_packages\n 5) verify_dns_resolver\n 6) verify_metrics_collection\n 7) verify_ngx_config_files_access\n 8) verify_ngx_logs_read_access\n 9) verify_ngx_master_ps\n 10) verify_ngx_metrics\n 11) verify_ngx_stub_status\n 12) verify_outbound_tls_access\n 13) verify_proc_sys_access\n 14) verify_py_pkgs\n 15) verify_sys_pkgs\n 16) verify_sys_ps_access\n 17) verify_sys_time\n\nvia api interface:\n^^^^^^^^^^^^^^^^^^\n\n.. code:: python\n\n import amplifyhealthcheck as amphc\n\n amphc = amphc.configure(\n config_file='./custom-config.cfg' # custom config file path in ini format\n )\n\n amphc.verify_agent_ps()\n amphc.verify_agent_log()\n amphc.verify_agent_user()\n\n amphc.verify_ngx_master_ps()\n amphc.verify_ngx_stub_status()\n amphc.verify_ngx_logs_read_access()\n amphc.verify_ngx_config_files_access()\n amphc.verify_ngx_metrics()\n\n amphc.verify_all_packages()\n amphc.verify_sys_time()\n amphc.verify_sys_ps_access()\n amphc.verify_outbound_tls_access()\n amphc.verify_proc_sys_access()\n amphc.verify_dns_resolver()\n amphc.verify_metrics_collection()\n\n.. |PyPI version| image:: https://img.shields.io/pypi/v/nginx-amplify-agent-health-check.svg\n :target: https://pypi.org/project/nginx-amplify-agent-health-check\n.. |Python versions| image:: https://img.shields.io/pypi/pyversions/nginx-amplify-agent-health-check.svg\n :target: https://pypi.org/project/nginx-amplify-agent-health-check\n.. |License| image:: https://img.shields.io/pypi/l/nginx-amplify-agent-health-check.svg\n :target: https://github.com/hiradyazdan/nginx-amplify-agent-health-check/blob/master/LICENSE.txt\n.. |CircleCI| image:: https://circleci.com/gh/hiradyazdan/nginx-amplify-agent-health-check.svg?style=shield&circle-token=592d09559d8a59748ff9d1870a83cb5eb9cc621c\n :target: https://circleci.com/gh/hiradyazdan/nginx-amplify-agent-health-check\n.. |Coverage Status| image:: https://coveralls.io/repos/github/hiradyazdan/nginx-amplify-agent-health-check/badge.svg?branch=master\n :target: https://coveralls.io/github/hiradyazdan/nginx-amplify-agent-health-check?branch=master\n.. |Code Health| image:: https://landscape.io/github/hiradyazdan/nginx-amplify-agent-health-check/master/landscape.svg?style=flat&badge_auth_token=49645f59a46e447e823775fa30645d54\n :target: https://landscape.io/github/hiradyazdan/nginx-amplify-agent-health-check/master\n.. |Requirements Status| image:: https://requires.io/github/hiradyazdan/nginx-amplify-agent-health-check/requirements.svg?branch=master\n :target: https://requires.io/github/hiradyazdan/nginx-amplify-agent-health-check/requirements/?branch=master\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/hiradyazdan/nginx-amplify-agent-health-check", "keywords": "nginx amplify nginx-amplify nginx-configuration health-check metrics", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "nginx-amplify-agent-health-check", "package_url": "https://pypi.org/project/nginx-amplify-agent-health-check/", "platform": "linux", "project_url": "https://pypi.org/project/nginx-amplify-agent-health-check/", "project_urls": { "Homepage": "https://github.com/hiradyazdan/nginx-amplify-agent-health-check" }, "release_url": "https://pypi.org/project/nginx-amplify-agent-health-check/0.1.6/", "requires_dist": null, "requires_python": "", "summary": "Static and Dynamic Analysis for nginx-amplify-agent Health Status", "version": "0.1.6" }, "last_serial": 3914135, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "62e5c7d770c412cc58d5667498059767", "sha256": "45dca0d7f61e75a3a29227e410e3a81678a4606e61e216ec55085fdcd0b04b98" }, "downloads": -1, "filename": "nginx-amplify-agent-health-check-0.1.1.tar.gz", "has_sig": false, "md5_digest": "62e5c7d770c412cc58d5667498059767", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5722, "upload_time": "2018-05-20T14:57:50", "url": "https://files.pythonhosted.org/packages/69/61/dd937e7003b7d61a74cdf939ff1e678b56f4a2eb2a9215a5e7072f899ea0/nginx-amplify-agent-health-check-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "e78cf236f78654d10cb3c685d03bac58", "sha256": "e920685318fd1c4ec2c551d00d23642fe934e6af1eb80cf71f193e13247e9326" }, "downloads": -1, "filename": "nginx-amplify-agent-health-check-0.1.2.tar.gz", "has_sig": false, "md5_digest": "e78cf236f78654d10cb3c685d03bac58", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5877, "upload_time": "2018-05-23T14:12:18", "url": "https://files.pythonhosted.org/packages/54/04/e85b70ae00d90959ee9ed911fa1a6263e6003b0180324d2f3d6a97979e20/nginx-amplify-agent-health-check-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "b39fc51521e9a783e54ac740e2af0447", "sha256": "a946709428f9c8d353cad571ed3f6448a63b80bdfe05e2f165109ed655023028" }, "downloads": -1, "filename": "nginx-amplify-agent-health-check-0.1.3.tar.gz", "has_sig": false, "md5_digest": "b39fc51521e9a783e54ac740e2af0447", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6497, "upload_time": "2018-05-26T13:47:43", "url": "https://files.pythonhosted.org/packages/e1/5a/9d12a6701398e7f25536fc024b44b0af9014df7b7436bb40981d145a87e9/nginx-amplify-agent-health-check-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "c93feac4e82017cf91ef26d3c9a53e36", "sha256": "7ed427a0dd6269ce611f82ab08e6c0978e1e9f4c8fc8353189d678866c256b41" }, "downloads": -1, "filename": "nginx-amplify-agent-health-check-0.1.4.tar.gz", "has_sig": false, "md5_digest": "c93feac4e82017cf91ef26d3c9a53e36", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8717, "upload_time": "2018-05-27T22:57:08", "url": "https://files.pythonhosted.org/packages/a9/87/dd26453b666d2381a44a3140c9baed5ecfd8ae6c73b32c14c5cd5ce64af4/nginx-amplify-agent-health-check-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "5181f8f30ebfb2ce3b74968b7276e7ad", "sha256": "bedad003d26601776dec475432dcbe2c4edf371eee354713f692dc73381ff4e9" }, "downloads": -1, "filename": "nginx-amplify-agent-health-check-0.1.5.tar.gz", "has_sig": false, "md5_digest": "5181f8f30ebfb2ce3b74968b7276e7ad", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10125, "upload_time": "2018-05-29T11:05:35", "url": "https://files.pythonhosted.org/packages/84/af/8a2c32cf3e83256c598243a6c885ffc81a07b5dc720af3199b496feb122c/nginx-amplify-agent-health-check-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "b6ee9ca96e406d05385bd700a6a55a1b", "sha256": "5672150fff1bf56ab7b1a49a156b7f6ddb2367884c0180f4ecbb7f4f086955ea" }, "downloads": -1, "filename": "nginx-amplify-agent-health-check-0.1.6.tar.gz", "has_sig": false, "md5_digest": "b6ee9ca96e406d05385bd700a6a55a1b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10151, "upload_time": "2018-05-30T19:02:10", "url": "https://files.pythonhosted.org/packages/62/aa/d638251d153d637b6bb32cbadd358e7364bd308f05f37fbb16a004e25945/nginx-amplify-agent-health-check-0.1.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b6ee9ca96e406d05385bd700a6a55a1b", "sha256": "5672150fff1bf56ab7b1a49a156b7f6ddb2367884c0180f4ecbb7f4f086955ea" }, "downloads": -1, "filename": "nginx-amplify-agent-health-check-0.1.6.tar.gz", "has_sig": false, "md5_digest": "b6ee9ca96e406d05385bd700a6a55a1b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10151, "upload_time": "2018-05-30T19:02:10", "url": "https://files.pythonhosted.org/packages/62/aa/d638251d153d637b6bb32cbadd358e7364bd308f05f37fbb16a004e25945/nginx-amplify-agent-health-check-0.1.6.tar.gz" } ] }