CLI
This guide covers the essential command-line options for configuring and running Qtap.
Basic Syntax
qtap [flags]Essential Flags
Configuration
--config=
Path to YAML configuration file or HTTP/HTTPS URL
--registration-token=
Token for cloud-connected mode
Logging Options
--log-level=
info
Set logging detail level (debug, info, warn, error)
--log-encoding=
console
Log format (console, json)
TLS Configuration
--tls-probes=
nodetls,openssl,gotls,javassl
TLS libraries to monitor (nodetls,openssl,gotls,javassl)
Tagging
--tags=
Deployment tags for categorization (comma-separated key:value pairs)
Debugging
--enable-dev-tools
Enable browser-based DevTools UI at http://localhost:10001/devtools
Other
-v, --version
Display Qtap version
-h, --help
Display help information
Common Usage Examples
Running with a Local Configuration File
qtap --config=/path/to/qpoint.yamlRunning with a Remote Configuration File
qtap --config=https://config.example.com/qpoint.yamlRunning with Qplane
qtap --registration-token=YOUR_TOKENAdjusting Log Level for Troubleshooting
qtap --config=/path/to/qpoint.yaml --log-level=debugUsing JSON Log Format for Structured Logging
qtap --config=/path/to/qpoint.yaml --log-encoding=jsonMonitoring Specific TLS Libraries
qtap --config=/path/to/qpoint.yaml --tls-probes=openssl,gotls,javasslCloud-Connected with Enhanced Debugging
qtap --registration-token=YOUR_TOKEN --log-level=debug --log-encoding=jsonAdding Deployment Tags
qtap --registration-token=YOUR_TOKEN --tags="env:prod,region:us-east"Enabling DevTools for Interactive Debugging
qtap --config=/path/to/qpoint.yaml --enable-dev-tools
# Access at http://localhost:10001/devtoolsDemo Mode with DevTools
curl -s https://get.qpoint.io/demo | sudo sh -s -- --enable-dev-tools
# Qtap runs in /tmp with DevTools enabledRemote Config with Debugging
qtap --config=https://config.example.com/qpoint.yaml --log-level=debugChecking the Qtap Version
qtap --versionConfiguration Sources
The --config flag supports multiple sources:
Local files:
/path/to/qpoint.yamlRemote URLs:
https://config.example.com/qpoint.yaml
Remote configurations are automatically cached locally and support reload functionality via SIGHUP.
TLS Probes Available
openssl
Monitor OpenSSL traffic
gotls
Monitor Go TLS traffic
nodetls
Monitor Node.js TLS traffic
javassl
Monitor Java SSL/TLS traffic
To monitor multiple libraries, combine them with commas (no spaces):
--tls-probes=openssl,gotls,javasslDevTools Interactive Debugging
The --enable-dev-tools flag enables a browser-based interface for real-time HTTP/S traffic inspection. See the DevTools Guide for complete documentation including:
Quick start with demo mode
SSH tunnel setup for remote servers
Use cases and troubleshooting workflows
Screenshots and visual walkthrough
Last updated