alignak-monitoring-contrib / alignak-webui

Web User Interface for Alignak monitoring framework

Alignak Web UI

Web User Interface for Alignak monitoring framework ...

Warning

As of now, the Alignak project is only maintained by one person. Though, I will not be able to maintain this Web UI anymore... sorry. For my own production environment, I am currently an alternative solution base on the former Shinken Web UI that I developed and still maintain. If you are using this Web UI for your Alignak instance, please feel free to contact me by mail

Screenshots

Documentation

You can find online documentation on Read The Docs and in the /docs directory.

Installation

The Alignak WebUI is easily installed and started thanks to the Python Package:

# Installing...
pip install alignak-webui
# Running...
alignak-webui-uwsgi
# Using!
http://127.0.0.1:5001

Note: Please note that you need to have a running Alignak framework reporting the live state to the Alignak backend.

Bugs, issues and contributing

Contributions to this project are welcome and encouraged, but please have a look to the contributing guidelines before raising an issue, or writing code for the project.

License

Alignak WebUI is available under the GPL version 3.

alignak-webui's Issues

Hosts / services overall state popover

Popover layout is to be improved, currently:

No log file rotation

According to configuration the application log file should rotate every day:

[logs]
; Application log files
; ------
; The application buils a log file if launched with --logs command line parameter
; Parameters in this section allow to configure logs file rotation
; ------

# CRITICAL  50
# ERROR     40
# WARNING   30
# INFO      20
# DEBUG     10
# Default is INFO (20)
level = 20

# Application logs directory
# Default is /var/log/"application name"
; dir = .

# Application log filename
# Default is application name with log extension
; filename = webui.log

# Rotation period (D for day, W0...W6 for a week day, or midnight)
; when = D

# Rotation period interval
; interval = 1

# Number of backup files before deletion (0 to disable deletion)
; backup = 6

... and it is not rotating!

/logcheckresult_table and default sort

It could be better to sort by default by Last check desc instead asc (so more recent to older)

User should be informed of bad search parameters

Hello @mohierf ,

If we make this kind of search on webui:

http://94.76.229.155:91/hosts_table?search=type:host%20state:UP or http://94.76.229.155:91/services_table?search=type:host%20state:OK, this seems broke display of webui.

After that /hosts_table and /services_table url are not yet available.

After log out / log in again, problem persist.

Some buttons disappear in full window on dashboard

Hello,

I noticed that the add_widget button disappears when my window is full screen and the menu is left.

If I reduce my window until the menu appears at the top , the buttons are present.

I test on Ubuntu 16.04, on Chrome and Firefox.

Broken link on host page for command

On Hosts page, link to commands are broken and make 404 error.

Create a bin directory ...

Create a bin directory (on the same model as Alignak's one):

• : include a run.sh script to start the WebUI with uswgi
• : include an init.d and rc.d with sample scripts

Acknowledge for several problems do not work

When selecting several problems in the livestate table, and trying to acknowledge them, the ack commands are not sent properly ...

Furthermore, it may be interesting to propose a dialog window to enter acknowledge parameters and comment, which will be the same for all the acks.

DataTables Warning when paste something in search box

During test session, I've do the following:

1. Write something in Services -> Host Name search box.
2. In this search box, I do CTRL-A and CTRL-X to cut string,
3. Then CTRL-V in main search box.

And I have the following warning:

And after I get many times this window until I remove the paste string.

Read the docs build broken

The doc build made by the online RTD is broken because the application can not be installed:

error: could not create '/etc/alignak_webui': Permission denied

Session problem with uwsgi multi-process

If we run uwsgi with multiprocess (-p 4 for example) and we connect to webui it return to login page because sessions seems not shared between processes

Map widget overlaping on menu

http://screencloud.net/v/z6uY
As you can see, there's things that hide stuffs

Explode item.py ...

The file item.py contains several classes ... it should exploded in several files that contain only one class

Tables: long item breaks table layout

Solutions:
1/ shorten the diaplyed text
2/ use text ellipsis

Improvement idea: NAGIOS Variable Commands

In Commands menu, if we can have values (as memo) of the following variables.

• $NAGIOSPLUGINSDIR$
• $PLUGINSDIR$

If I remember well, it's define in a file like path.cfg. I don't know if you can retrieve this an display on this board ?

Other thing in this page, columns seems not responsive on small screen. I'm not sure, it's your priority but it renderer like this:

Tables: improve filtering

Allow filtering columns on True / False for boolean values (eg. Acknowledged)

In livestate display last_check in human date readeable

Search box doesn't match anything

If i make some research in search box in general or in Host Name, search result:

"No matching records found"

Example in Services tab:

Timeline - add colors to separate services

Like this example:

Bad link in Host page

When you are on a page of a specific host, like:

http://xxx.xxx.xxx.xxx/host/57553dc35eb3a122bffa1b29

If you are on Services tab, under Host name, the link to host have the following format:

http://xxx.xxx.xxx.xxx/host/host/57553dc35eb3a122bffa1b29

The url contains double host/.

Broken table pagination ...

Showing 1 to 10 of 10 entries out of 102 entries

should be

Showing 1 to 10 of 102 entries out of 102 entries

when no column filtering is active.

Timeline pagination

The pagination is not very good for this type of display/view.

We could go in end of page/timeline and webui load the next page and display the page 2 at the end, like this, we have a continuous timeline.

As example, the google image search, it load the next page/section when we are on end of previous page/section

Currently view is broken - refactore graphs

Since the new Graph version, the currently view is broken ... needs refactoring

Configuration file location

The configuration file location are (in order):

• '/usr/local/etc/alignak-webui/settings.cfg',
• '/etc/alignak-webui/settings.cfg',
• '~/alignak-webui/settings.cfg',
• '/home/alignak/alignak-webui/etc/settings.cfg',
• '/home/alignak/alignak-webui/alignak-webui/etc/settings.cfg',
• './settings.cfg'

Several things:

• when installed, the WebUI uses alignak_webui and not alignak-webui to create some directories
• many directories ... probably that 2/3 directories would be enough

Table pagination when filtering is on

When filtering is activated on a column (at least) and the matching rows count is greater than the current page length, the pagination is broken:

With page length = 5, pagination is Showing 1 to 5 of 5 entries out of 102 entries. despite the 7 matching entries!

Display a status for a group / dependency

Assign a status to an elements group (eg. hosts group). This status is the worst state of all the elements in the group.

Indeed, an hosts group is a group of hosts and an host do not have any state. We have a livestate item that is linked to the host and it is this livestate item that holds the current host state. The idea behind this is to create a fake group of livestate items linked to the corresponding hosts/services group.

Same feature is interesting when displaying host/service dependency

Broken layout ...

As @algorys noticed on #7

This problem occurs when the sidebar is present on the page left side

All datatable search for columns related to an embedded object

In Log table, filtering on host or service does not work properly because host and service are embedded objects ...

Unreadable map POI

Regarding this : http://screencloud.net/v/cJ61
This feature is nice, but useless if we can't read it. Maybe coul be a good idea to enhance this

---

Edit include screen capture into the comment:

Use webui components into another website

We can use webui components (command list, host list, livestate list, minemap...) on a website.

For that, we need:

• Pass the backend token in auth basic to webui call
• be able to ajax display a part of webui (like command list without headers, footers and menu)

Static files not seems ok

I have configurated nginx to serve static files of webui but I have 2 strange bahaviors:

• /static/logo is in reality /static/images && image load without .png but in server le file have .png extension
• /static/photos is in reality /static/images && image load without .png but in server le file have .png extension

I add my nginx configuration here as example

        location ~ ^/static/plugins/(.*)$ {
            alias /usr/jails/webui/root/alignak-webui/alignak_webui/plugins/$1;
            expires 1h;
        }

        location ~ ^/static/logo/(.*)$ {
            alias /usr/jails/webui/root/alignak-webui/alignak_webui/htdocs/images/$1.png;
            expires 1h;
        }

        location ~ ^/static/photos/(.*)$ {
            alias /usr/jails/webui/root/alignak-webui/alignak_webui/htdocs/images/$1.png;
            expires 1h;
        }

        location ~ ^/static/(.*)$ {
            alias /usr/jails/webui/root/alignak-webui/alignak_webui/htdocs/$1;
            expires 1h;
        }

        location / {
            client_max_body_size 20M;
            proxy_pass http://10.0.0.6:5000;
                proxy_set_header Host $http_host;
                proxy_set_header X-Real-IP $remote_addr;
                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

            proxy_read_timeout 120;
        }

Port under 1000 doesn't work without sudo

Hello @mohierf ,

I've install alignak, backend and webui as user alignak. But when I try to launch app.py without sudo I've the following error:

2016-06-18 13:38:13,463 - alignak_webui - ERROR - Application run failed, exception: <class 'socket.error'> / No socket could be created -- (('192.168.237.129', 80): [Errno 13] Permission denied)
2016-06-18 13:38:13,465 - alignak_webui - INFO - Backtrace: Traceback (most recent call last):
  File "app.py", line 225, in main
    server=app_config.get('http_backend', 'cherrypy')
  File "/home/alignak/.local/lib/python2.7/site-packages/bottle.py", line 3117, in run
    server.run(app)
  File "/home/alignak/.local/lib/python2.7/site-packages/bottle.py", line 2795, in run
    server.start()
  File "/home/alignak/.local/lib/python2.7/site-packages/cherrypy/wsgiserver/wsgiserver2.py", line 1943, in start
    raise socket.error(msg)
error: No socket could be created -- (('192.168.237.129', 80): [Errno 13] Permission denied)

2016-06-18 13:38:13,465 - alignak_webui - INFO - stopping backend livestate thread...

I've trying with uwsgi too, it make the same.

I've made some tests and only port under 1000 seems not work with sudo.

Test was made on Ubuntu Server 16.04 LTS.

Material design

To have a more "modern" interface, perhaps we can use material design like http://fezvrasta.github.io/bootstrap-material-design/ (it works with bootstrap web use now)

Improve forms for material design

All the forms need to be improved for the material design ...

jquery 2.x

Perhaps it could be a good idea to update jquery to 2.x instead 1.x version ;)

Broken pagination element ...

Pagination element design is broken ... eg. on Worldmap or minemap view. Layout is misaligned ...

Minor Enhancement: Display of link in Services and Livestate

On Services and Livestate page, if you select a service or a host, link are not very apparent (blue on blue). The same appears when mouse is over.

Maybe choose a color like on link in Hosts page.

Limited number of items for a list displayed in a table

Currently when a list of items is displayed in a cell of a table (eg. hosts members of an host group), the list is limited to 10 elements and a text is included in the list to inform that only 10 elements are listed.

Including a button instead of this text will allow to navigate to the corresponding table ...

Bad display of Menus in reduced Windows

Hello,

On reduced windows, there is a display problem of left menu. This one who's call Global Elements.

It seems appears on Chrome (Ubuntu 16.24 LTS), Android (Chrome) and Firefox (Ubuntu too).

The bouton is over the other menu. And if we click on it, it display some information about user:

I don't know if it was tests or not.

Missing hosts in the hosts groups table

The hosts groups table is missing the hosts that are members of the group. Same problem with the services groups and users groups tables ...

In acknowledge form, enhance sticky description

Because not all know how sticky is used, add text after sticky:

, if checked remove when go in OK state, otherwise on state changes

Widgets loaded CSS/JS are loaded multiple times ...

When some widgets load extra CSS or JS files, those files are loaded multiple times ... check for already loaded will avoir to over-consume memory !

Main windows icon overlap on stats

Regarding the following screenshot, it's weird how icons overlaps stats ...
http://screencloud.net/v/y72o

Disabled refresh icon is not readable ; sound icon not readable when disabled

http://screencloud.net/v/FnV
Maybe could be good to chose an other way to tell user that its off, and it's nice to try to use the same way to indicate it.

I think it could be nice to just fill tile's bg in grey when it's disabled, its class and discreet :), for both icons

Table rows number selection is broken

The table rows number selection is broken:

• All choice do not display all the available rows

Improvement idea : bottom scrollbar

Bottom scrollbar may just slide each Tables (Hosts, Services,...) and keep left menu visible by user.

Or just reduce it on the head of window ?

Otherwise we'll lost menu and shortcut for the different panel.

Change user preferences route

Currently, user's preferences are managed with routes : /preference/user (GET, POST) or /preference/common (GET, POST). It should be better to use a single route: /user_preference and to use GET and PATCH rather than GET and POST ... we would have a better integration for externally embedded data tables ...

Test configuration

Build a test configuration: hosts, services, ...

Command list not searcheable

There is nothing to search in command list

Get backend configuration, check compatibility

• On login, get the backend configuration on the endpoint /backendconfig
• Check WebUI / backend versions compatibility