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[pipeline.Signal]map[component.ID]component.Component
  • func (g *Graph) HandleZPages(w http.ResponseWriter, r *http.Request)
  • func (g *Graph) ShutdownAll(ctx context.Context, reporter status.Reporter) error
  • func (g *Graph) StartAll(ctx context.Context, host *Host) error
• type Host
  • func (host *Host) GetExporters() map[pipeline.Signal]map[component.ID]component.Component
  • func (host *Host) GetExtensions() map[component.ID]component.Component
  • func (host *Host) GetFactory(kind component.Kind, componentType component.Type) component.Factory
  • func (host *Host) NotifyComponentStatusChange(source *componentstatus.InstanceID, event *componentstatus.Event)
  • func (host *Host) RegisterZPages(mux *http.ServeMux, pathPrefix string)
• type HostWrapper
  • func (host *HostWrapper) Report(event *componentstatus.Event)
• 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[pipeline.Signal]map[component.ID]component.Component

func (*Graph) HandleZPages

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

func (*Graph) ShutdownAll

func (g *Graph) ShutdownAll(ctx context.Context, reporter status.Reporter) error

func (*Graph) StartAll

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

type Host

type Host struct {
	AsyncErrorChannel chan error
	Receivers         *builders.ReceiverBuilder
	Processors        *builders.ProcessorBuilder
	Exporters         *builders.ExporterBuilder
	Connectors        *builders.ConnectorBuilder
	Extensions        *builders.ExtensionBuilder

	ModuleInfo extension.ModuleInfo
	BuildInfo  component.BuildInfo

	Pipelines         *Graph
	ServiceExtensions *extensions.Extensions

	Reporter status.Reporter
}

func (*Host) GetExporters

func (host *Host) GetExporters() map[pipeline.Signal]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 (*Host) GetExtensions

func (host *Host) GetExtensions() map[component.ID]component.Component

func (*Host) GetFactory

func (host *Host) GetFactory(kind component.Kind, componentType component.Type) component.Factory

func (*Host) NotifyComponentStatusChange

func (host *Host) NotifyComponentStatusChange(source *componentstatus.InstanceID, event *componentstatus.Event)

func (*Host) RegisterZPages

func (host *Host) RegisterZPages(mux *http.ServeMux, pathPrefix string)

type HostWrapper

type HostWrapper struct {
	*Host
	InstanceID *componentstatus.InstanceID
}

func (*HostWrapper) Report

func (host *HostWrapper) Report(event *componentstatus.Event)

type Settings

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

	ReceiverBuilder  *builders.ReceiverBuilder
	ProcessorBuilder *builders.ProcessorBuilder
	ExporterBuilder  *builders.ExporterBuilder
	ConnectorBuilder *builders.ConnectorBuilder

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

	ReportStatus status.ServiceStatusFunc
}

Settings holds configuration for building builtPipelines.