/
micro_command.go
449 lines (371 loc) · 10.9 KB
/
micro_command.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
// Copyright 2022-2023 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cli
import (
"bytes"
"context"
"encoding/json"
"fmt"
"os"
"sort"
"time"
"github.com/choria-io/fisk"
"github.com/dustin/go-humanize"
"github.com/nats-io/jsm.go/api"
"github.com/nats-io/nats.go"
"github.com/nats-io/nats.go/micro"
)
type microCmd struct {
name string
id string
showJSON bool
hdrs map[string]string
}
func configureMicroCommand(app commandHost) {
c := µCmd{hdrs: map[string]string{}}
mc := app.Command("micro", "Micro Services discovery and management").Alias("a")
mc.HelpLong("WARNING: This command is experimental")
ls := mc.Command("list", "List known Micro services").Alias("ls").Alias("l").Action(c.listAction)
ls.Arg("service", "List instances of a specific service").PlaceHolder("NAME").StringVar(&c.name)
ls.Flag("json", "Show JSON output").Short('j').UnNegatableBoolVar(&c.showJSON)
info := mc.Command("info", "Show Micro service information").Alias("i").Action(c.infoAction)
info.Arg("service", "Service to show").Required().StringVar(&c.name)
info.Arg("id", "Show info for a specific ID").StringVar(&c.id)
info.Flag("json", "Show JSON output").Short('j').UnNegatableBoolVar(&c.showJSON)
stats := mc.Command("stats", "Report Micro service statistics").Action(c.statsAction)
stats.Arg("service", "Service to show").Required().StringVar(&c.name)
stats.Arg("id", "Show info for a specific ID").StringVar(&c.id)
stats.Flag("json", "Show JSON output").Short('j').UnNegatableBoolVar(&c.showJSON)
ping := mc.Command("ping", "Sends a ping to all services").Action(c.pingAction)
ping.Arg("service", "Service to show").StringVar(&c.name)
echo := mc.Command("echo", "Runs a demo Micro service").Action(c.echoAction)
echo.Arg("name", "A name for the service to run on").Required().StringVar(&c.name)
echo.Flag("header", "Headers to add to responses").Short('H').StringMapVar(&c.hdrs)
}
func init() {
registerCommand("micro", 0, configureMicroCommand)
}
func (c *microCmd) echoAction(_ *fisk.ParseContext) error {
nc, _, err := prepareHelper("", natsOpts()...)
if err != nil {
return fmt.Errorf("setup failed: %v", err)
}
srv, err := micro.AddService(nc, micro.Config{
Name: c.name,
Version: "1.0.0",
Description: "NATS CLI Demo Service",
Metadata: map[string]string{},
})
if err != nil {
return err
}
echoHandler := func(req micro.Request) {
log.Printf("Handling request on subject %v", req.Subject())
resp := map[string]any{
"timestamp": time.Now(),
"request": map[string]any{
"body": req.Data(),
"headers": req.Headers(),
"subject": req.Subject(),
},
}
hdr := nats.Header{
"ConnectedUrl": []string{nc.ConnectedUrlRedacted()},
}
if nc.ConnectedClusterName() != "" {
hdr.Add("ConnectedCluster", nc.ConnectedClusterName())
}
for k, v := range c.hdrs {
hdr.Add(k, v)
}
req.RespondJSON(resp, micro.WithHeaders(micro.Headers(hdr)))
}
err = srv.AddGroup(c.name).AddEndpoint("echo", micro.HandlerFunc(echoHandler), micro.WithEndpointMetadata(map[string]string{}))
if err != nil {
return err
}
cols := newColumns("NATS CLI Micro Service %s waiting for requests on %s", c.name, nc.ConnectedUrlRedacted())
cols.AddSectionTitle("Listening Subjects")
cols.AddRow(fmt.Sprintf("%s.echo", c.name), "Echo Service")
cols.Println()
cols.AddSectionTitle("Requests Log")
cols.Frender(os.Stdout)
<-ctx.Done()
return nil
}
func (c *microCmd) makeSubj(v micro.Verb, s string, i string) string {
if s == "" {
return fmt.Sprintf("%s.%s", micro.APIPrefix, v.String())
}
if i == "" {
return fmt.Sprintf("%s.%s.%s", micro.APIPrefix, v.String(), s)
}
return fmt.Sprintf("%s.%s.%s.%s", micro.APIPrefix, v.String(), s, i)
}
func (c *microCmd) parseMessage(m []byte, expectedType string) (any, error) {
var (
t string
parsed any
err error
)
if os.Getenv("NOVALIDATE") == "" {
t, parsed, err = api.ParseAndValidateMessage(m, validator())
} else {
t, parsed, err = api.ParseMessage(m)
}
if err != nil {
return nil, err
}
if t != expectedType {
return nil, fmt.Errorf("invalid response type %s", t)
}
return parsed, nil
}
func (c *microCmd) getInstanceStats(nc *nats.Conn, name string, id string) (*micro.Stats, error) {
resp, err := doReq(nil, c.makeSubj(micro.StatsVerb, name, id), 1, nc)
if err != nil {
if err == nats.ErrNoResponders {
return nil, fmt.Errorf("no micro instances found")
}
return nil, err
}
if len(resp) == 0 {
return nil, fmt.Errorf("no statistics received for %s > %s", name, id)
}
stats, err := c.parseMessage(resp[0], micro.StatsResponseType)
if err != nil {
return nil, err
}
return stats.(*micro.Stats), err
}
func (c *microCmd) getInfo(nc *nats.Conn, name string, id string, wait int) ([]*micro.Info, error) {
resp, err := doReq(nil, c.makeSubj(micro.InfoVerb, name, id), wait, nc)
if err != nil {
if err == nats.ErrNoResponders {
return nil, fmt.Errorf("no micro instances found")
}
return nil, err
}
var nfos []*micro.Info
for _, r := range resp {
nfo, err := c.parseMessage(r, micro.InfoResponseType)
if err != nil {
return nil, err
}
nfos = append(nfos, nfo.(*micro.Info))
}
sort.Slice(nfos, func(i, j int) bool {
if nfos[i].Name < nfos[j].Name {
return true
}
return nfos[i].ID < nfos[j].ID
})
return nfos, nil
}
func (c *microCmd) pingAction(_ *fisk.ParseContext) error {
nc, _, err := prepareHelper("", natsOpts()...)
if err != nil {
return fmt.Errorf("setup failed: %v", err)
}
ctx, cancel := context.WithTimeout(context.Background(), opts.Timeout)
defer cancel()
start := time.Now()
sub, err := nc.Subscribe(nc.NewRespInbox(), func(m *nats.Msg) {
if opts.Trace {
log.Printf("<<< %s", string(m.Data))
}
resp, err := c.parseMessage(m.Data, micro.PingResponseType)
if err != nil {
return
}
r := resp.(*micro.Ping)
fmt.Printf("%-50s rtt=%s\n", fmt.Sprintf("%s %s", r.Name, r.ID), humanizeDuration(time.Since(start)))
})
if err != nil {
return err
}
msg := nats.NewMsg(c.makeSubj(micro.PingVerb, c.name, ""))
msg.Reply = sub.Subject
nc.PublishMsg(msg)
if opts.Trace {
log.Printf(">>> %s", msg.Subject)
}
<-ctx.Done()
return nil
}
func (c *microCmd) statsAction(_ *fisk.ParseContext) error {
nc, _, err := prepareHelper("", natsOpts()...)
if err != nil {
return fmt.Errorf("setup failed: %v", err)
}
resp, err := doReq(nil, c.makeSubj(micro.StatsVerb, c.name, c.id), 0, nc)
if err != nil {
if err == nats.ErrNoResponders {
return fmt.Errorf("no micro instances found")
}
return err
}
if len(resp) == 0 {
fmt.Println("No responses received")
return nil
}
var stats []*micro.Stats
for _, r := range resp {
s, err := c.parseMessage(r, micro.StatsResponseType)
if err != nil {
return err
}
stats = append(stats, s.(*micro.Stats))
}
sort.Slice(stats, func(i, j int) bool {
if stats[i].Name < stats[j].Name {
return true
}
return stats[i].ID < stats[j].ID
})
if c.showJSON {
printJSON(stats)
return nil
}
table := newTableWriter(fmt.Sprintf("%s Service Statistics", c.name))
table.AddHeaders("ID", "Endpoint", "Requests", "Errors", "Processing Time", "Average Time")
var requests, errors int
var runTime time.Duration
for _, s := range stats {
for c, e := range s.Endpoints {
id := s.ID
if c > 0 {
id = ""
}
table.AddRow(id, e.Name, humanize.Comma(int64(e.NumRequests)), humanize.Comma(int64(e.NumErrors)), humanizeDuration(e.ProcessingTime), humanizeDuration(e.AverageProcessingTime))
requests += e.NumRequests
errors += e.NumErrors
runTime += e.ProcessingTime
}
}
var avg time.Duration
if runTime > 0 {
avg = runTime / time.Duration(requests+errors)
}
table.AddFooter("", "", humanize.Comma(int64(requests)), humanize.Comma(int64(errors)), humanizeDuration(runTime), humanizeDuration(avg))
fmt.Println(table.Render())
return nil
}
func (c *microCmd) infoAction(_ *fisk.ParseContext) error {
nc, _, err := prepareHelper("", natsOpts()...)
if err != nil {
return fmt.Errorf("setup failed: %v", err)
}
nfos, err := c.getInfo(nc, c.name, c.id, 1)
if err != nil {
return err
}
if len(nfos) == 0 {
if c.showJSON {
fmt.Println("{}")
} else {
fmt.Println("No results received")
}
return nil
}
nfo := nfos[0]
stats, err := c.getInstanceStats(nc, nfo.Name, nfo.ID)
if err != nil {
return err
}
if c.showJSON {
printJSON(map[string]any{
"info": nfo,
"stats": stats,
})
return nil
}
cols := newColumns("Service Information")
defer cols.Frender(os.Stdout)
cols.AddRowf("Service", "%v (%v)", nfo.Name, nfo.ID)
cols.AddRow("Description", nfo.Description)
cols.AddRow("Version", nfo.Version)
cols.AddRow("Subjects", nfo.Subjects)
if len(nfo.Metadata) > 0 {
cols.Println()
cols.AddSectionTitle("Metadata")
cols.AddMapStrings(nfo.Metadata)
}
cols.AddSectionTitle("Statistics for %d Endpoint(s)", len(stats.Endpoints))
for _, e := range stats.Endpoints {
if e.Name == "" {
e.Name = "default"
}
cols.Indent(2)
cols.AddSectionTitle("%s Endpoint Statistics", e.Name)
cols.AddRow("Requests", e.NumRequests)
cols.AddRow("Errors", e.NumErrors)
cols.AddRowf("Processing Time", "%s (average %s)", humanizeDuration(e.ProcessingTime), humanizeDuration(e.AverageProcessingTime))
cols.AddRow("Started:", stats.Started)
cols.AddRowIfNotEmpty("Last Error", e.LastError)
if e.Data != nil {
cols.AddSectionTitle("Endpoint Specific Statistics")
out := bytes.NewBuffer([]byte{})
json.Indent(out, e.Data, " ", " ")
cols.Println(" " + out.String())
}
cols.Indent(0)
}
return nil
}
func (c *microCmd) listAction(_ *fisk.ParseContext) error {
nc, _, err := prepareHelper("", natsOpts()...)
if err != nil {
return fmt.Errorf("setup failed: %v", err)
}
nfos, err := c.getInfo(nc, c.name, "", 0)
if err != nil {
return err
}
if c.showJSON {
printJSON(nfos)
return nil
}
if len(nfos) == 0 {
fmt.Println("No results received")
return nil
}
var table *tbl
if c.name == "" {
table = newTableWriter("All Micro Services")
} else {
table = newTableWriter(fmt.Sprintf("%s Micro Service", c.name))
}
table.AddHeaders("Name", "Version", "ID", "Description")
var pd, pv, pn string
for _, s := range nfos {
v := s.Version
if v == pv {
v = ""
}
d := s.Description
if d == pd {
d = ""
}
n := s.Name
if n == pn {
n = ""
}
table.AddRow(n, v, s.ID, d)
pd = s.Description
pv = s.Version
pn = s.Name
}
fmt.Println(table.Render())
return nil
}