ISTIOCTL-EXPERIMENTAL-ENVOY-STATS(1)

πŸ“¦ version 1.31.3, in nixos 26.05, nixpkgs unstable

πŸ’… istioctl-experimental-envoy-stats πŸ’…

okay bestie, so this is the manual page for istioctl-experimental-envoy-stats, from the ISTIOCTL-EXPERIMENTAL-ENVOY-STATS(1) family of man pages β€” and literally all it does is go grab Envoy's metrics out of a pod for you. that's it. that's the whole vibe. and honestly? iconic. πŸŽ€


✨ NAME ✨

istioctl-experimental-envoy-stats β€” retrieves Envoy metrics in the specified pod. no cap, that's the entire job description. πŸ¦‹


🌸 SYNOPSIS 🌸

istioctl experimental envoy-stats [/][.] [flags]

like yes, the synopsis genuinely does look like that. [/][.] is real and you're gonna have to trust me on it. πŸ’€


πŸ’– DESCRIPTION πŸ’–

so you point it at a pod, and it goes and retrieves the Envoy emitted metrics for that specified pod. that's the tea. that's the whole paragraph. she's concise, she's efficient, she ate. πŸ‘‘


πŸ¦‹ OPTIONS πŸ¦‹

  • -h, --help[=false] β€” help for envoy-stats. the classic. the moment you're lost, she's there. 🫢
  • -o, --output="short" β€” output format, and it's gotta be one of json|yaml|short|prom|prom-merged. default is short, bestie. ✨
  • --proxy-admin-port=15000 β€” the Envoy proxy admin port. defaults to 15000, noted. 🌸
  • -l, --selector="" β€” label selector. empty by default, so specify it if you want it. πŸ’…
  • -t, --type="server" β€” where to grab the stats from: one of server|clusters. default is server. so you do get a choice, main character energy. ⭐

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these bad boys are handed down from the parent command β€” not this page's business, but they come with the package, so here they are in full:

  • --as="" β€” username to impersonate for the operation. user could be a regular user or a service account in a namespace. πŸ™ˆ
  • --as-group=[] β€” group to impersonate for the operation. this flag can be repeated to specify multiple groups. yes, repeat her. πŸ’œ
  • --as-uid="" β€” UID to impersonate for the operation. πŸ”₯
  • --context="" β€” Kubernetes configuration context.
  • -i, --istioNamespace="istio-system" β€” Istio system namespace. defaults to istio-system, cozy. 🧚
  • --kubeclient-timeout="15s" β€” Kubernetes client timeout as a time.Duration string. defaults to 15 seconds. πŸ“
  • -c, --kubeconfig="" β€” Kubernetes configuration file.
  • -n, --namespace="" β€” Kubernetes namespace.
  • --vklog=0 β€” number for the log level verbosity. like the -v flag. ex: --vklog=9. go off, crank it. πŸ”Š

πŸ”₯ EXAMPLE πŸ”₯

okay this is the part where it gets good, because there are LITERALLY five examples and each one is a whole mood:

# Retrieve Envoy emitted metrics for the specified pod.
istioctl experimental envoy-stats <pod-name[.namespace]>

# Retrieve Envoy server metrics in prometheus format
istioctl experimental envoy-stats <pod-name[.namespace]> --output prom

# Retrieve Envoy server metrics in prometheus format with custom proxy admin port
istioctl experimental envoy-stats <pod-name[.namespace]> --output prom --proxy-admin-port 15000

# Retrieve Envoy server metrics in prometheus format with merged application metrics
istioctl experimental envoy-stats <pod-name[.namespace]> --output prom-merged

# Retrieve Envoy cluster metrics
istioctl experimental envoy-stats <pod-name[.namespace]> --type clusters

see how <pod-name[.namespace]> keeps showing up? that's the whole "specified pod" thing from the description, bestie. you're giving her a pod name, optionally dotted with a namespace. slay. 🫢

ngl, prom-merged is lowkey the sneaky star of the show β€” that's the one that gets you the Envoy server metrics with merged application metrics. iykyk. πŸ’…

πŸ‘‘ SEE ALSO πŸ‘‘

istioctl-experimental(1) β€” go read her too, she's the parent and she knows things. 🌟


and that's the page!! πŸ’– fr fr, credit where it's due: this whole thing is auto generated by spf13/cobra, and the footer date on this copy reads Jan 198 (yes, really, it's cut off like that, don't come for me 😭). hope this helped bestie, go get those metrics πŸŽ€βœ¨

πŸ“¦ where this page comes from