Compare commits
5 Commits
Author | SHA1 | Date | |
---|---|---|---|
56037c4b05 | |||
70ba85bf79 | |||
55e3a68db6 | |||
c47eae8afa | |||
c6514e0590 |
7
TODO.md
7
TODO.md
@ -1,3 +1,8 @@
|
|||||||
# TODO
|
# TODO
|
||||||
|
|
||||||
- [ ] Unit tests
|
- [ ] Pattern for extending config
|
||||||
|
|
||||||
|
## Done
|
||||||
|
- [x] Unit tests
|
||||||
|
- [x] HTTP Logging Middleware
|
||||||
|
- [x] Fix panic with OTEL disabled
|
||||||
|
1
go.mod
1
go.mod
@ -4,7 +4,6 @@ go 1.23.4
|
|||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/caarlos0/env/v11 v11.3.1
|
github.com/caarlos0/env/v11 v11.3.1
|
||||||
github.com/caarlos0/env/v9 v9.0.0
|
|
||||||
github.com/prometheus/client_golang v1.20.5
|
github.com/prometheus/client_golang v1.20.5
|
||||||
github.com/rs/zerolog v1.33.0
|
github.com/rs/zerolog v1.33.0
|
||||||
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.58.0
|
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.58.0
|
||||||
|
19
go.sum
19
go.sum
@ -2,8 +2,6 @@ github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
|
|||||||
github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
|
github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
|
||||||
github.com/caarlos0/env/v11 v11.3.1 h1:cArPWC15hWmEt+gWk7YBi7lEXTXCvpaSdCiZE2X5mCA=
|
github.com/caarlos0/env/v11 v11.3.1 h1:cArPWC15hWmEt+gWk7YBi7lEXTXCvpaSdCiZE2X5mCA=
|
||||||
github.com/caarlos0/env/v11 v11.3.1/go.mod h1:qupehSf/Y0TUTsxKywqRt/vJjN5nz6vauiYEUUr8P4U=
|
github.com/caarlos0/env/v11 v11.3.1/go.mod h1:qupehSf/Y0TUTsxKywqRt/vJjN5nz6vauiYEUUr8P4U=
|
||||||
github.com/caarlos0/env/v9 v9.0.0 h1:SI6JNsOA+y5gj9njpgybykATIylrRMklbs5ch6wO6pc=
|
|
||||||
github.com/caarlos0/env/v9 v9.0.0/go.mod h1:ye5mlCVMYh6tZ+vCgrs/B95sj88cg5Tlnc0XIzgZ020=
|
|
||||||
github.com/cenkalti/backoff/v4 v4.3.0 h1:MyRJ/UdXutAwSAT+s3wNd7MfTIcy71VQueUuFK343L8=
|
github.com/cenkalti/backoff/v4 v4.3.0 h1:MyRJ/UdXutAwSAT+s3wNd7MfTIcy71VQueUuFK343L8=
|
||||||
github.com/cenkalti/backoff/v4 v4.3.0/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE=
|
github.com/cenkalti/backoff/v4 v4.3.0/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE=
|
||||||
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
|
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
|
||||||
@ -25,12 +23,8 @@ github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
|||||||
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
||||||
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||||
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||||
github.com/grpc-ecosystem/grpc-gateway/v2 v2.24.0 h1:TmHmbvxPmaegwhDubVz0lICL0J5Ka2vwTzhoePEXsGE=
|
|
||||||
github.com/grpc-ecosystem/grpc-gateway/v2 v2.24.0/go.mod h1:qztMSjm835F2bXf+5HKAPIS5qsmQDqZna/PgVt4rWtI=
|
|
||||||
github.com/grpc-ecosystem/grpc-gateway/v2 v2.25.1 h1:VNqngBF40hVlDloBruUehVYC3ArSgIyScOAyMRqBxRg=
|
github.com/grpc-ecosystem/grpc-gateway/v2 v2.25.1 h1:VNqngBF40hVlDloBruUehVYC3ArSgIyScOAyMRqBxRg=
|
||||||
github.com/grpc-ecosystem/grpc-gateway/v2 v2.25.1/go.mod h1:RBRO7fro65R6tjKzYgLAFo0t1QEXY1Dp+i/bvpRiqiQ=
|
github.com/grpc-ecosystem/grpc-gateway/v2 v2.25.1/go.mod h1:RBRO7fro65R6tjKzYgLAFo0t1QEXY1Dp+i/bvpRiqiQ=
|
||||||
github.com/klauspost/compress v1.17.9 h1:6KIumPrER1LHsvBVuDa0r5xaG0Es51mhhB9BQB2qeMA=
|
|
||||||
github.com/klauspost/compress v1.17.9/go.mod h1:Di0epgTjJY877eYKx5yC51cX2A2Vl2ibi7bDH9ttBbw=
|
|
||||||
github.com/klauspost/compress v1.17.11 h1:In6xLpyWOi1+C7tXUUWv2ot1QvBjxevKAaI6IXrJmUc=
|
github.com/klauspost/compress v1.17.11 h1:In6xLpyWOi1+C7tXUUWv2ot1QvBjxevKAaI6IXrJmUc=
|
||||||
github.com/klauspost/compress v1.17.11/go.mod h1:pMDklpSncoRMuLFrf1W9Ss9KT+0rH90U12bZKk7uwG0=
|
github.com/klauspost/compress v1.17.11/go.mod h1:pMDklpSncoRMuLFrf1W9Ss9KT+0rH90U12bZKk7uwG0=
|
||||||
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
|
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
|
||||||
@ -42,7 +36,6 @@ github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+
|
|||||||
github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
|
github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
|
||||||
github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
|
github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
|
||||||
github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
|
github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
|
||||||
github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA=
|
|
||||||
github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
||||||
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
|
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
|
||||||
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
||||||
@ -96,33 +89,21 @@ go.opentelemetry.io/proto/otlp v1.4.0 h1:TA9WRvW6zMwP+Ssb6fLoUIuirti1gGbP28GcKG1
|
|||||||
go.opentelemetry.io/proto/otlp v1.4.0/go.mod h1:PPBWZIP98o2ElSqI35IHfu7hIhSwvc5N38Jw8pXuGFY=
|
go.opentelemetry.io/proto/otlp v1.4.0/go.mod h1:PPBWZIP98o2ElSqI35IHfu7hIhSwvc5N38Jw8pXuGFY=
|
||||||
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
|
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/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
|
||||||
golang.org/x/net v0.32.0 h1:ZqPmj8Kzc+Y6e0+skZsuACbx+wzMgo5MQsJh9Qd6aYI=
|
|
||||||
golang.org/x/net v0.32.0/go.mod h1:CwU0IoeOlnQQWJ6ioyFrfRuomB8GKF6KbYXZVyeXNfs=
|
|
||||||
golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I=
|
golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I=
|
||||||
golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=
|
golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=
|
||||||
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
|
|
||||||
golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
|
||||||
golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
|
golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
|
||||||
golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||||
golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
|
golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
|
||||||
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
|
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
|
||||||
google.golang.org/genproto/googleapis/api v0.0.0-20241209162323-e6fa225c2576 h1:CkkIfIt50+lT6NHAVoRYEyAvQGFM7xEwXUUywFvEb3Q=
|
|
||||||
google.golang.org/genproto/googleapis/api v0.0.0-20241209162323-e6fa225c2576/go.mod h1:1R3kvZ1dtP3+4p4d3G8uJ8rFk/fWlScl38vanWACI08=
|
|
||||||
google.golang.org/genproto/googleapis/api v0.0.0-20250102185135-69823020774d h1:H8tOf8XM88HvKqLTxe755haY6r1fqqzLbEnfrmLXlSA=
|
google.golang.org/genproto/googleapis/api v0.0.0-20250102185135-69823020774d h1:H8tOf8XM88HvKqLTxe755haY6r1fqqzLbEnfrmLXlSA=
|
||||||
google.golang.org/genproto/googleapis/api v0.0.0-20250102185135-69823020774d/go.mod h1:2v7Z7gP2ZUOGsaFyxATQSRoBnKygqVq2Cwnvom7QiqY=
|
google.golang.org/genproto/googleapis/api v0.0.0-20250102185135-69823020774d/go.mod h1:2v7Z7gP2ZUOGsaFyxATQSRoBnKygqVq2Cwnvom7QiqY=
|
||||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20241209162323-e6fa225c2576 h1:8ZmaLZE4XWrtU3MyClkYqqtl6Oegr3235h7jxsDyqCY=
|
|
||||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20241209162323-e6fa225c2576/go.mod h1:5uTbfoYQed2U9p3KIj2/Zzm02PYhndfdmML0qC3q3FU=
|
|
||||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20250102185135-69823020774d h1:xJJRGY7TJcvIlpSrN3K6LAWgNFUILlO+OMAqtg9aqnw=
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20250102185135-69823020774d h1:xJJRGY7TJcvIlpSrN3K6LAWgNFUILlO+OMAqtg9aqnw=
|
||||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20250102185135-69823020774d/go.mod h1:3ENsm/5D1mzDyhpzeRi1NR784I0BcofWBoSc5QqqMK4=
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20250102185135-69823020774d/go.mod h1:3ENsm/5D1mzDyhpzeRi1NR784I0BcofWBoSc5QqqMK4=
|
||||||
google.golang.org/grpc v1.68.1 h1:oI5oTa11+ng8r8XMMN7jAOmWfPZWbYpCFaMUTACxkM0=
|
|
||||||
google.golang.org/grpc v1.68.1/go.mod h1:+q1XYFJjShcqn0QZHvCyeR4CXPA+llXIeUIfIe00waw=
|
|
||||||
google.golang.org/grpc v1.69.2 h1:U3S9QEtbXC0bYNvRtcoklF3xGtLViumSYxWykJS+7AU=
|
google.golang.org/grpc v1.69.2 h1:U3S9QEtbXC0bYNvRtcoklF3xGtLViumSYxWykJS+7AU=
|
||||||
google.golang.org/grpc v1.69.2/go.mod h1:vyjdE6jLBI76dgpDojsFGNaHlxdjXN9ghpnd2o7JGZ4=
|
google.golang.org/grpc v1.69.2/go.mod h1:vyjdE6jLBI76dgpDojsFGNaHlxdjXN9ghpnd2o7JGZ4=
|
||||||
google.golang.org/protobuf v1.35.2 h1:8Ar7bF+apOIoThw1EdZl0p1oWvMqTHmpA2fRTyZO8io=
|
|
||||||
google.golang.org/protobuf v1.35.2/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
|
|
||||||
google.golang.org/protobuf v1.36.1 h1:yBPeRvTftaleIgM3PZ/WBIZ7XM/eEYAaEyCwvyjq/gk=
|
google.golang.org/protobuf v1.36.1 h1:yBPeRvTftaleIgM3PZ/WBIZ7XM/eEYAaEyCwvyjq/gk=
|
||||||
google.golang.org/protobuf v1.36.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
|
google.golang.org/protobuf v1.36.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
|
@ -23,3 +23,10 @@ func MustSetupConfigAndLogging(ctx context.Context) context.Context {
|
|||||||
zerolog.Ctx(ctx).Trace().Any("config", *cfg).Send()
|
zerolog.Ctx(ctx).Trace().Any("config", *cfg).Send()
|
||||||
return ctx
|
return ctx
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Unmarshal config into a custom type
|
||||||
|
// Type MUST include *config.AppConfig
|
||||||
|
// Stored in context as *config.AppConfig but can be asserted back
|
||||||
|
func MustSetupConfigAndLoggingInto[T any](ctx context.Context, into T) (context.Context, T) {
|
||||||
|
return ctx, into
|
||||||
|
}
|
||||||
|
107
pkg/app/setup_custom.go
Normal file
107
pkg/app/setup_custom.go
Normal file
@ -0,0 +1,107 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"reflect"
|
||||||
|
|
||||||
|
"gopkg.in/yaml.v3"
|
||||||
|
|
||||||
|
"gitea.libretechconsulting.com/rmcguire/go-app/pkg/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Used to unmarshal config and environment into a custom type
|
||||||
|
// that overloads *config.AppConfig. Will perform normal env
|
||||||
|
// substitutions for AppConfig, but env overrides for custom type
|
||||||
|
// are up to the caller.
|
||||||
|
func MustLoadConfigInto[T any](ctx context.Context, into T) (context.Context, T) {
|
||||||
|
// Step 1: Check our custom type for required *config.AppConfig
|
||||||
|
if err := hasAppConfig(into); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 2: Do the normal thing
|
||||||
|
ctx = MustSetupConfigAndLogging(ctx)
|
||||||
|
|
||||||
|
// Step 3: Extract the config
|
||||||
|
cfg := config.MustFromCtx(ctx)
|
||||||
|
|
||||||
|
// Step 4: Unmarshal custom config
|
||||||
|
configPath := flag.Lookup("config")
|
||||||
|
if configPath != nil && configPath.Value.String() != "" {
|
||||||
|
file, err := os.Open(configPath.Value.String())
|
||||||
|
if err != nil {
|
||||||
|
panic(fmt.Errorf("could not open config file: %w", err))
|
||||||
|
}
|
||||||
|
defer file.Close()
|
||||||
|
|
||||||
|
decoder := yaml.NewDecoder(file)
|
||||||
|
if err := decoder.Decode(into); err != nil {
|
||||||
|
panic(fmt.Errorf("could not decode config file: %w", err))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 5: Re-apply AppConfig to custom type
|
||||||
|
if err := setAppConfig(into, cfg); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 6: Update context, return custom type
|
||||||
|
return ctx, into
|
||||||
|
}
|
||||||
|
|
||||||
|
func setAppConfig[T any](target T, appConfig *config.AppConfig) error {
|
||||||
|
// Ensure target is a pointer to a struct
|
||||||
|
v := reflect.ValueOf(target)
|
||||||
|
if v.Kind() != reflect.Ptr || v.IsNil() {
|
||||||
|
return errors.New("target must be a non-nil pointer to a struct")
|
||||||
|
}
|
||||||
|
|
||||||
|
v = v.Elem() // Dereference the pointer
|
||||||
|
if v.Kind() != reflect.Struct {
|
||||||
|
return errors.New("target must be a pointer to a struct")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Replace *config.AppConfig
|
||||||
|
for i := 0; i < v.NumField(); i++ {
|
||||||
|
field := v.Field(i)
|
||||||
|
if field.Type() == reflect.TypeOf((*config.AppConfig)(nil)) {
|
||||||
|
if !field.CanSet() {
|
||||||
|
return fmt.Errorf("field %q cannot be set", v.Type().Field(i).Name)
|
||||||
|
}
|
||||||
|
field.Set(reflect.ValueOf(appConfig))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return errors.New("no *config.AppConfig field found in target struct")
|
||||||
|
}
|
||||||
|
|
||||||
|
func hasAppConfig[T any](target T) error {
|
||||||
|
v := reflect.ValueOf(target)
|
||||||
|
if v.Kind() != reflect.Ptr || v.IsNil() {
|
||||||
|
return errors.New("target must be a non-nil pointer to a struct")
|
||||||
|
}
|
||||||
|
v = v.Elem()
|
||||||
|
|
||||||
|
if v.Kind() != reflect.Struct {
|
||||||
|
return errors.New("target must be a pointer to a struct")
|
||||||
|
}
|
||||||
|
|
||||||
|
hasAppConfig := false
|
||||||
|
for i := 0; i < v.NumField(); i++ {
|
||||||
|
field := v.Type().Field(i)
|
||||||
|
if field.Type == reflect.TypeOf((*config.AppConfig)(nil)) {
|
||||||
|
hasAppConfig = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !hasAppConfig {
|
||||||
|
return errors.New("struct does not contain a *config.AppConfig field")
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
123
pkg/app/setup_test.go
Normal file
123
pkg/app/setup_test.go
Normal file
@ -0,0 +1,123 @@
|
|||||||
|
package app
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"context"
|
||||||
|
"flag"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"regexp"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/rs/zerolog"
|
||||||
|
|
||||||
|
"gitea.libretechconsulting.com/rmcguire/go-app/pkg/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestMustSetupConfigAndLogging(t *testing.T) {
|
||||||
|
// Configure app and logger
|
||||||
|
type inputs struct {
|
||||||
|
envs map[string]string
|
||||||
|
}
|
||||||
|
type outputs struct {
|
||||||
|
appName string
|
||||||
|
logLevel zerolog.Level
|
||||||
|
logRegexChecks []*regexp.Regexp
|
||||||
|
}
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
inputs inputs
|
||||||
|
want outputs
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "Test json logging with short timestamp",
|
||||||
|
inputs: inputs{
|
||||||
|
envs: map[string]string{
|
||||||
|
"APP_NAME": "testapp",
|
||||||
|
"APP_LOG_LEVEL": "warn",
|
||||||
|
"APP_LOG_FORMAT": "json",
|
||||||
|
"APP_LOG_TIME_FORMAT": "short",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
want: outputs{
|
||||||
|
appName: "testapp",
|
||||||
|
logLevel: zerolog.WarnLevel,
|
||||||
|
logRegexChecks: []*regexp.Regexp{
|
||||||
|
regexp.MustCompile(`^\{.*time":"\d{1,}:\d{2}`),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Test json logging with unix timestamp",
|
||||||
|
inputs: inputs{
|
||||||
|
envs: map[string]string{
|
||||||
|
"APP_NAME": "testapp",
|
||||||
|
"APP_LOG_LEVEL": "info",
|
||||||
|
"APP_LOG_FORMAT": "json",
|
||||||
|
"APP_LOG_TIME_FORMAT": "unix",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
want: outputs{
|
||||||
|
appName: "testapp",
|
||||||
|
logLevel: zerolog.InfoLevel,
|
||||||
|
logRegexChecks: []*regexp.Regexp{
|
||||||
|
regexp.MustCompile(`time":\d+,`),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Set environment variables
|
||||||
|
for key, val := range tt.inputs.envs {
|
||||||
|
os.Setenv(key, val)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Prepare config in context
|
||||||
|
ctx := MustSetupConfigAndLogging(context.Background())
|
||||||
|
|
||||||
|
// Retrieve config and logger from prepared context
|
||||||
|
cfg := config.MustFromCtx(ctx)
|
||||||
|
logger := zerolog.Ctx(ctx)
|
||||||
|
|
||||||
|
// Check wants
|
||||||
|
if cfg.Name != tt.want.appName {
|
||||||
|
t.Errorf("Expected app name %s, got %s", tt.want.appName, cfg.Name)
|
||||||
|
}
|
||||||
|
if logger.GetLevel() != tt.want.logLevel {
|
||||||
|
t.Errorf("Expected log level %#v, got %#v", tt.want.logLevel, logger.GetLevel())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Send and capture a log
|
||||||
|
r, w := io.Pipe()
|
||||||
|
testLogger := logger.Output(w)
|
||||||
|
scanner := bufio.NewScanner(r)
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
testLogger.Error().Msg("test message")
|
||||||
|
w.Close()
|
||||||
|
}()
|
||||||
|
|
||||||
|
logOut := make([]byte, 0)
|
||||||
|
if scanner.Scan() {
|
||||||
|
logOut = scanner.Bytes()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check all expressions
|
||||||
|
for _, expr := range tt.want.logRegexChecks {
|
||||||
|
if !expr.Match(logOut) {
|
||||||
|
t.Errorf("Regex %s did not match log %s", expr.String(), logOut)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Super annoying need to reset due to app framework package
|
||||||
|
// using flag.Parse() and go test also using it
|
||||||
|
testlog := flag.Lookup("test.testlogfile").Value.String()
|
||||||
|
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
|
||||||
|
flag.String("test.testlogfile", testlog, "")
|
||||||
|
flag.String("test.paniconexit0", "", "")
|
||||||
|
flag.String("test.v", "", "")
|
||||||
|
flag.Parse()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
@ -2,10 +2,12 @@ package config
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"runtime/debug"
|
"runtime/debug"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/caarlos0/env/v11"
|
"github.com/caarlos0/env/v11"
|
||||||
"gopkg.in/yaml.v3"
|
"gopkg.in/yaml.v3"
|
||||||
@ -58,9 +60,52 @@ func loadConfig(configPath string) (*AppConfig, error) {
|
|||||||
return nil, fmt.Errorf("could not parse environment variables: %w", err)
|
return nil, fmt.Errorf("could not parse environment variables: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Perform updates / enrichments
|
||||||
|
err := prepareConfig(&cfg)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
return &cfg, nil
|
return &cfg, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func prepareConfig(cfg *AppConfig) error {
|
||||||
|
var errs error
|
||||||
|
|
||||||
|
// Set timeouts
|
||||||
|
if cfg.HTTP.ReadTimeout != "" {
|
||||||
|
if rT, err := time.ParseDuration(cfg.HTTP.ReadTimeout); err == nil {
|
||||||
|
cfg.HTTP.rT = &rT
|
||||||
|
} else {
|
||||||
|
errs = errors.Join(errs, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if cfg.HTTP.ReadTimeout != "" {
|
||||||
|
if wT, err := time.ParseDuration(cfg.HTTP.WriteTimeout); err == nil {
|
||||||
|
cfg.HTTP.wT = &wT
|
||||||
|
} else {
|
||||||
|
errs = errors.Join(errs, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if cfg.HTTP.IdleTimeout != "" {
|
||||||
|
if iT, err := time.ParseDuration(cfg.HTTP.IdleTimeout); err == nil {
|
||||||
|
cfg.HTTP.iT = &iT
|
||||||
|
} else {
|
||||||
|
errs = errors.Join(errs, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns read timeout, write timeout, and idle timeout, in that order
|
||||||
|
// nil if unset
|
||||||
|
func (h *HTTPConfig) Timeouts() (*time.Duration, *time.Duration, *time.Duration) {
|
||||||
|
return h.rT, h.wT, h.iT
|
||||||
|
}
|
||||||
|
|
||||||
func getVersion() string {
|
func getVersion() string {
|
||||||
if info, ok := debug.ReadBuildInfo(); ok && info.Main.Version != "(devel)" {
|
if info, ok := debug.ReadBuildInfo(); ok && info.Main.Version != "(devel)" {
|
||||||
return info.Main.Version
|
return info.Main.Version
|
||||||
|
81
pkg/config/config_test.go
Normal file
81
pkg/config/config_test.go
Normal file
@ -0,0 +1,81 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Changing defaults could be a breaking change,
|
||||||
|
// if this needs to be modified to pass the test,
|
||||||
|
// an item should be added to the changelog.
|
||||||
|
//
|
||||||
|
// This should be maintained, as it is the primary
|
||||||
|
// interface between an app and the app framework.
|
||||||
|
var testDefaultConfig = &AppConfig{
|
||||||
|
Environment: "development",
|
||||||
|
Version: getVersion(),
|
||||||
|
Logging: &LogConfig{
|
||||||
|
Enabled: true,
|
||||||
|
Level: "info",
|
||||||
|
Format: LogFormatJSON,
|
||||||
|
Output: "stderr",
|
||||||
|
TimeFormat: TimeFormatLong,
|
||||||
|
},
|
||||||
|
HTTP: &HTTPConfig{
|
||||||
|
Listen: "127.0.0.1:8080",
|
||||||
|
LogRequests: false,
|
||||||
|
ReadTimeout: "10s",
|
||||||
|
WriteTimeout: "10s",
|
||||||
|
IdleTimeout: "1m",
|
||||||
|
},
|
||||||
|
OTEL: &OTELConfig{
|
||||||
|
Enabled: true,
|
||||||
|
PrometheusEnabled: true,
|
||||||
|
PrometheusPath: "/metrics",
|
||||||
|
StdoutEnabled: false,
|
||||||
|
MetricIntervalSecs: 30,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_loadConfig(t *testing.T) {
|
||||||
|
type args struct {
|
||||||
|
configPath string
|
||||||
|
}
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
args args
|
||||||
|
want *AppConfig
|
||||||
|
wantErr bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "Ensure defaults",
|
||||||
|
args: args{configPath: ""},
|
||||||
|
want: testDefaultConfig,
|
||||||
|
wantErr: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
got, err := loadConfig(tt.args.configPath)
|
||||||
|
if (err != nil) != tt.wantErr {
|
||||||
|
t.Errorf("loadConfig() error = %v, wantErr %v", err, tt.wantErr)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Marshal both the expected and actual structs to JSON
|
||||||
|
gotJSON, err := json.Marshal(got)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Failed to marshal got to JSON: %v", err)
|
||||||
|
}
|
||||||
|
wantJSON, err := json.Marshal(tt.want)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Failed to marshal want to JSON: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Compare the JSON strings
|
||||||
|
if string(gotJSON) != string(wantJSON) {
|
||||||
|
t.Errorf("loadConfig() JSON = %s, want JSON = %s", string(gotJSON), string(wantJSON))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
43
pkg/config/ctx_test.go
Normal file
43
pkg/config/ctx_test.go
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFromCtx(t *testing.T) {
|
||||||
|
app := &AppConfig{
|
||||||
|
Name: "testapp",
|
||||||
|
}
|
||||||
|
appCtx := app.AddToCtx(context.Background())
|
||||||
|
|
||||||
|
type args struct {
|
||||||
|
ctx context.Context
|
||||||
|
}
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
args args
|
||||||
|
wantErr bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "Unprepared app context",
|
||||||
|
args: args{ctx: context.Background()},
|
||||||
|
wantErr: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Prepared app context",
|
||||||
|
args: args{ctx: appCtx},
|
||||||
|
wantErr: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
_, err := FromCtx(tt.args.ctx)
|
||||||
|
if (err != nil) != tt.wantErr {
|
||||||
|
t.Errorf("FromCtx() error = %v, wantErr %v", err, tt.wantErr)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
@ -1,5 +1,7 @@
|
|||||||
package config
|
package config
|
||||||
|
|
||||||
|
import "time"
|
||||||
|
|
||||||
// Default Settings
|
// Default Settings
|
||||||
var DefaultConfig = &AppConfig{
|
var DefaultConfig = &AppConfig{
|
||||||
Environment: "development",
|
Environment: "development",
|
||||||
@ -12,7 +14,11 @@ var DefaultConfig = &AppConfig{
|
|||||||
TimeFormat: TimeFormatLong,
|
TimeFormat: TimeFormatLong,
|
||||||
},
|
},
|
||||||
HTTP: &HTTPConfig{
|
HTTP: &HTTPConfig{
|
||||||
Listen: "127.0.0.1:8080",
|
Listen: "127.0.0.1:8080",
|
||||||
|
LogRequests: false,
|
||||||
|
ReadTimeout: "10s",
|
||||||
|
WriteTimeout: "10s",
|
||||||
|
IdleTimeout: "1m",
|
||||||
},
|
},
|
||||||
OTEL: &OTELConfig{
|
OTEL: &OTELConfig{
|
||||||
Enabled: true,
|
Enabled: true,
|
||||||
@ -70,8 +76,14 @@ const (
|
|||||||
|
|
||||||
// HTTP Configuration
|
// HTTP Configuration
|
||||||
type HTTPConfig struct {
|
type HTTPConfig struct {
|
||||||
Listen string `yaml:"listen,omitempty" env:"APP_HTTP_LISTEN"`
|
Listen string `yaml:"listen,omitempty" env:"APP_HTTP_LISTEN"`
|
||||||
RequestTimeout int `yaml:"requestTimeout,omitempty" env:"APP_HTTP_REQUEST_TIMEOUT"`
|
LogRequests bool `yaml:"logRequests" env:"APP_HTTP_LOG_REQUESTS"`
|
||||||
|
ReadTimeout string `yaml:"readTimeout" env:"APP_HTTP_READ_TIMEOUT"` // Go duration (e.g. 10s)
|
||||||
|
WriteTimeout string `yaml:"writeTimeout" env:"APP_HTTP_WRITE_TIMEOUT"` // Go duration (e.g. 10s)
|
||||||
|
IdleTimeout string `yaml:"idleTimeout" env:"APP_HTTP_IDLE_TIMEOUT"` // Go duration (e.g. 10s)
|
||||||
|
rT *time.Duration
|
||||||
|
wT *time.Duration
|
||||||
|
iT *time.Duration
|
||||||
}
|
}
|
||||||
|
|
||||||
// OTEL Configuration
|
// OTEL Configuration
|
||||||
|
@ -46,6 +46,11 @@ func Init(ctx context.Context) (context.Context, func(context.Context) error) {
|
|||||||
if !cfg.OTEL.Enabled {
|
if !cfg.OTEL.Enabled {
|
||||||
opentelemetry.SetMeterProvider(noopMetric.NewMeterProvider())
|
opentelemetry.SetMeterProvider(noopMetric.NewMeterProvider())
|
||||||
opentelemetry.SetTracerProvider(noop.NewTracerProvider())
|
opentelemetry.SetTracerProvider(noop.NewTracerProvider())
|
||||||
|
// Won't function with noop providers
|
||||||
|
meter := opentelemetry.Meter(cfg.Name)
|
||||||
|
ctx = AddMeterToCtx(ctx, meter)
|
||||||
|
tracer := opentelemetry.Tracer(cfg.Name)
|
||||||
|
ctx = AddTracerToCtx(ctx, tracer)
|
||||||
return ctx, func(context.Context) error {
|
return ctx, func(context.Context) error {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@ -62,12 +67,12 @@ func Init(ctx context.Context) (context.Context, func(context.Context) error) {
|
|||||||
if cfg.OTEL.StdoutEnabled {
|
if cfg.OTEL.StdoutEnabled {
|
||||||
options = append(options, EnableStdoutExporter)
|
options = append(options, EnableStdoutExporter)
|
||||||
}
|
}
|
||||||
if cfg.OTEL.MetricIntervalSecs > 0 {
|
|
||||||
metricInterval = time.Duration(cfg.OTEL.MetricIntervalSecs) * time.Second
|
|
||||||
}
|
|
||||||
if cfg.OTEL.PrometheusEnabled {
|
if cfg.OTEL.PrometheusEnabled {
|
||||||
options = append(options, EnablePrometheusExporter)
|
options = append(options, EnablePrometheusExporter)
|
||||||
}
|
}
|
||||||
|
if cfg.OTEL.MetricIntervalSecs > 0 {
|
||||||
|
metricInterval = time.Duration(cfg.OTEL.MetricIntervalSecs) * time.Second
|
||||||
|
}
|
||||||
options = append(options,
|
options = append(options,
|
||||||
WithMetricExportInterval(metricInterval))
|
WithMetricExportInterval(metricInterval))
|
||||||
|
|
||||||
|
@ -17,11 +17,11 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
httpMeter metric.Meter
|
httpMeter metric.Meter
|
||||||
httpTracer trace.Tracer
|
httpTracer trace.Tracer
|
||||||
readTimeout = 10 * time.Second
|
defReadTimeout = 10 * time.Second
|
||||||
writeTimeout = 10 * time.Second
|
defWriteTimeout = 10 * time.Second
|
||||||
idleTimeout = 15 * time.Second
|
defIdleTimeout = 15 * time.Second
|
||||||
)
|
)
|
||||||
|
|
||||||
type HTTPFunc struct {
|
type HTTPFunc struct {
|
||||||
@ -72,6 +72,28 @@ func prepHTTPServer(ctx context.Context, handleFuncs []HTTPFunc, hcFuncs ...Heal
|
|||||||
}
|
}
|
||||||
}))
|
}))
|
||||||
|
|
||||||
|
// Set timeouts from defaults, override
|
||||||
|
// with config timeouts if set
|
||||||
|
readTimeout := defReadTimeout
|
||||||
|
writeTimeout := defWriteTimeout
|
||||||
|
idleTimeout := defIdleTimeout
|
||||||
|
|
||||||
|
rT, wT, iT := cfg.HTTP.Timeouts()
|
||||||
|
if rT != nil {
|
||||||
|
readTimeout = *rT
|
||||||
|
}
|
||||||
|
if wT != nil {
|
||||||
|
writeTimeout = *wT
|
||||||
|
}
|
||||||
|
if iT != nil {
|
||||||
|
idleTimeout = *iT
|
||||||
|
}
|
||||||
|
|
||||||
|
// Inject logging middleware
|
||||||
|
if cfg.HTTP.LogRequests {
|
||||||
|
handler = loggingMiddleware(ctx, handler)
|
||||||
|
}
|
||||||
|
|
||||||
return &http.Server{
|
return &http.Server{
|
||||||
Addr: cfg.HTTP.Listen,
|
Addr: cfg.HTTP.Listen,
|
||||||
ReadTimeout: readTimeout,
|
ReadTimeout: readTimeout,
|
||||||
|
87
pkg/srv/http_log.go
Normal file
87
pkg/srv/http_log.go
Normal file
@ -0,0 +1,87 @@
|
|||||||
|
package srv
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"net/http"
|
||||||
|
"regexp"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/rs/zerolog"
|
||||||
|
)
|
||||||
|
|
||||||
|
var ExcludeFromLogging = regexp.MustCompile(`\/(ready|live|metrics)$`)
|
||||||
|
|
||||||
|
type LoggingResponseWriter struct {
|
||||||
|
http.ResponseWriter
|
||||||
|
statusCode int
|
||||||
|
body *bytes.Buffer
|
||||||
|
}
|
||||||
|
|
||||||
|
func loggingMiddleware(appCtx context.Context, next http.Handler) http.Handler {
|
||||||
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if ExcludeFromLogging.Match([]byte(r.URL.Path)) {
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
log := zerolog.Ctx(appCtx)
|
||||||
|
|
||||||
|
start := time.Now()
|
||||||
|
lrr := newLoggingResponseWriter(w)
|
||||||
|
next.ServeHTTP(lrr, r)
|
||||||
|
|
||||||
|
log.Debug().
|
||||||
|
Str("path", r.URL.Path).
|
||||||
|
Any("query", r.URL.Query()).
|
||||||
|
Int("statusCode", lrr.statusCode).
|
||||||
|
Str("protocol", r.Proto).
|
||||||
|
Str("remote", r.RemoteAddr).
|
||||||
|
Dur("duration", time.Since(start)).
|
||||||
|
Msg("http request served")
|
||||||
|
|
||||||
|
// Log response body
|
||||||
|
trcLog := log.Trace().
|
||||||
|
Str("path", r.URL.Path).
|
||||||
|
Int("statusCode", lrr.statusCode)
|
||||||
|
|
||||||
|
// Check if it's JSON
|
||||||
|
firstByte, err := lrr.body.ReadByte()
|
||||||
|
if err != nil {
|
||||||
|
trcLog.Err(errors.New("invalid response body")).Send()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
lrr.body.UnreadByte()
|
||||||
|
|
||||||
|
if firstByte == '{' {
|
||||||
|
trcLog = trcLog.RawJSON("response", lrr.body.Bytes())
|
||||||
|
} else {
|
||||||
|
trcLog = trcLog.Bytes("response", lrr.body.Bytes())
|
||||||
|
}
|
||||||
|
trcLog.Msg("response payload")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Implement Flush to support the http.Flusher interface
|
||||||
|
func (w *LoggingResponseWriter) Flush() {
|
||||||
|
if flusher, ok := w.ResponseWriter.(http.Flusher); ok {
|
||||||
|
flusher.Flush()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *LoggingResponseWriter) WriteHeader(code int) {
|
||||||
|
w.statusCode = code
|
||||||
|
w.ResponseWriter.WriteHeader(code)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *LoggingResponseWriter) Write(b []byte) (int, error) {
|
||||||
|
w.body.Write(b)
|
||||||
|
return w.ResponseWriter.Write(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
func newLoggingResponseWriter(w http.ResponseWriter) *LoggingResponseWriter {
|
||||||
|
return &LoggingResponseWriter{
|
||||||
|
ResponseWriter: w, statusCode: http.StatusOK, body: bytes.NewBuffer(nil),
|
||||||
|
}
|
||||||
|
}
|
Reference in New Issue
Block a user