{ "info": { "author": "Colin Hemmings", "author_email": "colin.hemmings@outlyer.com", "bugtrack_url": null, "classifiers": [], "description": "# Outlyer Plugin\n\napi for definining native Outlyer Plugins\n\n```python\n\nclass Plugin:\n \"\"\"\n The Plugin API.\n Users must derive from this class when implementing a custom Plugin\n \"\"\"\n def collect(self) -> Status:\n \"\"\"Perform collections operations for the provided Target\"\"\"\n\n def gauge(self, name: str, labels: Optional[dict]) -> Gauge:\n \"\"\"Get a Gauge instance for the specified Name/Labels\"\"\"\n\n def counter(self, name: str, labels: Optional[dict]) -> Counter:\n \"\"\"Get a Counter instance for the specified Name/Labels\"\"\"\n\n def get(self, key: str, default: any) -> any:\n \"\"\"Get a Target config property\"\"\"\n```\n\n## Usage\n```python\nfrom outlyer_plugin import Plugin, Status\n\nclass MyPlugin(Plugin):\n def collect(self):\n self.gauge(f'sys.cpu.user.pct').set(55)\n return Status.OK\n\nif __name__ == '__main__':\n # To run the collection\n sys.exit(MyPlugin().run())\n```\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/outlyerapp/outlyer_plugin", "keywords": "outlyer,plugin,metrics,monitoring", "license": "", "maintainer": "", "maintainer_email": "", "name": "outlyer-plugin", "package_url": "https://pypi.org/project/outlyer-plugin/", "platform": "", "project_url": "https://pypi.org/project/outlyer-plugin/", "project_urls": { "Homepage": "https://github.com/outlyerapp/outlyer_plugin" }, "release_url": "https://pypi.org/project/outlyer-plugin/0.0.1/", "requires_dist": null, "requires_python": "", "summary": "Library for building native plugins for the Outlyer monitoring agent", "version": "0.0.1" }, "last_serial": 4682100, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "8a8ebdbc5f7c41ea07b3b4787f810e70", "sha256": "0d79fecf4336de4e65d7d83344264a8f7cb8c584add66cbf4845f5f8bcb43d78" }, "downloads": -1, "filename": "outlyer_plugin-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "8a8ebdbc5f7c41ea07b3b4787f810e70", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5022, "upload_time": "2019-01-10T17:45:50", "url": "https://files.pythonhosted.org/packages/66/2b/faa0b060effb0fb81e718acdf98496bd378e3b15a01afd5fdb9cdb405588/outlyer_plugin-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "69d44ae9f406d8dcc721e8d7a27d435a", "sha256": "d2410a932c1a557f3384b8d6e712639541f65e448740c618157b14514989a797" }, "downloads": -1, "filename": "outlyer-plugin-0.0.1.tar.gz", "has_sig": false, "md5_digest": "69d44ae9f406d8dcc721e8d7a27d435a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4301, "upload_time": "2019-01-10T17:45:52", "url": "https://files.pythonhosted.org/packages/3a/f2/9c3baa12971c30783364f57ea899d9118fb7d496785f060a10b15e5b6306/outlyer-plugin-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8a8ebdbc5f7c41ea07b3b4787f810e70", "sha256": "0d79fecf4336de4e65d7d83344264a8f7cb8c584add66cbf4845f5f8bcb43d78" }, "downloads": -1, "filename": "outlyer_plugin-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "8a8ebdbc5f7c41ea07b3b4787f810e70", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5022, "upload_time": "2019-01-10T17:45:50", "url": "https://files.pythonhosted.org/packages/66/2b/faa0b060effb0fb81e718acdf98496bd378e3b15a01afd5fdb9cdb405588/outlyer_plugin-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "69d44ae9f406d8dcc721e8d7a27d435a", "sha256": "d2410a932c1a557f3384b8d6e712639541f65e448740c618157b14514989a797" }, "downloads": -1, "filename": "outlyer-plugin-0.0.1.tar.gz", "has_sig": false, "md5_digest": "69d44ae9f406d8dcc721e8d7a27d435a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4301, "upload_time": "2019-01-10T17:45:52", "url": "https://files.pythonhosted.org/packages/3a/f2/9c3baa12971c30783364f57ea899d9118fb7d496785f060a10b15e5b6306/outlyer-plugin-0.0.1.tar.gz" } ] }