title: User Guide nav_order: 5 has_children: true

User Guide

The User Guide covers the core concepts and workflows for using Apache Solr Orbit: from installation and configuration, through understanding the workload format, running benchmarks, and interpreting results.

SectionDescription
ConceptsCore terminology: workloads, challenges, pipelines, collections, metrics
Install and ConfigurePrerequisites, installation, and configuration file
Understanding WorkloadsWorkload anatomy, available workloads, built-in operations
Working with WorkloadsRunning, fine-tuning, creating, and contributing workloads
Understanding ResultsSummary reports, metrics definitions, telemetry
Optimizing BenchmarksTarget throughput, distributed load, best practices, query randomization