Giter VIP home page Giter VIP logo

minituff / nutcase Goto Github PK

View Code? Open in Web Editor NEW

This project forked from arthurmitchell42/nutcase

0.0 0.0 0.0 5.57 MB

A NUT and APCd UPS data conversion bridge and graphic UI to link to both Prometheus metrics and JSON format for HomePage/Uptime Kuma etc.

Home Page: https://arthurmitchell42.github.io/nutcase/

License: GNU General Public License v3.0

Shell 2.58% JavaScript 12.02% Python 68.61% CSS 1.79% HTML 14.28% Dockerfile 0.72%

nutcase's Introduction

NUTCase

Release Docker Image Size Docker Pulls Docker Stars

Docker Build Docker build and push release tag & latest

s

A Network UPS Tools (NUT) and APC daemon exporter working with Prometheus and any JSON compatible application and GUI

Key features

  • Acts as a drop in replacement for other NUT scrapers such as HON95 prometheus nut exporter
  • A graphic interface showing key data over time with diagnostic information.
  • Supports pulling data from NUT and APC servers, formatting the UPS metrics for the Prometheus logging system
  • Supports formatting the UPS data as JSON for use with the beautiful HomePage app.
  • The JSON output can be used with Uptime Kuma and other reporting, alerting and monitoring apps.
  • Provides diagnostic and usage information.
  • Supports APC apcupsd servers for graphic display and metric scraping - Use one Prometheus and Grafana dashboard for all servers.
  • Supports filtering of JSON elements to support simple monitoring apps. See Filtering the JSON

image

What it does for you

Structure

NUTCase sits between any nuber of UPS servers, either NUT or APC, and converts the UPS parameters in to either text metrics suitable for use with data caputre systems like Prometheus or JSON. The JSON is ideal for monitoring or display on dashboard systems such as HomePage.

The docker container:

https://hub.docker.com/repository/docker/kronos443/nutcase

Source code:

https://github.com/ArthurMitchell42/nutcase

The Wiki for usage information and advice:

https://github.com/ArthurMitchell42/nutcase/wiki

Supported Architectures

Currently supports 'AMD64', 'ARM64 (ARM64V8)' (suitable for running on docker under Raspberry PI with a 64-bit OS such as Raspberry PI OS 64-bit and Ubuntu 64-bit)'

Architecture Tag
AMD64 latest-amd64 For PC and Synology DSM
ARM64V8 (ARM64) arm64v8-latest. For Raspberry PI with a 64-bit OS (RaspberryPI OS 64-bit or Ubuntu 64-bit

Contents

History & Versions

Date Version Notes
7/3/2024 0.3.3 Add a check for release updates on the GUI, prep-work for next major release.
22/2/2024 0.3.2 Correct re-work of cl-count miss reading data
19/2/2024 0.3.1 Fix for start crash Re missing config file
3/2/2024 0.3.0 New GUI and many more features.
12/1/2024 0.2.2 Corrected potential crash re rework->ratio.
22/12/2023 0.2.1 Corrected error relating to the query port command.
16/12/2023 0.2.0 APC Support with other features, See GitHub notes.
01/12/2023 0.1.0 Initial release.

Contents

Getting started

Using NUTCase

Advanced useage

Contents

Credits

Credit goes to the HON95 container which gave inspiration to the metrics function.

Contents

Support

If you find this container useful then please consider buying me a coffee by following this link or scanning the QR below. ๐Ÿ˜ƒ โ˜•

Please consider donating

Contents

nutcase's People

Contributors

arthurmitchell42 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.