Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/pythops/oryx/llms.txt

Use this file to discover all available pages before exploring further.

The Metrics section lets you define custom packet counters scoped to a specific port or range of ports. Each metric tracks how many ingress TCP and UDP packets have been received on the specified destination port(s) since the metric was created, updated continuously in a background thread every 100 ms.

What a metric tracks

Each metric records:
  • Port or port range — a single port (e.g. 443) or a contiguous range (e.g. 5555-9999)
  • TCP count — number of ingress TCP packets whose destination port falls within the range
  • UDP count — number of ingress UDP packets whose destination port falls within the range
Metrics count only ingress packets. Both IPv4 and IPv6 are included.

Adding a metric

1

Open the Metrics Explorer form

Press n. A popup titled Metrics Explorer appears with a single input field labelled Port Packet Counter.
2

Enter a port or range

Type a single port number or a hyphen-separated range:
443
8080
5555-9999
The form shows example hints: 443, 8080, 5555-9999.
3

Confirm

Press Enter to validate and create the metric. If the input is not a valid port number or range (e.g. the start is greater than or equal to the end), an error is shown in red inline.
4

Press Esc to cancel

Press Esc to discard input and close the form without creating a metric.
Port ranges are exclusive on the upper bound — entering 5555-9999 monitors destination ports 5555 through 9998 inclusive.

Metric display

Each metric is rendered as a horizontal bar chart with two bars:
  • TCP — cumulative ingress TCP packet count for the port range
  • UDP — cumulative ingress UDP packet count for the port range
The chart title shows either Port: <n> for a single port or Ports: <start>-<end> for a range. The selected metric is highlighted with a magenta border; others use a gray border.
KeyAction
nAdd a new metric
dDelete the selected metric
j / DownMove selection down
k / UpMove selection up
When more metrics exist than can fit on screen, a vertical scrollbar appears on the right edge.

Update interval

Each metric runs its own background thread that wakes every 100 ms and processes packets received since the last check.

Build docs developers (and LLMs) love