namedpipereceiver

README

Named Pipe Receiver

Status
Stability	alpha: logs
Unsupported Platforms	windows, darwin
Distributions	contrib
Issues
Code Owners	@sinkingpoint, @djaglowski

This receiver supports opening a Unix Named Pipe (aka FIFO), and reading logs from it.

Prerequisites

Named pipes are only supported on Unix operating systems.

Configuration

The following settings are required:

• path: The path to open the named pipe at.

The following settings are optional:

• mode: The mode bits to set on the opened pipe (default: 666)

Example Configuration

receivers:
  namedpipe:
    path: /tmp/pipe
    mode: 0600

Documentation

Overview

Package namedpipereceiver implements a receiver that can be used by the OpenTelemetry collector to receive logs using the stanza log agent

Index

• func NewFactory() receiver.Factory
• type NamedPipeConfig
• type ReceiverType
  • func (f ReceiverType) BaseConfig(cfg component.Config) adapter.BaseConfig
  • func (f ReceiverType) CreateDefaultConfig() component.Config
  • func (f ReceiverType) InputConfig(cfg component.Config) operator.Config
  • func (f ReceiverType) Type() component.Type

Functions

func NewFactory

func NewFactory() receiver.Factory

Types

type NamedPipeConfig

type NamedPipeConfig struct {
	InputConfig        namedpipe.Config `mapstructure:",squash"`
	adapter.BaseConfig `mapstructure:",squash"`
}

NamedPipeConfig defines configuration for the namedpipe receiver

type ReceiverType

type ReceiverType struct{}

func (ReceiverType) BaseConfig

func (f ReceiverType) BaseConfig(cfg component.Config) adapter.BaseConfig

BaseConfig gets the base config from config, for now

func (ReceiverType) CreateDefaultConfig

func (f ReceiverType) CreateDefaultConfig() component.Config

CreateDefaultConfig creates a config with type and version

func (ReceiverType) InputConfig

func (f ReceiverType) InputConfig(cfg component.Config) operator.Config

InputConfig unmarshals the input operator

func (ReceiverType) Type

func (f ReceiverType) Type() component.Type

Type is the receiver type