telemetry

Documentation

Index

• Constants
• func ReadFileByLines(filename string) ([]string, error)
• type BridgeInfo
• type DiskInfo
• type InterfaceInfo
• type MemInfo
• type OSInfo
• type OrchestratorInfo
• type Report
  • func (report *Report) GetInterfaceDetails(queryUrl string)
  • func (report *Report) GetOSDetails()
  • func (report *Report) GetOrchestratorDetails()
  • func (report *Report) GetReportState() bool
  • func (report *Report) GetSystemDetails()
  • func (report *Report) SetReportState() error
• type ReportManager
  • func (reportMgr *ReportManager) GetReport(name string, version string)
  • func (reportMgr *ReportManager) SendReport() error
• type SystemInfo

Constants

const (
	MB = 1048576
	KB = 1024
)

const (
	// TelemetryFile Path.
	TelemetryFile = platform.CNIRuntimePath + "AzureCNITelemetry.json"
)

Functions

func ReadFileByLines

func ReadFileByLines(filename string) ([]string, error)

Read file line by line and return array of lines.

Types

type BridgeInfo

type BridgeInfo struct {
	NetworkMode  string
	BridgeName   string
	ErrorMessage string
}

CNI Bridge Details structure.

type DiskInfo

type DiskInfo struct {
	DiskTotal uint64
	DiskFree  uint64
}

Disk Info structure.

type InterfaceInfo

type InterfaceInfo struct {
	InterfaceType         string
	Subnet                string
	PrimaryCA             string
	MAC                   string
	Name                  string
	SecondaryCATotalCount int
	SecondaryCAUsedCount  int
	ErrorMessage          string
}

Interface Details structure.

type MemInfo

type MemInfo struct {
	MemTotal uint64
	MemFree  uint64
}

Memory Info structure.

type OSInfo

type OSInfo struct {
	OSType         string
	OSVersion      string
	KernelVersion  string
	OSDistribution string
	ErrorMessage   string
}

OS Details structure.

type OrchestratorInfo

type OrchestratorInfo struct {
	OrchestratorName    string
	OrchestratorVersion string
	ErrorMessage        string
}

Orchestrator Details structure.

type Report

type Report struct {
	StartFlag           bool
	CniSucceeded        bool
	Name                string
	Version             string
	ErrorMessage        string
	Context             string
	SubContext          string
	VnetAddressSpace    []string
	OrchestratorDetails *OrchestratorInfo
	OSDetails           *OSInfo
	SystemDetails       *SystemInfo
	InterfaceDetails    *InterfaceInfo
	BridgeDetails       *BridgeInfo
}

Azure CNI Telemetry Report structure.

func (*Report) GetInterfaceDetails

func (report *Report) GetInterfaceDetails(queryUrl string)

This function creates a report with interface details(ip, mac, name, secondaryca count).

func (*Report) GetOSDetails

func (report *Report) GetOSDetails()

This function creates a report with os details(ostype, version).

func (*Report) GetOrchestratorDetails

func (report *Report) GetOrchestratorDetails()

This function creates a report with orchestrator details(name, version).

func (*Report) GetReportState

func (report *Report) GetReportState() bool

This function will check if report is sent atleast once by checking telemetry file.

func (*Report) GetSystemDetails

func (report *Report) GetSystemDetails()

This function creates a report with system details(memory, disk, cpu).

func (*Report) SetReportState

func (report *Report) SetReportState() error

This function will save the state in file if telemetry report sent successfully.

type ReportManager

type ReportManager struct {
	HostNetAgentURL string
	IpamQueryURL    string
	ReportType      string
	Report          *Report
}

ReportManager structure.

func (*ReportManager) GetReport

func (reportMgr *ReportManager) GetReport(name string, version string)

GetReport retrieves orchestrator, system, OS and Interface details and create a report structure.

func (*ReportManager) SendReport

func (reportMgr *ReportManager) SendReport() error

This function will send telemetry report to HostNetAgent.

type SystemInfo

type SystemInfo struct {
	MemVMTotal       uint64
	MemVMFree        uint64
	MemUsedByProcess uint64
	DiskVMTotal      uint64
	DiskVMFree       uint64
	CPUCount         int
	ErrorMessage     string
}

System Details structure.