Documentation
¶
Overview ¶
Package target contains information about the thing that is sending metrics - either a NetworkDevice (a machine) or a Task (a service). There is a default target that is usually configured with commandline flags (flags.go), but a target can also be passed through the Context (context.go) if you need to set metric values for a different target.
Index ¶
- Constants
- func Get(ctx context.Context) types.Target
- func GetWithDefault(ctx context.Context, def types.Target) types.Target
- func NewFromFlags(fl *Flags) (types.Target, error)
- func Set(ctx context.Context, t types.Target) context.Context
- type Flags
- type NetworkDevice
- type SysInfo
- type Task
- type Type
Constants ¶
Variables ¶
This section is empty.
Functions ¶
func GetWithDefault ¶
GetWithDefault is like Get, except it returns the given default value if there is no target set in the context.
func NewFromFlags ¶
NewFromFlags returns a Target configured from commandline flags.
Types ¶
type Flags ¶
type Flags struct {
TargetType Type
DeviceHostname string
DeviceRegion string
DeviceRole string
DeviceNetwork string
TaskServiceName string
TaskJobName string
TaskRegion string
TaskHostname string
TaskNumber int
AutoGenHostname bool
// If nil, system info is computed from the actual host. Used
// in tests.
SysInfo *SysInfo
}
Flags defines command line flags related to tsmon targets. Use NewFlags() to get a Flags struct with sensible default values.
func NewFlags ¶
func NewFlags() Flags
NewFlags returns a Flags struct with sensible default values. Hostname, region and network flags are expensive to compute, so get assigned default values later in SetDefaultsFromHostname.
func (*Flags) Register ¶
Register adds tsmon target related flags to a FlagSet.
type NetworkDevice ¶
A NetworkDevice is a machine that has a hostname.
func (*NetworkDevice) Clone ¶
func (t *NetworkDevice) Clone() types.Target
Clone returns a copy of this object.
func (*NetworkDevice) Hash ¶
func (t *NetworkDevice) Hash() uint64
Hash returns a uint64 hash of this target.
func (*NetworkDevice) PopulateProto ¶
func (t *NetworkDevice) PopulateProto(d *pb.MetricsCollection)
PopulateProto implements Target.
type SysInfo ¶
SysInfo overrides system's hostname and region for tests.
Source Files