okerrupdate - client-side okerr module and utilities
Installation
# newer method with pipx
sudo pipx install okerrupdate
# old method with pip3, if you cannot install pipx
sudo pip3 install okerrupdate
sudo okerrmod --init # enable few basic modules, create /etc/cron.d/ job, create okerrupdate config template
sudo vim /etc/okerr/okerrupdate
and modify okerrupdate file:
# Stub for okerrmod
PREFIX=braconnier:
OKERR_TEXTID=
OKERR_SECRET=
OKERR_URL=
OKERR_DIRECT=0
OKERR_MOD_AVAIL=
or provide values to okerrmod --init as option values (e.g. okerrmod --init --textid MyTextid).
Basic usage
okerrupdate utility
okerrupdate is small script which updates/creates indicators in okerr project.
This will create simplest indicator 'myindicator' with all default settings (type 'heartbeat', policy 'Default'). Indicator will send alert if it will be updated to 'ERR' or if will not be updated for some time (Default policy period+patience).
$ okerrupdate myindicator OK
okerr updated (200 OK) myindicator@okerr = OK
This will create numerical indicator 'temp' with current value 36.6, and policy 'Daily'. Will send alert if not updated for a day or if value will be over maxlim (37).
$ okerrupdate -p Daily -m 'numerical|maxlim=37' temp 36.6
okerr updated (200 OK) temp@okerr = 36.6
Project TextID and secret is read from /etc/okerr/okerrupdate file or OKERR_TEXTID and OKERR_SECRET environment
variables.
okerrmod utility
okerrmod is script to perform different local checks (such as free disk space, mysql running, load average, etc.). After initial okerrmod --init, few basic check modules
are enabled.
List all available check modules (+ - module enabled, - - module disabled ):
$ okerrmod --list
+ backups 0.1 Check freshness for backup files
+ df 0.1 Free disk space
...
To run enabled checks just run okerrmod without any other commands:
xenon@braconnier:~$ sudo okerrmod
okerr updated (200 OK) braconnier:maxfilesz@okerr = 9077814
okerr updated (200 OK) braconnier:apache@okerr = 0
okerr updated (200 OK) braconnier:nonempty@okerr = 0
okerr updated (200 OK) braconnier:empty@okerr = 0
...
To run just one check:
$ sudo okerrmod --run ok
okerr updated (200 OK) braconnier:ok@okerr = OK
To enable new check:
$ sudo okerrmod --enable runstatus
2020/01/17 16:12:30 enable /usr/local/lib/python3.7/dist-packages/okerrupdate/mods-available/runstatus
2020/01/17 16:12:30 make default config file: /etc/okerr/mods-env/runstatus
After this, you may want to edit default configuration for this check
sudo vim /etc/okerr/mods-env/runstatus
After this, okerrmod will run this check.
To create your own very basic check 'my' create dir /etc/okerr/mods-available/my and edit /etc/okerr/mods-available/my/check:
#!/usr/bin/python3
print("STATUS: OK")
or if you prefer shell (check is any executable file):
#!/bin/sh
echo STATUS: OK
Now you can run it manually okerrmod --run my, enable okerrmod --enable my, make/edit config file for it
/etc/okerr/mods-env/my.
Using okerrupdate python library
Simplest case:
#!/usr/bin/python
import okerrupdate
op = okerrupdate.OkerrProject('MyTextID', secret='MySecret')
i = op.indicator('temp', method='numerical|maxlim=37', policy='Daily')
i.update('36.6')
Documentation
More info in okerrupdate documentation.
Other okerr resources
1 maintainer
Release files for okerrupdate 2.1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| okerrupdate-2.1.7.tar.gz | 22.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| okerrupdate-2.1.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 66.1 kB
Release files / okerrupdate-2.1.7.tar.gz
| Download URL | okerrupdate-2.1.7.tar.gz |
|---|---|
| Size | 22.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ee14decb12bee7dc2de5d04773c195872076e1ce54712dfa2514cd603477e83c
|
|
BLAKE2b-256 checksum How to use checksums |
8f315fbce5b36ac49bca3db523fef7692c54c654d6b46d02abe1f53b71734694
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.5 cpython/3.10.12 HTTPX/0.28.1
|
Release files / okerrupdate-2.1.7-py3-none-any.whl
| Download URL | okerrupdate-2.1.7-py3-none-any.whl |
|---|---|
| Size | 43.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
58e6e9925951283cc637532c6ba9ddb73d1500616ab90829a21635e4ede61dc8
|
|
BLAKE2b-256 checksum How to use checksums |
e33afee891cb0cc68bf2c3404b50c1db6d7e49acb3d0d343ad80490dfd457898
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.5 cpython/3.10.12 HTTPX/0.28.1
|
