setup

Documentation

Overview

Package setup contains common logic for setting up the export package across binaries.

Index

• Constants
• Variables
• func ExporterOptsFlags(a *kingpin.Application, opts *export.ExporterOpts)
• func ExtraArgs() ([]string, error)
• func Global() *export.Exporter
• func SetGlobal(exporter *export.Exporter) (err error)
• type HAOptions
  • func (opts *HAOptions) DefaultUnsetFields()
  • func (opts *HAOptions) NewLease(logger log.Logger, reg prometheus.Registerer) (export.Lease, error)
  • func (opts *HAOptions) SetupFlags(a *kingpin.Application)
• type MetadataOpts
  • func (o *MetadataOpts) DefaultUnsetFields()
  • func (o *MetadataOpts) ExtractMetadata(logger log.Logger, exporterOpts *export.ExporterOpts)
  • func (o *MetadataOpts) SetupFlags(a *kingpin.Application)
• type Opts
  • func (opts *Opts) NewExporter(ctx context.Context, logger log.Logger, reg prometheus.Registerer) (*export.Exporter, error)
  • func (opts *Opts) SetupFlags(a *kingpin.Application)

Constants

const (
	// Supported HA backend modes.
	HABackendNone       = "none"
	HABackendKubernetes = "kube"
	// User agent environments.
	UAEnvGKE         = "gke"
	UAEnvGCE         = "gce"
	UAEnvUnspecified = "unspecified"

	// User agent modes.
	UAModeGKE         = "gke"
	UAModeKubectl     = "kubectl"
	UAModeUnspecified = "unspecified"
	UAModeAVMW        = "on-prem"
	UAModeABM         = "baremetal"
)

const ExtraArgsEnvvar = "EXTRA_ARGS"

Environment variable that contains additional command line arguments. It can be used to inject additional arguments when the regular ones cannot be easily modified.

Variables

var ErrLocationGlobal = errors.New("Location must be set to a named Google Cloud " +
	"region and cannot be set to \"global\". Please choose the " +
	"Google Cloud region that is physically nearest to your cluster. " +
	"See https://www.cloudinfrastructuremap.com/")

Functions

func ExporterOptsFlags

func ExporterOptsFlags(a *kingpin.Application, opts *export.ExporterOpts)

ExporterOptsFlags adds flags to the application, defaulting the options.

func ExtraArgs

func ExtraArgs() ([]string, error)

ExtraArgs returns additional command line arguments extracted from the EXTRA_ARGS. environment variable. It is parsed like a shell parses arguments. For example: EXTRA_ARGS="--foo=bar -x 123". It can be used like `flagset.Parse(append(os.Args[1:], ExtraArgs()...))`.

func Global

func Global() *export.Exporter

Global returns the global instance of the GCM exporter.

func SetGlobal

func SetGlobal(exporter *export.Exporter) (err error)

SetGlobal sets the global instance of the GCM exporter.

Types

type HAOptions

type HAOptions struct {
	Backend        string
	KubeConfigFile string
	KubeNamespace  string
	KubeName       string
}

func (*HAOptions) DefaultUnsetFields

func (opts *HAOptions) DefaultUnsetFields()

DefaultUnsetFields defaults any zero-valued fields.

func (*HAOptions) NewLease

func (opts *HAOptions) NewLease(logger log.Logger, reg prometheus.Registerer) (export.Lease, error)

func (*HAOptions) SetupFlags

func (opts *HAOptions) SetupFlags(a *kingpin.Application)

SetupFlags adds flags to the application, defaulting the options.

type MetadataOpts

type MetadataOpts struct {
	FetchTimeout time.Duration
}

func (*MetadataOpts) DefaultUnsetFields

func (o *MetadataOpts) DefaultUnsetFields()

DefaultUnsetFields defaults any zero-valued fields.

func (*MetadataOpts) ExtractMetadata

func (o *MetadataOpts) ExtractMetadata(logger log.Logger, exporterOpts *export.ExporterOpts)

func (*MetadataOpts) SetupFlags

func (o *MetadataOpts) SetupFlags(a *kingpin.Application)

SetupFlags adds flags to the application, defaulting the options.

type Opts

type Opts struct {
	ExporterOpts export.ExporterOpts
	MetadataOpts MetadataOpts
	HAOptions    HAOptions
}

func (*Opts) NewExporter

func (opts *Opts) NewExporter(ctx context.Context, logger log.Logger, reg prometheus.Registerer) (*export.Exporter, error)

func (*Opts) SetupFlags

func (opts *Opts) SetupFlags(a *kingpin.Application)

SetupFlags adds flags to the application, defaulting the options.