Documentation
  • Introduction
    • How It Works
    • Architecture & Data Flow
    • Why another Agent?
    • eBPF Concepts
    • Use Cases
  • Deployment
  • Qtap
    • Getting Started
    • System Requirements
    • Installation
      • Linux Binary
      • Docker Container
      • Helm Chart
      • Kubernetes Manifest
    • Configuration
      • Storage Configuration
      • Traffic Processing with Plugins
      • Traffic Capture Settings
      • Configuration Examples
    • CLI
  • Qplane
    • Getting Started
      • Create an Account
      • Install Qtap
      • Review your Dashboards
    • Installation
      • Linux Binary
      • Docker Container
      • Helm Chart
    • Configuration
  • Security & Compliance
  • License
  • Appendix
    • Qcontrol (Beta)
    • Java
    • Object Storage
      • Google Cloud Storage
    • S3 Credentials for Qtap using Kubernetes Secrets
  • FAQ
Powered by GitBook
On this page
  • Basic Syntax
  • Essential Flags
  • Common Usage Examples
  • TLS Probes Available
  1. Qtap

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 the YAML configuration file

--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)

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

Checking the Qtap Version

qtap --version

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
PreviousConfiguration ExamplesNextQplane

Last updated 3 days ago

Running with

Qplane