Pro plan from £5 per endpoint per month · see pricing
Secronyx
In the next releaseLinux

Envoy

See which Envoy upstream clusters have no healthy hosts and why, where its listeners accept connections, which certificates expire soon and what its counters say, from its admin interface on this host with read-only requests. This plugin is in the next Secronyx release; the current download does not include it yet.

What it answers

Questions an on-call engineer asks, which an AI client can answer with this plugin.

  • Which upstream clusters have no healthy hosts, and which hosts fail their health checks?
  • Why does Envoy answer 503 with no healthy upstream?
  • Which TLS certificates has Envoy loaded, and how many days does each have left?
  • Which addresses and ports does Envoy listen on?
  • Is Envoy live or draining, which version runs, and when did it last restart?

What it returns

Each of the plugin's read-only tools, described in words.

  • Envoy server state in one row - version, state (LIVE, DRAINING, PRE_INITIALIZING or INITIALIZING), uptime, node id and cluster, worker threads, log level, config path, restart epoch and drain settings
  • Envoy upstream clusters, one row each - hosts and how many are healthy, the unhealthy hosts and why, requests and connections in flight, connect failures, request errors and timeouts
  • Envoy listeners, one row per listener - its name and the address and port (or unix socket path) it accepts connections on
  • Envoy counters and gauges that have been written at least once and whose name matches a filter, one row per stat with its name and value; histograms and text values are left out
  • TLS certificates Envoy has loaded, soonest to expire first - served chain or trusted CA, file path, subject alternative names, days until expiry and validity dates; never keys

At a glance

Plugin
envoy 1.0.0
Publisher
levantar
Platforms
Linux

Tested on

  • Envoy 1.30.11 and 1.31.10 on Linux (Ubuntu 24.04, Docker), test lab

How it logs in

Without an explicit choice, install tries the methods that need no secret first, in this order.

  • No login (a local endpoint)

Least privilege

The setup file in the pack. This plugin needs no password and creates no login: the file says what it needs on the host and how to keep that to the minimum.

# The least privilege for the envoy plugin. Envoy's admin interface has no # logins or roles: every client that reaches it is an administrator. It # can shut Envoy down (/quitquitquit), drain its listeners, fail its # health checks so load balancers take it out, change log levels and # runtime values, start profilers that write files, and read the whole # config with the secrets in it (/config_dump). The plugin only sends # GETs to /server_info, /clusters, /listeners, /stats and /certs (the # engine refuses every other path and method for driver envoy), but the # listener itself is the whole grant, so keep it on this host: # # 1. In the bootstrap config: admin: address: socket_address: { address: 127.0.0.1, port_value: 9901 } # 2. Restart Envoy (the admin address cannot be changed while it runs). # 3. Install with auth none (the only method): secronyx plugin install <pack> # For another port: --endpoint 127.0.0.1:<port> # # A unix socket ("pipe: { path: /run/envoy/admin.sock }") also passes the # check, but the plugin connects over TCP. # # Do not set the address to 0.0.0.0, :: or a LAN address (many examples # and container images do): every host that reaches that port can then # shut Envoy down. The privilege check refuses such a listener. It reads # the address from the bootstrap config, so it cannot see a firewall, a # network namespace or a port published by a container runtime. Every # local user and process on this host can still reach a loopback admin # port; a unix socket with file permissions is the only way to narrow # that.

See it run

Terminal recording from the test lab: envoy-linux-harness
A real run on the shared test lab.

Read-only, in layers

Every request is a GET or HEAD to the endpoint the operator configured, on a path fixed in the signed pack. Redirects are not followed, and requests known to change state are refused.

These controls narrow what the plugin can do; none of them is a guarantee on its own. An administrator can still accept a more powerful login on purpose (audited and shown in status), root or Administrator on the host can replace the agent, and the plugin can read whatever its login can see.