Skip to content

App Overview

This document provides an overview of the App, including key capabilities and important considerations when deploying it within a Nautobot environment.

Note

Throughout this documentation, the terms "app" and "plugin" are used interchangeably.

Description

This App extends Nautobot with enhanced observability, diagnostics, and operational tooling to support day-to-day network management and troubleshooting workflows.

It provides a combination of high-level insights dashboards and low-level diagnostic tools, enabling users to both monitor the overall health of their environment and quickly investigate issues when they arise. The App integrates with existing Nautobot data and optional companion apps to deliver a more complete view.

Key capabilities include:

  • Insights Dashboards for inventory, devices, and jobs, with additional dashboards available when companion apps are installed.
  • Network Diagnostic Tools for executing live tests such as ping, traceroute, DNS lookups, HTTP requests, and SSH validation.
  • Troubleshooting and Diagnostics Collection tools for gathering system and environment data, including support for both active and unavailable Nautobot instances.

Audience (User Personas) - Who should use this App?

This App is designed for:

  • Network Engineers: Diagnose connectivity and device-level issues.
  • Network Administrators: Maintain day-to-day network operations and verify system and service functionality.
  • Site Reliability Engineers: Investigate outages, collect diagnostics, and improve operational visibility and response workflows.

Nautobot Features Used

This App leverages several core Nautobot capabilities to deliver its functionality:

  • Jobs Framework: Provides executable workflows for diagnostics, network testing, and data collection.
  • Dashboards and UI Views: Adds custom dashboards for visualizing inventory, job execution, and operational insights.
  • Management Commands: Adds CLI-based tools for diagnostics and health checks.