metric

Documentation

Overview

Package metric ...

This package contains all the runtime metrics collected by the SDK This is used to collect the runtime statistics of the process and publish it to IA This runs in a separate go process based on time interval configured in config

Index

• type Metric
  • func CollectRuntimeMetrics() []Metric
  • func CollectStaticMetrics() []Metric

Types

type Metric

type Metric struct {
	Op    string
	Id    string
	Type  int
	Value string
}

The Metric type has the information about the metrics collected like op - Type of Operation Id - Display ID of the metric in IA Type - Type of the metrics like counter,timepahse Value - Value of the metric

func CollectRuntimeMetrics

func CollectRuntimeMetrics() []Metric

CollectRuntimeMetrics is used to retrieve the runtime metrics of the process The following metrics are collected at present and this can be extended to collect more metrics heapObjects -- Cumulative count of heap objects allocation(Total Heap Allocated) heapObjectsFreed -- Cumulative count of heap object freed(Total Heap Free) allocation -- Bytes of allocated heap objects (Bytes In Use) totalAllocation -- Cumulative bytes allocated for heap objects (Bytes Total) goRoutines -- Represents the number of currently active goRoutines for the process(Routines Total)

func CollectStaticMetrics

func CollectStaticMetrics() []Metric

CollectStaticMetrics is used to retrieve the metrics of the process The following metrics are collected at only once processID -- Current ID of the running process version -- GO Version by the running process cpu -- Logical CPU count of the process HostName -- Name of the host the probe is running