Analyzer envoy-lua-on-cpu

Name

envoy-lua-on-cpu - Envoy Lua-Land on-CPU Flame Graph

This analyzer profiles CPU usage in Lua-land code execution within Envoy proxy applications. It captures stack traces from Lua script execution, including user-defined filters, request/response processing logic, and Lua standard library calls. The analyzer generates flame graphs that visualize CPU time distribution across Lua function calls, helping identify performance bottlenecks in Lua-based request processing, inefficient algorithms, and hot code paths in Envoy Lua filters.

Resource Category

CPU.

Application Type & Technical Stack

  • Envoy

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 envoy-lua-on-cpu -p PID

# trace a shell command directly
orxray analyzer run envoy-lua-on-cpu -c SHELL_CMD

# PGID is the process group ID or any process's PID within the target process
# group.
orxray analyzer run envoy-lua-on-cpu -p -PGID

# trace any processes started from the specified executable path.
orxray analyzer run envoy-lua-on-cpu --exe /path/to/exe/file

Tracing Multiple Processes

Supported.

Output Formats

  • Flame Graphs

Author

The OpenResty Inc. Team.

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