Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
door7302 committed Feb 5, 2024
1 parent 7371fd7 commit 5c86279
Show file tree
Hide file tree
Showing 25 changed files with 193 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONFIG.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ sudo vi compose/jtso/config.yml
/.../
protocols:
netconf:
port: 9339
port: 830
/.../
```

Expand Down
191 changes: 191 additions & 0 deletions PROFILES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
# Profiles informations

Each profile is a set of files packed together in a tgz archive. Those tgz files are stored in compose/jtso/profile directory. This folder is monitored, if you push a new version of a profile, this will trigger an automatic update of the stack.

## Router Health profile

Router health KPIs: CPU, Memory, Errors, Drops...

### Sensor path details

### Dashboard screenshots

![health1.png](./img/profiles/health/health1.png)

(1) Select Route
(2) Current Real Time Error – monitored by the ALARMING Telegraf plugin
(3) Current chassis alarms – i.e. show chassis alarms
(4) Current RE Master/Backup CPU & Memory usage
(5) List of all MPC/FPC current CPU & Memory usage
(6) On-Change based Syslog

![health2.png](./img/profiles/health/health2.png)

(1) Details of the current chassis alarms
(2) All past/active MPC/FPC CMERROR
(3) All current router alarms – monitored by the ALARMING Telegraf plugin
(4) Details of all current router alarms – monitored by the ALARMING Telegraf plugin

![health3.png](./img/profiles/health/health3.png)

(1) History of CPU/Memory usage of Nominal/Backup RE
(2) History of CPU/Memory usage of all MPC/FPC

![health4.png](./img/profiles/health/health4.png)

(1) History of CPU consumption of all RE Master Processes
(2) History of CPU usage of each RE Master cores
(3) History of Memory consumption of all RE Master Processes

![health5.png](./img/profiles/health/health5.png)

(1) History of per FPC/MPC Fabric drops
(2) History of per FPC/MPC input Fabric rate (pps)
(3) History of per FPC/MPC output Fabric rate (pps)

## BGP profile

BGP KPIs: peer-groups, families and peers statistics.

### Sensor path details

### Dashboard screenshots

![bgp1.png](./img/profiles/bgp/bgp1.png)

(1) Filter per Router, per Routing-Instance, per Peer-Group, per Family and Per Neighbor
(2) Per Peer-Group (Instance / Name) number of active paths
(3) Per Peer-Group Received/Installed/Sent prefixes
(4) Per family number of active paths
(5) On-Change BGP events

![bgp2.png](./img/profiles/bgp/bgp2.png)

(1) Per neighbor detailed info
(2) For each neighbor: peer name, peer AS, Current session state, Input&Output queues
(3) Per family prefix-limit if configured
(4) History over the time of routes received, installed, rejected by policy, sent
(5) Per Family route details

## Traffic/CoS profile

Traffic KPIs: peer queue statistics, per port statistics, queue-depth, drop per queue/port...

### Sensor path details

### Dashboard screenshots

![traffic1.png](./img/profiles/traffic/traffic1.png)

(1) Filter per router, physical interfaces
(2) Current real-time traffic alarms (RED, TAIL, CRC) drops - monitored by the ALARMING Telegraf plugin
(3) Overall traffic distribution – per Queue
(4) Details of each real-time traffic alarms (point 2)

![traffic2.png](./img/profiles/traffic/traffic2.png)

(1) For each port port statistics – In/Out in bps and pps
(2) For each port – per queue drops (red & tail) over the time

![traffic3.png](./img/profiles/traffic/traffic3.png)

(1) Real time per Queue Depth utilization – current usage
(2) Real time per Queue Depth utilization – peak usage
(3) Traffic distribution per queue for the given port
(4) Queued traffic per queue – in Bps
(5) Real Forwarded traffic per queue – in Bps

![traffic4.png](./img/profiles/traffic/traffic4.png)

(1) Queued traffic per queue – in Bps
(2) Real Forwarded traffic per queue - in Bps
(3) Queued traffic per queue – in pps
(4) Real Forwarded traffic per queue - in pps

## Optic profile

Optic KPIs: Optic levels, Physical errors, per optic details...

### Sensor path details

### Dashboard screenshots

![optic1.png](./img/profiles/optic/optic1.png)

(1) Filter per router and per physical port
(2) Real-time CRC/BLOCK error alarms – monitored by the ALARMING Telegraf plugin
(3) Details of each CRC/BLOCK error alarms over the time
(4) Per port – per lane Current TX, RX, BIAS values

![optic2.png](./img/profiles/optic/optic2.png)

(1) Per port Optic Alarms

![optic3.png](./img/profiles/optic/optic3.png)

(1) For each physical port/optic – per Lane current RX
(2) For each physical port/optic – per Lane current TX
(3) History over the time of each lane RX/TX + low/high warning threshold
(4) History over the time of optic BIAS and temperature
(5) For OTN Optic (i.e. 400G ZR optic) – history over time of the OSNR and pre-FEC correction
(6) History over the time of the CRC and BLOCK errors
(7) Input frame size distributions over the time

## Power profile

Power KPIs: per component power usage, global usage, temperature, fan state...

### Sensor path details

### Dashboard screenshots

![power1.png](./img/profiles/power/power1.png)

(1) Chassis information
(2) Configured Ambient Temperature
(3) Overall chassis power information
(4) In case of multi-zone Chassis – overall zone power information

![power2.png](./img/profiles/power/power2.png)

(1) History over the time of the overall chassis power consumption
(2) Per components power consumption – over time

![power3.png](./img/profiles/power/power3.png)

(1) Per component temperature over the time

![power4.png](./img/profiles/power/power4.png)

(1) Per MPC/FPC current power consumption
(2) History over the time of each MPC/FPC power consumption
(3) Per FAN current power consumption
(4) History over the time of each FAN power consumption

![power5.png](./img/profiles/power/power5.png)

(1) Per FAN current FAN Speed
(2) History over the time of each FAN speed

![power6.png](./img/profiles/power/power6.png)

(1) Per CB/Fabric/RE current power consumption
(2) History over the time of each CB/Fabric/RE power consumption
(3) Per PEM/PSM current power consumption
(4) History over the time of each PEM/PSM power consumption

![power7.png](./img/profiles/power/power7.png)

(1) Total of power consumption
(2) Per Model power consumption
(3) History over the time of the total power consumption
(4) History over the time for each chassis model of the total power consumption

## Firewall profile

FWF KPIs: per firewall term counters, per policer drop counter...

### Sensor path details

### Dashboard screenshots

2 changes: 1 addition & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ sudo docker compose up -d
## Manage the stack via JTSO

Once launched you should have access to the JTSO portal (http or https). Open a web browser and open the portal: **http(s)://your-ip:your-port/index.html**
You should have access to this page - this one provide the state of the OpenJTS.
You should have access to this page - this one provide the state of the OpenJTS. You can also empty the InfluxDB database by clicking on the "EmptyDB" button.

![jtso1.png](./img/jtso1.png)

Expand Down
Binary file modified img/jtso1.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 img/profiles/bgp/bgp1.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 img/profiles/bgp/bgp2.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 img/profiles/health/health1.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 img/profiles/health/health2.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 img/profiles/health/health3.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 img/profiles/health/health4.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 img/profiles/health/health5.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 img/profiles/optic/optic1.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 img/profiles/optic/optic2.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 img/profiles/optic/optic3.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 img/profiles/power/power1.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 img/profiles/power/power2.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 img/profiles/power/power3.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 img/profiles/power/power4.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 img/profiles/power/power5.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 img/profiles/power/power6.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 img/profiles/power/power7.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 img/profiles/traffic/traffic1.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 img/profiles/traffic/traffic2.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 img/profiles/traffic/traffic3.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 img/profiles/traffic/traffic4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5c86279

Please sign in to comment.