50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
|
# gRPC Zerolog
|
||
|
|
|
||
|
|
[![BuildStatus Widget]][BuildStatus Result]
|
||
|
|
[![CodeCov Widget]][CodeCov Result]
|
||
|
|
[![GoReport Widget]][GoReport Status]
|
||
|
|
[![GoDoc Widget]][GoDoc]
|
||
|
|
|
||
|
|
[BuildStatus Result]: https://travis-ci.org/philip-bui/grpc-zerolog
|
||
|
|
[BuildStatus Widget]: https://travis-ci.org/philip-bui/grpc-zerolog.svg?branch=master
|
||
|
|
|
||
|
|
[CodeCov Result]: https://codecov.io/gh/philip-bui/grpc-zerolog
|
||
|
|
[CodeCov Widget]: https://codecov.io/gh/philip-bui/grpc-zerolog/branch/master/graph/badge.svg
|
||
|
|
|
||
|
|
[GoReport Status]: https://goreportcard.com/report/github.com/philip-bui/grpc-zerolog
|
||
|
|
[GoReport Widget]: https://goreportcard.com/badge/github.com/philip-bui/grpc-zerolog
|
||
|
|
|
||
|
|
[GoDoc]: https://godoc.org/github.com/philip-bui/grpc-zerolog
|
||
|
|
[GoDoc Widget]: https://godoc.org/github.com/philip-bui/grpc-zerolog?status.svg
|
||
|
|
|
||
|
|
Implementation of gRPC Logging Middleware, integrating [Zerolog](https://github.com/rs/zerolog) as a gRPC [Interceptor](https://github.com/grpc-ecosystem/go-grpc-middleware) to log the following fields:
|
||
|
|
|
||
|
|
- Request Protobufs as JSON.
|
||
|
|
- Response Protobufs as JSON, or Errors.
|
||
|
|
- Status Code, Duration, Timestamp, Service Name, Service Method, IP, Metadata Fields and User Agent.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```go
|
||
|
|
import (
|
||
|
|
"github.com/philip-bui/grpc-zerolog"
|
||
|
|
)
|
||
|
|
|
||
|
|
func main() {
|
||
|
|
// With global Zerolog logger.
|
||
|
|
grpc.NewServer(
|
||
|
|
zerolog.UnaryInterceptor(),
|
||
|
|
)
|
||
|
|
|
||
|
|
// With custom Zerolog instance.
|
||
|
|
log := zerolog.New(os.Stdout)
|
||
|
|
grpc.NewServer(
|
||
|
|
zerolog.UnaryInterceptorWithLogger(&log),
|
||
|
|
)
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
gRPC Zerolog is available under the MIT license. [See LICENSE](https://github.com/philip-bui/grpc-zerolog/blob/master/LICENSE) for details.
|