log_kafka

README

caddy-log-kafka

A Caddy log writer that writes logs to Kafka.

Usage

This is a Caddy log output module so you can configure it in your Caddyfile:

example.com {
  log {
    output kafka {
      address kafka.default.svc.cluster.local:9092
      topic "com.example.caddy-log.{args.0}"
      partition 0
    }
    format json
  }
}

Processing the logs

I use the following tools to analyze the logs:

• ClickHouse
• caddy-watch

Documentation

Index

• type KafkaLogger
  • func (KafkaLogger) CaddyModule() caddy.ModuleInfo
  • func (k *KafkaLogger) Cleanup() error
  • func (k *KafkaLogger) OpenWriter() (io.WriteCloser, error)
  • func (k *KafkaLogger) Provision(ctx caddy.Context) error
  • func (k *KafkaLogger) String() string
  • func (k *KafkaLogger) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
  • func (k *KafkaLogger) Validate() error
  • func (k *KafkaLogger) WriterKey() string
• type LogWriter
  • func (w *LogWriter) Close() error
  • func (w *LogWriter) Write(p []byte) (n int, err error)

Types

type KafkaLogger

type KafkaLogger struct {
	Address   string `json:"address"`
	Topic     string `json:"topic"`
	Partition int64  `json:"partition"`
	// contains filtered or unexported fields
}

Reference: https://github.com/caddyserver/caddy/blob/e3c369d4526e44f23efb10aaad8a60ce519720a0/modules/logging/netwriter.go

func (KafkaLogger) CaddyModule

func (KafkaLogger) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*KafkaLogger) Cleanup

func (k *KafkaLogger) Cleanup() error

func (*KafkaLogger) OpenWriter

func (k *KafkaLogger) OpenWriter() (io.WriteCloser, error)

func (*KafkaLogger) Provision

func (k *KafkaLogger) Provision(ctx caddy.Context) error

func (*KafkaLogger) String

func (k *KafkaLogger) String() string

func (*KafkaLogger) UnmarshalCaddyfile

func (k *KafkaLogger) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile implements caddyfile.Unmarshaler.

func (*KafkaLogger) Validate

func (k *KafkaLogger) Validate() error

Validate implements caddy.Validator.

func (*KafkaLogger) WriterKey

func (k *KafkaLogger) WriterKey() string

type LogWriter

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

func (*LogWriter) Close

func (w *LogWriter) Close() error

func (*LogWriter) Write

func (w *LogWriter) Write(p []byte) (n int, err error)