kafka

Documentation

Index

• Variables
• type Config
• type Target
  • func New(config Config) *Target
  • func (h *Target) Cancel()
  • func (h *Target) Endpoint() string
  • func (h *Target) Init() error
  • func (h *Target) Send(entry interface{}) error
  • func (h *Target) String() string
  • func (h *Target) Type() types.TargetType
• type XDGSCRAMClient
  • func (x *XDGSCRAMClient) Begin(userName, password, authzID string) (err error)
  • func (x *XDGSCRAMClient) Done() bool
  • func (x *XDGSCRAMClient) Step(challenge string) (response string, err error)

Variables

var KafkaSHA256 scram.HashGeneratorFcn = sha256.New

KafkaSHA256 is a function that returns a crypto/sha256 hasher and should be used to create Client objects configured for SHA-256 hashing.

var KafkaSHA512 scram.HashGeneratorFcn = sha512.New

KafkaSHA512 is a function that returns a crypto/sha512 hasher and should be used to create Client objects configured for SHA-512 hashing.

Types

type Config

type Config struct {
	Enabled bool        `json:"enable"`
	Brokers []xnet.Host `json:"brokers"`
	Topic   string      `json:"topic"`
	Version string      `json:"version"`
	TLS     struct {
		Enable        bool               `json:"enable"`
		RootCAs       *x509.CertPool     `json:"-"`
		SkipVerify    bool               `json:"skipVerify"`
		ClientAuth    tls.ClientAuthType `json:"clientAuth"`
		ClientTLSCert string             `json:"clientTLSCert"`
		ClientTLSKey  string             `json:"clientTLSKey"`
	} `json:"tls"`
	SASL struct {
		Enable    bool   `json:"enable"`
		User      string `json:"username"`
		Password  string `json:"password"`
		Mechanism string `json:"mechanism"`
	} `json:"sasl"`

	// Custom logger
	LogOnce func(ctx context.Context, err error, id string, errKind ...interface{}) `json:"-"`
}

Config - kafka target arguments.

type Target

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

Target - Kafka target.

func New

func New(config Config) *Target

New initializes a new logger target which sends log over http to the specified endpoint

func (*Target) Cancel

func (h *Target) Cancel()

Cancel - cancels the target

func (*Target) Endpoint

func (h *Target) Endpoint() string

Endpoint - return kafka target

func (*Target) Init

func (h *Target) Init() error

Init initialize kafka target

func (*Target) Send

func (h *Target) Send(entry interface{}) error

Send log message 'e' to kafka target.

func (*Target) String

func (h *Target) String() string

String - kafka string

func (*Target) Type

func (h *Target) Type() types.TargetType

Type - returns type of the target

type XDGSCRAMClient

type XDGSCRAMClient struct {
	*scram.Client
	*scram.ClientConversation
	scram.HashGeneratorFcn
}

XDGSCRAMClient implements the client-side of an authentication conversation with a server. A new conversation must be created for each authentication attempt.

func (*XDGSCRAMClient) Begin

func (x *XDGSCRAMClient) Begin(userName, password, authzID string) (err error)

Begin constructs a SCRAM client component based on a given hash.Hash factory receiver. This constructor will normalize the username, password and authzID via the SASLprep algorithm, as recommended by RFC-5802. If SASLprep fails, the method returns an error.

func (*XDGSCRAMClient) Done

func (x *XDGSCRAMClient) Done() bool

Done returns true if the conversation is completed or has errored.

func (*XDGSCRAMClient) Step

func (x *XDGSCRAMClient) Step(challenge string) (response string, err error)

Step takes a string provided from a server (or just an empty string for the very first conversation step) and attempts to move the authentication conversation forward. It returns a string to be sent to the server or an error if the server message is invalid. Calling Step after a conversation completes is also an error.