Skip to content

Commit

Permalink
little fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
yaroslaff committed Nov 13, 2020
1 parent 6039063 commit 23bd250
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_build
10 changes: 10 additions & 0 deletions User/Features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,15 @@ Not required to install okerr server, you can use our [okerr server](https://oke
If you want to perform *optional* local checks (from inside server, e.g. check free disk space) you need to install one small python package.

.. rubric:: Service

You can install full software on your server for your project. But also you can install software and provide service to your customers.

.. rubric:: Team work

It's possible to work on project alone or with other team members.

.. rubric:: Network checks

- SSL certificate expiration (for websites, mail servers etc.)
- Ping (check if host is online)
- TCP Port (check if TCP port is listening)
Expand Down Expand Up @@ -57,26 +60,33 @@ Among other, local checks will warn if:
`Full list of built-in local check modules <https://gitlab.com/yaroslaff/okerrupdate/-/wikis/basic%20okerrmod%20modules>`_.

.. rubric:: Logical (Lamdba expressions)

Logical indicators allows to make complex logical conditions based on basic indicators. For example:
- Server X may go down for maintenance from 3:00 to 5:00 of night
- We may have up to 2 servers down, if we have at least 3 servers up.

.. rubric:: Telegram

Okerr uses telegram bot for mobile interface. You can instantly check status of your projects and re-test failed indicators from any location.

.. rubric:: Free

Okerr server is free and open source software distributed with [AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html) license. Client-side modules uses even more free [MIT](https://opensource.org/licenses/MIT) license.

.. rubric:: Low resources

Client-side python module is less then 50Kb in size (requires python3 and few other requirements, most of it is already installed on typical server).

Resident size (in RAM) is *ZERO*, just runs as cron job every 20 minutes.

.. rubric:: Open source, open API

Everything (client, libraries, server) are open-source. Interactions are based on standard protocols, so you can integrate your software with okerr, write your own okerr modules and clients. You can even update indicators right from shell with `curl`.

.. rubric:: Easy to integrate

If your software is in python or shell, you can use [okerrupdate](https://gitlab.com/yaroslaff/okerrupdate) library. You can use your favorite HTTP client library for any other programming language.

.. rubric:: Easy to extend

Client-side checks uses very simple interface and can be implemented in any programming languages.
17 changes: 17 additions & 0 deletions User/Indicators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,56 +5,73 @@ Indicator properties
====================

.. rubric:: Name

Each indicator belongs to one project, must have unique name in project and can by addressed by full name of indicator is *name@textid* where *textid* is any of project textid.

.. rubric:: Status

Status is either "OK" or "ERR" (Yes, that's why it's OKERR). When status of indicator changes, alert is sent to email/telegram.

.. rubric:: Details

Details is more detailed info about status. For example, free disk space indicator may have status "OK", current value 59.3% and details: "59.30%, 5.8G/9.8G used, 3.5G free"

.. rubric:: Check method

Most important property of indicator is "check method". All available methods are described in [Check methods](en/Check methods). Indicator status is updated according to check method.

.. rubric:: Changed

Date/time when indicator changed status last time.

.. rubric:: Updated

Date/time when indicator was checked and status updated (even if not changed).

.. rubric:: Expected

Date/time when okerr server expects to receives update (when it will be re-checked)

.. rubric:: Scheduled

Date/time when okerr server schedules some action if indicator will not be updated in time. For active indicator - server will re-send task to sensor. For passive - switch status to ERR.

.. rubric:: Disabled

If indicator is disabled, it will not work any more (until enabled again). Updates will be discarded. Status will never change and alerts will not be send.

.. rubric:: Problem

Rarely used (only in logical indicators). Problem flag means something is wrong with indicator configuration and you should reconfigure it and remove flag. Indicator will not be executed until problem flag is removed.

.. rubric:: Silent

Silent indicator sends no alerts. You may want to set silent flag if ERR state is expected for indicator.

.. rubric:: Maintenance

Maintenance state is very similar to silent (alerts are not send) but displayed differently and designed to be used temporary for work in progress (e.g. when you reconfigure remote service or indicator). Date/time when and who set maintenance mode is recorded.

.. rubric:: Policy

Policy (set of configuration options) applied to this indicator. Each indicator uses exactly one policy. When indicator created, policy 'Default' is used.

.. rubric:: Location suffix

For active indicators specified sensor(s) which will execute it. For example, you can ping server from specific sensor 'echo@paris.fr' or any sensor in 'paris.fr' or any sensor in 'fr'. For passive indicators it's not used.

.. rubric:: Description

Just informational field, comment to indicator, reminder for yourself or other team members.

Indicator user settings
=======================
Indicator user settings are specific for user (if many users are working on project, one user settings does not affects other users).

.. rubric:: Star

If indicator is 'starred' it will be displayed with 'star' icon on project indicators dashboard. This is useful to quickly find important indicators if project has many indicators.

.. rubric:: Subscribe

Even if user has alerts turned off, but subscribed to indicator, he will get alerts from this indicator. This is useful, for example, if project manager do not want to be alerted about any problem, but want to be alerted about important indicators (such as escalation logical indicator).
5 changes: 3 additions & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,10 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
#html_theme = 'alabaster'

html_theme = 'alabaster'
#html_theme = 'nervproject'
html_theme = 'press'
#html_theme = 'press'
#html_theme = 'flask'


Expand Down

0 comments on commit 23bd250

Please sign in to comment.