Metadata-Version: 2.1
Name: nautobot-chatops-grafana
Version: 1.0.1
Summary: Nautobot Plugin Chatops Grafana
Home-page: https://github.com/nautobot/nautobot-plugin-chatops-grafana
License: Apache-2.0
Keywords: nautobot,nautobot-plugin
Author: Network to Code, LLC
Author-email: opensource@networktocode.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: nautobot
Requires-Dist: diffsync (>=1.3.0,<2.0.0)
Requires-Dist: isodate (>=0.6.0,<0.7.0)
Requires-Dist: nautobot (>=1.0.0,<2.0.0); extra == "nautobot"
Requires-Dist: nautobot-chatops (>=1.3.1,<2.0.0)
Requires-Dist: pydantic (>=1.8.2,<2.0.0)
Requires-Dist: schema-enforcer (>=1.1.1,<2.0.0)
Project-URL: Repository, https://github.com/nautobot/nautobot-plugin-chatops-grafana
Description-Content-Type: text/markdown

# 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)

