graph

Documentation

Overview

Package graph contains the internal graph representation of the pipelines.

Build is the constructor for a Graph object. The method calls out to helpers that transform the graph from a config to a DAG of components. The configuration undergoes additional validation here as well, and is used to instantiate the components of the pipeline.

Graph.StartAll starts all components in each pipeline.

Graph.ShutdownAll stops all components in each pipeline.

Index

• type Graph
  • func Build(ctx context.Context, set Settings) (*Graph, error)
  • func (g *Graph) GetExporters() map[component.DataType]map[component.ID]component.Component
  • func (g *Graph) HandleZPages(w http.ResponseWriter, r *http.Request)
  • func (g *Graph) ShutdownAll(ctx context.Context) error
  • func (g *Graph) StartAll(ctx context.Context, host component.Host) error
• type Settings

Types

type Graph

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

func Build

func Build(ctx context.Context, set Settings) (*Graph, error)

Build builds a full pipeline graph. Build also validates the configuration of the pipelines and does the actual initialization of each Component in the Graph.

func (*Graph) GetExporters

func (g *Graph) GetExporters() map[component.DataType]map[component.ID]component.Component

Deprecated: [0.79.0] This function will be removed in the future. Several components in the contrib repository use this function so it cannot be removed before those cases are removed. In most cases, use of this function can be replaced by a connector. See https://github.com/open-telemetry/opentelemetry-collector/issues/7370 and https://github.com/open-telemetry/opentelemetry-collector/pull/7390#issuecomment-1483710184 for additional information.

func (*Graph) HandleZPages

func (g *Graph) HandleZPages(w http.ResponseWriter, r *http.Request)

func (*Graph) ShutdownAll

func (g *Graph) ShutdownAll(ctx context.Context) error

func (*Graph) StartAll

func (g *Graph) StartAll(ctx context.Context, host component.Host) error

type Settings

type Settings struct {
	Telemetry servicetelemetry.TelemetrySettings
	BuildInfo component.BuildInfo

	ReceiverBuilder  *receiver.Builder
	ProcessorBuilder *processor.Builder
	ExporterBuilder  *exporter.Builder
	ConnectorBuilder *connector.Builder

	// PipelineConfigs is a map of component.ID to PipelineConfig.
	PipelineConfigs pipelines.Config
}

Settings holds configuration for building builtPipelines.