file_stats

Documentation

Overview

Package file_stats provides an otelcol.receiver.file_stats component.

Index

• type Arguments
  • func (args Arguments) Convert() (otelcomponent.Config, error)
  • func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments
  • func (args Arguments) Exporters() map[otelcomponent.DataType]map[otelcomponent.ID]otelcomponent.Component
  • func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension
  • func (args Arguments) NextConsumers() *otelcol.ConsumerArguments
  • func (args *Arguments) SetToDefault()
  • func (args *Arguments) Validate() error
• type FilterArguments
  • func (args *FilterArguments) Validate() error
• type MetricArguments
• type MetricsArguments
  • func (args *MetricsArguments) SetToDefault()
• type MetricsBuilderArguments
  • func (args *MetricsBuilderArguments) SetToDefault()
• type ResourceAttributeArguments
• type ResourceAttributesArguments
  • func (args *ResourceAttributesArguments) SetToDefault()

Types

type Arguments

type Arguments struct {
	Include string `alloy:"include,attr"`

	Controller     otelcol.ControllerArguments `alloy:",squash"`
	MetricsBuilder MetricsBuilderArguments     `alloy:",squash"`

	// DebugMetrics configures component internal metrics. Optional.
	DebugMetrics otelcolCfg.DebugMetricsArguments `alloy:"debug_metrics,block,optional"`

	// Output configures where to send received data. Required.
	Output *otelcol.ConsumerArguments `alloy:"output,block"`
}

Arguments configures the otelcol.receiver.file_stats component.

func (Arguments) Convert

func (args Arguments) Convert() (otelcomponent.Config, error)

Convert implements receiver.Arguments.

func (Arguments) DebugMetricsConfig

func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments

DebugMetricsConfig implements receiver.Arguments.

func (Arguments) Exporters

func (args Arguments) Exporters() map[otelcomponent.DataType]map[otelcomponent.ID]otelcomponent.Component

Exporters implements receiver.Arguments.

func (Arguments) Extensions

func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension

Extensions implements receiver.Arguments.

func (Arguments) NextConsumers

func (args Arguments) NextConsumers() *otelcol.ConsumerArguments

NextConsumers implements receiver.Arguments.

func (*Arguments) SetToDefault

func (args *Arguments) SetToDefault()

SetToDefault implements syntax.Defaulter.

func (*Arguments) Validate

func (args *Arguments) Validate() error

Validate implemenets syntax.Validator.

type FilterArguments

type FilterArguments struct {
	Strict string `alloy:"strict,attr,optional"`
	Regex  string `alloy:"regexp,attr,optional"`
}

FilterArguments configures the matching behavior of a FilterSet.

func (*FilterArguments) Validate

func (args *FilterArguments) Validate() error

Validate implements syntax.Validator.

type MetricArguments

type MetricArguments struct {
	Enabled bool `alloy:"enabled,attr,optional"`
}

MetricArguments provides common config for a particular metric.

type MetricsArguments

type MetricsArguments struct {
	FileAtime MetricArguments `alloy:"file.atime,block,optional"`
	FileCount MetricArguments `alloy:"file.count,block,optional"`
	FileCtime MetricArguments `alloy:"file.ctime,block,optional"`
	FileMtime MetricArguments `alloy:"file.mtime,block,optional"`
	FileSize  MetricArguments `alloy:"file.size,block,optional"`
}

MetricsArguments provides config for file_stats metrics.

func (*MetricsArguments) SetToDefault

func (args *MetricsArguments) SetToDefault()

SetToDefault implements syntax.Defaulter.

type MetricsBuilderArguments

type MetricsBuilderArguments struct {
	Metrics            MetricsArguments            `alloy:"metrics,block,optional"`
	ResourceAttributes ResourceAttributesArguments `alloy:"resource_attributes,block,optional"`
}

MetricsBuilderArguments is a configuration for file_stats metrics builder.

func (*MetricsBuilderArguments) SetToDefault

func (args *MetricsBuilderArguments) SetToDefault()

SetToDefault implements syntax.Defaulter.

type ResourceAttributeArguments

type ResourceAttributeArguments struct {
	Enabled        bool              `alloy:"enabled,attr,optional"`
	MetricsInclude []FilterArguments `alloy:"metrics_include,block,optional"`
	MetricsExclude []FilterArguments `alloy:"metrics_exclude,block,optional"`
}

ResourceAttributeArguments provides common config for a particular resource attribute.

type ResourceAttributesArguments

type ResourceAttributesArguments struct {
	FileName ResourceAttributeArguments `alloy:"file.name,block,optional"`
	FilePath ResourceAttributeArguments `alloy:"file.path,block,optional"`
}

ResourceATtributesArguments provides config for file_stats resource attributes.

func (*ResourceAttributesArguments) SetToDefault

func (args *ResourceAttributesArguments) SetToDefault()

SetToDefault implements syntax.Defaulter.