-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmain.go
659 lines (562 loc) · 19.5 KB
/
main.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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
package main
import (
"context"
"crypto/rand"
"crypto/rsa"
"crypto/tls"
"crypto/x509"
"crypto/x509/pkix"
"encoding/json"
"encoding/pem"
"fmt"
"math/big"
"net"
"net/http"
"os"
"os/signal"
"strconv"
"strings"
"syscall"
"time"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/quic-go/quic-go/http3"
log "github.com/sirupsen/logrus"
"github.com/spf13/pflag"
"github.com/spf13/viper"
"google.golang.org/grpc"
"google.golang.org/grpc/peer"
"google.golang.org/grpc/reflection"
pb "echo-app/proto"
)
// Default port numbers
const (
DefaultMessage = ""
DefaultNode = ""
DefaultPrintHeaders = false
DefaultTLS = false
DefaultTCP = false
DefaultGRPC = false
DefaultQUIC = false
DefaultLogLevel = log.InfoLevel
DefaultHTTPPort = "8080"
DefaultTLSPort = "8443"
DefaultTCPPort = "9090"
DefaultGRPCPort = "50051"
DefaultQUICPort = "4433"
DefaultMetrics = true
DefaultMetricsPort = "3000"
)
var (
metricsEnabled bool
httpRequestsTotal = prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: "http_requests_total",
Help: "Total number of HTTP requests",
},
[]string{"listener", "method", "endpoint"},
)
tcpRequestsTotal = prometheus.NewCounter(
prometheus.CounterOpts{
Name: "tcp_requests_total",
Help: "Total number of TCP requests",
},
)
grpcRequestsTotal = prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: "grpc_requests_total",
Help: "Total number of gRPC requests",
},
[]string{"method"},
)
quicRequestsTotal = prometheus.NewCounter(
prometheus.CounterOpts{
Name: "quic_requests_total",
Help: "Total number of QUIC requests",
},
)
)
func initMetrics() {
log.Debug("Initializing metrics")
prometheus.MustRegister(httpRequestsTotal)
prometheus.MustRegister(tcpRequestsTotal)
prometheus.MustRegister(grpcRequestsTotal)
prometheus.MustRegister(quicRequestsTotal)
}
// Response is the struct for the JSON response
type Response struct {
Timestamp string `json:"timestamp"`
Message *string `json:"message,omitempty"`
SourceIP string `json:"source_ip"`
Hostname string `json:"hostname"`
Listener string `json:"listener"` // Field to include the listener name
Node *string `json:"node,omitempty"` // Optional field to include node name
Headers map[string][]string `json:"headers,omitempty"` // Optional field to include headers
HTTPVersion string `json:"http_version,omitempty"`
HTTPMethod string `json:"http_method,omitempty"`
HTTPEndpoint string `json:"http_endpoint,omitempty"`
GRPCMethod string `json:"grpc_method,omitempty"`
}
// EchoServer is the gRPC server that implements the EchoService
type EchoServer struct {
pb.UnimplementedEchoServiceServer
messagePtr *string
nodePtr *string
}
// Echo handles the Echo gRPC request
func (s *EchoServer) Echo(ctx context.Context, req *pb.EchoRequest) (*pb.EchoResponse, error) {
// Extract the gRPC method name from the context
method, _ := grpc.Method(ctx)
if metricsEnabled {
log.Debug("Incrementing gRPC requests counter")
// Increment the gRPC requests counter
grpcRequestsTotal.WithLabelValues(method).Inc()
}
// Get the current time in human-readable format with milliseconds
timestamp := time.Now().Format("2006-01-02T15:04:05.999Z07:00")
host, _ := os.Hostname()
// Extract the client's IP address from the context
var clientIP string
if p, ok := peer.FromContext(ctx); ok {
if addr, ok := p.Addr.(*net.TCPAddr); ok {
clientIP = addr.IP.String()
}
}
// Log the serving request with detailed information
log.Infof("Serving gRPC request from %s via gRPC listener, method: %s", clientIP, method)
// Create the response struct
response := &pb.EchoResponse{
Timestamp: timestamp,
Hostname: host,
Listener: "gRPC",
SourceIp: clientIP,
GrpcMethod: method,
}
// Optionally set the message if it's not nil
if s.messagePtr != nil {
response.Message = *s.messagePtr
}
// Optionally set the node name if it's not nil
if s.nodePtr != nil {
response.Node = *s.nodePtr
}
return response, nil
}
func main() {
// Set up Viper
viper.AutomaticEnv()
viper.SetEnvPrefix("ECHO_APP")
viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
// Define command line flags using pflag
pflag.String("message", DefaultMessage, "Custom message to include in the response")
pflag.String("node", DefaultNode, "Node name to include in the response")
pflag.Bool("print-http-request-headers", DefaultPrintHeaders, "Include HTTP request headers in the response")
pflag.Bool("tls", DefaultTLS, "Enable TLS (HTTPS) support")
pflag.Bool("tcp", DefaultTCP, "Enable TCP listener")
pflag.Bool("grpc", DefaultGRPC, "Enable gRPC listener")
pflag.Bool("quic", DefaultQUIC, "Enable QUIC listener")
pflag.Bool("metrics", DefaultMetrics, "Enable Prometheus metrics endpoint")
pflag.String("port", DefaultHTTPPort, "Port for the HTTP server")
pflag.String("tls-port", DefaultTLSPort, "Port for the TLS server")
pflag.String("tcp-port", DefaultTCPPort, "Port for the TCP server")
pflag.String("grpc-port", DefaultGRPCPort, "Port for the gRPC server")
pflag.String("quic-port", DefaultQUICPort, "Port for the QUIC server")
pflag.String("metrics-port", DefaultMetricsPort, "Port for the Prometheus metrics server")
pflag.String("log-level", DefaultLogLevel.String(), "Logging level (debug, info, warn, error)")
// Set custom usage function
pflag.Usage = func() {
fmt.Fprintf(os.Stderr, "echo-app: A simple Go application that responds with a JSON payload containing various details.\n\n")
fmt.Fprintf(os.Stderr, "Usage:\n")
pflag.PrintDefaults()
}
// Parse command line flags
pflag.Parse()
// Bind command line flags to Viper
if err := viper.BindPFlags(pflag.CommandLine); err != nil {
log.Fatalf("Failed to bind command line flags: %v", err)
}
// Set up logging
setLogLevel()
// Get configuration values
messagePtr := getMessagePtr()
nodePtr := getNodePtr()
printHeaders := getPrintHeadersSetting()
tlsEnabled := getTLSSetting()
tcpEnabled := getTCPSetting()
grpcEnabled := getGRPCSetting()
quicEnabled := getQUICSetting()
metricsEnabled = getMetricsSetting()
// Prepare the message log
messageLog := "No MESSAGE environment variable set"
if messagePtr != nil {
messageLog = "MESSAGE is set to: " + *messagePtr
}
// Prepare the node log
nodeLog := "No NODE environment variable set"
if nodePtr != nil {
nodeLog = "NODE environment variable set to: " + *nodePtr
}
// Print optional configs on multiple lines
log.Debug("Server configuration:")
log.Debugf(" %s", messageLog)
log.Debugf(" %s", nodeLog)
log.Debugf(" PRINT_HTTP_REQUEST_HEADERS is set to: %t", printHeaders)
log.Debugf(" TLS is set to: %t", tlsEnabled)
log.Debugf(" TCP is set to: %t", tcpEnabled)
log.Debugf(" GRPC is set to: %t", grpcEnabled)
log.Debugf(" QUIC is set to: %t", quicEnabled)
log.Debugf(" METRICS is set to: %t", metricsEnabled)
// Use PORT environment variable, or default to DefaultHTTPPort
port := getValidPort("port", DefaultHTTPPort)
// Register handleHTTPConnection function to handle all requests
mux := http.NewServeMux()
mux.HandleFunc("/", handleHTTPConnection(messagePtr, nodePtr, printHeaders, "HTTP")) // Pass message, node pointers, printHeaders, and listener name to the handleHTTPConnection function
// Start the web server on port and accept requests
go func() {
listener, err := net.Listen("tcp", ":"+port)
if err != nil {
log.Fatalf("Failed to start HTTP server: %v", err)
}
defer listener.Close()
log.Infof("HTTP server listening on port %s/%s", port, getL4Protocol(listener))
log.Fatal(http.Serve(listener, mux))
}()
if tlsEnabled {
startTLSServer(messagePtr, nodePtr, printHeaders)
}
if tcpEnabled {
startTCPServer(messagePtr, nodePtr)
}
if grpcEnabled {
startGRPCServer(messagePtr, nodePtr)
}
if quicEnabled {
startQUICServer(messagePtr, nodePtr, printHeaders)
}
if metricsEnabled {
initMetrics()
startMetricsServer()
}
// Handle OS signals
handleSignals()
// Block forever
select {}
}
func startTLSServer(messagePtr, nodePtr *string, printHeaders bool) {
// Use TLS_PORT environment variable, or default to DefaultTLSPort
tlsPort := getValidPort("tls-port", DefaultTLSPort)
// Generate in-memory TLS certificate pair
cert, err := generateSelfSignedCert()
if err != nil {
log.Fatalf("Failed to generate self-signed certificate: %v", err)
}
// Start the HTTPS server on the specified TLS port
go func() {
listener, err := tls.Listen("tcp", ":"+tlsPort, &tls.Config{
Certificates: []tls.Certificate{cert},
})
if err != nil {
log.Fatalf("Failed to start TLS server: %v", err)
}
defer listener.Close()
log.Infof("TLS server listening on port %s/%s", tlsPort, getL4Protocol(listener))
server := &http.Server{
Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
handleHTTPConnection(messagePtr, nodePtr, printHeaders, "TLS")(w, r)
}),
}
log.Fatal(server.Serve(listener))
}()
}
func startTCPServer(messagePtr, nodePtr *string) {
// Use TCP_PORT environment variable, or default to DefaultTCPPort
tcpPort := getValidPort("tcp-port", DefaultTCPPort)
// Start the TCP server on the specified TCP port
go func() {
listener, err := net.Listen("tcp", ":"+tcpPort)
if err != nil {
log.Fatalf("Failed to start TCP server: %v", err)
}
defer listener.Close()
log.Infof("TCP server listening on port %s/%s", tcpPort, getL4Protocol(listener))
for {
conn, err := listener.Accept()
if err != nil {
log.Errorf("Failed to accept TCP connection: %v", err)
continue
}
go handleTCPConnection(conn, messagePtr, nodePtr)
}
}()
}
func startGRPCServer(messagePtr, nodePtr *string) {
// Use GRPC_PORT environment variable, or default to DefaultGRPCPort
grpcPort := getValidPort("grpc-port", DefaultGRPCPort)
// Start the gRPC server on the specified gRPC port
go func() {
listener, err := net.Listen("tcp", ":"+grpcPort)
if err != nil {
log.Fatalf("Failed to start gRPC server: %v", err)
}
defer listener.Close()
log.Infof("gRPC server listening on port %s/%s", grpcPort, getL4Protocol(listener))
grpcServer := grpc.NewServer()
pb.RegisterEchoServiceServer(grpcServer, &EchoServer{messagePtr: messagePtr, nodePtr: nodePtr})
reflection.Register(grpcServer)
if err := grpcServer.Serve(listener); err != nil {
log.Fatalf("Failed to serve gRPC server: %v", err)
}
}()
}
func startQUICServer(messagePtr, nodePtr *string, printHeaders bool) {
// Use QUIC_PORT environment variable, or default to DefaultQUICPort
quicPort := getValidPort("quic-port", DefaultQUICPort)
// Generate in-memory TLS certificate pair
cert, err := generateSelfSignedCert()
if err != nil {
log.Fatalf("Failed to generate self-signed certificate: %v", err)
}
// Start the HTTP/3 server on the specified QUIC port
go func() {
server := &http3.Server{
Addr: ":" + quicPort,
Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if metricsEnabled {
log.Debug("Incrementing QUIC requests counter")
// Increment the QUIC requests counter
quicRequestsTotal.Inc()
}
handleHTTPConnection(messagePtr, nodePtr, printHeaders, "QUIC")(w, r)
}),
TLSConfig: http3.ConfigureTLSConfig(&tls.Config{
Certificates: []tls.Certificate{cert},
}),
}
defer server.Close()
log.Infof("QUIC server listening on port %s/udp", quicPort)
log.Fatal(server.ListenAndServe())
}()
}
func startMetricsServer() {
log.Debug("Starting Prometheus metrics server")
// Start the Prometheus metrics server
mux := http.NewServeMux()
mux.Handle("/metrics", promhttp.Handler())
go func() {
metricsPort := getValidPort("metrics-port", DefaultMetricsPort)
listener, err := net.Listen("tcp", ":"+metricsPort)
if err != nil {
log.Fatalf("Failed to start metrics HTTP server: %v", err)
}
defer listener.Close()
log.Infof("Prometheus HTTP metrics server listening on port %s/%s", metricsPort, getL4Protocol(listener))
log.Fatal(http.Serve(listener, mux))
}()
}
// getL4Protocol determines the L4 protocol (TCP or UDP) from the listener.
func getL4Protocol(listener net.Listener) string {
switch listener.Addr().Network() {
case "tcp", "tcp4", "tcp6":
return "tcp"
case "udp", "udp4", "udp6":
return "udp"
default:
return "Unknown"
}
}
// handleHTTPConnection returns a http.HandlerFunc that uses the provided message pointer, node pointer, printHeaders flag, and listener name.
func handleHTTPConnection(messagePtr *string, nodePtr *string, printHeaders bool, listener string) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
if metricsEnabled {
log.Debug("Incrementing HTTP requests counter")
// Increment the HTTP requests counter
httpRequestsTotal.WithLabelValues(listener, r.Method, r.URL.Path).Inc()
}
// Get the IP address without the port number
ip, _, err := net.SplitHostPort(r.RemoteAddr)
if err != nil {
log.Errorf("Error getting remote address: %v", err)
http.Error(w, "Internal Server Error", http.StatusInternalServerError)
return
}
// Log the serving request with detailed information in info log level, as serving those is the core functionality of the application.
log.Infof("Serving request: %s %s from %s (User-Agent: %s) via %s listener, HTTP version: %s", r.Method, r.URL.Path, ip, r.UserAgent(), listener, r.Proto)
host, _ := os.Hostname()
// Get the current time in human-readable format with milliseconds
timestamp := time.Now().Format("2006-01-02T15:04:05.999Z07:00")
// Create the response struct with the timestamp as the first field
response := Response{
Timestamp: timestamp,
Message: messagePtr,
Hostname: host,
Listener: listener,
Node: nodePtr,
SourceIP: ip,
HTTPVersion: r.Proto,
HTTPMethod: r.Method,
HTTPEndpoint: r.URL.Path,
}
// Conditionally add headers if printHeaders is true
if printHeaders {
response.Headers = make(map[string][]string)
for name, values := range r.Header {
response.Headers[name] = values
}
}
// Set the Content-Type header to application/json
w.Header().Set("Content-Type", "application/json")
// Encode the response struct to JSON and send it as the response
err = json.NewEncoder(w).Encode(response)
if err != nil {
log.Errorf("Error encoding JSON response: %v", err)
http.Error(w, "Internal Server Error", http.StatusInternalServerError)
}
}
}
// handleTCPConnection handles a TCP connection and sends the JSON response.
func handleTCPConnection(conn net.Conn, messagePtr *string, nodePtr *string) {
defer conn.Close()
if metricsEnabled {
log.Debug("Incrementing TCP requests counter")
// Increment the TCP requests counter
tcpRequestsTotal.Inc()
}
// Get the IP address without the port number
ip, _, err := net.SplitHostPort(conn.RemoteAddr().String())
if err != nil {
log.Errorf("Error getting remote address: %v", err)
return
}
// Log the serving request with detailed information
log.Infof("Serving TCP request from %s via TCP listener", ip)
host, _ := os.Hostname()
// Get the current time in human-readable format with milliseconds
timestamp := time.Now().Format("2006-01-02T15:04:05.999Z07:00")
// Create the response struct with the timestamp as the first field
response := Response{
Timestamp: timestamp,
Message: messagePtr,
Hostname: host,
Listener: "TCP",
Node: nodePtr,
SourceIP: ip,
}
// Encode the response struct to JSON and send it as the response
err = json.NewEncoder(conn).Encode(response)
if err != nil {
log.Errorf("Error encoding JSON response: %v", err)
}
}
// getMessagePtr gets the MESSAGE environment variable and returns a pointer to it, or nil if it's not set or invalid.
func getMessagePtr() *string {
message := viper.GetString("message")
if message == "" {
log.Debugf("No MESSAGE environment variable set. Falling back to default value: '%s'", DefaultMessage)
return nil
}
return &message
}
// getNodePtr gets the NODE environment variable and returns a pointer to it, or nil if it's not set or invalid.
func getNodePtr() *string {
node := viper.GetString("node")
if node == "" {
log.Debugf("No NODE environment variable set. Falling back to default value: '%s'", DefaultNode)
return nil
}
return &node
}
// getPrintHeadersSetting checks the PRINT_HTTP_REQUEST_HEADERS environment variable.
func getPrintHeadersSetting() bool {
return viper.GetBool("print-http-request-headers")
}
// getTLSSetting checks the TLS environment variable.
func getTLSSetting() bool {
return viper.GetBool("tls")
}
// getTCPSetting checks the TCP environment variable.
func getTCPSetting() bool {
return viper.GetBool("tcp")
}
// getGRPCSetting checks the GRPC environment variable.
func getGRPCSetting() bool {
return viper.GetBool("grpc")
}
// getQUICSetting checks the QUIC environment variable.
func getQUICSetting() bool {
return viper.GetBool("quic")
}
// getMetricsSetting checks the METRICS environment variable.
func getMetricsSetting() bool {
return viper.GetBool("metrics")
}
// setLogLevel sets the log level based on the LOG_LEVEL environment variable.
func setLogLevel() {
logLevel := viper.GetString("log-level")
if logLevel == "" {
// Default log level should be "info"
logLevel = DefaultLogLevel.String()
}
level, err := log.ParseLevel(logLevel)
if err != nil {
log.Warnf("Invalid log level: %v. Falling back to '%s'.", err, DefaultLogLevel)
level = DefaultLogLevel
}
log.SetLevel(level)
}
// getValidPort retrieves and validates the port from the environment variable, falling back to the default if invalid.
func getValidPort(envVar string, defaultPort string) string {
port := viper.GetString(envVar)
if port == "" {
log.Debugf("No port for %s set. Falling back to default port: '%s'", envVar, defaultPort)
return defaultPort
}
if !isValidPort(port) {
log.Warnf("Invalid port for %s: %s. Falling back to default port: '%s'", envVar, port, defaultPort)
return defaultPort
}
return port
}
// isValidPort checks if the given port is a valid port number.
func isValidPort(port string) bool {
portNum, err := strconv.Atoi(port)
if err != nil {
return false
}
return portNum > 0 && portNum <= 65535
}
// generateSelfSignedCert generates a self-signed TLS certificate.
func generateSelfSignedCert() (tls.Certificate, error) {
priv, err := rsa.GenerateKey(rand.Reader, 4096)
if err != nil {
return tls.Certificate{}, err
}
template := x509.Certificate{
SerialNumber: big.NewInt(1),
Subject: pkix.Name{
Organization: []string{"echo Inc."},
},
NotBefore: time.Now(),
NotAfter: time.Now().Add(10 * 365 * 24 * time.Hour), // 10 years validity
KeyUsage: x509.KeyUsageKeyEncipherment | x509.KeyUsageDigitalSignature,
ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth},
BasicConstraintsValid: true,
}
derBytes, err := x509.CreateCertificate(rand.Reader, &template, &template, &priv.PublicKey, priv)
if err != nil {
return tls.Certificate{}, err
}
certPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: derBytes})
keyPEM := pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(priv)})
return tls.X509KeyPair(certPEM, keyPEM)
}
// handleSignals sets up signal handling for SIGINT and SIGTSTP.
func handleSignals() {
sigChan := make(chan os.Signal, 1)
signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTSTP)
go func() {
for sig := range sigChan {
log.Infof("Received signal: %s. Terminating...", sig)
os.Exit(0)
}
}()
}