User Guide

Reference documentation for how to use Stroom.

Application Programming Interfaces (API)

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

Background Jobs

Managing background jobs.

Concepts

Describes a number of core concepts involved in using Stroom.

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.

Indexing data

Indexing data for querying.

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

Searching Data

Searching the data held in Stroom using Dashboards, Queries, Views and Analytic Rules.

Security

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

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.

Last modified September 3, 2024: Merge branch '7.4' into 7.5 (3fb608f)