nautobot/nautobot-plugin-chatops-grafana

Grafana extension for Nautobot Chatops

The code in this repository has been migrated to the Nautobot ChatOps Repository as an integration - read more about it in the ChatOps Docs! As of July 2023 this repository has been FROZEN - all development / issues / discussions for this integration are in the Nautobot ChatOps Repository going forward.

Grafana ChatOps

The Grafana Chatops plugin is a Nautobot extension used with the Nautobot ChatOps base framework to provide all the operational graphs provided by Grafana delivered via chat clients.

Documentation

• Installation Guide
• Getting Started
• Advanced Usage Guide
• FAQ
• Contributing
• Code of Conduct

Usage

For basic usage and getting your first set of Grafana commands added to your chat client, see the Getting Started Guide.

To dive deeper into the Grafana configuration and variables within dashboards, see our Advanced Usage Guide

Contributing

Thank you for your interest in helping to improve the Nautobot Grafana Plugin! Please refer to the contributing guidelines for details.

Project Documentation

Project documentation is generated by mkdocs from the documentation located in the docs folder.
You can configure 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, as changes are saved the docs will be automatically reloaded.

Questions

For any questions or comments, please check the FAQ first and feel free to swing by the Network to Code slack channel (channel #networktocode). Sign up here

Screenshots

• Get Top-Host Bar Gauge specifying the last 12 months:

• Get Successful Automation Jobs Graph specifying the last 12 months and light theme:

• Get Automation Jobs Run Stat chart specifying the last 12 months:

• Get Automation Jobs Run Stat chart specifying the last 12 months using a custom variable of Playbook:

• Get Top-Host Bar Gauge specifying the last 12 months with a Device and Site variable set, prompting in chat:

nautobot-plugin-chatops-grafana's Issues

Cleanup worker.py

especially chat_validate_nautobot_args

Panel Variables Sync: Prompt user for a list of panels to associate variables to.

Proposed Functionality

Currently, the panel variables sync will create and associate a panel variable for each panel in the dashboard. The proposed functionality would also prompt the user with a list of panels in the dashboard to create variables for, rather than all panels.

Implement Timestamp

timestamp logic is currently commented out fix

Plugin not compatible with Nautobot 1.2.3

Environment

• Python version: 3.9
• Nautobot version: 1.2.3
• nautobot-plugin-chatops-grafana version: 1.0.1

Expected Behavior

Plugin should work with Nautobot 1.2.3

Observed Behavior

If this plugin is a requirement, Nautobot will be downgraded to 1.2.2 during install.

Steps to Reproduce

1. Pin Nautobot to 1.2.3 in pyproject.toml
2. Run poetry lock
3. Resolving fails due to Click version requirement of schema-enforcer conflicting with Click requirement of the new Celery version

19:58 $ poetry lock
Updating dependencies
Resolving dependencies... (3.1s)

  SolverProblemError

  Because no versions of celery match >5.2.2,<5.2.3 || >5.2.3,<5.3.0
   and celery (5.2.2) depends on click (>=8.0,<9.0), celery (>=5.2.2,<5.2.3 || >5.2.3,<5.3.0) requires click (>=8.0,<9.0).
  And because celery (5.2.3) depends on click (>=8.0.3,<9.0), celery (>=5.2.2,<5.3.0) requires click (>=8.0,<9.0).
  Because no versions of schema-enforcer match >1.1.1,<2.0.0
   and schema-enforcer (1.1.1) depends on click (>=7.1,<8.0), schema-enforcer (>=1.1.1,<2.0.0) requires click (>=7.1,<8.0).
  Thus, schema-enforcer (>=1.1.1,<2.0.0) is incompatible with celery (>=5.2.2,<5.3.0).
  And because nautobot (1.2.3) depends on celery (>=5.2.2,<5.3.0), schema-enforcer (>=1.1.1,<2.0.0) is incompatible with nautobot (1.2.3).
  So, because nautobot-chatops-grafana depends on both nautobot (1.2.3) and schema-enforcer (^1.1.1), version solving failed.

  at ~/.poetry/lib/poetry/puzzle/solver.py:241 in _solve
      237│             packages = result.packages
      238│         except OverrideNeeded as e:
      239│             return self.solve_in_compatibility_mode(e.overrides, use_latest=use_latest)
      240│         except SolveFailure as e:
    → 241│             raise SolverProblemError(e)
      242│
      243│         results = dict(
      244│             depth_first_search(
      245│                 PackageNode(self._package, packages), aggregate_package_nodes

Migrate configuration to Nautobot models

I should be able to configure grafanas, dashboards, panels, and slack commands through the Nautobot UI

Implement Unit Tests

Implement some unit testing

Schema Validation

Implement shema validation for panels.yaml

Dynamically Determine Neccisary Variables For Panel

Not every panel uses all variables in a dashboard. Possibly filter based on the raw query and the data source type.