Function BeginTelemetry

internal/attachments/telemetry.go:15–36

BeginTelemetry starts an attachment event at full sampling for the raw supplied count. A zero count returns nil without changing sampling. recorder is required; use a no-op service when telemetry is disabled. Call immediately before Flag.UserAssets so invalid and over-limit inputs count.

(recorder ghtelemetry.InvocationRecorder, command string, attachCount int)

// use a no-op service when telemetry is disabled.
// Call immediately before Flag.UserAssets so invalid and over-limit inputs count.
func BeginTelemetry(recorder ghtelemetry.InvocationRecorder, command string, attachCount int) *TelemetryEvent {
	if attachCount == 0 {
		return nil
	}

	recorder.SetSampleRate(ghtelemetry.SAMPLE_ALL)
	pendingEvent := recorder.Begin(ghtelemetry.Event{
		Type: "attachment_invocation",
		Dimensions: ghtelemetry.Dimensions{
			"command": command,
		},
		Measures: ghtelemetry.Measures{
			"attach_count":      int64(attachCount),
			"append_ops_count":  0,
			"replace_ops_count": 0,
		},
	})

	return &TelemetryEvent{
		pendingEvent: pendingEvent,
	}
}

// RecordOperations replaces, rather than adds to, the completed operation counts.
// Pass partial results before handling an upload error so successful work is retained.