Analyzer ngx-tls-handshake-info

# Name

ngx-tls-handshake-info - SSL/TLS Session handshake information Statistics

This analyzer collects statistical information about SSL/TLS handshake sessions in Nginx-based applications including OpenResty, Kong, and APISIX. It captures cipher suite usage and TLS protocol version distributions across client connections. The analyzer generates bar charts showing the frequency of different cipher suites and TLS versions, helping assess security posture, protocol compatibility, and identify deprecated or weak cryptographic configurations.

# Resource Category

Network I/O.

# Application Type & Technical Stack

• OpenResty
• Kong
• APISIX

# Command Line Syntax

The analyzer can be invoked directly on the command-line via the orxray utility from the openresty-xray-cli software package.

Alternatively, the analyzer can also be invoked manually or automatically on the web console UI of OpenResty XRay (like on the Advanced web page).

# PID is the target process PID.
orxray analyzer run ngx-tls-handshake-info -p PID

# trace a shell command directly
orxray analyzer run ngx-tls-handshake-info -c SHELL_CMD

# PGID is the process group ID or any process's PID within the target process
# group.
orxray analyzer run ngx-tls-handshake-info -p -PGID

# trace any processes started from the specified executable path.
orxray analyzer run ngx-tls-handshake-info --exe /path/to/exe/file

# Tracing Multiple Processes

Supported.

# Output Formats

• Bar Charts
• Plain Texts

# Output Example

{
  "data": [
    {
      "title": "SSL/TLS RSA Certificate Usage Statistics",
      "subtitle": "",
      "series": {
        "data": {"RSA-2048": 9, "RSA-4096": 12},
        "name": "samples"
      },
      "ver": 1,
      "type": "bar"
    },
    {
      "title": "SSL/TLS Cipher Usage Statistics",
      "subtitle": "",
      "series": {
        "data": {"TLS_AES_128_GCM_SHA256": 18},
        "name": "samples"
      },
      "ver": 1,
      "type": "bar"
    },
    {
      "title": "SSL/TLS Version Usage Statistics",
      "subtitle": "",
      "series": {
        "data": {"TLSv1_3": 18},
        "name": "samples"
      },
      "ver": 1,
      "type": "bar"
    }
  ],
  "kind": "common"
}

# Author

The OpenResty Inc. Team.

# Copyright

Copyright (C) by OpenResty Inc. All rights reserved.