├── .gitignore ├── requirements.txt ├── OIDMAN.png ├── oidman.gif ├── config.py ├── Dockerfile ├── docker-compose.yml ├── README.MD ├── lookups.py ├── templates ├── template.html └── js.js ├── oidman.py └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | .vscode/ 3 | .vscode/settings.json -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | fastapi 2 | jinja2 3 | uvicorn 4 | websockets -------------------------------------------------------------------------------- /OIDMAN.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tbotnz/OIDMAN/HEAD/OIDMAN.png -------------------------------------------------------------------------------- /oidman.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tbotnz/OIDMAN/HEAD/oidman.gif -------------------------------------------------------------------------------- /config.py: -------------------------------------------------------------------------------- 1 | config = { 2 | "listen_ip": "0.0.0.0", 3 | "listen_port": 9012, 4 | "snmpwalk_path": "snmpwalk", #could also be /usr/bin/snmpwalk 5 | } -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine:3.14 2 | RUN apk add python3 3 | RUN apk add py3-pip 4 | RUN apk add net-snmp 5 | RUN apk add net-snmp-tools 6 | ADD . /code 7 | WORKDIR /code 8 | RUN python3 -m pip install -r /code/requirements.txt 9 | 10 | CMD uvicorn oidman:app --reload --port 9002 --host "0.0.0.0" -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | oidman: 5 | build: 6 | context: . 7 | dockerfile: Dockerfile 8 | ports: 9 | - "9002:9002" 10 | restart: always 11 | networks: 12 | - "oidman-network" 13 | networks: 14 | oidman-network: 15 | name: "oidman-network" -------------------------------------------------------------------------------- /README.MD: -------------------------------------------------------------------------------- 1 | # OIDMAN 2 | 3 | #### summary 4 | A simple ui providing fast SNMP polling one or multiple OID's (sub second if supported by your hardware). 5 | 6 | - Built on the tried and true SNMPWalk 7 | - Simple container deployment 8 | - Leverages websockets for near realtime polling 9 | 10 | #### installing 11 | ``` 12 | git clone https://github.com/tbotnz/oidman.git 13 | cd oidman 14 | sudo docker-compose up --build 15 | ``` 16 | 17 | you can then access oidman via ```http://localhost:9002``` 18 | 19 | #### demo 20 | ![oidman demo](/oidman.gif) 21 | 22 | 23 | #### important note 24 | project is experimental, we assume you know what you are doing. 25 | 26 | -------------------------------------------------------------------------------- /lookups.py: -------------------------------------------------------------------------------- 1 | lookup_table = [ 2 | { 3 | "match_str": "Timeticks", 4 | "regexp": r'Timeticks: \((\d+)\)', 5 | "group": 1, 6 | "type": int 7 | }, 8 | { 9 | "match_str": "Counter32", 10 | "regexp": r'Counter32: (\d+)', 11 | "group": 1, 12 | "type": int 13 | }, 14 | { 15 | "match_str": "Counter64", 16 | "regexp": r'Counter64: (\d+)', 17 | "group": 1, 18 | "type": int 19 | }, 20 | { 21 | "match_str": "INTEGER", 22 | "regexp": r'INTEGER: (\d+)', 23 | "group": 1, 24 | "type": int 25 | }, 26 | { 27 | "match_str": "Gauge32", 28 | "regexp": r'Gauge32: (\d+)', 29 | "group": 1, 30 | "type": int 31 | }, 32 | { 33 | "match_str": "Gauge64", 34 | "regexp": r'Gauge64: (\d+)', 35 | "group": 1, 36 | "type": int 37 | }, 38 | ] 39 | -------------------------------------------------------------------------------- /templates/template.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 35 |
36 |
37 | 38 |
39 | 42 |
43 | 44 | -------------------------------------------------------------------------------- /oidman.py: -------------------------------------------------------------------------------- 1 | from fastapi import FastAPI, WebSocket, Request 2 | from fastapi.responses import HTMLResponse 3 | from fastapi.templating import Jinja2Templates 4 | 5 | import subprocess 6 | import asyncio 7 | 8 | from config import config 9 | 10 | from datetime import datetime 11 | 12 | import random 13 | 14 | import re 15 | 16 | from lookups import lookup_table 17 | 18 | app = FastAPI() 19 | templates = Jinja2Templates(directory="templates") 20 | 21 | 22 | async def get_snmp(oid: str, host: str, community: str, resolve: str): 23 | return_result = [] 24 | try: 25 | if resolve: 26 | result = subprocess.check_output( 27 | ["snmpwalk", "-v2c", "-Of", "-c", community, host, oid] 28 | ) 29 | else: 30 | result = subprocess.check_output( 31 | ["snmpwalk", "-v2c", "-On", "-c", community, host, oid] 32 | ) 33 | response = result.decode("utf-8").split("\n") 34 | for message in response: 35 | if message != "": 36 | lookups = lookup_table 37 | for lookup in lookups: 38 | if lookup["match_str"] in message: 39 | match = re.search(lookup["regexp"], message) 40 | if match: 41 | oid = message.split(" = ")[0] 42 | return_result.append( 43 | { 44 | "oid": oid, 45 | "value": lookup["type"](match.group(lookup["group"])), 46 | } 47 | ) 48 | except Exception as e: 49 | print (e) 50 | return return_result 51 | 52 | 53 | @app.get("/", response_class=HTMLResponse) 54 | async def get(request: Request): 55 | return templates.TemplateResponse("template.html", {"request": request}) 56 | 57 | 58 | @app.websocket("/ws") 59 | async def websocket_endpoint(websocket: WebSocket): 60 | await websocket.accept() 61 | while True: 62 | data = await websocket.receive_json() 63 | for lp in range(int(data[0]["polls"])): 64 | result = [] 65 | for payload in data: 66 | await asyncio.sleep(float(data[0]["interval"])) 67 | snmp_pl = await get_snmp( 68 | oid=payload["oid"], 69 | host=payload["host"], 70 | community=payload["community"], 71 | resolve=payload["resolve_oid"], 72 | ) 73 | for snmp_result in snmp_pl: 74 | now = datetime.now() 75 | date_time = now.strftime("%m/%d/%Y, %H:%M:%S") 76 | result.append( 77 | { 78 | "message": payload, 79 | "payload": snmp_result["value"], 80 | "timestamp": date_time, 81 | "chart_key": snmp_result["oid"] + "-" + payload["host"], 82 | } 83 | ) 84 | await websocket.send_json(result) -------------------------------------------------------------------------------- /templates/js.js: -------------------------------------------------------------------------------- 1 | 2 | var charts = { 3 | }; 4 | 5 | var payloads = [ 6 | ]; 7 | 8 | function addData(chartd, label, data, title) { 9 | chartd.data.labels.push(label); 10 | chartd.data.datasets.forEach((dataset) => { 11 | dataset.data.push(data); 12 | }); 13 | chartd.options.title.text = title; 14 | chartd.update(); 15 | } 16 | 17 | var ws = new WebSocket("ws://" + window.location.host + "/ws"); 18 | ws.onmessage = function (event) { 19 | let data = JSON.parse(event.data) 20 | for (const n in data) { 21 | console.log("chart key " + data[n].chart_key); 22 | if ((data[n].chart_key in charts) == false) { 23 | let charte = newChart(data[n].chart_key); 24 | } 25 | let chartdata = charts[data[n].chart_key]; 26 | addData(chartdata, data[n].timestamp, data[n].payload, data[n].chart_key) 27 | } 28 | }; 29 | 30 | function newChart(chart_key) { 31 | 32 | 33 | 34 | let canvas = document.createElement("canvas"); 35 | canvas.setAttribute("id", chart_key); 36 | canvas.setAttribute("height", "300px"); 37 | 38 | let canvasContainer = document.createElement("div"); 39 | canvasContainer.setAttribute("class", "row"); 40 | canvasContainer.appendChild(canvas); 41 | 42 | let card = document.createElement("div"); 43 | card.setAttribute("class", "card bg-dark text-white"); 44 | 45 | let cardbody = document.createElement("div"); 46 | cardbody.setAttribute("class", "card-body"); 47 | cardbody.appendChild(canvasContainer); 48 | card.appendChild(cardbody); 49 | 50 | let row = document.createElement("div"); 51 | row.setAttribute("class", "row"); 52 | row.appendChild(card); 53 | 54 | document.getElementById("chartbox").prepend(row); 55 | 56 | var color = Math.floor(Math.random() * 16777215).toString(16); 57 | const chart = new Chart(document.getElementById(chart_key), { 58 | type: 'line', 59 | data: { 60 | labels: [], 61 | datasets: [{ 62 | borderColor: `#${color}` 63 | }] 64 | }, 65 | options: { 66 | title: { 67 | display: true, 68 | text: '' 69 | }, 70 | responsive: true, 71 | legend: { 72 | labels: { 73 | defaultFontColor: 'white' 74 | }, 75 | display: false 76 | } 77 | } 78 | }); 79 | charts[chart_key] = chart; 80 | return chart; 81 | } 82 | 83 | function sendMessage(event) { 84 | let chart_key = document.getElementById("oid").value + "-" + document.getElementById("host").value; 85 | let data = { 86 | "interval": document.getElementById("interval").value, 87 | "polls": document.getElementById("polls").value, 88 | "oid": document.getElementById("oid").value, 89 | "host": document.getElementById("host").value, 90 | "community": document.getElementById("community").value, 91 | "resolve_oid": document.getElementById("resolve_oid").checked 92 | } 93 | payloads.push(data); 94 | ws.send(JSON.stringify(payloads)); 95 | data = ""; 96 | event.preventDefault() 97 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | --------------------------------------------------------------------------------