telemetry

package
v0.1.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 8, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package telemetry sends optional, anonymous usage events. It is OFF by default and only active when the operator explicitly opts in AND configures an endpoint, so runeward never phones home without consent.

Enable with:

RUNEWARD_TELEMETRY=1
RUNEWARD_TELEMETRY_ENDPOINT=https://your-collector.example/ingest

The DO_NOT_TRACK convention (https://consoledonottrack.com) always wins. Events carry only the runeward version, OS, and architecture plus any explicit, non-identifying properties the caller passes — no hostnames, no paths, no profile contents, no IDs.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Enabled

func Enabled() bool

Enabled reports whether telemetry should be sent: opt-in flag set, an endpoint configured, and DO_NOT_TRACK not set.

func Notice

func Notice() string

Notice is a one-line, human-readable disclosure of the current telemetry state, suitable for logging at startup.

func Report

func Report(version, name string, props map[string]string)

Report sends an anonymous event best-effort. It returns immediately (the send happens in the background with a short timeout) and never errors; when telemetry is disabled it is a no-op.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL