opale

package module
v0.0.0-...-88ec88e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 20, 2018 License: MIT Imports: 3 Imported by: 3

README

Opale

Simple Linux monitoring with history saving.

What Opale is

A Linux laptop and desktop monitoring utility with history saving in a local SQLite database. The utility is build around a client-server architecture, with the server saving monitored items (CPU load, memory usage, battery status...) into the database at a given interval, and answering to clients request. A client can be used to display items into a window manager status bar, or to show a graph of values. Watchers could also be implemented to send alerts or notifications or some pre-defined conditions.

What Opale is not

Opale is not a server-monitoring solution, there are already plenty of these which are battle-tested and available for free. Think more of Opale as the Linux version of iStat.

CLI tool

opale-cli get cpu --percentage

Required Elements to Operate

  • Data loading
  • SQLite saving
  • gRPC communication
  • TOML configuration file
  • Use XDG path
  • Leveled logging
  • CLI parameters
  • SQLite cleanup entries
  • SQLite request

Available Monitors

  • CPU
  • RAM
  • Swap
  • Load Average
  • Network i/o
  • Storage i/o
  • Storage status
  • Battery
  • Screen backlight
  • Temperatures
  • Network settings (IP, hostname, SSID...)
  • Process count
  • Kernel version

Features

  • Server:
    • Monitor items
    • Save them in SQLite database
    • TOML configuration file
    • Customizable items
    • Customizable retention policy
    • Customizable saving interval
  • Simple query client:
    • Query server for a given item
    • Customizable answer format
  • Curses client:
    • Show graph of item values
    • Customizable date range
  • Notification watcher:
    • Be alerted via native notifications of an event
    • Advanced customization (rules, histeresis...)
  • PushOver watcher:
    • Be alerted via PushOver of events

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClientConfig

type ClientConfig struct {
	Debug bool
}

type Config

type Config struct {
	Socket  string
	Sensors []string
	Server  ServerConfig
	Client  ClientConfig
}

func LoadConfig

func LoadConfig() (conf Config, err error)

type ServerConfig

type ServerConfig struct {
	Debug     bool
	Interval  uint32
	Retention [3]uint32
}

Directories

Path Synopsis
cmd
cpu
ram

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL