file

Documentation

Index

• Variables
• type Config
• type File
  • func (f *File) Close() error
  • func (f *File) Init(ctx context.Context, name string, cfg map[string]interface{}, ...) error
  • func (f *File) RegisterMetrics(reg *prometheus.Registry)
  • func (f *File) SetClusterName(name string)
  • func (f *File) SetEventProcessors(ps map[string]map[string]interface{}, logger *log.Logger, ...)
  • func (f *File) SetLogger(logger *log.Logger)
  • func (f *File) SetName(name string)
  • func (f *File) String() string
  • func (f *File) Write(ctx context.Context, rsp proto.Message, meta outputs.Meta)
  • func (f *File) WriteEvent(ctx context.Context, ev *formatters.EventMsg)

Variables

var NumberOfFailWriteMsgs = prometheus.NewCounterVec(prometheus.CounterOpts{
	Namespace: "gnmic",
	Subsystem: "file_output",
	Name:      "number_messages_writes_fail_total",
	Help:      "Number of failed message writes to file output",
}, []string{"file_name", "reason"})

var NumberOfReceivedMsgs = prometheus.NewCounterVec(prometheus.CounterOpts{
	Namespace: "gnmic",
	Subsystem: "file_output",
	Name:      "number_messages_received_total",
	Help:      "Number of messages received by file output",
}, []string{"file_name"})

var NumberOfWrittenBytes = prometheus.NewCounterVec(prometheus.CounterOpts{
	Namespace: "gnmic",
	Subsystem: "file_output",
	Name:      "number_bytes_written_total",
	Help:      "Number of bytes written to file output",
}, []string{"file_name"})

var NumberOfWrittenMsgs = prometheus.NewCounterVec(prometheus.CounterOpts{
	Namespace: "gnmic",
	Subsystem: "file_output",
	Name:      "number_messages_writes_total",
	Help:      "Number of messages written to file output",
}, []string{"file_name"})

Types

type Config

type Config struct {
	FileName         string   `mapstructure:"filename,omitempty"`
	FileType         string   `mapstructure:"file-type,omitempty"`
	Format           string   `mapstructure:"format,omitempty"`
	Multiline        bool     `mapstructure:"multiline,omitempty"`
	Indent           string   `mapstructure:"indent,omitempty"`
	Separator        string   `mapstructure:"separator,omitempty"`
	EventProcessors  []string `mapstructure:"event-processors,omitempty"`
	ConcurrencyLimit int      `mapstructure:"concurrency-limit,omitempty"`
	EnableMetrics    bool     `mapstructure:"enable-metrics,omitempty"`
	Debug            bool     `mapstructure:"debug,omitempty"`
}

Config //

type File

type File struct {
	Cfg *Config
	// contains filtered or unexported fields
}

File //

func (*File) Close

func (f *File) Close() error

Close //

func (*File) Init

func (f *File) Init(ctx context.Context, name string, cfg map[string]interface{}, opts ...outputs.Option) error

Init //

func (*File) RegisterMetrics

func (f *File) RegisterMetrics(reg *prometheus.Registry)

Metrics //

func (*File) SetClusterName

func (f *File) SetClusterName(name string)

func (*File) SetEventProcessors

func (f *File) SetEventProcessors(ps map[string]map[string]interface{}, logger *log.Logger, tcs map[string]interface{})

func (*File) SetLogger

func (f *File) SetLogger(logger *log.Logger)

func (*File) SetName

func (f *File) SetName(name string)

func (*File) String

func (f *File) String() string

func (*File) Write

func (f *File) Write(ctx context.Context, rsp proto.Message, meta outputs.Meta)

Write //

func (*File) WriteEvent

func (f *File) WriteEvent(ctx context.Context, ev *formatters.EventMsg)