fileacquisition

package

v1.7.3 Latest Latest Go to latest Published: Oct 24, 2025 License: MIT Imports: 25 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/crowdsecurity/crowdsec

Links

Open Source Insights

Documentation ¶

Rendered for

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type FileConfiguration ¶

type FileConfiguration struct {
	Filenames                         []string
	ExcludeRegexps                    []string `yaml:"exclude_regexps"`
	Filename                          string
	ForceInotify                      bool          `yaml:"force_inotify"`
	MaxBufferSize                     int           `yaml:"max_buffer_size"`
	PollWithoutInotify                *bool         `yaml:"poll_without_inotify"`
	DiscoveryPollEnable               bool          `yaml:"discovery_poll_enable"`
	DiscoveryPollInterval             time.Duration `yaml:"discovery_poll_interval"`
	configuration.DataSourceCommonCfg `yaml:",inline"`
}

type FileSource ¶

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

func (*FileSource) CanRun ¶

func (f *FileSource) CanRun() error

func (*FileSource) Configure ¶

func (f *FileSource) Configure(yamlConfig []byte, logger *log.Entry, metricsLevel metrics.AcquisitionMetricsLevel) error

func (*FileSource) ConfigureByDSN ¶

func (f *FileSource) ConfigureByDSN(dsn string, labels map[string]string, logger *log.Entry, uuid string) error

func (*FileSource) Dump ¶

func (f *FileSource) Dump() any

func (*FileSource) GetAggregMetrics ¶

func (f *FileSource) GetAggregMetrics() []prometheus.Collector

func (*FileSource) GetMetrics ¶

func (f *FileSource) GetMetrics() []prometheus.Collector

func (*FileSource) GetMode ¶

func (f *FileSource) GetMode() string

func (*FileSource) GetName ¶

func (f *FileSource) GetName() string

func (*FileSource) GetUuid ¶ added in v1.5.0

func (f *FileSource) GetUuid() string

func (*FileSource) IsTailing ¶ added in v1.6.9

func (f *FileSource) IsTailing(filename string) bool

IsTailing returns whether a given file is currently being tailed. For testing purposes. It is case sensitive and path delimiter sensitive (filename must match exactly what the filename would look being OS specific)

func (*FileSource) OneShotAcquisition ¶

func (f *FileSource) OneShotAcquisition(ctx context.Context, out chan types.Event, t *tomb.Tomb) error

OneShotAcquisition reads a set of file and returns when done

func (*FileSource) RemoveTail ¶ added in v1.6.9

func (f *FileSource) RemoveTail(filename string)

RemoveTail is used for testing to simulate a dead tailer. For testing purposes. It is case sensitive and path delimiter sensitive (filename must match exactly what the filename would look being OS specific)

func (*FileSource) StreamingAcquisition ¶

func (f *FileSource) StreamingAcquisition(ctx context.Context, out chan types.Event, t *tomb.Tomb) error

func (*FileSource) SupportedModes ¶

func (f *FileSource) SupportedModes() []string

SupportedModes returns the supported modes by the acquisition module

func (*FileSource) UnmarshalConfig ¶ added in v1.5.0

func (f *FileSource) UnmarshalConfig(yamlConfig []byte) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL