FilesExpand file tree

trunk

/

telemetry.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

80 lines (69 loc) · 1.95 KB

trunk

/

telemetry.go

Copy path

Top

File metadata and controls

• Code
• Blame

80 lines (69 loc) · 1.95 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

package cmdutil

import (

"slices"

"strings"

"github.com/cli/cli/v2/internal/gh/ghtelemetry"

"github.com/spf13/cobra"

"github.com/spf13/pflag"

)

// RecordTelemetry instruments a command with an invocation-owned telemetry event.

func RecordTelemetry(cmd *cobra.Command, telemetry ghtelemetry.EventRecorder) {

if isTelemetryDisabled(cmd) {

return

}

if cmd.RunE == nil {

return

}

var event ghtelemetry.PendingEvent

currentArgs := cmd.Args

cmd.Args = func(cmd *cobra.Command, args []string) error {

event = telemetry.Begin(ghtelemetry.Event{

Type: "command_invocation",

Dimensions: ghtelemetry.Dimensions{

"command": cmd.CommandPath(),

"flags": telemetryFlags(cmd),

},

})

if currentArgs != nil {

return currentArgs(cmd, args)

}

return nil

}

currentRunE := cmd.RunE

cmd.RunE = func(cmd *cobra.Command, args []string) error {

runErr := currentRunE(cmd, args)

// Commands with DisableFlagParsing may parse their flags inside RunE.

event.UpsertDimensions(ghtelemetry.Dimensions{"flags": telemetryFlags(cmd)})

return runErr

}

}

func telemetryFlags(cmd *cobra.Command) string {

var flags []string

cmd.Flags().Visit(func(f *pflag.Flag) {

flags = append(flags, f.Name)

})

slices.Sort(flags)

return strings.Join(flags, ",")

}

// RecordTelemetryForSubcommands instruments all descendants of a command.

func RecordTelemetryForSubcommands(cmd *cobra.Command, telemetry ghtelemetry.EventRecorder) {

for _, c := range cmd.Commands() {

RecordTelemetry(c, telemetry)

RecordTelemetryForSubcommands(c, telemetry)

}

}

func DisableTelemetry(cmd *cobra.Command) {

if cmd.Annotations == nil {

cmd.Annotations = map[string]string{}

}

cmd.Annotations["telemetry"] = "disabled"

}

func DisableTelemetryForSubcommands(cmd *cobra.Command) {

for _, c := range cmd.Commands() {

DisableTelemetry(c)

DisableTelemetryForSubcommands(c)

}

}

func isTelemetryDisabled(cmd *cobra.Command) bool {

return cmd.Annotations["telemetry"] == "disabled"

}