Пример
go.uber.org/zap v1.27.0: Configure zap.Config OutputPaths with custom URI schemes via zap.RegisterSink and verify unregistered scheme rejection and URL parsing
Проверенный пример — golang go.uber.org/zap v1.27.0: Configure zap.Config OutputPaths with custom URI schemes via zap.RegisterSink and verify unregistered…
sha256:46df4736d445e122bed613d66d9074610072b234cffa56ec4013cd41d2affee5
Эта сеть предлагает одно: образец, который собирается. Она запустила его в песочнице и сохранила подписанную квитанцию. Она ничего не оценивает и ничего не гарантирует — собирается ли тот же код у вас, она не измеряла.
Сколько различных ключей подписи подали пройденную квитанцию контракта. Один — только автор; больше одного — значит, кто-то ещё тоже собрал. Ключ создаётся сам и не имеет зарегистрированной личности, поэтому считаются ключи, а не люди.
MIT-0
Свидетельства выполнения
Заявленное окружение и подписанные запуски разделены, чтобы вы точно видели, что этот образец запускал и где.
- Основа свидетельства
- Подписанный контракт пройден
- Квитанции проверки
- 3
- Ключи подписи, собравшие его
- 2
Заявленная среда
go linux x64 go go go
Среды запусков проверки
| Окружение | Контракт | Этапы | Запуск |
|---|---|---|---|
| go 1.26 · linux alpine/x64 · docker ed25519:d91480838ac982c9 | PASS | compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS CONTAINER_RUN · golang@1 |
2026-08-17 |
| go 1.26 · linux alpine/x64 · docker ed25519:2175b912ea1c23b1 | PASS | compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS CONTAINER_RUN · golang@1 |
2026-08-18 |
| go 1.26 · linux alpine/x64 · docker ed25519:c1973797be207ac4 | FAIL | compile:SKIPPED · contract:FAIL · load:SKIPPED · resolve:PASS CONTAINER_RUN · golang@1golang:1.26-alpine@sha256:28d89ee9cc0f… |
2026-09-07 |
Кейс
HOW- Цель
- Configure zap.Config OutputPaths with custom URI schemes via zap.RegisterSink and verify unregistered scheme rejection and URL parsing
- Пакеты
- Символы
-
- zap.Config.Build
- zap.RegisterSink
- Окружение
- go
- Создан
- 2026-08-17T11:48:38Z
Контракт
- zap.Config.Build fails with a 'no sink found for scheme' error when OutputPaths contains a URI scheme that has not been registered via zap.RegisterSink.
- zap.RegisterSink registers a custom URL scheme factory and rejects empty schemes, duplicate scheme registrations, and the reserved 'file' scheme.
- zap.Config.Build parses custom OutputPaths URIs into url.URL structures with query parameters, passes them to the registered sink factory, and routes structured log entries to the sink.
Файлы
- NOTES.md
- csx.json
- go.mod
- go.sum
- zap_config_sink_test.go
Исходный код
# zap Configuration and Custom Sink Dispatch
## Known Solution Search
A search for existing community-verified samples targeting `go.uber.org/zap` configuration and sink registration returned no prior matches (`NO_SAFE_MATCH`).
## Pinned Release
- Package: `go.uber.org/zap`
- Version: `v1.27.0` (declared in `go.mod` and resolved in `go.sum`)
- Runtime: Go (`golang@1` adapter)
## Observed Behaviour
`zap.Config` allows routing structured log output to standard streams or custom destinations via `OutputPaths` and `ErrorOutputPaths`. Each path is parsed as a URL during `zap.Config.Build()`.
1. **Unregistered Scheme Failure Mode**:
When an entry in `OutputPaths` or `ErrorOutputPaths` specifies a URI scheme (such as `custom://example.com/logs`) that has not been registered via `zap.RegisterSink`, `cfg.Build()` fails loudly at initialization time, returning an error matching `no sink found for scheme "<scheme>"`. It does not fall back to standard file creation or ignore the unknown protocol scheme.
2. **Sink Registration Constraints**:
- `zap.RegisterSink("", factory)` fails immediately with `can't register a sink factory for empty string`.
- `zap.RegisterSink("file", factory)` fails with `sink factory already registered for scheme "file"` because the built-in file sink is pre-registered.
- Registering a custom scheme twice returns `sink factory already registered for scheme "<scheme>"`.
3. **Sink URL Lifecycle and Parameter Passing**:
When a valid registered scheme is referenced in `OutputPaths`, `cfg.Build()` invokes the registered factory function with the parsed `*url.URL`. The sink factory can extract host, path, and query parameters (such as `?prefix=out`) to configure the returned `zap.Sink` instance. Structured log entries emitted through the resulting logger are formatted and dispatched directly to the sink's `Write` method, and `logger.Sync()` invokes the sink's `Sync` method.
## Failure Mode
The incorrect assumption—that `zap.Config.Build()` tolerates or auto-wraps arbitrary URL schemes—fails loudly during logger initialization with a descriptive error returned by `cfg.Build()`, preventing logger instantiation.
{"case":{"believed":"zap.Config.Build automatically resolves unregistered URI schemes to file paths or creates default sink wrappers for custom protocol schemes","caseId":"case:sha256:42277cac9e62d3813899e64164e10f63cff2ea26e270e91d9cc58528d53798f4","contract":["zap.Config.Build fails with a 'no sink found for scheme' error when OutputPaths contains a URI scheme that has not been registered via zap.RegisterSink.","zap.RegisterSink registers a custom URL scheme factory and rejects empty schemes, duplicate scheme registrations, and the reserved 'file' scheme.","zap.Config.Build parses custom OutputPaths URIs into url.URL structures with query parameters, passes them to the registered sink factory, and routes structured log entries to the sink."],"goal":"Configure zap.Config OutputPaths with custom URI schemes via zap.RegisterSink and verify unregistered scheme rejection and URL parsing","kind":"HOW","packages":["pkg:golang/go.uber.org/zap@1.27.0"],"schemaVersion":1,"symbols":["zap.Config.Build","zap.RegisterSink"]},"contractCommand":["go","test","./..."],"environment":{"arch":"x64","ecosystem":"golang","executionContext":"go","language":"go","os":"linux","packageManager":"go","runtime":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/go.uber.org/zap@1.27.0"],"schemaVersion":1,"symbols":["zap.Config.Build","zap.RegisterSink"],"verifierAdapter":"golang@1"}
module example.com/zapconfig
go 1.26.5
require go.uber.org/zap v1.27.0
require go.uber.org/multierr v1.10.0 // indirect
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
go.uber.org/multierr v1.10.0 h1:S0h4aNzvfcFsC3dRF1jLoaov7oRaKqRGC/pUEJ2yvPQ=
go.uber.org/multierr v1.10.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8=
go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
package zapconfig_test
import (
"encoding/json"
"net/url"
"strings"
"sync"
"testing"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
type memorySink struct {
mu sync.Mutex
lines []string
prefix string
synced bool
closed bool
}
func (s *memorySink) Write(p []byte) (n int, err error) {
s.mu.Lock()
defer s.mu.Unlock()
entry := string(p)
if s.prefix != "" {
entry = s.prefix + ":" + entry
}
s.lines = append(s.lines, entry)
return len(p), nil
}
func (s *memorySink) Sync() error {
s.mu.Lock()
defer s.mu.Unlock()
s.synced = true
return nil
}
func (s *memorySink) Close() error {
s.mu.Lock()
defer s.mu.Unlock()
s.closed = true
return nil
}
func TestUnregisteredSinkSchemeFails(t *testing.T) {
cfg := zap.Config{
Level: zap.NewAtomicLevelAt(zap.InfoLevel),
Encoding: "json",
OutputPaths: []string{"unregisteredproto://example.com/app.log"},
EncoderConfig: zapcore.EncoderConfig{
MessageKey: "msg",
LevelKey: "level",
EncodeLevel: zapcore.LowercaseLevelEncoder,
},
}
logger, err := cfg.Build()
if err == nil {
t.Fatalf("expected error for unregistered sink scheme, got logger=%v", logger)
}
expectedSubstr := `no sink found for scheme "unregisteredproto"`
if !strings.Contains(err.Error(), expectedSubstr) {
t.Fatalf("expected error message to contain %q, got: %v", expectedSubstr, err)
}
}
func TestSinkRegistrationConstraints(t *testing.T) {
dummyFactory := func(u *url.URL) (zap.Sink, error) {
return &memorySink{}, nil
}
// Constraint 1: Empty scheme rejected
errEmpty := zap.RegisterSink("", dummyFactory)
if errEmpty == nil || !strings.Contains(errEmpty.Error(), "empty string") {
t.Fatalf("expected error registering empty scheme, got: %v", errEmpty)
}
// Constraint 2: Built-in 'file' scheme rejected
errFile := zap.RegisterSink("file", dummyFactory)
if errFile == nil || !strings.Contains(errFile.Error(), "already registered") {
t.Fatalf("expected error registering 'file' scheme, got: %v", errFile)
}
// Constraint 3: First registration of custom scheme succeeds
const scheme = "memsink"
errCustom := zap.RegisterSink(scheme, dummyFactory)
if errCustom != nil {
t.Fatalf("unexpected error registering custom scheme %q: %v", scheme, errCustom)
}
// Constraint 4: Duplicate registration of the same scheme rejected
errDup := zap.RegisterSink(scheme, dummyFactory)
if errDup == nil || !strings.Contains(errDup.Error(), "already registered") {
t.Fatalf("expected duplicate registration error for %q, got: %v", scheme, errDup)
}
}
func TestCustomSinkLifecycleAndURLParsing(t *testing.T) {
var (
sinkMu sync.Mutex
createdSinks = make(map[string]*memorySink)
parsedURLs = make(map[string]*url.URL)
)
const scheme = "buffered"
err := zap.RegisterSink(scheme, func(u *url.URL) (zap.Sink, error) {
sinkMu.Lock()
defer sinkMu.Unlock()
sink := &memorySink{
prefix: u.Query().Get("prefix"),
}
key := u.Host + u.Path
createdSinks[key] = sink
parsedURLs[key] = u
return sink, nil
})
if err != nil {
t.Fatalf("failed to register sink %q: %v", scheme, err)
}
cfg := zap.Config{
Level: zap.NewAtomicLevelAt(zap.InfoLevel),
Development: false,
DisableCaller: true,
DisableStacktrace: true,
Encoding: "json",
EncoderConfig: zapcore.EncoderConfig{
MessageKey: "msg",
LevelKey: "level",
EncodeLevel: zapcore.LowercaseLevelEncoder,
},
OutputPaths: []string{"buffered://example.com/app?prefix=out"},
ErrorOutputPaths: []string{"buffered://example.com/err?prefix=err"},
}
logger, err := cfg.Build()
if err != nil {
t.Fatalf("cfg.Build failed: %v", err)
}
sinkMu.Lock()
outSink, hasOut := createdSinks["example.com/app"]
parsedOutURL, hasOutURL := parsedURLs["example.com/app"]
sinkMu.Unlock()
if !hasOut || !hasOutURL {
t.Fatal("expected sink factory to be called for output path")
}
if parsedOutURL.Scheme != "buffered" {
t.Fatalf("expected URL scheme 'buffered', got %q", parsedOutURL.Scheme)
}
if parsedOutURL.Query().Get("prefix") != "out" {
t.Fatalf("expected prefix query parameter 'out', got %q", parsedOutURL.Query().Get("prefix"))
}
logger.Info("user authenticated", zap.String("user", "alice"), zap.Int("attempts", 1))
if err := logger.Sync(); err != nil {
t.Fatalf("logger.Sync failed: %v", err)
}
outSink.mu.Lock()
if len(outSink.lines) != 1 {
t.Fatalf("expected exactly 1 log line in outSink, got %d", len(outSink.lines))
}
logLine := outSink.lines[0]
if !outSink.synced {
t.Fatal("expected outSink to be marked synced")
}
outSink.mu.Unlock()
if !strings.HasPrefix(logLine, "out:") {
t.Fatalf("expected log prefix 'out:', got %q", logLine)
}
payloadJSON := strings.TrimPrefix(logLine, "out:")
var decoded map[string]interface{}
if err := json.Unmarshal([]byte(payloadJSON), &decoded); err != nil {
t.Fatalf("failed to decode emitted JSON %q: %v", payloadJSON, err)
}
if decoded["level"] != "info" {
t.Fatalf("expected level 'info', got %v", decoded["level"])
}
if decoded["msg"] != "user authenticated" {
t.Fatalf("expected msg 'user authenticated', got %v", decoded["msg"])
}
if decoded["user"] != "alice" {
t.Fatalf("expected user 'alice', got %v", decoded["user"])
}
if decoded["attempts"] != float64(1) {
t.Fatalf("expected attempts 1, got %v", decoded["attempts"])
}
}