Analyzer openresty-cosocket-timeout

# Name

openresty-cosocket-timeout - OpenResty Cosocket Timeout Distribution

This analyzer profiles the distribution of timeout values configured for cosocket operations in OpenResty-based applications. It captures timeout settings across different cosocket operations, generating histograms that visualize timeout distributions. The analyzer helps identify timeout configuration patterns, detect suboptimal timeout settings, and optimize timeout values to balance responsiveness and reliability in upstream communications.

# 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 openresty-cosocket-timeout -p PID

# trace a shell command directly
orxray analyzer run openresty-cosocket-timeout -c SHELL_CMD

# PGID is the process group ID or any process's PID within the target process
# group.
orxray analyzer run openresty-cosocket-timeout -p -PGID

# trace any processes started from the specified executable path.
orxray analyzer run openresty-cosocket-timeout --exe /path/to/exe/file

# Tracing Multiple Processes

Supported.

# Output Formats

• Histogram Bar Charts
• Plain Texts

# Output Example

[
  {
    "title": "OpenResty Cosocket Connect Timeout Distribution",
    "subtitle": "",
    "series": {
      "data": {"1000 ms": 40, "10000 ms": 60, "2000 ms": 6},
      "name": "samples"
    },
    "ver": 1,
    "type": "bar"
  },
  {
    "title": "OpenResty Cosocket Read Timeout Distribution",
    "subtitle": "",
    "series": {
      "data": {"1000 ms": 40, "10000 ms": 60, "2000 ms": 6},
      "name": "samples"
    },
    "ver": 1,
    "type": "bar"
  },
  {
    "title": "OpenResty Cosocket Send Timeout Distribution",
    "subtitle": "",
    "series": {
      "data": {"1000 ms": 40, "10000 ms": 60, "2000 ms": 6},
      "name": "samples"
    },
    "ver": 1,
    "type": "bar"
  }
]

# Author

The OpenResty Inc. Team.

# Copyright

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