0 | |
[![GoDoc](https://godoc.org/github.com/go-logfmt/logfmt?status.svg)](https://godoc.org/github.com/go-logfmt/logfmt)
|
1 | |
[![Go Report Card](https://goreportcard.com/badge/go-logfmt/logfmt)](https://goreportcard.com/report/go-logfmt/logfmt)
|
2 | |
[![TravisCI](https://travis-ci.org/go-logfmt/logfmt.svg?branch=master)](https://travis-ci.org/go-logfmt/logfmt)
|
3 | |
[![Coverage Status](https://coveralls.io/repos/github/go-logfmt/logfmt/badge.svg?branch=master)](https://coveralls.io/github/go-logfmt/logfmt?branch=master)
|
4 | |
|
5 | |
# logfmt
|
6 | |
|
7 | |
Package logfmt implements utilities to marshal and unmarshal data in the [logfmt
|
8 | |
format](https://brandur.org/logfmt). It provides an API similar to
|
9 | |
[encoding/json](http://golang.org/pkg/encoding/json/) and
|
10 | |
[encoding/xml](http://golang.org/pkg/encoding/xml/).
|
11 | |
|
12 | |
The logfmt format was first documented by Brandur Leach in [this
|
13 | |
article](https://brandur.org/logfmt). The format has not been formally
|
14 | |
standardized. The most authoritative public specification to date has been the
|
15 | |
documentation of a Go Language [package](http://godoc.org/github.com/kr/logfmt)
|
16 | |
written by Blake Mizerany and Keith Rarick.
|
17 | |
|
18 | |
## Goals
|
19 | |
|
20 | |
This project attempts to conform as closely as possible to the prior art, while
|
21 | |
also removing ambiguity where necessary to provide well behaved encoder and
|
22 | |
decoder implementations.
|
23 | |
|
24 | |
## Non-goals
|
25 | |
|
26 | |
This project does not attempt to formally standardize the logfmt format. In the
|
27 | |
event that logfmt is standardized this project would take conforming to the
|
28 | |
standard as a goal.
|
29 | |
|
30 | |
## Versioning
|
31 | |
|
32 | |
Package logfmt publishes releases via [semver](http://semver.org/) compatible Git tags prefixed with a single 'v'.
|
|
0 |
[![Go Reference](https://pkg.go.dev/badge/github.com/go-logfmt/logfmt.svg)](https://pkg.go.dev/github.com/go-logfmt/logfmt)
|
|
1 |
[![Go Report Card](https://goreportcard.com/badge/go-logfmt/logfmt)](https://goreportcard.com/report/go-logfmt/logfmt)
|
|
2 |
[![Github Actions](https://github.com/go-logfmt/logfmt/actions/workflows/test.yml/badge.svg)](https://github.com/go-logfmt/logfmt/actions/workflows/test.yml)
|
|
3 |
[![Coverage Status](https://coveralls.io/repos/github/go-logfmt/logfmt/badge.svg?branch=master)](https://coveralls.io/github/go-logfmt/logfmt?branch=master)
|
|
4 |
|
|
5 |
# logfmt
|
|
6 |
|
|
7 |
Package logfmt implements utilities to marshal and unmarshal data in the [logfmt
|
|
8 |
format](https://brandur.org/logfmt). It provides an API similar to
|
|
9 |
[encoding/json](http://golang.org/pkg/encoding/json/) and
|
|
10 |
[encoding/xml](http://golang.org/pkg/encoding/xml/).
|
|
11 |
|
|
12 |
The logfmt format was first documented by Brandur Leach in [this
|
|
13 |
article](https://brandur.org/logfmt). The format has not been formally
|
|
14 |
standardized. The most authoritative public specification to date has been the
|
|
15 |
documentation of a Go Language [package](http://godoc.org/github.com/kr/logfmt)
|
|
16 |
written by Blake Mizerany and Keith Rarick.
|
|
17 |
|
|
18 |
## Goals
|
|
19 |
|
|
20 |
This project attempts to conform as closely as possible to the prior art, while
|
|
21 |
also removing ambiguity where necessary to provide well behaved encoder and
|
|
22 |
decoder implementations.
|
|
23 |
|
|
24 |
## Non-goals
|
|
25 |
|
|
26 |
This project does not attempt to formally standardize the logfmt format. In the
|
|
27 |
event that logfmt is standardized this project would take conforming to the
|
|
28 |
standard as a goal.
|
|
29 |
|
|
30 |
## Versioning
|
|
31 |
|
|
32 |
Package logfmt publishes releases via [semver](http://semver.org/) compatible Git tags prefixed with a single 'v'.
|