From 876a79968949c8b6d746f759f40cabe5a28ec786 Mon Sep 17 00:00:00 2001 From: Etienne Perot Date: Tue, 7 Feb 2023 17:17:52 -0800 Subject: [PATCH] gvisor.dev: Update metric server documentation to have `localhost` as default. PiperOrigin-RevId: 507928107 --- g3doc/user_guide/observability.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/g3doc/user_guide/observability.md b/g3doc/user_guide/observability.md index a1462d833..b59354d7e 100644 --- a/g3doc/user_guide/observability.md +++ b/g3doc/user_guide/observability.md @@ -50,7 +50,10 @@ runsc_fs_reads{sandbox="c7ce77796e0ece4c0881fb26261608552ea4a67b2fe5934658b8b443 Use the `runsc metric-server` subcommand: ```shell -$ sudo runsc --root=/var/run/docker/runtime-runc/moby --metric-server=:1337 metric-server +$ sudo runsc \ + --root=/var/run/docker/runtime-runc/moby \ + --metric-server=localhost:1337 \ + metric-server ``` `--root` needs to be set to the OCI runtime root directory that your runtime @@ -95,7 +98,7 @@ this can be set in `/etc/docker/daemon.json` like so: "runsc": { "path": "/path/to/runsc", "runtimeArgs": [ - "--metric-server=:1337" + "--metric-server=localhost:1337" ] } } @@ -253,11 +256,6 @@ runsc_fs_reads{iteration="2407456650315156914",sandbox="737ce142058561d764ad870d # [...] ``` -Note that this example won't work if your Docker runtime uses -`--metric-server=localhost:1337`, since the in-sandbox `runsc metric-server` -process uses `--metric-server=:1337`. The flag values need to be an *exact* -string match, even if they run in different contexts. - ## Labeling pods on Kubernetes When using Kubernetes, users typically deal with pod names and container names.