socket

package
v0.74.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 29, 2025 License: BSD-3-Clause Imports: 12 Imported by: 0

README

Socket plugin

It reads events from socket network.

Examples

TCP:

pipelines:
  example_pipeline:
    ...
    input:
      type: socket
      network: tcp
      address: ':6666'
    ...

TLS:

pipelines:
  example_pipeline:
    ...
    input:
      type: socket
      network: tcp
      address: ':6666'
      ca_cert: './cert.pem'
      private_key: './key.pem'
    ...

UDP:

pipelines:
  example_pipeline:
    ...
    input:
      type: socket
      network: udp
      address: '[2001:db8::1]:1234'
    ...

Unix:

pipelines:
  example_pipeline:
    ...
    input:
      type: socket
      network: unix
      address: '/tmp/filed.sock'
    ...

Config params

network string default=tcp options=tcp|udp|unix

Which network type to listen.


address string required

An address to listen to.

For example:

  • /tmp/filed.sock
  • 1.2.3.4:9092
  • :9092

ca_cert string

CA certificate in PEM encoding. This can be a path or the content of the certificate.

Works only if network is set to tcp.


private_key string

CA private key in PEM encoding. This can be a path or the content of the key.

Works only if network is set to tcp.



Generated using insane-doc

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Factory

func Factory() (pipeline.AnyPlugin, pipeline.AnyConfig)

Types

type Config

type Config struct {
	// > @3@4@5@6
	// >
	// > Which network type to listen.
	Network string `json:"network" default:"tcp" options:"tcp|udp|unix"` // *

	// > @3@4@5@6
	// >
	// > An address to listen to.
	// >
	// > For example:
	// > - /tmp/filed.sock
	// > - 1.2.3.4:9092
	// > - :9092
	Address string `json:"address" required:"true"` // *

	// > @3@4@5@6
	// >
	// > CA certificate in PEM encoding. This can be a path or the content of the certificate.
	// >> Works only if `network` is set to `tcp`.
	CACert string `json:"ca_cert" default:""` // *

	// > @3@4@5@6
	// >
	// > CA private key in PEM encoding. This can be a path or the content of the key.
	// >> Works only if `network` is set to `tcp`.
	PrivateKey string `json:"private_key" default:""` // *
}

! config-params ^ config-params

type Plugin

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

func (*Plugin) Commit

func (p *Plugin) Commit(_ *pipeline.Event)

func (*Plugin) PassEvent

func (p *Plugin) PassEvent(_ *pipeline.Event) bool

func (*Plugin) Start

func (p *Plugin) Start(config pipeline.AnyConfig, params *pipeline.InputPluginParams)

func (*Plugin) Stop

func (p *Plugin) Stop()

Jump to

Keyboard shortcuts

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