telemetry

Documentation

Index

• type Telemetry
  • func Setup(cfg *config.Config) (Telemetry, error)

Types

type Telemetry

type Telemetry interface {
	// Start enables the metrics server.
	Start()
	// Stop terminates the metrics server.
	Stop() error
	// RecordGameStateUpdateDuration records the duration a game state update took to complete.
	RecordGameStateUpdateDuration(duration float64)
	// RecordPlayerConnected tracks a player that was connected to the server.
	RecordPlayerConnected()
	// RecordPlayerDisconnected tracks a player that was disconnected from the server.
	RecordPlayerDisconnected()
}

Telemetry is an interface for metrics providers that instrument the game server.

func Setup

func Setup(cfg *config.Config) (Telemetry, error)

Setup creates a new metrics provider. If the provider cannot be created, an error is returned. You must call Start() on the returned Telemetry provider to initialize it, and call Drop() to clean up resources.