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.
 
 
 
 
 
 
Go to file
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>
2 days ago
.bencher bencher: add config to suppress failures on benchmark regressions. 3 years ago
.github .github: Bump actions/setup-go from 5.0.2 to 5.1.0 (#13934) 1 week ago
appc appc: track metrics for route info storing 4 months ago
atomicfile various: add golangci-lint, fix issues (#7905) 2 years ago
chirp all: update copyright and license headers 2 years ago
client client/tailscale,ipn/{ipnlocal,localapi}: add a pre-shutdown localAPI endpoint that terminates control connections. (#14028) 2 weeks ago
clientupdate clientupdate: don't link distsign on platforms that don't download 1 month ago
cmd cmd/{containerboot,k8s-operator},k8s-operator: new options to expose user metrics (#14035) 2 days ago
control cmd/tailscale/cli: create netmon in debug ts2021 3 days ago
derp derp/derphttp: don't link websockets other than on GOOS=js 2 weeks ago
disco disco: correct noun for nacl box type in disco docs 12 months ago
docs cmd/k8s-operator,kube/kubeclient,docs/k8s: update rbac to emit events + small fixes (#14164) 4 days ago
doctor net/{interfaces,netmon}, all: merge net/interfaces package into net/netmon 7 months ago
drive drive/driveimpl: use su instead of sudo 3 months ago
envknob envknob,kube/kubetypes,cmd/k8s-operator: add app type for ProxyGroup (#14029) 2 weeks ago
gokrazy gokrazy, various: use point versions of Go and update Nix deps 2 months ago
health health: fix spurious warning about DERP home region '0' 1 month ago
hostinfo types/result, util/lineiter: add package for a result type, use it 3 weeks ago
internal all: add test for package comments, fix, add comments as needed 5 months ago
ipn kube/{kubeapi,kubeclient},ipn/store/kubestore,cmd/{containerboot,k8s-operator}: emit kube store Events (#14112) 5 days ago
jsondb all: update copyright and license headers 2 years ago
k8s-operator cmd/{containerboot,k8s-operator},k8s-operator: new options to expose user metrics (#14035) 2 days ago
kube cmd/k8s-operator,kube/kubeclient,docs/k8s: update rbac to emit events + small fixes (#14164) 4 days ago
licenses licenses: update license notices 4 days ago
log log/sockstatlog: don't block for more than 5s on shutdown 4 months ago
logpolicy cmd/tsconnect, logpolicy: fixes for wasm_js.go 1 month ago
logtail logtail: close idle HTTP connections on shutdown 4 months ago
metrics metrics: revert changes to MultiLabelMap's String method 2 months ago
net net/tsaddr: include test input in test failure output 3 days ago
omit cmd/tailscaled, ipn/conffile: support ec2 user-data config file 6 months ago
packages/deb go.mod: upgrade nfpm to v2 (#8786) 1 year ago
paths all: use Go 1.22 range-over-int 7 months ago
portlist all: use Go 1.22 range-over-int 7 months ago
posture control/controlclient,posture,util/syspolicy: use predefined syspolicy keys instead of string literals 3 months ago
prober cmd/derpprobe,prober: add ability to restrict derpprobe to a single region 1 week ago
proxymap ipnlocal,proxymap,wgengine/netstack: add optional WhoIs/proxymap debug 2 months ago
release release/dist: clamp min / max version for synology package centre (#13857) 1 month ago
safesocket safesocket: don't depend on go-ps on iOS 2 months ago
safeweb safeweb: add a Shutdown method to the Server type (#14048) 2 weeks ago
scripts scripts/installer.sh: allow Archcraft for Arch packages (#13870) 1 month ago
sessionrecording sessionrecording: implement v2 recording endpoint support (#14105) 5 days ago
smallzstd all: use Go 1.22 range-over-int 7 months ago
ssh/tailssh sessionrecording: implement v2 recording endpoint support (#14105) 5 days ago
syncs syncs: allocate map with Map.WithLock (#13755) 2 months ago
tailcfg wgengine/filter: actually use the passed CapTestFunc [capver 109] 4 days ago
taildrop taildrop: fix defer in loop (#13757) 2 months ago
tempfork cmd/tailscale: add shell tab-completion 7 months ago
tka tka: truncate long rotation signature chains 3 months ago
tool tool/gocross: remove trimpath from test builds 4 weeks ago
tsconst cmd/tailscale/cli: support passing network lock keys via files 3 months ago
tsd util/usermetrics: make usermetrics non-global 2 months ago
tsnet all: use iterators over slice views more 2 weeks ago
tstest tstest/integration/testcontrol: remove a vestigial unused parameter 1 week ago
tstime all: use math/rand/v2 more 6 months ago
tsweb tsweb: change RequestID format to have a date in it 3 days ago
types all: use iterators over slice views more 2 weeks ago
util util/fastuuid: delete unused package 3 days ago
version version: fix earlier test/wording mistakes 4 days ago
wf wf/firewall: allow link-local multicast for permitted local routes when the killswitch is on on Windows 2 months ago
wgengine wgengine/filter: actually use the passed CapTestFunc [capver 109] 4 days ago
words words: Add scoville to scales.txt (#14084) 1 week ago
.gitattributes .: add .gitattributes entry to use Go hunk-header driver 3 years ago
.gitignore tstest/tailmac: add customized macOS virtualization tooling (#13146) 3 months ago
.golangci.yml ci: run 'go vet' in golangci-lint; fix errors in tests 12 months ago
ALPINE.txt ALPINE.txt,Dockerfile{.base},build_docker.sh: bump alpine (#10543) 12 months ago
AUTHORS Move Linux client & common packages into a public repo. 5 years ago
CODEOWNERS CODEOWNERS: add the start of an owners file 1 year ago
CODE_OF_CONDUCT.md Add a code of conduct. 5 years ago
Dockerfile all: switch to and require Go 1.23 3 months ago
Dockerfile.base ALPINE.txt,Dockerfile{.base},build_docker.sh: bump alpine (#10543) 12 months ago
LICENSE all: update tools that manage copyright headers 2 years ago
Makefile ssh/tailssh: fix SSH on busybox systems 3 months ago
PATENTS Move Linux client & common packages into a public repo. 5 years ago
README.md all: switch to and require Go 1.23 3 months ago
SECURITY.md Add a SECURITY.md for vulnerability reports. 5 years ago
VERSION.txt VERSION.txt: this is v1.77.0 (#13779) 1 month ago
api.md {api.md,publicapi}: remove old API docs (#13468) 2 months ago
assert_ts_toolchain_match.go tailscaleroot: panic if tailscale_go build tag but Go toolchain mismatch 2 months ago
build_dist.sh cmd/tailscale: add shell tab-completion 7 months ago
build_docker.sh go.{mod,sum},build_docker.sh: bump mkctr, add ability to set OCI annotations for images (#14065) 2 weeks ago
flake.lock nix: update nix and use go 1.23 3 months ago
flake.nix gokrazy, various: use point versions of Go and update Nix deps 2 months ago
go.mod go.mod: bump tailscale/wireguard-go 1 week ago
go.mod.sri go.mod.sri: update SRI hash for go.mod changes 3 months ago
go.sum go.mod: bump tailscale/wireguard-go 1 week ago
go.toolchain.branch all: switch to and require Go 1.23 3 months ago
go.toolchain.rev go.toolchain.rev: bump from Go 1.23.1 to Go 1.23.3 1 week ago
gomod_test.go go.mod: add test that replace directives aren't added in oss 1 year ago
header.txt cmd/k8s-operator: operator can create subnetrouter (#9505) 12 months ago
pkgdoc_test.go all: add test for package comments, fix, add comments as needed 5 months ago
pull-toolchain.sh pull-toolchain.sh: don't run update-flake.sh 2 years ago
shell.nix go.mod.sri: update SRI hash for go.mod changes 3 months ago
staticcheck.conf all: cleanup unused code, part 2 (#10670) 11 months ago
update-flake.sh Code Improvements (#11311) 9 months ago
version-embed.go tailscaleroot: panic if tailscale_go build tag but Go toolchain mismatch 2 months ago
version_tailscale_test.go tailscaleroot: panic if tailscale_go build tag but Go toolchain mismatch 2 months ago
version_test.go go.mod,wgengine/netstack: bump gvisor 10 months ago

README.md

Tailscale

https://tailscale.com

Private WireGuard® networks made easy

Overview

This repository contains the majority of Tailscale's open source code. Notably, it includes the tailscaled daemon and the tailscale CLI tool. The tailscaled daemon runs on Linux, Windows, macOS, and to varying degrees on FreeBSD and OpenBSD. The Tailscale iOS and Android apps use this repo's code, but this repo doesn't contain the mobile GUI code.

Other Tailscale repos of note:

For background on which parts of Tailscale are open source and why, see https://tailscale.com/opensource/.

Using

We serve packages for a variety of distros and platforms at https://pkgs.tailscale.com.

Other clients

The macOS, iOS, and Windows clients use the code in this repository but additionally include small GUI wrappers. The GUI wrappers on non-open source platforms are themselves not open source.

Building

We always require the latest Go release, currently Go 1.23. (While we build releases with our Go fork, its use is not required.)

go install tailscale.com/cmd/tailscale{,d}

If you're packaging Tailscale for distribution, use build_dist.sh instead, to burn commit IDs and version info into the binaries:

./build_dist.sh tailscale.com/cmd/tailscale
./build_dist.sh tailscale.com/cmd/tailscaled

If your distro has conventions that preclude the use of build_dist.sh, please do the equivalent of what it does in your distro's way, so that bug reports contain useful version information.

Bugs

Please file any issues about this code or the hosted service on the issue tracker.

Contributing

PRs welcome! But please file bugs. Commit messages should reference bugs.

We require Developer Certificate of Origin Signed-off-by lines in commits.

See git log for our commit message style. It's basically the same as Go's style.

About Us

Tailscale is primarily developed by the people at https://github.com/orgs/tailscale/people. For other contributors, see:

WireGuard is a registered trademark of Jason A. Donenfeld.