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

TLS libraries to monitor (nodetls,openssl,gotls,javassl)

Tagging

Flag
Description

--tags=

Deployment tags for categorization (comma-separated key:value pairs)

Debugging

Flag
Description

--enable-dev-tools

Enable browser-based DevTools UI at http://localhost:10001/devtools

Other

Flag
Description

-v, --version

Display Qtap version

-h, --help

Display help information

Common Usage Examples

Running with a Local Configuration File

Running with a Remote Configuration File

Running with Qplane

Adjusting Log Level for Troubleshooting

Using JSON Log Format for Structured Logging

Monitoring Specific TLS Libraries

Cloud-Connected with Enhanced Debugging

Adding Deployment Tags

Enabling DevTools for Interactive Debugging

Demo Mode with DevTools

Remote Config with Debugging

Checking the 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):

DevTools 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