db

Documentation

Overview

Package db contains functions for communication with an InfluxDB host.

Index

• func AddRound(r game.RoundInfo)
• type ConnectOpts
• type ConnectionDetails
• type InfluxClient
  • func NewInfluxClient(opts ConnectOpts) *InfluxClient
  • func (c *InfluxClient) Close()
  • func (c *InfluxClient) LoopAsync() <-chan InfluxEvent
  • func (c *InfluxClient) ValidateConn(timeout time.Duration) (details *ConnectionDetails, err error)
• type InfluxEvent

Functions

func AddRound

func AddRound(r game.RoundInfo)

AddRound adds a game round to the buffer to be pushed to the InfluxDB when possible.

Types

type ConnectOpts

type ConnectOpts struct {
	URL    string
	Token  string
	Org    string
	Bucket string
}

ConnectOpts allows defining options for a new client.

type ConnectionDetails

type ConnectionDetails struct {
	Name    string
	Version string
	Commit  string
}

ConnectionDetails contains details about the connection to an InfluxDB host.

type InfluxClient

type InfluxClient struct {
	URL string
	// contains filtered or unexported fields
}

InfluxClient is used to send R6 round data to an InfluxDB host.

func NewInfluxClient

func NewInfluxClient(opts ConnectOpts) *InfluxClient

NewInfluxClient creates a new client with the provided options.

func (*InfluxClient) Close

func (c *InfluxClient) Close()

Close calls the client's underlying Close function, finishing all asynchronous writes.

func (*InfluxClient) LoopAsync

func (c *InfluxClient) LoopAsync() <-chan InfluxEvent

LoopAsync starts a goroutine which pushes the data from the queue iteratively (FIFO) to the InfluxDB. It returns a channel used for providing event information.

func (*InfluxClient) ValidateConn

func (c *InfluxClient) ValidateConn(timeout time.Duration) (details *ConnectionDetails, err error)

ValidateConn validates that the InfluxDB host can be reached, is healthy and that the client has write permissions.

type InfluxEvent

type InfluxEvent struct {
	Err        error
	MatchID    string
	RoundIndex int
}

InfluxEvent contains data sent from the asynchronous loop started by LoopAsync. It contains the MatchID and RoundIndex for the related event and an Err field indicating success if nil.