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
- Variables
- func DisabledReporter(ctx context.Context) error
- func RegisterTelemetryCollector(datastoreEngine string, ds datastore.Datastore) (*prometheus.Registry, error)
- func SilentlyDisabledReporter(_ context.Context) error
- func SpiceDBClusterInfoCollector(ctx context.Context, subsystem, dsEngine string, ds datastore.Datastore) (promutil.CollectorFunc, error)
- type Reporter
Constants ¶
View Source
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 )
Variables ¶
View Source
var LogicalChecks = promauto.NewCounter(prometheus.CounterOpts{
Namespace: "spicedb",
Subsystem: "services",
Name: "logical_checks_total",
Help: `Count of the number of "checks" made across all APIs (e.g. each item within a CheckBulk, each item returned from a Lookup).`,
})
Functions ¶
func DisabledReporter ¶
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 SpiceDBClusterInfoCollector ¶ added in v1.38.0
Types ¶
Click to show internal directories.
Click to hide internal directories.