-
-
Notifications
You must be signed in to change notification settings - Fork 36
/
client.go
189 lines (150 loc) · 5.9 KB
/
client.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
package rpc
import (
"context"
"fmt"
grpc_prometheus "github.com/grpc-ecosystem/go-grpc-middleware/providers/prometheus"
"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/timeout"
"github.com/spf13/viper"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"go.opentelemetry.io/otel/trace"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
"github.com/shortlink-org/shortlink/pkg/logger"
"github.com/shortlink-org/shortlink/pkg/logger/field"
"github.com/shortlink-org/shortlink/pkg/observability/monitoring"
grpc_logger "github.com/shortlink-org/shortlink/pkg/rpc/middleware/logger"
session_interceptor "github.com/shortlink-org/shortlink/pkg/rpc/middleware/session"
)
type Client struct {
interceptorUnaryClientList []grpc.UnaryClientInterceptor
interceptorStreamClientList []grpc.StreamClientInterceptor
optionsNewClient []grpc.DialOption
port int
host string
}
func (c *Client) GetURI() string {
return fmt.Sprintf("%s:%d", c.host, c.port)
}
// InitClient - set up a connection to the server.
func InitClient(ctx context.Context, log logger.Logger, tracer trace.TracerProvider, monitor *monitoring.Monitoring) (*grpc.ClientConn, func(), error) {
config, err := SetClientConfig(tracer, monitor, log)
if err != nil {
return nil, nil, err
}
// Set up a connection to the server peer
conn, err := grpc.NewClient(
config.GetURI(),
config.optionsNewClient...,
)
if err != nil {
return nil, nil, err
}
log.Info("Run gRPC Client", field.Fields{"port": config.port, "host": config.host})
cleanup := func() {
_ = conn.Close()
}
return conn, cleanup, nil
}
// setConfig - set configuration
func SetClientConfig(tracer trace.TracerProvider, monitor *monitoring.Monitoring, log logger.Logger) (*Client, error) {
viper.AutomaticEnv()
viper.SetDefault("GRPC_CLIENT_PORT", "50051") // gRPC port
grpc_port := viper.GetInt("GRPC_CLIENT_PORT")
viper.SetDefault("GRPC_CLIENT_HOST", "0.0.0.0") // gRPC host
grpc_host := viper.GetString("GRPC_CLIENT_HOST")
config := &Client{
port: grpc_port,
host: grpc_host,
}
// Initialize gRPC Client's interceptor.
config.withSession()
config.withMetrics(monitor)
config.withTracer(tracer, monitor)
config.withLogger(log)
config.withTimeout()
// Initialize your gRPC server's interceptor.
config.optionsNewClient = append(
config.optionsNewClient,
grpc.WithChainUnaryInterceptor(config.interceptorUnaryClientList...),
grpc.WithChainStreamInterceptor(config.interceptorStreamClientList...),
)
// NOTE: made after initialize your gRPC Client's interceptor.
err := config.withTLS()
if err != nil {
return nil, err
}
return config, nil
}
// GetOptions - return options for gRPC Client.
func (c *Client) GetOptions() []grpc.DialOption {
return c.optionsNewClient
}
// withTimeout - setup timeout
func (c *Client) withTimeout() {
viper.SetDefault("GRPC_CLIENT_TIMEOUT", "10s") // Set timeout for gRPC-Client
timeoutClient := viper.GetDuration("GRPC_CLIENT_TIMEOUT")
c.interceptorUnaryClientList = append(c.interceptorUnaryClientList, timeout.UnaryClientInterceptor(timeoutClient))
}
// withLogger - setup logger
func (c *Client) withLogger(log logger.Logger) {
viper.SetDefault("GRPC_CLIENT_LOGGER_ENABLED", true) // Enable logging for gRPC-Client
isEnableLogger := viper.GetBool("GRPC_CLIENT_LOGGER_ENABLED")
if isEnableLogger {
c.interceptorUnaryClientList = append(c.interceptorUnaryClientList, grpc_logger.UnaryClientInterceptor(log))
c.interceptorStreamClientList = append(c.interceptorStreamClientList, grpc_logger.StreamClientInterceptor(log))
}
}
// withTLS - setup TLS
func (c *Client) withTLS() error {
viper.SetDefault("GRPC_CLIENT_TLS_ENABLED", false) // gRPC TLS
isEnableTLS := viper.GetBool("GRPC_CLIENT_TLS_ENABLED")
viper.SetDefault("GRPC_CLIENT_CERT_PATH", "ops/cert/intermediate_ca.pem") // gRPC Client cert
certFile := viper.GetString("GRPC_CLIENT_CERT_PATH")
if isEnableTLS {
creds, err := credentials.NewClientTLSFromFile(certFile, "")
if err != nil {
return err
}
c.optionsNewClient = append(c.optionsNewClient, grpc.WithTransportCredentials(creds))
return nil
}
c.optionsNewClient = append(c.optionsNewClient, grpc.WithTransportCredentials(insecure.NewCredentials()))
return nil
}
// withTracer - setup tracing
func (c *Client) withTracer(tracer trace.TracerProvider, monitor *monitoring.Monitoring) {
if tracer == nil {
return
}
c.optionsNewClient = append(c.optionsNewClient, grpc.WithStatsHandler(
otelgrpc.NewClientHandler(
otelgrpc.WithTracerProvider(tracer),
otelgrpc.WithMeterProvider(monitor.Metrics),
otelgrpc.WithMessageEvents(otelgrpc.ReceivedEvents, otelgrpc.SentEvents))),
)
}
// withMetrics - setup metrics.
func (c *Client) withMetrics(monitor *monitoring.Monitoring) {
if monitor == nil {
return
}
clientMetrics := grpc_prometheus.NewClientMetrics(
grpc_prometheus.WithClientHandlingTimeHistogram(
grpc_prometheus.WithHistogramBuckets([]float64{0.001, 0.01, 0.1, 0.3, 0.6, 1, 3, 6, 9, 20, 30, 60, 90, 120}),
),
)
c.interceptorUnaryClientList = append(c.interceptorUnaryClientList, clientMetrics.UnaryClientInterceptor(grpc_prometheus.WithExemplarFromContext(exemplarFromContext)))
c.interceptorStreamClientList = append(c.interceptorStreamClientList, clientMetrics.StreamClientInterceptor(grpc_prometheus.WithExemplarFromContext(exemplarFromContext)))
defer func() {
if err := recover(); err != nil { //nolint:staticcheck // ignore SA1019: recover from panic by calling a function
// ignore panic from duplicate registration
}
}()
monitor.Prometheus.MustRegister(clientMetrics)
}
// withSession - setup session
func (c *Client) withSession() {
c.interceptorUnaryClientList = append(c.interceptorUnaryClientList, session_interceptor.SessionUnaryClientInterceptor())
c.interceptorStreamClientList = append(c.interceptorStreamClientList, session_interceptor.SessionStreamClientInterceptor())
}