Cluster Status

Cluster Status#

The Squirro cluster status can be observed in the user interface with a few Studio components.

Log Files#

The log files tab shows the contents of Squirro server log files in real time. See Monitoring and Services for descriptions about the log file contents.

Usage#

image9

In the Server space select Log Files.

The dropdown provides a list of all log files (one per service) that can be looked at. Use the number of lines field and the minimum log level options to change what is displayed. By selecting the checkbox to automatically refresh, the contents of the log file are updated every few seconds.

Eventually, click the Show Log button to see the contents of the log file.

All time-stamps are in UTC, independent of the server time zone.

Limitations#

This does not support tailing log files in a multi-server environment. It will randomly show the log file contents of the server that is currently being accessed.

Monitoring Plugin#

This is a dedicated monitoring space of all Squirro services as well as an entire cluster overview. With the Monitoring plugin, you can see the health of your Squirro cluster, as well as the individual service status running on each node. Besides service-related information, you can also monitor your Elasticsearch cluster as well as the Ingester.

Usage#

In the Server space select Monitoring.

image1

Squirro Service Health#

The first tab is the most important one. Squirro Service Health is where can see all of your Squirro nodes and check the individual service statuses, running on each machine. Here you can see when a service is down or not responding.

image2

Elasticsearch Status#

The second tab, Elasticsearch Status, gives you an overview of your Elasticsearch cluster.

image3

Besides the cluster overview, you have access to a detailed list of all your Elasticsearch indexes.

image4

Ingester Status#

In the Ingester Status tab you can see how many items are being processed, in how many batches, and how many errors have occurred.

The information is presented split up by the different pipeline priorities. To learn more, see Pipeline Prioritization.

image5

Additionally this information is also available per source. This shows the sources for the selected project, which can be selected in the menu.

image6

Refresh Metadata#

The last tab, Refresh Metadata, is used to update the Ingester metadata to retrieve more accurate results.

image7

Scheduled Tasks#

Warning

Scheduled Tasks are currently not yet fully deployed. Treat as a Beta feature.

Squirro’s scheduler service can run commands in regular intervals. The scheduled tasks interface provide an interface to manage these tasks.

Usage#

In the Server space select Scheduled Tasks. Using the plus button on the top right a new task can be scheduled.

image8

Scheduling#

The cron syntax is a space-separated list of:

  • minute

  • hour

  • day-of-month

  • month

  • day-of-week

The asterisk (*) can be used as a wildcard. For example the value 5 * * * * would run an action every hour at 5 minutes past the hour.

Action#

Tasks are currently limited to HTTP requests. The details of that can be specified in the action parameters as a JSON dictionary:

{
    "url": "https://service.example.com/url",
    "method":"post"
}

This example triggers a regular POST action to the indicated URL.

Contents