processscraper

Documentation

Index

• Constants
• type Config
• type Factory
  • func (f *Factory) CreateDefaultConfig() internal.Config
  • func (f *Factory) CreateMetricsScraper(_ context.Context, settings receiver.Settings, cfg internal.Config) (scraper.Metrics, error)
• type MatchConfig

Constants

const (
	// TypeStr the value of "type" key in configuration.
	TypeStr = "process"
)

Types

type Config

type Config struct {
	// MetricsBuilderConfig allows to customize scraped metrics/attributes representation.
	metadata.MetricsBuilderConfig `mapstructure:",squash"`
	internal.ScraperConfig
	// Include specifies a filter on the process names that should be included from the generated metrics.
	// Exclude specifies a filter on the process names that should be excluded from the generated metrics.
	// If neither `include` or `exclude` are set, process metrics will be generated for all processes.
	Include MatchConfig `mapstructure:"include"`
	Exclude MatchConfig `mapstructure:"exclude"`

	// MuteProcessAllErrors is a flag that will mute all the errors encountered when trying to read metrics of a process.
	// When this flag is enabled, there is no need to activate any other error suppression flags.
	MuteProcessAllErrors bool `mapstructure:"mute_process_all_errors,omitempty"`

	// MuteProcessNameError is a flag that will mute the error encountered when trying to read a process name the
	// collector does not have permission to read.
	// See https://github.com/open-telemetry/opentelemetry-collector/issues/3004 for more information.
	// This flag is ignored when MuteProcessAllErrors is set to true as all errors are muted.
	MuteProcessNameError bool `mapstructure:"mute_process_name_error,omitempty"`

	// MuteProcessIOError is a flag that will mute the error encountered when trying to read IO metrics of a process
	// the collector does not have permission to read.
	// This flag is ignored when MuteProcessAllErrors is set to true as all errors are muted.
	MuteProcessIOError bool `mapstructure:"mute_process_io_error,omitempty"`

	// MuteProcessCgroupError is a flag that will mute the error encountered when trying to read the cgroup of a process
	// the collector does not have permission to read.
	// This flag is ignored when MuteProcessAllErrors is set to true as all errors are muted.
	MuteProcessCgroupError bool `mapstructure:"mute_process_cgroup_error,omitempty"`

	// MuteProcessExeError is a flag that will mute the error encountered when trying to read the executable path of a process
	// the collector does not have permission to read (Linux).
	// This flag is ignored when MuteProcessAllErrors is set to true as all errors are muted.
	MuteProcessExeError bool `mapstructure:"mute_process_exe_error,omitempty"`

	// MuteProcessUserError is a flag that will mute the error encountered when trying to read uid which
	// doesn't exist on the system, eg. is owned by user existing in container only.
	// This flag is ignored when MuteProcessAllErrors is set to true as all errors are muted.
	MuteProcessUserError bool `mapstructure:"mute_process_user_error,omitempty"`

	// ScrapeProcessDelay is used to indicate the minimum amount of time a process must be running
	// before metrics are scraped for it.  The default value is 0 seconds (0s).
	ScrapeProcessDelay time.Duration `mapstructure:"scrape_process_delay"`
}

Config relating to Process Metric Scraper.

type Factory

type Factory struct{}

Factory is the Factory for scraper.

func (*Factory) CreateDefaultConfig

func (f *Factory) CreateDefaultConfig() internal.Config

CreateDefaultConfig creates the default configuration for the Scraper.

func (*Factory) CreateMetricsScraper

func (f *Factory) CreateMetricsScraper(
	_ context.Context,
	settings receiver.Settings,
	cfg internal.Config,
) (scraper.Metrics, error)

CreateMetricsScraper creates a resource scraper based on provided config.

type MatchConfig

type MatchConfig struct {
	filterset.Config `mapstructure:",squash"`

	Names []string `mapstructure:"names"`
}