telemetry

Documentation

Overview

Package telemetry implements a client for reporting telemetry data used to prioritize development of SpiceDB.

For more information, see: https://github.com/authzed/spicedb/blob/main/TELEMETRY.md

Index

• Constants
• func DisabledReporter(ctx context.Context) error
• func RegisterTelemetryCollector(datastoreEngine string, ds datastore.Datastore) (*prometheus.Registry, error)
• func SilentlyDisabledReporter(_ context.Context) error
• type Reporter
  • func RemoteReporter(registry *prometheus.Registry, endpoint string, caOverridePath string, ...) (Reporter, error)

Constants

const (
	// DefaultEndpoint is the endpoint to which telemetry will report if none
	// other is specified.
	DefaultEndpoint = "https://telemetry.authzed.com"

	// DefaultInterval is the default amount of time to wait between telemetry
	// reports.
	DefaultInterval = 1 * time.Hour

	// MaxElapsedTimeBetweenReports is the maximum amount of time that the
	// telemetry reporter will attempt to write to the telemetry endpoint
	// before terminating the reporter.
	MaxElapsedTimeBetweenReports = 168 * time.Hour

	// MinimumAllowedInterval is the minimum amount of time one can request
	// between telemetry reports.
	MinimumAllowedInterval = 1 * time.Minute
)

Functions

func DisabledReporter

func DisabledReporter(ctx context.Context) error

func RegisterTelemetryCollector

func RegisterTelemetryCollector(datastoreEngine string, ds datastore.Datastore) (*prometheus.Registry, error)

RegisterTelemetryCollector registers a collector for the various pieces of data required by SpiceDB telemetry.

func SilentlyDisabledReporter

func SilentlyDisabledReporter(_ context.Context) error

Types

type Reporter

type Reporter func(ctx context.Context) error

func RemoteReporter

func RemoteReporter(
	registry *prometheus.Registry,
	endpoint string,
	caOverridePath string,
	interval time.Duration,
) (Reporter, error)

RemoteReporter creates a telemetry reporter with the specified parameters, or errors if the configuration was invalid.