Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Telemetry demo #150

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
.DS_Store
site
venv/
clab-om
custom_anta_catalogs
intended
2 changes: 1 addition & 1 deletion .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ MD007:

# line length
MD013:
line_length: 120
line_length: 140
code_block_line_length: 450
tables: false

Expand Down
Binary file added docs/_media/aclabs-telemetryA-grafana-ex1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_media/aclabs-telemetryA-grafana-ex2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_media/aclabs-telemetryA-grafana-ex3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_media/aclabs-telemetryA-grafana-ex4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_media/topology.drawio.light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_media/topology.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions docs/telemetry/adapters/gnmic/prometheus-grafana-demo/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
layout: default
title: "Prometheus and Grafana Demo"
date: 2024-09-21 20:00:00 +0100
categories:
---

## Introduction

This lab deploys a small cEOS-lab topology using containerlab and
uses [gNMIc](https://gnmic.openconfig.net/) to subscribe and collect telemetry states and output
them into [Prometheus](https://prometheus.io/docs/prometheus/latest/getting_started/) and visualize
the data in [Grafana](https://grafana.com/).

## Prerequisite

- github account

- laptop or server with [Docker](https://www.docker.com/) and [git](https://git-scm.com/downloads) installed

- [arista.com] account to download cEOS-lab

cEOS-lab is autodownloaded using the arista.com token in either codespaces or the devcontainer examples.

Check for more details on the prerequisites on the [Arista Community Labs QuickStart](https://aclabs.arista.com/quickstart/).

## Lab Topology

![topology](../../../../_media/topology.drawio.png)

### Running the lab

The lab can be run in multiple ways:

- codespaces

- locally using devcontainer (either on local PC/laptop or using Remote SSH to a server via vscode)

To run it codespaces please press the button below and follow:

<!-- markdownlint-disable -->
[Start :octicons-play-16: gNMIc-Prometheus-Grafana Lab :octicons-mark-github-24:](https://codespaces.new/aristanetworks/aclabs/tree/main?quickstart=1&devcontainer_path=.devcontainer%2Fgnmic-prometheus-grafana%2Fdevcontainer.json){ .md-button .md-button--primary target=_blank}
<!-- markdownlint-enable -->

After the lab is deployed, the containerlab topology will automatically start and Codespaces
will send a notification and reveal the `Open in Browser` button where Grafana can be accessed.

![grafana1](_media/aclabs-telemetryA-grafana-ex1.png)

![grafana2](assets/img/aclabs-telemetryA-grafana-ex2.png)

![grafana3](assets/img/aclabs-telemetryA-grafana-ex3.png)

For more details and to run it in devcontainer please check the
[Arista Community Labs](https://aclabs.arista.com/telemetry) site.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ nav:
- ygot: examples/ygot/index.md
- WiFi: examples/WiFi/index.md
- Telemetry:
- gnmic:
- gnmic-prometheus: telemetry/adapters/gnmic/prometheus-grafana-demo/index.md
- gNMIReverse: telemetry/adapters/gnmireverse/index.md
- kafka-telegraf: telemetry/adapters/kafka/index.md
- Models: models/index.md
Expand Down
Loading