README
¶
pkg
Common ANZ Go Packages
Development
- Pre-requisites: go, golangci-lint, GNU make
- Build with
make - View build options with
make help
On OSX, after installing go 1.18 run
brew install golangci/tap/golangci-lint make
Working with protos
All generated code derived from Protobuf and gRPC definitions is committed to this repo, however if you need to regenerate the Go code or work with gRPC, install the following tools:
On OSX run
(cd /tmp; go get -u golang.org/x/tools/goimports)
brew install grpcurl protoc-gen-go grpc prototool
After the initial installation run
make generate
Directories
¶
| Path | Synopsis |
|---|---|
|
Package clock is a context-driven wrapper for the time library.
|
Package clock is a context-driven wrapper for the time library. |
|
Package env is a context-driven wrapper for access to environment variable.
|
Package env is a context-driven wrapper for access to environment variable. |
|
Package health contains a gRPC and an HTTP server providing application health related information.
|
Package health contains a gRPC and an HTTP server providing application health related information. |
|
ochealth
Package ochealth exports health.State data via OpenCensus.
|
Package ochealth exports health.State data via OpenCensus. |
|
otelhealth
Package otelhealth exports health.State data via OpenTelemetry.
|
Package otelhealth exports health.State data via OpenTelemetry. |
|
pb
Package pb provides protoc generated types and methods for Health service with Alive, Ready and Version methods.
|
Package pb provides protoc generated types and methods for Health service with Alive, Ready and Version methods. |
|
Package logging handles your application logs.
|
Package logging handles your application logs. |
Click to show internal directories.
Click to hide internal directories.