telemetry

Documentation

Overview

Package telemetry controls the telemetry settings to be used in the collector.

Index

• type Level
  • func ParseLevel(s string) (Level, error)
• type ProcessMetricsViews
  • func NewProcessMetricsViews(ballastSizeBytes uint64) *ProcessMetricsViews
  • func (pmv *ProcessMetricsViews) StartCollection()
  • func (pmv *ProcessMetricsViews) StopCollection()
  • func (pmv *ProcessMetricsViews) Views() []*view.View

Types

type Level

type Level int8

Level of telemetry data to be generated.

const (
	// None indicates that no telemetry data should be collected.
	None Level = iota - 1
	// Basic is the default and covers the basics of the service telemetry.
	Basic
	// Normal adds some other indicators on top of basic.
	Normal
	// Detailed adds dimensions and views to the previous levels.
	Detailed
)

func ParseLevel

func ParseLevel(s string) (Level, error)

ParseLevel returns the Level represented by the string. The parsing is case-insensitive and it returns error if the string value is unknown.

type ProcessMetricsViews

type ProcessMetricsViews struct {
	// contains filtered or unexported fields
}

ProcessMetricsViews is a struct that contains views related to process metrics (cpu, mem, etc)

func NewProcessMetricsViews

func NewProcessMetricsViews(ballastSizeBytes uint64) *ProcessMetricsViews

NewProcessMetricsViews creates a new set of ProcessMetrics (mem, cpu) that can be used to measure basic information about this process.

func (*ProcessMetricsViews) StartCollection

func (pmv *ProcessMetricsViews) StartCollection()

StartCollection starts a ticker'd goroutine that will update the PMV measurements every 5 seconds

func (*ProcessMetricsViews) StopCollection

func (pmv *ProcessMetricsViews) StopCollection()

StopCollection stops the collection of the process metric information

func (*ProcessMetricsViews) Views

func (pmv *ProcessMetricsViews) Views() []*view.View

Views returns the views internal to the PMV