cmd

README

Go cmd helper.

This provides helpers on top of github.com/urfave/cli.

Overview

Install with:

go get github.com/hamba/cmd/v2

Example

func yourAction(c *cli.Context) error {
    log, err := cmd.NewLogger(c)
	if err != nil {
		// Handle error.
	}

	stats, err := cmd.NewStatter(c, log)
	if err != nil {
		// Handle error.
	}

    tracer, err := cmd.NewTracer(c, log,
        semconv.ServiceNameKey.String("my-service"),
        semconv.ServiceVersionKey.String("1.0.0"),
    )
    if err != nil {
        // Handle error.
        return
    }
    defer tracer.Shutdown(context.Background())

    // Run your application here...
	
	return nil
}

Flags

Logger

The logger flags are used by cmd.NewLogger to create a hamba.Logger.

FlagLogFormat: --log.format, $LOG_FORMAT

This flag sets the log formatter to use. The available options are logfmt (default), json, console.

Example: --log.format=console

FlagLogLevel: --log.level, $LOG_LEVEL

This flag sets the log level to filer on. The available options are debug, info (default), warn, error, crit.

Example: --log.level=error

FlagLogCtx: --log.ctx, $LOG_CTX

This flag sets contextual key value pairs to set on all log messages. This flag can be specified multiple times.

Example: --log.ctx="app=my-app" --log.ctx="zone=eu-west"

Statter

The statter flags are used by cmd.NewStatter to create a new `hamba.Statter.

FlagStatsDSN: --stats.dsn, $STATS_DSN

This flag sets the DSN describing the stats reporter to use. The available options are statsd, prometheus, l2met, victoriametrics.

The DSN can in some situations specify the host and configuration values as shown in the below examples:

Statsd:

--stats.dsn="statsd://host:port?flushBytes=1432&flushInterval=10s"

The host and port are required. Optionally flushBytes and flushInterval can be set, controlling how often the stats will be sent to the Statsd server.

Prometheus:

--stats.dsn="prometheus://host:port"

or

--stats.dsn="prom://host:port"

The host and port are optional. If set they will start a prometheus http server on the specified host and port.

Victoria Metrics:

--stats.dsn="victoriametrics://host:port"

or

--stats.dsn="vm://host:port"

The host and port are optional. If set they will start a victoria metrics http server on the specified host and port.

l2met:

--stats.dsn="l2met://"

This report has no exposed options.

FlagStatsInterval: --stats.interval, $STATS_INTERVAL

This flag sets the interval at which the aggregated stats will be reported to the reporter.

Example: --stats-interval=10s

FlagStatsPrefix: --stats.prefix, $STATS_PREFIX

This flag sets the prefix attached to all stats keys.

Example: --stats.prefix=my-app.server

FlagStatsTags: --stats.tags, $STATS_TAGS

This flag sets tag key value pairs to set on all stats. This flag can be specified multiple times.

Example: --stats.tags="app=my-app" --stats.tags="zone=eu-west"

Profiler

The profiler flags are used by cmd.NewProfiler to create a Pyroscope *pyroscope.Profiler.

FlagProfilingDSN: --profiling.dsn, $PROFILING_DSN

This flag configures the URL, authentication and optionally the Tenant ID for Pyroscope.

Example: --profiling.dsn=https://user:pass@host/path?token=auth-token&tenantid=my-tenant-id

FlagProfileUploadRate: --profiling.upload-rate, $PROFILING_UPLOAD_RATE

This flag configures the rate at which profiles are uploaded.

Example: --profiling.upload-rate=10s

FlagProfilingTags: --profiling.tags, $PROFILING_TAGS

This configures a list of tags appended to every profile. This flag can be specified multiple times.

Example: --profiling.tags="app=my-app" --profiling.tags="zone=eu-west"

FlagProfilingTypes: --profiling.types, $PROFILING_TYPES

This configures the profile types that are captured. By default all supported types are captured. This flag can be specified multiple times.

Example: --profiling.types=cpu --profiling.types=inuse_object

Tracer

The tracing flags are used by cmd.NewTracer to create a new open telemetry trace.TraceProvider.

FlagTracingExporter: --tracing.exporter, $TRACING_EXPORTER

This flag sets the exporter to send spans to. The available options are zipkin, otlphttp and otlpgrpc.

Example: --tracing.exporter=otlphttp

FlagTracingEndpoint: --tracing.endpoint, $TRACING_ENDPOINT

This flag sets the endpoint the exporter should send traces to.

Example: --tracing.endpoint="agent-host:port" or --tracing.endpoint="http://host:port/api/v2"

FlagTracingEndpointInsecure: --tracing.endpoint-insecure, $TRACING_ENDPOINT_INSECURE

This flag sets the endpoint the exporter should send traces to.

Example: --tracing.endpoint-insecure

FlagTracingRatio: --tracing.ratio, $TRACING_RATIO

This flag sets the sample ratio of spans that will be reported to the exporter. This should be between 0 and 1.

Example: --tracing.ratio=0.2

FlagTracingTags: --tracing.tags, $TRACING_TAGS

This flag sets a list of tags appended to every trace. This flag can be specified multiple times.

Example: --tracing.tags="app=my-app" --tracing.tags="zone=eu-west"

Observer

The observe package exposes an Observer type which is essentially a helper that combines a logger, tracer and statter. It is useful if you use all three for your services and want to avoid carrying around many arguments.

Here is an example of how one might use it:

func yourAction(c *cli.Context) error {
     obsvr, err := observe.NewFromCLI(c, "my-service", &observe.Options{
        LogTimestamps: true,
        StatsRuntime:  true,
        TracingAttrs: []attribute.KeyValue{
            semconv.ServiceVersionKey.String("1.0.0"),
        },
    })
    if err != nil {
        return err
    }
    defer obsvr.Close()

	// Run your application here...

	return nil
}

It also exposes NewFake which allows you to pass fake loggers, tracers and statters in your tests easily.

Documentation

Overview

Package cmd implements cmd helpers.

This provides helpers on top of `github.com/urfave/cli`.

Index

• Constants
• Variables
• func NewLogger(cmd *cli.Command) (*logger.Logger, error)
• func NewLoggerWithOptions(cmd *cli.Command, opts *LoggerOptions) (*logger.Logger, error)
• func NewProfiler(cmd *cli.Command, svc string, log *logger.Logger) (*pyroscope.Profiler, error)
• func NewStatter(cmd *cli.Command, log *logger.Logger, opts ...statter.Option) (*statter.Statter, error)
• func NewTracer(ctx context.Context, cmd *cli.Command, log *logger.Logger, ...) (*trace.TracerProvider, error)
• type Flags
  • func (f Flags) Merge(flags ...Flags) Flags
• type LoggerOptions

Examples

• NewLogger
• NewProfiler
• NewStatter
• NewTracer

Constants

const (
	FlagLogFormat = "log.format"
	FlagLogLevel  = "log.level"
	FlagLogCtx    = "log.ctx"
)

Log flag constants declared for CLI use.

const (
	FlagProfilingDSN      = "profiling.dsn"
	FlagProfileUploadRate = "profiling.upload-rate"
	FlagProfilingTags     = "profiling.tags"
	FlagProfilingTypes    = "profiling.types"
)

Tracing flag constants declared for CLI use.

const (
	FlagStatsDSN      = "stats.dsn"
	FlagStatsInterval = "stats.interval"
	FlagStatsPrefix   = "stats.prefix"
	FlagStatsTags     = "stats.tags"
)

Stats flag constants declared for CLI use.

const (
	FlagTracingExporter         = "tracing.exporter"
	FlagTracingEndpoint         = "tracing.endpoint"
	FlagTracingEndpointInsecure = "tracing.endpoint-insecure"
	FlagTracingTags             = "tracing.tags"
	FlagTracingHeaders          = "tracing.headers"
	FlagTracingRatio            = "tracing.ratio"
)

Tracing flag constants declared for CLI use.

const CategoryLog = "Logging"

CategoryLog is the log flag category.

const CategoryProfiling = "Profiling"

CategoryProfiling is the profiling category.

const CategoryStats = "Stats"

CategoryStats is the stats flag category.

const CategoryTracing = "Tracing"

CategoryTracing is the tracing flag category.

Variables

var LogFlags = Flags{
	&cli.StringFlag{
		Name:     FlagLogFormat,
		Category: CategoryLog,
		Usage:    "Specify the format of logs. Supported formats: 'logfmt', 'json', 'console'",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagLogFormat)),
	},
	&cli.StringFlag{
		Name:     FlagLogLevel,
		Category: CategoryLog,
		Value:    "info",
		Usage:    "Specify the log level. e.g. 'debug', 'info', 'error'.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagLogLevel)),
	},
	&cli.StringMapFlag{
		Name:     FlagLogCtx,
		Category: CategoryLog,
		Usage:    "A list of context field appended to every log. Format: key=value.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagLogCtx)),
	},
}

LogFlags are flags that configure logging.

var MonitoringFlags = Flags{}.Merge(LogFlags, StatsFlags, ProfilingFlags, TracingFlags)

MonitoringFlags are flags that configure logging, stats, profiling and tracing.

var ProfilingFlags = Flags{
	&cli.StringFlag{
		Name:     FlagProfilingDSN,
		Category: CategoryProfiling,
		Usage: "The address to the Pyroscope server, in the format: " +
			"'http://basic:auth@server:port?token=auth-token&tenantid=tenant-id'.",
		Sources: cli.EnvVars(strcase.ToSNAKE(FlagProfilingDSN)),
	},
	&cli.DurationFlag{
		Name:     FlagProfileUploadRate,
		Category: CategoryProfiling,
		Usage:    "The rate at which profiles are uploaded.",
		Value:    15 * time.Second,
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagProfileUploadRate)),
	},
	&cli.StringMapFlag{
		Name:     FlagProfilingTags,
		Category: CategoryProfiling,
		Usage:    "A list of tags appended to every profile.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagProfilingTags)),
	},
	&cli.StringSliceFlag{
		Name:     FlagProfilingTypes,
		Category: CategoryProfiling,
		Usage:    "The type of profiles to include. Defaults to all.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagProfilingTypes)),
	},
}

ProfilingFlags are flags that configure profiling.

var StatsFlags = Flags{
	&cli.StringFlag{
		Name:     FlagStatsDSN,
		Category: CategoryStats,
		Usage:    "The DSN of a stats backend.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagStatsDSN)),
	},
	&cli.DurationFlag{
		Name:     FlagStatsInterval,
		Category: CategoryStats,
		Usage:    "The frequency at which the stats are reported.",
		Value:    defaultStatsInterval,
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagStatsInterval)),
	},
	&cli.StringFlag{
		Name:     FlagStatsPrefix,
		Category: CategoryStats,
		Usage:    "The prefix of the measurements names.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagStatsPrefix)),
	},
	&cli.StringMapFlag{
		Name:     FlagStatsTags,
		Category: CategoryStats,
		Usage:    "A list of tags appended to every measurement.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagStatsTags)),
	},
}

StatsFlags are flags that configure stats.

var TracingFlags = Flags{
	&cli.StringFlag{
		Name:     FlagTracingExporter,
		Category: CategoryTracing,
		Usage:    "The tracing backend. Supported: 'zipkin', 'otlphttp', 'otlpgrpc'.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagTracingExporter)),
	},
	&cli.StringFlag{
		Name:     FlagTracingEndpoint,
		Category: CategoryTracing,
		Usage:    "The tracing backend endpoint.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagTracingEndpoint)),
	},
	&cli.BoolFlag{
		Name:     FlagTracingEndpointInsecure,
		Category: CategoryTracing,
		Usage:    "Determines if the endpoint is insecure.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagTracingEndpointInsecure)),
	},
	&cli.StringMapFlag{
		Name:     FlagTracingTags,
		Category: CategoryTracing,
		Usage:    "A list of tags appended to every trace.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagTracingTags)),
	},
	&cli.StringMapFlag{
		Name:     FlagTracingHeaders,
		Category: CategoryTracing,
		Usage:    "A list of headers appended to every trace when supported by the exporter.",
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagTracingHeaders)),
	},
	&cli.FloatFlag{
		Name:     FlagTracingRatio,
		Category: CategoryTracing,
		Usage:    "The ratio between 0 and 1 of sample traces to take.",
		Value:    0.5,
		Sources:  cli.EnvVars(strcase.ToSNAKE(FlagTracingRatio)),
	},
}

TracingFlags are flags that configure tracing.

Functions

func NewLogger

func NewLogger(cmd *cli.Command) (*logger.Logger, error)

NewLogger returns a logger configured from the cli.

Example

var c *cli.Command // Get this from your action

log, err := cmd.NewLogger(c)
if err != nil {
	// Handle error.
	return
}

_ = log

func NewLoggerWithOptions

func NewLoggerWithOptions(cmd *cli.Command, opts *LoggerOptions) (*logger.Logger, error)

NewLoggerWithOptions returns a logger configured from the cli.

func NewProfiler

func NewProfiler(cmd *cli.Command, svc string, log *logger.Logger) (*pyroscope.Profiler, error)

NewProfiler returns a profiler configured from the cli. If no profiler is configured, nil is returned.

Example

var c *cli.Command // Get this from your action

log, err := cmd.NewLogger(c)
if err != nil {
	// Handle error.
	return
}

prof, err := cmd.NewProfiler(c, "my-service", log)
if err != nil {
	// Handle error.
	return
}
if prof != nil {
	defer func() { _ = prof.Stop() }()
}

_ = prof

func NewStatter

func NewStatter(cmd *cli.Command, log *logger.Logger, opts ...statter.Option) (*statter.Statter, error)

NewStatter returns a statter configured from the cli.

Example

var c *cli.Command // Get this from your action

log, err := cmd.NewLogger(c)
if err != nil {
	// Handle error.
	return
}

stats, err := cmd.NewStatter(c, log)
if err != nil {
	// Handle error.
	return
}
defer func() { _ = stats.Close() }()

_ = stats

func NewTracer

func NewTracer(ctx context.Context, cmd *cli.Command, log *logger.Logger, attrs ...attribute.KeyValue) (*trace.TracerProvider, error)

NewTracer returns a tracer configured from the cli.

Example

var (
	ctx context.Context
	c   *cli.Command // Get this from your action
)

log, err := cmd.NewLogger(c)
if err != nil {
	// Handle error.
	return
}

tracer, err := cmd.NewTracer(ctx, c, log,
	semconv.ServiceNameKey.String("my-service"),
	semconv.ServiceVersionKey.String("1.0.0"),
)
if err != nil {
	// Handle error.
	return
}
defer func() { _ = tracer.Shutdown(context.Background()) }()

_ = tracer

Types

type Flags

type Flags []cli.Flag

Flags represents a set of CLI flags.

func (Flags) Merge

func (f Flags) Merge(flags ...Flags) Flags

Merge joins one or more Flags together, making a new set.

type LoggerOptions

type LoggerOptions struct {
	Writer io.Writer
}

LoggerOptions are options for creating a logger.