# The code in this repository has been migrated to the [Nautobot ChatOps Repository](https://github.com/nautobot/nautobot-plugin-chatops) as an integration - read more about it in the [ChatOps Docs](https://docs.nautobot.com/projects/chatops/en/latest/admin/install/)! As of July 2023 this repository has been **FROZEN** - all development / issues / discussions for this integration are in the [Nautobot ChatOps Repository](https://github.com/nautobot/nautobot-plugin-chatops) going forward.
# Grafana ChatOps
The Grafana Chatops plugin is a [Nautobot](https://github.com/nautobot/nautobot) extension used with
the [Nautobot ChatOps](https://github.com/nautobot/nautobot-plugin-chatops/)
base framework to provide all the operational graphs provided by Grafana delivered via chat clients.
## Documentation
* [Installation Guide](docs/installation.md)
* [Getting Started](docs/getting_started.md)
* [Advanced Usage Guide](docs/advanced_usage.md)
* [FAQ](docs/faq.md)
* [Contributing](docs/contributing.md)
* [Code of Conduct](docs/code_of_conduct.md)
## Usage
For basic usage and getting your first set of Grafana commands added to your chat client, see
the [Getting Started Guide](docs/getting_started.md).
To dive deeper into the Grafana configuration and variables within dashboards, see our
[Advanced Usage Guide](docs/advanced_usage.md)
## Contributing
Thank you for your interest in helping to improve the Nautobot Grafana Plugin!
Please refer to the [contributing](docs/contributing.md) guidelines for details.
### Project Documentation
Project documentation is generated by [mkdocs](https://www.mkdocs.org/) from the documentation located in the docs folder.
You can configure [readthedocs.io](https://readthedocs.io/) to point at this folder in your repo.
For development purposes a `docker-compose.docs.yml` is also included.
A container hosting the docs will be started using the invoke commands on [http://localhost:8001](http://localhost:8001),
as changes are saved the docs will be automatically reloaded.
## Questions
For any questions or comments, please check the [FAQ](docs/faq.md) first and feel free to swing by
the [Network to Code slack channel](https://networktocode.slack.com/) (channel #networktocode).
Sign up [here](http://slack.networktocode.com/)
## Screenshots
* Get Top-Host *Bar Gauge* specifying the `last 12 months`:
![Top Hosts P12M](docs/img/ss_top_host_timespan_P12M.png)
* Get Successful Automation Jobs *Graph* specifying the `last 12 months` and `light` theme:
![Top Hosts P12M](docs/img/ss_successful_jobs_lighttheme.png)
* Get Automation Jobs Run *Stat* chart specifying the `last 12 months`:
![Top Hosts P12M](docs/img/ss_jobs_run_P12M.png)
* Get Automation Jobs Run *Stat* chart specifying the `last 12 months` using a custom variable of `Playbook`:
![Top Hosts P12M](docs/img/ss_jobs_run_P12M_w_Playbook.png)
* Get Top-Host *Bar Gauge* specifying the `last 12 months` with a `Device` and `Site` variable set, prompting in chat:
![Top Hosts P12M](docs/img/ss_top_host_variable_prompt.png)
Raw data
{
"_id": null,
"home_page": "https://github.com/nautobot/nautobot-plugin-chatops-grafana",
"name": "nautobot-chatops-grafana",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "nautobot,nautobot-plugin",
"author": "Network to Code, LLC",
"author_email": "opensource@networktocode.com",
"download_url": "https://files.pythonhosted.org/packages/96/3a/7165b362a8bf69b9622b53ab165a782247686559dd5e863501b484ea9449/nautobot_chatops_grafana-1.1.0.tar.gz",
"platform": null,
"description": "# The code in this repository has been migrated to the [Nautobot ChatOps Repository](https://github.com/nautobot/nautobot-plugin-chatops) as an integration - read more about it in the [ChatOps Docs](https://docs.nautobot.com/projects/chatops/en/latest/admin/install/)! As of July 2023 this repository has been **FROZEN** - all development / issues / discussions for this integration are in the [Nautobot ChatOps Repository](https://github.com/nautobot/nautobot-plugin-chatops) going forward.\n\n# Grafana ChatOps \n\nThe Grafana Chatops plugin is a [Nautobot](https://github.com/nautobot/nautobot) extension used with \nthe [Nautobot ChatOps](https://github.com/nautobot/nautobot-plugin-chatops/)\nbase framework to provide all the operational graphs provided by Grafana delivered via chat clients.\n\n## Documentation\n * [Installation Guide](docs/installation.md)\n * [Getting Started](docs/getting_started.md)\n * [Advanced Usage Guide](docs/advanced_usage.md)\n * [FAQ](docs/faq.md)\n * [Contributing](docs/contributing.md)\n * [Code of Conduct](docs/code_of_conduct.md)\n\n\n## Usage\n\nFor basic usage and getting your first set of Grafana commands added to your chat client, see\nthe [Getting Started Guide](docs/getting_started.md).\n\nTo dive deeper into the Grafana configuration and variables within dashboards, see our \n[Advanced Usage Guide](docs/advanced_usage.md)\n\n## Contributing\n\nThank you for your interest in helping to improve the Nautobot Grafana Plugin! \nPlease refer to the [contributing](docs/contributing.md) guidelines for details.\n\n### Project Documentation\n\nProject documentation is generated by [mkdocs](https://www.mkdocs.org/) from the documentation located in the docs folder. \nYou can configure [readthedocs.io](https://readthedocs.io/) to point at this folder in your repo. \nFor development purposes a `docker-compose.docs.yml` is also included. \n A container hosting the docs will be started using the invoke commands on [http://localhost:8001](http://localhost:8001), \n as changes are saved the docs will be automatically reloaded.\n\n## Questions\n\nFor any questions or comments, please check the [FAQ](docs/faq.md) first and feel free to swing by \nthe [Network to Code slack channel](https://networktocode.slack.com/) (channel #networktocode).\nSign up [here](http://slack.networktocode.com/)\n\n## Screenshots\n\n* Get Top-Host *Bar Gauge* specifying the `last 12 months`:\n![Top Hosts P12M](docs/img/ss_top_host_timespan_P12M.png)\n\n* Get Successful Automation Jobs *Graph* specifying the `last 12 months` and `light` theme:\n![Top Hosts P12M](docs/img/ss_successful_jobs_lighttheme.png)\n\n* Get Automation Jobs Run *Stat* chart specifying the `last 12 months`:\n![Top Hosts P12M](docs/img/ss_jobs_run_P12M.png)\n\n* Get Automation Jobs Run *Stat* chart specifying the `last 12 months` using a custom variable of `Playbook`:\n![Top Hosts P12M](docs/img/ss_jobs_run_P12M_w_Playbook.png)\n\n* Get Top-Host *Bar Gauge* specifying the `last 12 months` with a `Device` and `Site` variable set, prompting in chat:\n![Top Hosts P12M](docs/img/ss_top_host_variable_prompt.png)\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Nautobot Plugin Chatops Grafana",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/nautobot/nautobot-plugin-chatops-grafana",
"Repository": "https://github.com/nautobot/nautobot-plugin-chatops-grafana"
},
"split_keywords": [
"nautobot",
"nautobot-plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "040aa08b541e4f9a314ff23cc908c8b9a216c3cb2f497b3017cc5dd942c326d0",
"md5": "bd0e8fa5cd7532f7cfd6ad839d4ff340",
"sha256": "74546753580c1cae4a038a4bcdf6b23ec9a2bc74608019865309090765f8e585"
},
"downloads": -1,
"filename": "nautobot_chatops_grafana-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd0e8fa5cd7532f7cfd6ad839d4ff340",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 62275,
"upload_time": "2023-09-01T09:40:11",
"upload_time_iso_8601": "2023-09-01T09:40:11.665822Z",
"url": "https://files.pythonhosted.org/packages/04/0a/a08b541e4f9a314ff23cc908c8b9a216c3cb2f497b3017cc5dd942c326d0/nautobot_chatops_grafana-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "963a7165b362a8bf69b9622b53ab165a782247686559dd5e863501b484ea9449",
"md5": "273ff7fac867e9c0727c509545275d69",
"sha256": "bd4d14ae9e8bf57f59945229c0e07168ef6264aa4515dcbdca5cacf3a1fc76eb"
},
"downloads": -1,
"filename": "nautobot_chatops_grafana-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "273ff7fac867e9c0727c509545275d69",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 51427,
"upload_time": "2023-09-01T09:40:12",
"upload_time_iso_8601": "2023-09-01T09:40:12.815715Z",
"url": "https://files.pythonhosted.org/packages/96/3a/7165b362a8bf69b9622b53ab165a782247686559dd5e863501b484ea9449/nautobot_chatops_grafana-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-01 09:40:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nautobot",
"github_project": "nautobot-plugin-chatops-grafana",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nautobot-chatops-grafana"
}