Repository files navigation

Stroom is a data processing, storage and analysis platform.It is scalable - just add more CPUs / servers for greater throughput.It is suitable for processing high volume data such as system logs, to provide valuable insights into IT performance andusage.

Stroom provides a number of powerful capabilities:

• Data ingest. Receive and store large volumes of data such as native format logs.Ingested data is always available in its raw form.
• Data transformation pipelines. Create sequences of XSL and text operations, in order to normalise or export datain any format.It is possible to enrich data using lookups and reference data.
• Integrated transformation development. Easily add new data formats and debug the transformations if they don'twork as expected.
• Scalable Search. Create multiple indexes with different retention periods.These can be sharded across your cluster.
• Dashboards. Run queries against your indexes or statistics and view the results within custom visualisations.
• Statistics. Record counts or values of items over time, providing answers to questions such as "how many times hasa specific machine provided data in the last hour/day/month?"

To run Stroom in docker do the following:

# Download and extract Stroom v7.0 stackbash<(curl -s https://gchq.github.io/stroom-resources/v7.0/get_stroom.sh)# Navigate into the new stack directorycd stroom_core_test/stroom_core_test*# Start the stack./start.sh

For more details on the commands above and any prerequisitesseeSingle Node Docker Installation.

For the releases of the core Stroom product, seeStroom releases. For thereleases of the docker application stacks,seeStroom-Resources releases.

The Stroom application spans several repositories but we've bundled all the documentation intooneStroom Documentation site.

If you'd like to make a contribution then the details for doing all of that areinCONTRIBUTING.md.

Stroom and its associated libraries, services and content span several repositories:

• stroom - The core Stroom application.
• stroom-agent - An application for capturing and sending log files to Stroom.
• stroom-auth - The OAuth2 authentication service used by Stroom.
• stroom-clients - Various client libraries for sending logs to Stroom.
• stroom-content - Packaged content packs for import into Stroom.
• stroom-docs - Documentation for the Stroom family of products.
• stroom-expression - An expression library used in Stroom's dashboardsand query API.
• stroom-headless - An example of how to run Stroom in headless mode fromthe command line.
• stroom-proxy - An application that acts as a data receipt proxy for Stroom (Legacy v5 only).
• stroom-query - A library for querying Stroom's data sources.
• stroom-resources - Configuration for orchestrating stroom in dockercontainers and released docker stacks.
• stroom-stats - An application for storing and querying aggregates of eventdata.
• stroom-visualisations-dev - A set of visualisations for use inStroom.
• event-logging-schema - An XML Schema for describing auditableevents.
• event-logging - A JAXB API for theevent-logging XML Schema.