User Guide

Application Programming Interfaces (API)

Stroom’ public REST APIs for querying and interacting with all aspects of Stroom.

Concepts

Describes a number of core concepts involved in using Stroom.

Dashboards

The means of displaying and visualising the results of queries.

Data Retention

Controlling the purging/retention of old data.

Data Splitter

Event Feeds

Feeds provide the means to logically group data common to a data format and source system.

Finding Things

How to find things in Stroom, for example content, simple string values, etc.

Indexing data

Indexing data for querying.

Keyboard Shortcuts

Keyboard shortcuts for actions in Stroom.

Nodes

Configuring the nodes in a Stroom cluster.

Pipelines

Pipelines are the mechanism for processing and transforming ingested data.

Properties

Configuration of Stroom’s application properties.

Roles

Security

There are many aspects of security that should be considered when installing and running Stroom.

Stroom Jobs

Managing background jobs.

Tools

Various additional tools to assist in administering Stroom and accessing its data.

User Content

This section relates to the content created in Stroom by the user, e.g. Dashboards, Translations, Feeds, etc.

Viewing Data

How to view data in Stroom.

Volumes

Stroom’s logical storage volumes for storing event and index data.