-
Notifications
You must be signed in to change notification settings - Fork 0
/
trace_metrics_rules.gen.go
626 lines (560 loc) · 19.6 KB
/
trace_metrics_rules.gen.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
// Code generated by chronogen; DO NOT EDIT
package configv1
import (
"context"
"fmt"
"github.com/chronosphereio/chronoctl-core/src/cmd/cli"
"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/client"
"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/clienterror"
"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/dry"
"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/file"
"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/groups"
"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/output"
"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/pagination"
"github.com/chronosphereio/chronoctl-core/src/cmd/pkg/ptr"
config_v1 "github.com/chronosphereio/chronoctl-core/src/generated/swagger/configv1/client/operations"
"github.com/chronosphereio/chronoctl-core/src/generated/swagger/configv1/models"
"github.com/chronosphereio/chronoctl-core/src/types"
"github.com/spf13/cobra"
flag "github.com/spf13/pflag"
)
func init() { types.MustRegisterObject(TraceMetricsRuleTypeMeta, &TraceMetricsRule{}) }
var _ types.Object = &TraceMetricsRule{}
var TraceMetricsRuleTypeMeta = types.TypeMeta{
APIVersion: "v1/config",
Kind: "TraceMetricsRule",
}
type TraceMetricsRule struct {
types.TypeMeta `json:",inline"`
Spec *models.Configv1TraceMetricsRule `json:"spec"`
}
func NewTraceMetricsRule(spec *models.Configv1TraceMetricsRule) *TraceMetricsRule {
return &TraceMetricsRule{
TypeMeta: TraceMetricsRuleTypeMeta,
Spec: spec,
}
}
func (e *TraceMetricsRule) Description() string {
return types.TypeDescription(e, "name", e.Spec.Name, "slug", e.Spec.Slug)
}
func (e *TraceMetricsRule) Identifier() string {
return e.Spec.Slug
}
func CreateTraceMetricsRule(
ctx context.Context,
client config_v1.ClientService,
entity *TraceMetricsRule,
dryRun bool,
) (*TraceMetricsRule, error) {
res, err := client.CreateTraceMetricsRule(&config_v1.CreateTraceMetricsRuleParams{
Context: ctx,
Body: &models.Configv1CreateTraceMetricsRuleRequest{
DryRun: dryRun,
TraceMetricsRule: entity.Spec,
},
})
if err != nil {
return nil, clienterror.Wrap(err)
}
return NewTraceMetricsRule(res.Payload.TraceMetricsRule), nil
}
func newTraceMetricsRuleCreateCmd() *cobra.Command {
var (
permissiveParsing bool
dryRunFlags = dry.NewFlags()
clientFlags = client.NewClientFlags()
outputFlags = output.NewFlags(output.WithoutOutputDirectory(), output.WithoutCreateFilePerObject())
fileFlags = file.NewFlags(true /* required */)
)
var (
use string
short string
)
use = "create -f <file>"
short = "Creates a single TraceMetricsRule."
cmd := &cobra.Command{
Use: use,
GroupID: groups.Commands.ID,
Short: short,
RunE: func(cmd *cobra.Command, args []string) error {
ctx, cancel := context.WithTimeout(cmd.Context(), clientFlags.Timeout())
defer cancel()
if err := outputFlags.Validate(); err != nil {
return err
}
defer outputFlags.Close(cmd.OutOrStdout())
stderr := output.NewStderrPrinter(cmd)
client, err := clientFlags.ConfigV1Client()
if err != nil {
return err
}
var traceMetricsRule *TraceMetricsRule
file, err := fileFlags.File()
if err != nil {
return err
}
defer file.Close() //nolint:errcheck
traceMetricsRule, err = types.MustDecodeSingleObject[*TraceMetricsRule](file, permissiveParsing)
if err != nil {
return err
}
if dryRunFlags.DryRun {
stderr.Println("--dry-run is set")
}
fullTraceMetricsRule, err := CreateTraceMetricsRule(ctx, client, traceMetricsRule, dryRunFlags.DryRun)
if err != nil {
return err
}
if dryRunFlags.DryRun {
stderr.Println("TraceMetricsRule is valid and can be created")
return nil
}
stderr.Printf("TraceMetricsRule with slug %q created successfully\n", fullTraceMetricsRule.Spec.Slug)
if err := outputFlags.WriteObject(fullTraceMetricsRule, cmd.OutOrStdout()); err != nil {
return err
}
return nil
},
}
dryRunFlags.AddFlags(cmd)
clientFlags.AddFlags(cmd)
outputFlags.AddFlags(cmd)
fileFlags.AddFlags(cmd)
cmd.Flags().BoolVar(&permissiveParsing, "no-strict", false, "If set, manifests with unknown fields are not rejected. Defaults to false.")
return cmd
}
func GetTraceMetricsRule(
ctx context.Context,
client config_v1.ClientService,
slug string,
) (*TraceMetricsRule, error) {
res, err := client.ReadTraceMetricsRule(&config_v1.ReadTraceMetricsRuleParams{
Context: ctx,
Slug: slug,
})
if err != nil {
return nil, clienterror.Wrap(err)
}
return NewTraceMetricsRule(res.GetPayload().TraceMetricsRule), nil
}
func newTraceMetricsRuleReadCmd() *cobra.Command {
clientFlags := client.NewClientFlags()
outputFlags := output.NewFlags(output.WithoutOutputDirectory(), output.WithoutCreateFilePerObject())
var (
short string
use string
args cobra.PositionalArgs
)
short = "Reads a single TraceMetricsRule by slug"
use = "read <slug>"
args = cobra.ExactArgs(1)
cmd := &cobra.Command{
Use: use,
GroupID: groups.Commands.ID,
Short: short,
Args: args,
RunE: func(cmd *cobra.Command, args []string) error {
ctx, cancel := context.WithTimeout(cmd.Context(), clientFlags.Timeout())
defer cancel()
if err := outputFlags.Validate(); err != nil {
return err
}
defer outputFlags.Close(cmd.OutOrStdout())
client, err := clientFlags.ConfigV1Client()
if err != nil {
return err
}
entity, err := GetTraceMetricsRule(ctx, client, args[0])
if err != nil {
return err
}
if err := outputFlags.WriteObject(entity, cmd.OutOrStdout()); err != nil {
return err
}
return nil
},
}
clientFlags.AddFlags(cmd)
outputFlags.AddFlags(cmd)
return cmd
}
func UpdateTraceMetricsRule(
ctx context.Context,
client config_v1.ClientService,
entity *TraceMetricsRule,
opts UpdateOptions,
) (*TraceMetricsRule, error) {
res, err := client.UpdateTraceMetricsRule(&config_v1.UpdateTraceMetricsRuleParams{
Context: ctx,
Slug: entity.Spec.Slug,
Body: config_v1.UpdateTraceMetricsRuleBody{
CreateIfMissing: opts.CreateIfMissing,
DryRun: opts.DryRun,
TraceMetricsRule: entity.Spec,
},
})
if err != nil {
return nil, clienterror.Wrap(err)
}
return NewTraceMetricsRule(res.Payload.TraceMetricsRule), nil
}
func newTraceMetricsRuleUpdateCmd() *cobra.Command {
var (
permissiveParsing bool
createIfMissing bool
dryRunFlags = dry.NewFlags()
clientFlags = client.NewClientFlags()
outputFlags = output.NewFlags(output.WithoutOutputDirectory(), output.WithoutCreateFilePerObject())
fileFlags = file.NewFlags(true /* required */)
)
cmd := &cobra.Command{
Use: "update -f <filename>",
GroupID: groups.Commands.ID,
Short: "Updates an existing TraceMetricsRule.",
RunE: func(cmd *cobra.Command, args []string) error {
ctx, cancel := context.WithTimeout(cmd.Context(), clientFlags.Timeout())
defer cancel()
if err := outputFlags.Validate(); err != nil {
return err
}
defer outputFlags.Close(cmd.OutOrStdout())
stderr := output.NewStderrPrinter(cmd)
client, err := clientFlags.ConfigV1Client()
if err != nil {
return err
}
file, err := fileFlags.File()
if err != nil {
return err
}
defer file.Close() //nolint:errcheck
traceMetricsRule, err := types.MustDecodeSingleObject[*TraceMetricsRule](file, permissiveParsing)
if err != nil {
return err
}
updateOpts := UpdateOptions{
DryRun: dryRunFlags.DryRun,
CreateIfMissing: createIfMissing,
}
if dryRunFlags.DryRun {
stderr.Println("--dry-run is set, update not persisted")
}
fullTraceMetricsRule, err := UpdateTraceMetricsRule(ctx, client, traceMetricsRule, updateOpts)
if err != nil {
return err
}
if dryRunFlags.DryRun {
stderr.Println("TraceMetricsRule is valid and can be updated")
return nil
}
stderr.Printf("TraceMetricsRule with slug %q applied successfully\n", fullTraceMetricsRule.Spec.Slug)
if err := outputFlags.WriteObject(fullTraceMetricsRule, cmd.OutOrStdout()); err != nil {
return err
}
return nil
},
}
dryRunFlags.AddFlags(cmd)
clientFlags.AddFlags(cmd)
outputFlags.AddFlags(cmd)
fileFlags.AddFlags(cmd)
cmd.Flags().BoolVar(&permissiveParsing, "no-strict", false, "If set, manifests with unknown fields are allowed. Defaults to false.")
cmd.Flags().BoolVar(&createIfMissing, "create-if-missing", false, "If set, creates the TraceMetricsRule if it does not already exist. Defaults to false.")
return cmd
}
func DeleteTraceMetricsRule(
ctx context.Context,
client config_v1.ClientService,
slug string,
) error {
_, err := client.DeleteTraceMetricsRule(&config_v1.DeleteTraceMetricsRuleParams{
Context: ctx,
Slug: slug,
})
if err != nil {
return clienterror.Wrap(err)
}
return nil
}
func newTraceMetricsRuleDeleteCmd() *cobra.Command {
clientFlags := client.NewClientFlags()
outputFlags := output.NewFlags(output.WithoutOutputDirectory(), output.WithoutCreateFilePerObject())
cmd := &cobra.Command{
Use: "delete <slug>",
GroupID: groups.Commands.ID,
Short: "Deletes a single TraceMetricsRule by slug",
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
ctx, cancel := context.WithTimeout(cmd.Context(), clientFlags.Timeout())
defer cancel()
if err := outputFlags.Validate(); err != nil {
return err
}
defer outputFlags.Close(cmd.OutOrStdout())
client, err := clientFlags.ConfigV1Client()
if err != nil {
return err
}
res, err := client.DeleteTraceMetricsRule(&config_v1.DeleteTraceMetricsRuleParams{
Context: ctx,
Slug: args[0],
})
if err != nil {
return clienterror.Wrap(err)
}
_ = res
fmt.Fprintf(cmd.OutOrStdout(), "deleted TraceMetricsRule with slug %q\n", args[0])
return nil
},
}
clientFlags.AddFlags(cmd)
outputFlags.AddFlags(cmd)
return cmd
}
type TraceMetricsRuleListOpts struct {
// Limit represents that maximum number of items we wish to return.
Limit int
// PageToken is the pagination token we want to start our request at.
PageToken string
// PageMaxSize is the maximum page size to use when making List calls.
PageMaxSize int
MetricNames []string
Names []string
Slugs []string
}
func (r *TraceMetricsRuleListOpts) registerFlags(flags *flag.FlagSet) {
var emptyMetricNames []string
flags.StringSliceVar(&r.MetricNames, "metric-names", emptyMetricNames, "Get trace metric rules by name.")
var emptyNames []string
flags.StringSliceVar(&r.Names, "names", emptyNames, "Filters results by name, where any TraceMetricsRule with a matching name in the given list (and matches all other filters) is returned.")
var emptySlugs []string
flags.StringSliceVar(&r.Slugs, "slugs", emptySlugs, "Filters results by slug, where any TraceMetricsRule with a matching slug in the given list (and matches all other filters) is returned.")
flags.IntVar(&r.Limit, "limit", 0, "maximum number of items to return")
flags.IntVar(&r.PageMaxSize, "page-max-size", 0, "maximum page size")
flags.StringVar(&r.PageToken, "page-token", "", "begins listing items at the start of the pagination token")
}
func ListTraceMetricsRules(
ctx context.Context,
client config_v1.ClientService,
streamer output.Streamer[*TraceMetricsRule],
opts TraceMetricsRuleListOpts,
) (pagination.Token, error) {
var (
gotItems = 0
nextToken = opts.PageToken
pageMaxSize = opts.PageMaxSize
)
// Use the limit if it's set, and smaller than a set page size.
if opts.Limit > 0 && (opts.Limit < pageMaxSize || pageMaxSize == 0) {
pageMaxSize = opts.Limit
}
for {
res, err := client.ListTraceMetricsRules(&config_v1.ListTraceMetricsRulesParams{
Context: ctx,
PageToken: &nextToken,
PageMaxSize: ptr.Int64(int64(pageMaxSize)),
MetricNames: opts.MetricNames,
Names: opts.Names,
Slugs: opts.Slugs,
})
if err != nil {
return pagination.Token(""), clienterror.Wrap(err)
}
for _, v := range res.Payload.TraceMetricsRules {
if err := streamer(NewTraceMetricsRule(v)); err != nil {
return pagination.Token(""), err
}
gotItems++
}
nextToken = res.Payload.Page.NextToken
if nextToken == "" {
return pagination.Token(""), nil
}
if opts.Limit > 0 && gotItems >= opts.Limit {
return pagination.Token(nextToken), nil
}
pageMaxSize = pagination.CalculatePageSize(pagination.Calculation{
GotItems: gotItems,
MaxItems: opts.Limit,
MaxPageSize: len(res.Payload.TraceMetricsRules),
})
}
}
func newTraceMetricsRuleListCmd() *cobra.Command {
var listOptions TraceMetricsRuleListOpts
clientFlags := client.NewClientFlags()
outputFlags := output.NewFlags()
cmd := &cobra.Command{
Use: "list",
Short: "Lists all TraceMetricsRules and applies optional filters",
GroupID: groups.Commands.ID,
RunE: func(cmd *cobra.Command, args []string) error {
ctx, cancel := context.WithTimeout(cmd.Context(), clientFlags.Timeout())
defer cancel()
if err := outputFlags.Validate(); err != nil {
return err
}
writer, err := outputFlags.NewWriterManager(cmd.OutOrStdout())
if err != nil {
return err
}
defer writer.Close()
client, err := clientFlags.ConfigV1Client()
if err != nil {
return err
}
streamer := output.NewWriteObjectStreamer[*TraceMetricsRule](writer)
nextToken, err := ListTraceMetricsRules(ctx, client, streamer, listOptions)
if err != nil {
return err
}
if nextToken != "" {
nextPage := pagination.Result{
Kind: pagination.ResultKind,
Message: "There are additional traceMetricsRules. To view more, use the next page token or run the full command.",
NextPageToken: nextToken,
FullCommand: fmt.Sprintf("%s --page-token %q",
cli.BuildCommandString(cmd, []string{"page-token"}),
nextToken),
}
if err := outputFlags.WriteObject(nextPage, cmd.OutOrStdout()); err != nil {
return err
}
}
return nil
},
}
listOptions.registerFlags(cmd.Flags())
clientFlags.AddFlags(cmd)
outputFlags.AddFlags(cmd)
return cmd
}
const TraceMetricsRuleScaffoldYAML = `api_version: v1/config
kind: TraceMetricsRule
spec:
# Required name of the TraceMetricsRule. May be modified after the TraceMetricsRule is created.
name: <string>
# Unique identifier of the TraceMetricsRule. If slug is not provided, one will be generated based of the name field. Cannot be modified after the TraceMetricsRule is created.
slug: <string>
# The name of the generated trace metrics.
metric_name: <string>
# Labels to apply to the generated trace metrics.
metric_labels:
key_1: <string>
# Histogram bucket values, in seconds, for generated duration metrics.
histogram_buckets_secs:
- <number>
# Add labels to the resultant metrics based on these specified GroupBy messages.
group_by:
- # The label to use in the resultant metrics.
label: <string>
# GroupByKey describes a key to group by.
key:
# For named KeyTypes (e.g. span tags), the name of the key to group by.
named_key: <string>
# - SERVICE: Group by service.
# - OPERATION: Group by operation.
# - TAG: Group by span tag.
type: <SERVICE|OPERATION|TAG>
trace_filter:
# Each SpanFilter object represents all conditions that need to be true on
# the same span for the span to be considered matching the SpanFilter. If
# 'span_count' is used, the number of spans within the trace that match the
# SpanFilter needs to be within [min, max]. Multiple SpanFilters can be used,
# and each can be satisfied by any number of spans within the trace.
span:
- # Matches the tags of the candidate.
tags:
- # The key (or name) of the span tag that is inspected by this filter.
key: <string>
numeric_value:
# The filter value used in comparison against match candidates.
value: <number>
comparison: <EQUAL|NOT_EQUAL|GREATER_THAN|GREATER_THAN_OR_EQUAL|LESS_THAN|LESS_THAN_OR_EQUAL>
value:
# The value the filter compares to the target trace or span field.
value: <string>
# Values the filter tests against when using IN or NOT_IN match type.
in_values:
- <string>
match: <EXACT|REGEX|EXACT_NEGATION|REGEX_NEGATION|IN|NOT_IN>
duration:
# Minimum duration, in seconds, required for a span or trace to match.
min_secs: <number>
# Maximum duration, in seconds, required for a span or trace to match.
max_secs: <number>
error:
# The value the filter compares to the target trace or span field.
value: <true|false>
match_type: <INCLUDE|EXCLUDE>
operation:
# The value the filter compares to the target trace or span field.
value: <string>
# Values the filter tests against when using IN or NOT_IN match type.
in_values:
- <string>
match: <EXACT|REGEX|EXACT_NEGATION|REGEX_NEGATION|IN|NOT_IN>
parent_operation:
# The value the filter compares to the target trace or span field.
value: <string>
# Values the filter tests against when using IN or NOT_IN match type.
in_values:
- <string>
match: <EXACT|REGEX|EXACT_NEGATION|REGEX_NEGATION|IN|NOT_IN>
parent_service:
# The value the filter compares to the target trace or span field.
value: <string>
# Values the filter tests against when using IN or NOT_IN match type.
in_values:
- <string>
match: <EXACT|REGEX|EXACT_NEGATION|REGEX_NEGATION|IN|NOT_IN>
service:
# The value the filter compares to the target trace or span field.
value: <string>
# Values the filter tests against when using IN or NOT_IN match type.
in_values:
- <string>
match: <EXACT|REGEX|EXACT_NEGATION|REGEX_NEGATION|IN|NOT_IN>
span_count:
# Minimum number of spans that must match a SpanFilter (inclusive).
min: <integer>
# Maximum number of spans that must match a SpanFilter (inclusive).
max: <integer>
trace:
duration:
# Minimum duration, in seconds, required for a span or trace to match.
min_secs: <number>
# Maximum duration, in seconds, required for a span or trace to match.
max_secs: <number>
error:
# The value the filter compares to the target trace or span field.
value: <true|false>
`
func newTraceMetricsRuleScaffoldCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "scaffold",
GroupID: groups.Commands.ID,
Short: "Scaffolds a complete object with placeholder values",
Run: func(cmd *cobra.Command, args []string) {
fmt.Fprint(cmd.OutOrStdout(), TraceMetricsRuleScaffoldYAML)
},
}
return cmd
}
func NewTraceMetricsRuleCmd() *cobra.Command {
root := &cobra.Command{
Use: "trace-metrics-rules",
GroupID: groups.Config.ID,
Short: "All commands for TraceMetricsRules",
}
root.AddGroup(groups.Commands)
root.AddCommand(
newTraceMetricsRuleCreateCmd(),
newTraceMetricsRuleReadCmd(),
newTraceMetricsRuleUpdateCmd(),
newTraceMetricsRuleDeleteCmd(),
newTraceMetricsRuleListCmd(),
newTraceMetricsRuleScaffoldCmd(),
)
return root
}