telemetry

type MetricsDB interface {
	// CreateSchema creates table schemas to the provided database.
	// returns error if table creation fails for any reason
	CreateSchema() error

	// SaveOperationMetric inserts CLI operation metrics collected into database
	SaveOperationMetric(*OperationMetricsPayload) error

	// GetRowCount gets metrics table current row count
	GetRowCount() (int, error)

	// ClearMetricData clears all the CLI operation metrics collected in the database
	ClearMetricData() error
}

type MetricsHandler interface {
	// SetInstalledPlugins adds the installed plugins to the handler used to retrieve
	// the plugin information
	SetInstalledPlugins(plugins []cli.PluginInfo)
	// UpdateCmdPreRunMetrics updates the metrics collected before running the command
	UpdateCmdPreRunMetrics(cmd *cobra.Command, args []string) error
	// UpdateCmdPostRunMetrics updates the metrics collected after command execution is completed
	UpdateCmdPostRunMetrics(metrics *PostRunMetrics) error
	// SaveMetrics saves the metrics to the metrics store/DB
	SaveMetrics() error
	// SendMetrics sends the metrics to the destination(metrics data lake)
	SendMetrics(ctx context.Context, timeoutInSecs int) error
}

type OperationMetricsPayload struct {
	CliID         string
	StartTime     time.Time
	EndTime       time.Time
	Args          []string
	NameArg       string
	CommandName   string
	ExitStatus    int
	PluginName    string
	Flags         string
	CliVersion    string
	PluginVersion string
	Target        string
	Endpoint      string
	IsInternal    bool
	Error         string
}

type PostRunMetrics struct {
	ExitCode int
}