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
|
package clients
import (
"context"
"fmt"
"strings"
"sync"
"time"
"github.com/mimecast/dtail/internal/clients/remote"
"github.com/mimecast/dtail/internal/discovery"
"github.com/mimecast/dtail/internal/io/logger"
"github.com/mimecast/dtail/internal/omode"
"github.com/mimecast/dtail/internal/regex"
"github.com/mimecast/dtail/internal/ssh/client"
gossh "golang.org/x/crypto/ssh"
)
// This is the main client data structure.
type baseClient struct {
Args
// To display client side stats
stats *stats
// List of remote servers to connect to.
servers []string
// We have one connection per remote server.
connections []*remote.Connection
// SSH auth methods to use to connect to the remote servers.
sshAuthMethods []gossh.AuthMethod
// To deal with SSH host keys
hostKeyCallback client.HostKeyCallback
// Throttle how fast we initiate SSH connections concurrently
throttleCh chan struct{}
// Retry connection upon failure?
retry bool
// Connection maker helper.
maker maker
// Regex is the regular expresion object for line filtering
Regex regex.Regex
}
func (c *baseClient) init() {
logger.Debug("Initiating base client")
flag := regex.Default
if c.Args.RegexInvert {
flag = regex.Invert
}
regex, err := regex.New(c.Args.RegexStr, flag)
if err != nil {
logger.FatalExit(c.Regex, "invalid regex!", err, regex)
}
c.Regex = regex
logger.Debug("Regex", c.Regex)
c.sshAuthMethods, c.hostKeyCallback = client.InitSSHAuthMethods(c.Args.SSHAuthMethods, c.Args.SSHHostKeyCallback, c.Args.TrustAllHosts, c.throttleCh, c.Args.PrivateKeyPathFile)
}
func (c *baseClient) makeConnections(maker maker) {
c.maker = maker
discoveryService := discovery.New(c.Discovery, c.ServersStr, discovery.Shuffle)
for _, server := range discoveryService.ServerList() {
c.connections = append(c.connections, c.makeConnection(server, c.sshAuthMethods, c.hostKeyCallback))
}
c.stats = newTailStats(len(c.connections))
}
func (c *baseClient) Start(ctx context.Context, statsCh <-chan string) (status int) {
// Periodically check for unknown hosts, and ask the user whether to trust them or not.
go c.hostKeyCallback.PromptAddHosts(ctx)
// Print client stats every time something on statsCh is recieved.
go c.stats.Start(ctx, c.throttleCh, statsCh, c.Args.Quiet)
// Keep count of active connections
active := make(chan struct{}, len(c.connections))
var mutex sync.Mutex
for i, conn := range c.connections {
go func(i int, conn *remote.Connection) {
connStatus := c.start(ctx, active, i, conn)
// Update global status.
mutex.Lock()
defer mutex.Unlock()
if connStatus > status {
status = connStatus
}
}(i, conn)
}
c.waitUntilDone(ctx, active)
return
}
func (c *baseClient) start(ctx context.Context, active chan struct{}, i int, conn *remote.Connection) (status int) {
// Increment connection count
active <- struct{}{}
// Derement connection count
defer func() { <-active }()
for {
connCtx, cancel := context.WithCancel(ctx)
defer cancel()
conn.Start(connCtx, cancel, c.throttleCh, c.stats.connectionsEstCh)
// Retrieve status code from handler (dtail client will exit with that status)
status = conn.Handler.Status()
if !c.retry {
return
}
time.Sleep(time.Second * 2)
logger.Debug(conn.Server, "Reconnecting")
conn = c.makeConnection(conn.Server, c.sshAuthMethods, c.hostKeyCallback)
c.connections[i] = conn
}
}
func (c *baseClient) makeCommandOptions() map[string]string {
options := make(map[string]string)
if c.Args.Quiet {
options["quiet"] = fmt.Sprintf("%v", c.Args.Quiet)
}
if c.Args.LContext.MaxCount != 0 {
options["max"] = fmt.Sprintf("%d", c.Args.LContext.MaxCount)
}
if c.Args.LContext.BeforeContext != 0 {
options["before"] = fmt.Sprintf("%d", c.Args.LContext.BeforeContext)
}
if c.Args.LContext.AfterContext != 0 {
options["after"] = fmt.Sprintf("%d", c.Args.LContext.AfterContext)
}
return options
}
func (c *baseClient) commandOptionsToString(options map[string]string) string {
var sb strings.Builder
count := 0
for k, v := range options {
if count > 0 {
sb.WriteString(":")
}
sb.WriteString(fmt.Sprintf("%s=%s", k, v))
count++
}
return sb.String()
}
func (c *baseClient) makeConnection(server string, sshAuthMethods []gossh.AuthMethod, hostKeyCallback client.HostKeyCallback) *remote.Connection {
conn := remote.NewConnection(server, c.UserName, sshAuthMethods, hostKeyCallback)
conn.Handler = c.maker.makeHandler(server)
conn.Commands = c.maker.makeCommands(c.makeCommandOptions())
return conn
}
func (c *baseClient) waitUntilDone(ctx context.Context, active chan struct{}) {
defer logger.Debug("Terminated connection")
// We want to have at least one active connection
<-active
// Put it back on the channel
active <- struct{}{}
if c.Mode == omode.TailClient && c.retry {
<-ctx.Done()
}
for {
numActive := len(active)
if numActive == 0 {
return
}
logger.Debug("Active connections", numActive)
time.Sleep(time.Second)
}
}
|
