A ClickHouse Handler for slog Go library.
See also:
- slog-multi:
slog.Handlerchaining, fanout, routing, failover, load balancing... - slog-formatter:
slogattribute formatting - slog-sampling:
slogsampling policy - slog-gin: Gin middleware for
sloglogger - slog-echo: Echo middleware for
sloglogger - slog-fiber: Fiber middleware for
sloglogger - slog-chi: Chi middleware for
sloglogger - slog-datadog: A
sloghandler forDatadog - slog-rollbar: A
sloghandler forRollbar - slog-sentry: A
sloghandler forSentry - slog-syslog: A
sloghandler forSyslog - slog-logstash: A
sloghandler forLogstash - slog-fluentd: A
sloghandler forFluentd - slog-graylog: A
sloghandler forGraylog - slog-loki: A
sloghandler forLoki - slog-slack: A
sloghandler forSlack - slog-telegram: A
sloghandler forTelegram - slog-mattermost: A
sloghandler forMattermost - slog-microsoft-teams: A
sloghandler forMicrosoft Teams - slog-webhook: A
sloghandler forWebhook - slog-kafka: A
sloghandler forKafka - slog-nats: A
sloghandler forNATS - slog-parquet: A
sloghandler forParquet+Object Storage - slog-zap: A
sloghandler forZap - slog-zerolog: A
sloghandler forZerolog - slog-logrus: A
sloghandler forLogrus - slog-channel: A
sloghandler for Go channels
go get github.com/smllnest/slog-clickhouseCompatibility: go >= 1.21
type Option struct {
// log level (default: debug)
Level slog.Leveler
// ClickHouse connection
DB *sql.DB
LogTable string
Timeout time.Duration // default: 60s
// optional: customize clickhouse event builder
Converter Converter
// optional: see slog.HandlerOptions
AddSource bool
ReplaceAttr func(groups []string, a slog.Attr) slog.Attr
}Other global parameters:
slogclickhouse.SourceKey = "source"
slogclickhouse.ContextKey = "extra"
slogclickhouse.RequestKey = "request"
slogclickhouse.ErrorKeys = []string{"error", "err"}
slogclickhouse.RequestIgnoreHeaders = falseThe following attributes are interpreted by slogclickhouse.DefaultConverter:
| Atribute name | slog.Kind | Underlying type |
|---|---|---|
| "error" | any | error |
| "request" | any | *http.Request |
| other attributes | * |
Other attributes will be injected in extra field.
You must create the table before using it:
CREATE TABLE logs (
timestamp DateTime,
level String,
message String,
attrs String
) ENGINE = MergeTree()
ORDER BY timestamp
PARTITION BY toYYYYMMDD(timestamp)then run the below code:
package main
import (
"log/slog"
"testing"
"time"
"github.com/smallnest/slog-clickhouse"
)
func main() {
conn := clickhouse.OpenDB(&clickhouse.Options{
Addr: []string{"127.0.0.1:9000"},
Auth: clickhouse.Auth{
Database: "myapp",
Username: "",
Password: "",
},
Settings: clickhouse.Settings{
"max_execution_time": 60,
},
DialTimeout: time.Second * 30,
Debug: true,
BlockBufferSize: 10,
MaxCompressionBuffer: 10240,
})
if err := conn.Ping(); err != nil {
t.Log("local clickhouse server is not running, skipping test...")
return
}
conn.SetMaxIdleConns(5)
conn.SetMaxOpenConns(10)
conn.SetConnMaxLifetime(time.Hour)
logger := slog.New(Option{Level: slog.LevelDebug, DB: conn, LogTable: "myapp.logs"}.NewClickHouseHandler())
logger.Info("Hello, ClickHouse!", "key1", "value1", "key2", 2)
}check the result in ClickHouse: