mirror of
https://github.com/tailscale/tailscale.git
synced 2025-04-28 11:40:58 +00:00
61bea75092
3dabea0fc2c added some docs with inconsistent usage docs. This fixes them, and adds a test. It also adds some other tests and fixes other verb tense inconsistencies. Updates tailscale/corp#25278 Change-Id: I94c2a8940791bddd7c35c1c3d5fb791a317370c2 Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
89 lines
2.4 KiB
Go
89 lines
2.4 KiB
Go
// Copyright (c) Tailscale Inc & AUTHORS
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
package cli
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/peterbourgon/ff/v3/ffcli"
|
|
"tailscale.com/atomicfile"
|
|
)
|
|
|
|
var metricsCmd = &ffcli.Command{
|
|
Name: "metrics",
|
|
ShortHelp: "Show Tailscale metrics",
|
|
LongHelp: strings.TrimSpace(`
|
|
|
|
The 'tailscale metrics' command shows Tailscale user-facing metrics (as opposed
|
|
to internal metrics printed by 'tailscale debug metrics').
|
|
|
|
For more information about Tailscale metrics, refer to
|
|
https://tailscale.com/s/client-metrics
|
|
|
|
`),
|
|
ShortUsage: "tailscale metrics <subcommand> [flags]",
|
|
UsageFunc: usageFuncNoDefaultValues,
|
|
Exec: runMetricsNoSubcommand,
|
|
Subcommands: []*ffcli.Command{
|
|
{
|
|
Name: "print",
|
|
ShortUsage: "tailscale metrics print",
|
|
Exec: runMetricsPrint,
|
|
ShortHelp: "Print current metric values in Prometheus text format",
|
|
},
|
|
{
|
|
Name: "write",
|
|
ShortUsage: "tailscale metrics write <path>",
|
|
Exec: runMetricsWrite,
|
|
ShortHelp: "Write metric values to a file",
|
|
LongHelp: strings.TrimSpace(`
|
|
|
|
The 'tailscale metrics write' command writes metric values to a text file provided as its
|
|
only argument. It's meant to be used alongside Prometheus node exporter, allowing Tailscale
|
|
metrics to be consumed and exported by the textfile collector.
|
|
|
|
As an example, to export Tailscale metrics on an Ubuntu system running node exporter, you
|
|
can regularly run 'tailscale metrics write /var/lib/prometheus/node-exporter/tailscaled.prom'
|
|
using cron or a systemd timer.
|
|
|
|
`),
|
|
},
|
|
},
|
|
}
|
|
|
|
// runMetricsNoSubcommand prints metric values if no subcommand is specified.
|
|
func runMetricsNoSubcommand(ctx context.Context, args []string) error {
|
|
if len(args) > 0 {
|
|
return fmt.Errorf("tailscale metrics: unknown subcommand: %s", args[0])
|
|
}
|
|
|
|
return runMetricsPrint(ctx, args)
|
|
}
|
|
|
|
// runMetricsPrint prints metric values to stdout.
|
|
func runMetricsPrint(ctx context.Context, args []string) error {
|
|
out, err := localClient.UserMetrics(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
Stdout.Write(out)
|
|
return nil
|
|
}
|
|
|
|
// runMetricsWrite writes metric values to a file.
|
|
func runMetricsWrite(ctx context.Context, args []string) error {
|
|
if len(args) != 1 {
|
|
return errors.New("usage: tailscale metrics write <path>")
|
|
}
|
|
path := args[0]
|
|
out, err := localClient.UserMetrics(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return atomicfile.WriteFile(path, out, 0644)
|
|
}
|