egress

type ConnectorOption ¶

type ConnectorOption func(*SyslogConnector)

ConnectorOption allows a syslog connector to be customized.

func WithConstructors(constructors map[string]WriterConstructor) ConnectorOption

func WithDroppedMetrics(metrics map[string]pulseemitter.CounterMetric) ConnectorOption

func WithEgressMetrics(metrics map[string]pulseemitter.CounterMetric) ConnectorOption

func WithLogClient(logClient LogClient, sourceIndex string) ConnectorOption

type DialFunc ¶

type DialFunc func(addr string) (net.Conn, error)

DialFunc represents a method for creating a connection, either TCP or TLS.

type DiodeWriter ¶

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

func NewDiodeWriter(
	ctx context.Context,
	wc WriteCloser,
	alerter gendiodes.Alerter,
	wg WaitGroup,
) *DiodeWriter

func (d *DiodeWriter) Write(env *loggregator_v2.Envelope) error

type HTTPSWriter ¶

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

func (*HTTPSWriter) Close() error

func (w *HTTPSWriter) Write(env *loggregator_v2.Envelope) error

type LogClient ¶

type LogClient interface {
	EmitLog(message string, opts ...loggregator.EmitLogOption)
}

LogClient is used to emit logs.

type NetworkTimeoutConfig ¶

type NetworkTimeoutConfig struct {
	Keepalive    time.Duration
	DialTimeout  time.Duration
	WriteTimeout time.Duration
}

NetworkTimeoutConfig stores various timeout values.

type RetryDuration ¶

type RetryDuration func(attempt int) time.Duration

RetryDuration calculates a duration based on the number of write attempts.

type RetryWriter ¶

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

RetryWriter wraps a WriteCloser and will retry writes if the first fails.

func (r *RetryWriter) Close() error

func (r *RetryWriter) Write(e *loggregator_v2.Envelope) error

type SyslogConnector ¶

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

SyslogConnector creates the various egress syslog writers.

func NewSyslogConnector(
	netConf NetworkTimeoutConfig,
	skipCertVerify bool,
	wg WaitGroup,
	opts ...ConnectorOption,
) *SyslogConnector

func (w *SyslogConnector) Connect(ctx context.Context, b *v1.Binding) (Writer, error)

type TCPWriter ¶

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

TCPWriter represents a syslog writer that connects over unencrypted TCP. This writer is not meant to be used from multiple goroutines. The same goroutine that calls `.Write()` should be the one that calls `.Close()`.

func (w *TCPWriter) Close() error

func (w *TCPWriter) Write(env *loggregator_v2.Envelope) error

type TLSWriter ¶

type TLSWriter struct {
	TCPWriter
}

TLSWriter represents a syslog writer that connects over unencrypted TCP.

type URLBinding ¶

type URLBinding struct {
	Context  context.Context
	AppID    string
	Hostname string
	URL      *url.URL
}

application is identified by AppID and Hostname. The syslog URL is identified by URL.

func (u *URLBinding) Scheme() string

type WaitGroup ¶

type WaitGroup interface {
	Add(delta int)
	Done()
}

type WriteCloser ¶

type WriteCloser interface {
	Writer
	io.Closer
}

WriteCloser is the interface for all syslog writers.

func NewHTTPSWriter(
	binding *URLBinding,
	netConf NetworkTimeoutConfig,
	skipCertVerify bool,
	egressMetric pulseemitter.CounterMetric,
) WriteCloser

func NewTCPWriter(
	binding *URLBinding,
	netConf NetworkTimeoutConfig,
	skipCertVerify bool,
	egressMetric pulseemitter.CounterMetric,
) WriteCloser

func NewTLSWriter(
	binding *URLBinding,
	netConf NetworkTimeoutConfig,
	skipCertVerify bool,
	egressMetric pulseemitter.CounterMetric,
) WriteCloser

type Writer ¶

type Writer interface {
	Write(*loggregator_v2.Envelope) error
}

Write is the interface for all diode writers.

type WriterConstructor ¶

type WriterConstructor func(
	binding *URLBinding,
	netConf NetworkTimeoutConfig,
	skipCertVerify bool,
	egressMetric pulseemitter.CounterMetric,
) WriteCloser

WriterConstructor creates syslog connections to https, syslog, and syslog-tls drains

func RetryWrapper(
	wc WriterConstructor,
	r RetryDuration,
	maxRetries int,
	logClient LogClient,
	sourceIndex string,
) WriterConstructor