package
0.1.4
Repository: https://github.com/kong/kubernetes-telemetry.git
Documentation: pkg.go.dev

# Functions

NewClusterStateWorkflow creates a new 'cluster-state' workflow, based on a predefined set of providers that will deliver telemetry data about the cluster state.
NewConsumer creates a new consumer which will use the provided serializer to serialize the data and then forward it using the provided forwarder.
NewIdentifyPlatformWorkflow creates a new 'identify-platform' workflow, based on a predefined set of providers that will deliver telemetry data from a cluster.
NewManager creates a new manager configured via the provided options.
NewMeshDetectWorkflow returns a mesh detection workflow.
NewRawConsumer creates a new rawconsumer that will use the provided raw forwarder to forward received reports.
NewStateWorkflow creates a new 'state' workflow, based on a predefined set of providers that will deliver telemetry date about the state of the system.
NewWorkflow creates a new empty workflow.
OptManagerLogger returns an option that will set manager's logger.
OptManagerPeriod returns an option that will set manager's workflows period.

# Constants

ClusterStateWorkflowName is the name assigned to cluster state workflow.
DefaultWorkflowTickPeriod is the default tick period with which the manager will trigger configured workflows execution.
ErrCantAddConsumersAfterStart occurs when consumers are tried to be added after the manager has been already started.
ErrManagerAlreadyStarted occurs when a manager has been already started and it's attempted to be started again.
ErrManagerAlreadyStopped occurs when manager has already been stopped.
ErrNilControllerRuntimeClientProvided occurs when a nil controller-runtime client is provided.
ErrNilDynClientProvided occurs when a nil dynamic.Interface is provided.
ErrNilKubernetesInterfaceProvided occurs when a nil kubernetes.Interface is provided.
ErrNilRestConfig occurs when a nil *rest.Config is provided.
IdentifyPlatformWorkflowName is the name assigned to identify platform workflow.
MeshDetectWorkflowName is the name assigned to mesh detect workflow.
StateWorkflowName is the name assigned to state workflow.

# Interfaces

Consumer is an entity that can consume telemetry reports on a channel returned by Intake().
Forwarder is used to forward telemetry reports to configured destination(s).
Manager controls and runs workflows which provide telemetry data.
RawForwarder is used to forward raw, unserialized telemetry reports to configured destination(s).
Serializer serializes telemetry reports into byte slices.
Workflow defines the workflow interface which will be used either for manual interaction or in programmed manner in manager.

# Type aliases

OptManager is the option function type that can configure the manager.