{"id":13582258,"url":"https://github.com/inexio/thola","last_synced_at":"2026-03-14T14:14:39.316Z","repository":{"id":43468758,"uuid":"307712731","full_name":"inexio/thola","owner":"inexio","description":"Tool for monitoring network devices (mainly using SNMP) - monitoring check plugin","archived":false,"fork":false,"pushed_at":"2025-04-02T08:28:18.000Z","size":1248,"stargazers_count":290,"open_issues_count":9,"forks_count":30,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-02T09:31:42.995Z","etag":null,"topics":["checkmk","go","golang","golang-application","icinga","icinga-plugin","icinga-plugins","icinga2","icinga2-plugin","monitoring","nagios","nagios-plugin","sensu-plugin","shinken-plugin","snmp","zabbix"],"latest_commit_sha":null,"homepage":"https://thola.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/inexio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-10-27T13:41:14.000Z","updated_at":"2025-03-16T06:12:05.000Z","dependencies_parsed_at":"2024-01-14T09:32:48.854Z","dependency_job_id":"c50a5e45-d83f-4d37-ac45-bb68cabbb116","html_url":"https://github.com/inexio/thola","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inexio%2Fthola","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inexio%2Fthola/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inexio%2Fthola/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inexio%2Fthola/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inexio","download_url":"https://codeload.github.com/inexio/thola/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247495641,"owners_count":20948089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checkmk","go","golang","golang-application","icinga","icinga-plugin","icinga-plugins","icinga2","icinga2-plugin","monitoring","nagios","nagios-plugin","sensu-plugin","shinken-plugin","snmp","zabbix"],"created_at":"2024-08-01T15:02:32.687Z","updated_at":"2025-12-14T21:16:21.348Z","avatar_url":"https://github.com/inexio.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Thola\n\n\u003cimg align=\"right\" src=\"https://raw.githubusercontent.com/inexio/thola/main/doc/logo.png\" width=\"256\" alt=\"Thola\"\u003e\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/inexio/thola)](https://goreportcard.com/report/github.com/inexio/thola)\n[![GitHub code style](https://img.shields.io/badge/code%20style-uber--go-brightgreen)](https://github.com/uber-go/guide/blob/master/style.md)\n[![GitHub license](https://img.shields.io/badge/license-BSD-blue.svg)](https://github.com/inexio/thola/blob/main/LICENSE)\n[![GitHub branch checks state](https://img.shields.io/github/checks-status/inexio/thola/main)](https://github.com/inexio/thola/actions)\n[![GoDoc doc](https://img.shields.io/badge/docs-online-brightgreen)](https://docs.thola.io)\n\n## Description\n\nA tool for monitoring network devices written in Go.\nIt features a check mode which complies with the [monitoring plugins development guidelines](https://www.monitoring-plugins.org/doc/guidelines.html) and is therefore compatible with Nagios, Icinga, Zabbix, Checkmk, etc.\n\n## Installation\n\nYou can download the latest compiled version for your platform under the \"Releases\" tab or build it yourself:\n\n    git clone https://github.com/inexio/thola.git\n    cd thola\n    go build\n    \n**Note: This requires Go 1.16 or newer**\n\nIf you also want to build the client binary, which can be used for sending requests to a running Thola API, use the following build command:\n   \n    go build --tags client -o thola-client\n\n## Features\n\nThola currently has three main modes of operation with various subcommands:\n\n- `identify` automatically identifies the device and outputs its vendor, model and other properties.\n- `read` reads out values and statistics of the device.\n    - `read available-components` returns the available components for the device.\n    - `read count-interfaces` counts the interfaces.\n    - `read cpu-load` returns the current cpu load of all CPUs.\n    - `read disk` reads storage utilization.\n    - `read hardware-health` reads hardware health information like temperatures and fans.\n    - `read high-availability` reads out the high availability status of a device.\n    - `read interfaces` outputs the interfaces with several values like error counters and statistics.\n    - `read sbc` reads out SBC specific information.\n    - `read memory-usage` reads out the current memory usage.\n    - `read server` outputs server specific information like users and process count.\n    - `read ups` outputs the special values of a UPS device.\n- `check` performs checks that can be used in monitoring systems. Output is by default in check plugin format.\n    - `check cpu-load` checks the average CPU load of all CPUs against given thresholds and outputs the current load of all CPUs as performance data.\n    - `check disk` checks the free space of storages.\n    - `check hardware-health` checks the hardware-health of a device.\n    - `check high-availability` checks the high availability status of a device.\n    - `check identify` compares the device properties with given expectations.\n    - `check interface-metrics` outputs performance data for the interfaces, including special values based on the interface type (e.g. Radio Interface).\n    - `check memory-usage` checks the current memory usage against given thresholds.\n    - `check sbc` checks an SBC device and outputs metrics for each realm and agent as performance data.\n    - `check server` checks server specific information.\n    - `check snmp` checks SNMP reachability.\n    - `check ups` checks if a UPS device has its main voltage applied and outputs additional performance data like battery capacity or current load, and compares them to optionally given thresholds.\n    - `check thola-server` checks reachability of a Thola API.\n\n## Quick Start\n\nUse the `identify` mode to automatically discover some properties of a network device.\n    \n    $ thola identify\n    \n    Usage:\n      thola identify [host] [flags]\nSpecify the address of the network device in the `[host]` argument.\nThe `--format` flag modifies the format of the output. `--format pretty` is set by default and is useful when reading the output manually. Other options are `json` and `xml`.\n\n    $ thola identify 10.204.2.90\n    \n    Device: \n      Class: ceraos/ip10\n      Properties: \n        Vendor: Ceragon\n        Model: IP-10\n        SerialNumber: 00:0A:25:25:77:67\n        OSVersion: 2.9.25-1\nNext we want to print the interfaces of the network device and their relevant data. We use the `read interfaces` command for this.\n\n    $ thola read interfaces 10.204.2.90\n    \n    Interfaces: [8] \n      IfIndex: 1\n      IfDescr: Radio Interface #0\n      IfType: sonet\n      IfMtu: 2430\n      IfSpeed: 367000\n      ...\n      \n      IfIndex: 5001\n      IfDescr: Ethernet #7\n      IfType: ethernetCsmacd\n      IfMtu: 1548\n      IfSpeed: 10000000\n      IfPhysAddress: 00:0A:25:27:57:1E\n      IfAdminStatus: up\n      IfOperStatus: down\n      ...\n\n## API Mode\n\nThola can be executed as a REST API. You can start the API using the `api` command:\n\n    $ thola api\n     ______   __  __     ______     __         ______   \n    /\\__  _\\ /\\ \\_\\ \\   /\\  __ \\   /\\ \\       /\\  __ \\  \n    \\/_/\\ \\/ \\ \\  __ \\  \\ \\ \\/\\ \\  \\ \\ \\____  \\ \\  __ \\ \n       \\ \\_\\  \\ \\_\\ \\_\\  \\ \\_____\\  \\ \\_____\\  \\ \\_\\ \\_\\\n        \\/_/   \\/_/\\/_/   \\/_____/   \\/_____/   \\/_/\\/_/\n    \n    ⇨ http server started on [::]:8237\n    \nFor sending requests to the Thola API you can use the Thola client. When executing the Thola client you can specify the address of the API with the `--target-api` flag.\n\n    $ thola-client identify 10.204.2.90 --target-api http://192.168.10.20:8237 \n    \n    Device: \n      Class: ceraos/ip10\n        Properties: \n          Vendor: Ceragon\n          Model: IP-10\n          SerialNumber: 00:0A:25:25:77:67\n          OSVersion: 2.9.25-1\n        \nYou can find the full API documentation on our [SwaggerHub](https://app.swaggerhub.com/apis-docs/thola/thola/1.0.0).\n\n## Supported Devices\n\nWe support a lot of different devices and hope for your contributions to grow our device collection. Some examples are:\n\n- Cisco\n- Juniper\n- Huawei\n- Nokia/ISAM\n- Ceragon\n- Brocade\n- Edgecore\n- ...\n\nBasic interface readout is supported for every device.\n\n## Supported Protocols\n\nCurrently we mostly work with SNMP, but already provide basic features for HTTP(S).\nWe plan to support more protocols like telnet, SSH and more.\n\n## Tests\n\nYou can run our test located in the `test` directory with the `go test` command if you have Docker and Docker Compose installed. \n\nIf you want to add your own devices  to the tests you can put your SNMP recordings in the `testdata/devices` folder.\nAfter that you just need to run the script located in `create_testdata` to create the expectation files and your devices are included in the testsuite!\n\n## Contribution\n\nWe are always looking forward to your ideas and suggestions.\n\nIf you want to help us please make sure that your code is conform to our coding style.\n\nHappy coding!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finexio%2Fthola","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finexio%2Fthola","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finexio%2Fthola/lists"}