CLI

This guide covers the essential command-line options for configuring and running Qtap.

Basic Syntax

qtap [flags]

Essential Flags

Configuration

Flag	Description
--config=	Path to YAML configuration file or HTTP/HTTPS URL
--registration-token=	Token for cloud-connected mode

Logging Options

Flag	Default	Description
--log-level=	info	Set logging detail level (debug, info, warn, error)
--log-encoding=	console	Log format (console, json)

TLS Configuration

Flag	Default	Description
--tls-probes=	nodetls,openssl,gotls	TLS libraries to monitor (nodetls,openssl,gotls,javassl)

Tagging

Flag	Default	Description
--tags=		Deployment tags for categorization (comma-separated key:value pairs)

Other

Flag	Default	Description
-v, --version		Display Qtap version
-h, --help		Display help information

Common Usage Examples

Running with a Local Configuration File

qtap --config=/path/to/qpoint.yaml

Running with a Remote Configuration File

qtap --config=https://config.example.com/qpoint.yaml

Running with Qplane

qtap --registration-token=YOUR_TOKEN

Adjusting Log Level for Troubleshooting

qtap --config=/path/to/qpoint.yaml --log-level=debug

Using JSON Log Format for Structured Logging

qtap --config=/path/to/qpoint.yaml --log-encoding=json

Monitoring Specific TLS Libraries

qtap --config=/path/to/qpoint.yaml --tls-probes=openssl,gotls,javassl

Cloud-Connected with Enhanced Debugging

qtap --registration-token=YOUR_TOKEN --log-level=debug --log-encoding=json

Adding Deployment Tags

qtap --registration-token=YOUR_TOKEN --tags="env:prod,region:us-east"

Remote Config with Debugging

qtap --config=https://config.example.com/qpoint.yaml --log-level=debug

Remote Config with Debugging

qtap --config=https://config.example.com/qpoint.yaml --log-level=debug

Checking the Qtap Version

qtap --version

Configuration Sources

The --config flag supports multiple sources:

• Local files: /path/to/qpoint.yaml

• Remote URLs: https://config.example.com/qpoint.yaml

Remote configurations are automatically cached locally and support reload functionality via SIGHUP.

TLS Probes Available

Probe	Description
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,javassl