Skip to content

Getting Started with the App

This document provides a step-by-step tutorial on how to get the App going and how to use it.

Install the App

To install the App, please follow the instructions detailed in the Installation Guide.

First steps with the App

It is recommended to setup Dynamic Groups before setting anything else up.

It is recommended to have two sets of dynamic groups created: general manufacture/device type and agent groups. This is helpful when building Telegraf configs as you can then have generic dynamic groups for the plugin groups and more specific dynamic groups for the agent groups.

Dynamic Group Name Filter Use Case
Cisco IOS-XR Devices with a platform of cisco_iosxr Telegraf Plugin Group - Cisco IOS-XR
Nokia SROS Devices with a platform of nokia_sros Telegraf Plugin Group - Nokia SROS
NA Core Routers Devices with role of "Core" in the "NA" region location (includes both IOS-XR and SROS devices) Telegraf Agent Group

Note

Exact filters, names, and types of Dynamic Groups are up to each individual install. The above are just samples

Setup Git Repositories

The Nautobot Netobs App provides two types of Git Repository:

  1. Telegraf Generated Configs - this is where Telegraf configs and templates are saved to.
  2. Netobs Library - this is where you can import Telegraf data (schemas, plugin groups, plugins, JSON data, and templates).

Neither of these Git Repositories is required, but will make it simpler to get Telegraf configs generated.

Data Import

In order to get configs generated much quicker, importing the Netobs Library provides commonly used schemas, plugin groups, plugins, JSON data, and templates.

Note

This does not apply if you don't have a Git Repository for Netobs Library.

Import Netobs Library

  1. From the Netobs Dashboard, click on the Play button for the Import Netobs Library job.
  2. On the Job Submission page, select all of the objects you want to import.
  3. On the Job Results page, once the job is completed, you should see success and that all of the objects you previously selected have successfully imported.

What are the next steps?

See the Telegraf Workflow or Prometheus Overviewfor the next setup steps.