logfmt

README

logfmt

logfmt permet d'encoder des couples de clé/valeur au format "logfmt".

Exemples:

couple clé/valeur	résultat
nil, nil	@nil=@nil
age, 53	age=53
"a\tb\nc", "def"	abc="def"
[]byte("lsm"), "ceci est un message"	[]byte{0x6c,0x73,0x6d}="ceci est un message"
"", 789.456	@key=789.456
"jour", 24, "mois", "décembre", "année", 2019	jour=24 mois="décembre" année=2019
"la valeur est manquante"	lavaleurestmanquante=@nil
"message", "Joyeuses\tfêtes\n"	message="Joyeuses\tfêtes\n"

Remarques:

• @key remplace les clés qui ne sont pas valides.
• @nil correspond à une clé ou une valeur valant nil.

Benchmark

goos: linux
goarch: amd64
pkg: github.com/archivage-numerique/quag.kit/tools/logfmt
BenchmarkLogFmt-4   	 2491536	       483 ns/op	      16 B/op	       3 allocs/op
PASS
ok  	github.com/archivage-numerique/quag.kit/tools/logfmt	1.698s
Success: Benchmarks passed.

---

Copyright (c) 2020 Institut National de l'Audiovisuel

Documentation

Index

• type Encoder
  • func NewEncoder(iow io.Writer) *Encoder
  • func (enc *Encoder) EncodeKeyValues(kv ...interface{}) error
  • func (enc *Encoder) Reset()

Types

type Encoder

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

Encoder représente l'encodeur au format "logfmt".

func NewEncoder

func NewEncoder(iow io.Writer) *Encoder

NewEncoder permet de créer une nouvelle instance d'un encodeur avec 'iow' pour flux de sortie.

func (*Encoder) EncodeKeyValues

func (enc *Encoder) EncodeKeyValues(kv ...interface{}) error

EncodeKeyValues effectue l'encodage de couples clé/valeur au format "logfmt". Normalement, la clé est une chaîne de caractères identifiant la valeur. Elle est transformée en une chaîne de caractères si elle n'en est pas une.

func (*Encoder) Reset

func (enc *Encoder) Reset()

Reset permet de réinitialiser l'encodeur.