index.md

Gravwell Docs

This site contains documentation for Gravwell, plus other resources such as Changelogs.

If you're just starting out with Gravwell, we recommend reading the Quickstart first, then moving on to the Search pipeline documentation to learn more.

Gravwell is pleased to announce our free Community Edition!

Quickstart and Downloads

• Quickstart

• Downloads

• Splunk Migration

Searching with Gravwell

• Search overview

• Search Extraction modules

• Search Processing modules

• Search Render modules

• Alphabetical List of All Pipeline Modules

• Direct Query REST API

System Architecture

• Gravwell System Architecture

  • Network Ports Used by Gravwell

• The Resource System

Ingester Configuration: Getting Data Into Gravwell

• Overview and List of Ingesters

• Ingester Preprocessors

• Custom Time Formats

• Service Integrations

• Data Migration

• Federator

Advanced Gravwell Installation and Configuration

• Installing and Configuring Gravwell

• Docker Deployment

• Setting up TLS/HTTPS

• Building a Gravwell Cluster

• Distributed Frontends

  • Overwatch

• Environment Variables

• Detailed Configuration Parameters

• Single Sign-On

• Hardening Gravwell

• Common Problems & Caveats

• Performance Tuning

Query Acceleration, Auto-Extraction, and Data Management

• Setting up Auto-extractors

• Query Acceleration (indexing and bloom filters)

• Data Replication

• Data Ageout

• Data Compression

• Data Archiving

• Aggregates

Automation

• Flows

• Scheduled Searches & Scripts

  • Automation Script APIs & Examples

• Scripting Overview

  • The Anko Module

  • The Eval Module

User Interfaces

• Gravwell Web GUI

  • The Search Interface

  • Labels and Filtering

  • Kits

  • Tokens

• Command-Line Client

API

• API

• REST Query API

Misc

• Licensing

• Metrics & Crash Reporting

• Changelogs

• Gravwell EULA

• Open-source Licenses

Documentation version 2.0