Analyzer openresty-coro-timeout-packets

# Name

openresty-coro-timeout-packets - Nginx Request Latency

This analyzer monitors and captures timeout events in OpenResty, Kong, and APISIX applications that utilize OpenResty Inc’s C coroutine implementation. It instruments the ngx_http_coro_timeout_handler function to detect coroutine-based request timeout events and captures TCP network packets associated with the timed-out requests. The analyzer filters packets by matching the socket file descriptor of timeout events, providing complete visibility into both application-level timeout occurrences and network-level packet exchanges. Output includes packets details and PCAP files containing captured packets for detailed network analysis, enabling comprehensive troubleshooting of request timeout issues and network-related performance problems in coroutine-based architectures.

# Resource Category

Latency.

# 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-coro-timeout-packets -p PID

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

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

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

# Tracing Multiple Processes

Supported.

# Output Formats

• Line Charts
• Plain Texts

# Author

The OpenResty Inc. Team.

# Copyright

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