configuration

Documentation

Overview

Copyright Microsoft. All rights reserved.

Index

• func SetCNSConfigDefaults(config *CNSConfig)
• type CNSConfig
  • func ReadConfig() (CNSConfig, error)
• type ManagedSettings
• type TelemetrySettings

Functions

func SetCNSConfigDefaults

func SetCNSConfigDefaults(config *CNSConfig)

SetCNSConfigDefaults set default values of CNS config if not specified

Types

type CNSConfig

type CNSConfig struct {
	TelemetrySettings           TelemetrySettings
	ManagedSettings             ManagedSettings
	ChannelMode                 string
	UseHTTPS                    bool
	TLSSubjectName              string
	TLSCertificatePath          string
	TLSPort                     string
	TLSEndpoint                 string
	WireserverIP                string
	SyncHostNCVersionIntervalMs time.Duration
	SyncHostNCTimeoutMs         time.Duration
}

func ReadConfig

func ReadConfig() (CNSConfig, error)

This functions reads cns config file and save it in a structure

type ManagedSettings

type ManagedSettings struct {
	PrivateEndpoint           string
	InfrastructureNetworkID   string
	NodeID                    string
	NodeSyncIntervalInSeconds int
}

type TelemetrySettings

type TelemetrySettings struct {
	// Flag to disable the telemetry.
	DisableAll bool
	// Flag to Disable sending trace.
	DisableTrace bool
	// Flag to Disable sending metric.
	DisableMetric bool
	// Flag to Disable sending events.
	DisableEvent bool
	// Configure how many bytes can be sent in one call to the data collector
	TelemetryBatchSizeBytes int
	// Configure the maximum delay before sending queued telemetry in milliseconds
	TelemetryBatchIntervalInSecs int
	// Heartbeat interval for sending heartbeat metric
	HeartBeatIntervalInMins int
	// Enable thread for getting metadata from wireserver
	DisableMetadataRefreshThread bool
	// Refresh interval in milliseconds for metadata thread
	RefreshIntervalInSecs int
	// Disable debug logging for telemetry messages
	DebugMode bool
	// Interval for sending snapshot events.
	SnapshotIntervalInMins int
}