Frequently Asked Questions

How can I help or contribute?

SENTINL is open-source and anyone can help the project by contributing code, testing, hunting bugs and updating documentation. Not a technical user? Help us by improving documentation, adding examples you find valuable, or just spreading the word about the feature with a blog post, or a tweet promoting the project to potential users.

Is version 6.x supported?

SENTINL will support all modern versions of Kibana and Elasticsearch. Version 6.x is already available for testing in our releases and will bring a new wave of native integration with Kibana tools, enhancing the experience.

Emails are not being sent. Why?

SENTINL uses emailjs to send emails. This NPM module requires a correct message to be formed, so make sure your configuration includes valid from and to values, as well as the proper authentication method for your email relay. If in doubt, refer to the documentation.

Reports are not being generated. Why?

SENTINL uses either node-horseman or puppeteer to generate reports. The node-horseman NPM module requires PhantomJS to be installed on the system running KaaE and Reports, and puppeteer requires Chrome. The default engine used is puppeteer, but this can be changed to horseman with the configuration property.

Watchers are not running in my timezone. Why?

SENTINL uses the UTC timezone internally to execute schedule. While rolling watchers are not effected (every x minutes) UTC timezone will be used for absolute timed executions. Future versions will allow adapting to localTimezone of the server executing Kibana.

To change the server or container localtime use the following example:

###Make a backup
sudo mv /etc/localtime /etc/localtime.bak
### set my localtime
sudo ln -s /usr/share/zoneinfo/XXX/XXX /etc/localtime

How can I avoid string encoding in mustache templates output?

SENTINL uses Mustache to enrich the messages of actions with data from its execution. If you want to use double braces without it being replaced, use triple braces ({{{hello}}}). See the Mustache documentation for more information.

How can I use SENTINL with ReadonlyREST authentication?

When using ReadonlyREST, the following SENTINL exceptions should be added to its configuration:

  type: allow
  uri_re:  ^/watcher_alarms-.*/
  hosts: [localhost]
  verbosity: info

  type: allow
  uri_re:  ^/watcher.*/
  hosts: [localhost]
  verbosity: info

Why are prebuilt SENTINL packages so big?

SENTINL packages include PhantomJS and Chrome binaries, occupying most of the archive space. These are used to generate screenshots for reports.

How can I secure sensitive passwords and values in SENTINL configuration?

When using Kibana 6.1+, the Secure Settings feature can be used to encrypt sensitive details. For example, to protect an email password:

bin/kibana-keystore create
bin/kibana-keystore add

Reports failing with "HeadlessError"

When running reports using PhantomJS, the following error might be returned:

"fail to report, HeadlessError: Error executing command to extract phantom ports: Error: Command failed: ss -nlp | grep "[,=]354," || netstat -nlp | grep "[[:space:]]354/"\n/bin/sh: ss: command not found

This can be resolved by installing the missing ss command on your system or container, ie:

sudo yum install -y iproute