Configuration
Qtap can be managed locally with a yaml config file. This guide explains how to create, deploy, and maintain a local configuration file for Qtap.
Configuration File Structure
The qpoint.yaml file consists of three main sections:
Storage Configurations (Where processed data goes)
Stacks (How data is processed)
Traffic Capture Rules (What data is processed)
Here's the basic structure:
version: 2
services:
event_stores:
# Event storage configuration
object_stores:
# Object storage configuration
stacks:
stack_1:
plugins:
# First plugin configuration
stack_2:
plugins:
# Second plugin configurations (optional)
tap:
# Global traffic capture settingsCreating a Basic Configuration
Let's walk through creating a simple configuration file step by step.
Step 1: Set Version
Start by setting the configuration version:
Step 2: Configure Data Storage
Next, define where captured data will be stored:
This configuration:
Outputs events (connection metadata) to the console for debugging
Outputs objects (request/response content) to the console for debugging
This configuration:
Outputs events (connection metadata) to the console for debugging
Stores objects (request/response content) in a locally running MinIO S3-compatible store
Uses environment variables for S3 credentials (recommended for security)
Step 3: Set Up Processing Plugins
Define how captured data will be processed:
This configuration:
Creates a stack named "default_stack"
The access logs plugin provides summary-level debug information with specific capture definitions for example.com, or full payload capture for traffic with a status code above 400
Step 4: Configure Traffic Capture
Finally, set up what traffic to capture and send to plugins:
This configuration:
Captures all outgoing (egress) traffic
Includes loopback traffic
Includes DNS information in audit logs
Applies the default_stack to HTTP traffic for processing
Example
Putting it all together:
Last updated