telemetrylib

type DatabaseStore struct {
	Conn       *sql.DB
	Driver     string
	DataSource string
	// contains filtered or unexported fields
}

type TelemetryBundle struct {
	// NOTE: omitempty option used in json tags to support generating test scenarios
	Header             TelemetryBundleHeader `json:"header" validate:"required"`
	TelemetryDataItems []TelemetryDataItem   `json:"telemetryDataItems,omitempty" validate:"required,gt=0,dive"`
	Footer             TelemetryBundleFooter `json:"footer,omitempty" validate:"omitempty"`
}

type TelemetryBundleFooter struct {
	// NOTE: omitempty option used in json tags to support generating test scenarios
	Checksum string `json:"checksum,omitempty" validate:"omitempty,md5"`
}

type TelemetryBundleHeader struct {
	// NOTE: omitempty option used in json tags to support generating test scenarios
	BundleId          string   `json:"bundleId,omitempty" validate:"required,uuid|uuid_rfc4122"`
	BundleTimeStamp   string   `json:"bundleTimeStamp" validate:"required"`
	BundleClientId    string   `json:"bundleClientId" validate:"required,uuid|uuid_rfc4122"`
	BundleCustomerId  string   `json:"bundleCustomerId" validate:"omitempty"`
	BundleAnnotations []string `json:"bundleAnnotations,omitempty"`
}

type TelemetryBundleRow struct {
	Id                int64
	BundleId          string
	BundleTimestamp   string
	BundleClientId    string
	BundleCustomerId  string
	BundleAnnotations string
	ReportId          sql.NullInt64
}

type TelemetryCommon interface {

	// Whether the datastore is persistent or not
	Persistent() bool

	// Get a count of telemetry data items that are not associated with a bundle
	ItemCount(bundleIds ...any) (int, error)

	// Get all telemetry data items from the items table
	GetItemRows(bundleIds ...any) ([]*TelemetryDataItemRow, error)

	// Delete a specified telemetry data item from the items table
	DeleteItem(dataItemRow *TelemetryDataItemRow) error

	// Get a count of telemetry bundles that are not associated with a report
	BundleCount(bundleIds ...any) (int, error)

	// Get telemetry bundles from the bundles table
	GetBundleRows(reportIds ...any) ([]*TelemetryBundleRow, error)

	// Delete a specified telemetry bundle from the bundles table
	DeleteBundle(bundleRow *TelemetryBundleRow) error

	// Get a count of telemetry reports
	ReportCount(ids ...any) (int, error)

	// Get telemetry reports from the reports table
	GetReportRows(ids ...any) ([]*TelemetryReportRow, error)

	// Delete a specified telemetry report from the reports table
	DeleteReport(reportRow *TelemetryReportRow) error
	// contains filtered or unexported methods
}

type TelemetryCommonImpl struct {
	// contains filtered or unexported fields
}

type TelemetryDataItem struct {
	// NOTE: omitempty option used in json tags to support generating test scenarios
	Header        TelemetryDataItemHeader `json:"header"  validate:"required"`
	TelemetryData json.RawMessage         `json:"telemetryData"  validate:"required,dive"`
	Footer        TelemetryDataItemFooter `json:"footer,omitempty" validate:"omitempty"`
}

type TelemetryDataItemFooter struct {
	Checksum string `json:"checksum"  validate:"required"`
}

type TelemetryDataItemHeader struct {
	TelemetryId          string   `json:"telemetryId"  validate:"required,uuid|uuid_rfc4122"`
	TelemetryTimeStamp   string   `json:"telemetryTimeStamp"  validate:"required"`
	TelemetryType        string   `json:"telemetryType"  validate:"required,min=5"`
	TelemetryAnnotations []string `json:"telemetryAnnotations,omitempty"`
}

type TelemetryDataItemRow struct {
	Id              int64
	ItemId          string
	ItemType        string
	ItemTimestamp   string
	ItemAnnotations string
	ItemData        []byte
	ItemChecksum    string
	Compression     sql.NullString
	BundleId        sql.NullInt64
}

type TelemetryProcessor interface {
	TelemetryCommon

	// Add telemetry data - a method to process jsonData as a byte[]
	AddData(
		telemetry types.TelemetryType,
		content *types.TelemetryBlob,
		tags types.Tags,
	) (err error)

	// Generate telemetry bundle
	GenerateBundle(
		clientId string,
		customerId string,
		tags types.Tags,
	) (bundleRow *TelemetryBundleRow, err error)

	// Generate telemetry report
	GenerateReport(
		clientId string,
		tags types.Tags,
	) (reportRow *TelemetryReportRow, err error)

	// Convert TelemetryReportRow structure to TelemetryReport
	ToReport(reportRow *TelemetryReportRow) (report *TelemetryReport, err error)

	// Convert TelemetryBundleRow structure to TelemetryBundle
	ToBundle(bundleRow *TelemetryBundleRow) (bundle *TelemetryBundle, err error)

	// Convert TelemetryDataItemRow structure to TelemetryDataItem
	ToItem(itemRow *TelemetryDataItemRow) (item *TelemetryDataItem, err error)
}

type TelemetryProcessorImpl struct {
	// contains filtered or unexported fields
}

type TelemetryReport struct {
	// NOTE: omitempty option used in json tags to support generating test scenarios
	Header           TelemetryReportHeader `json:"header" validate:"required"`
	TelemetryBundles []TelemetryBundle     `json:"telemetryBundles,omitempty" validate:"required,gt=0,dive"`
	Footer           TelemetryReportFooter `json:"footer,omitempty" validate:"omitempty"`
}

type TelemetryReportFooter struct {
	// NOTE: omitempty option used in json tags to support generating test scenarios
	Checksum string `json:"checksum,omitempty" validate:"omitempty,md5"`
}

type TelemetryReportHeader struct {
	// NOTE: omitempty option used in json tags to support generating test scenarios
	ReportId          string   `json:"reportId,omitempty" validate:"required,uuid|uuid_rfc4122"`
	ReportTimeStamp   string   `json:"reportTimeStamp" validate:"required"`
	ReportClientId    string   `json:"reportClientId" validate:"required,uuid|uuid_rfc4122"`
	ReportAnnotations []string `json:"reportAnnotations,omitempty"`
}

type TelemetryReportRow struct {
	Id                int64
	ReportId          string
	ReportTimestamp   string
	ReportClientId    string
	ReportAnnotations string
}