User docs#
These docs explain how to use and operate CLP. Use the left sidebar (if it’s hidden, click the icon) to navigate to specific docs.
Quick start#
New to CLP? Get CLP up and running quickly on a single host.
Quick start
A quick-start guide for choosing a flavor of CLP, setting it up, compressing your logs, and searching them.
Deployment#
Dive deeper into deploying CLP with Docker Compose or Kubernetes. In particular, multi-host deployments enable horizontal scaling and high availability for production workloads.
Docker Compose deployment
Deploy CLP using Docker Compose for single or multi-host setups.
Kubernetes deployment
Deploy CLP on a Kubernetes cluster using Helm.
Input & storage#
Configure how CLP ingests, stores, and retains data.
Using object storage
Ingest logs from and store archives on S3-compatible object storage.
Using log-ingestor
Use log-ingestor to continuously ingest logs.
External database setup
Use external MariaDB/MySQL and MongoDB databases.
Configuring retention periods
Configure retention periods for archives and search results.
Query & analytics#
Learn how to query and analyze logs with CLP.
Using the API server
Submit queries, view results, and manage jobs programmatically.
MCP server
Integrate CLP with AI assistants using the Model Context Protocol.
Using Presto
Use Presto for distributed SQL queries on compressed logs.
Using Spider
Use Spider for compression and query job task distribution.
Core#
Try CLP’s core binaries directly, without deploying the full CLP package.
There are currently two flavors of CLP, depending on the format of your logs:
CLP for JSON logs
A flavor of CLP for JSON logs.
CLP for unstructured logs
A flavor of CLP for unstructured (e.g., free-text) logs.
The guide below explains how to use a container to try either flavor.
Core container
A container for trying CLP’s core.
Resources#
Get sample datasets for testing and benchmarking CLP.
Datasets
Log datasets for testing and benchmarking.
Reference#
References for search syntax, command line tools, and so on.
clp-json search syntax
Syntax reference for clp-json’s (and clp-s’) search syntax.
clp-text search syntax
Syntax reference for clp-text’s (and clp’s) search syntax.
Package scripts
Reference for the shell scripts in the package’s sbin/ directory.
Schema file syntax
Syntax reference for clp’s schema file for parsing unstructured text logs.