You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tailscale/cmd
Tom Proctor 74d4652144
cmd/{containerboot,k8s-operator},k8s-operator: new options to expose user metrics (#14035)
containerboot:

Adds 3 new environment variables for containerboot, `TS_LOCAL_ADDR_PORT` (default
`"${POD_IP}:9002"`), `TS_METRICS_ENABLED` (default `false`), and `TS_DEBUG_ADDR_PORT`
(default `""`), to configure metrics and debug endpoints. In a follow-up PR, the
health check endpoint will be updated to use the `TS_LOCAL_ADDR_PORT` if
`TS_HEALTHCHECK_ADDR_PORT` hasn't been set.

Users previously only had access to internal debug metrics (which are unstable
and not recommended) via passing the `--debug` flag to tailscaled, but can now
set `TS_METRICS_ENABLED=true` to expose the stable metrics documented at
https://tailscale.com/kb/1482/client-metrics at `/metrics` on the addr/port
specified by `TS_LOCAL_ADDR_PORT`.

Users can also now configure a debug endpoint more directly via the
`TS_DEBUG_ADDR_PORT` environment variable. This is not recommended for production
use, but exposes an internal set of debug metrics and pprof endpoints.

operator:

The `ProxyClass` CRD's `.spec.metrics.enable` field now enables serving the
stable user metrics documented at https://tailscale.com/kb/1482/client-metrics
at `/metrics` on the same "metrics" container port that debug metrics were
previously served on. To smooth the transition for anyone relying on the way the
operator previously consumed this field, we also _temporarily_ serve tailscaled's
internal debug metrics on the same `/debug/metrics` path as before, until 1.82.0
when debug metrics will be turned off by default even if `.spec.metrics.enable`
is set. At that point, anyone who wishes to continue using the internal debug
metrics (not recommended) will need to set the new `ProxyClass` field
`.spec.statefulSet.pod.tailscaleContainer.debug.enable`.

Users who wish to opt out of the transitional behaviour, where enabling
`.spec.metrics.enable` also enables debug metrics, can set
`.spec.statefulSet.pod.tailscaleContainer.debug.enable` to false (recommended).

Separately but related, the operator will no longer specify a host port for the
"metrics" container port definition. This caused scheduling conflicts when k8s
needs to schedule more than one proxy per node, and was not necessary for allowing
the pod's port to be exposed to prometheus scrapers.

Updates #11292

---------

Co-authored-by: Kristoffer Dalby <kristoffer@tailscale.com>
Signed-off-by: Tom Proctor <tomhjp@users.noreply.github.com>
1 year ago
..
addlicense all: update tools that manage copyright headers 3 years ago
build-webclient client/web: precompress assets 2 years ago
cloner cmd/cloner, cmd/viewer, util/codegen: add support for aliases of cloneable types 1 year ago
connector-gen cmd/connector-gen: add helper tool for wide app connector configurations 2 years ago
containerboot cmd/{containerboot,k8s-operator},k8s-operator: new options to expose user metrics (#14035) 1 year ago
derper tsweb: change RequestID format to have a date in it 1 year ago
derpprobe cmd/derpprobe,prober: add ability to restrict derpprobe to a single region 1 year ago
dist release/dist/qnap: add qnap target builder 2 years ago
get-authkey client/tailscale,cmd/{cli,get-authkey,k8s-operator}: set distinct User-Agents 1 year ago
gitops-pusher cmd/gitops-pusher: ignore previous etag if local acls match control (#13068) 1 year ago
hello cmd/hello: link to the Hello KB article (#11022) 2 years ago
k8s-nameserver cmd/k8s-nameserver: fix AAAA record query response (#12412) 2 years ago
k8s-operator cmd/{containerboot,k8s-operator},k8s-operator: new options to expose user metrics (#14035) 1 year ago
mkmanifest cmd/mkmanifest, cmd/tailscale, cmd/tailscaled: remove Windows arm32 resources from OSS 3 years ago
mkpkg go.mod: upgrade nfpm to v2 (#8786) 2 years ago
mkversion version/mkversion: open-source version generation logic 3 years ago
nardump all: update copyright and license headers 3 years ago
natc cmd/natc: fix nil pointer 1 year ago
netlogfmt all: use Go 1.22 range-over-int 2 years ago
nginx-auth tailcfg,all: add and use Node.IsTagged() 3 years ago
pgproxy tsnet: split user facing and backend logging 2 years ago
printdep cmd/printdep: print correct toolchain URL 3 years ago
proxy-to-grafana cmd/proxy-to-grafana: add flag for alternative control server 1 year ago
sniproxy all: use math/rand/v2 more 2 years ago
speedtest all: update copyright and license headers 3 years ago
ssh-auth-none-demo all: replace deprecated ioutil references 2 years ago
stunc cmd/stunc: support user-specified port (#12469) 1 year ago
stund tsweb: change RequestID format to have a date in it 1 year ago
stunstamp cmd/stunstamp: add protocol context to timeout logs (#13422) 1 year ago
sync-containers all: adjust some build tags for plan9 2 years ago
systray cmd/systray: handle reconnects to IPN bus (#13386) 1 year ago
tailscale cli: present risk warning when setting up app connector on macOS (#14181) 1 year ago
tailscaled derp/derphttp: don't link websockets other than on GOOS=js 1 year ago
testcontrol all: use Go 1.22 range-over-int 2 years ago
testwrapper cmd/testwrapper: add pkg runtime to output (#13894) 1 year ago
tl-longchain cmd/tl-longchain: tool to re-sign nodes with long rotation signatures 1 year ago
tsconnect all: use iterators over slice views more 1 year ago
tsidp cmd/tsidp: add --dir flag 1 year ago
tsshd all: update copyright and license headers 3 years ago
tta cmd/tta: pull out test driver dialing into a type, fix bugs 1 year ago
viewer cmd/viewer: import types/views when generating a getter for a map field 1 year ago
vnet tstest/natlab/vnet: add start of IPv6 support 1 year ago
xdpderper all: add test for package comments, fix, add comments as needed 1 year ago