const (TallymanCoderLicenseKeyHeader   = "Coder-License-Key"TallymanCoderDeploymentIDHeader = "Coder-Deployment-ID")

funcParseEvent¶

func ParseEvent(datajson.RawMessage, outEvent)error

ParseEvent parses the raw event data into the provided event. It fails ifthere is any unknown fields or extra data at the end of the JSON. Thereturned event is validated.

typeDCManagedAgentsV1¶

type DCManagedAgentsV1 struct {Countuint64 `json:"count"`}

DCManagedAgentsV1 is a discrete usage event for the number of managed agents.This event is sent in the following situations:

• Once on first startup after usage tracking is added to the product withthe count of all existing managed agents (count=N)
• A new managed agent is created (count=1)

func (DCManagedAgentsV1) EventType()UsageEventType

func (eDCManagedAgentsV1) Fields() map[string]any

func (eDCManagedAgentsV1) Valid()error

typeDiscreteEvent¶

type DiscreteEvent interface {Event// contains filtered or unexported methods}

DiscreteEvent is a usage event that is collected as a discrete event.

typeEvent¶

type Event interface {EventType()UsageEventTypeValid()errorFields() map[string]any// fields to be marshaled and sent to tallyman/Metronome// contains filtered or unexported methods}

Event is a usage event that can be collected by the usage collector.

Note that the following event types should not be updated once they aremerged into the product. Please consult Dean before making any changes.

This type cannot be implemented outside of this package as it this packageis the source of truth for the coder/tallyman repo.

func ParseEventWithType(eventTypeUsageEventType, datajson.RawMessage) (Event,error)

typeTallymanV1IngestAcceptedEvent¶

type TallymanV1IngestAcceptedEvent struct {IDstring `json:"id"`}

TallymanV1IngestAcceptedEvent is an event that was accepted by the TallymanAPI.

typeTallymanV1IngestEvent¶

type TallymanV1IngestEvent struct {IDstring          `json:"id"`EventTypeUsageEventType  `json:"event_type"`EventDatajson.RawMessage `json:"event_data"`CreatedAttime.Time       `json:"created_at"`}

TallymanV1IngestEvent is an event to be ingested into the Tallyman API.

func (eTallymanV1IngestEvent) Valid()error

typeTallymanV1IngestRejectedEvent¶

type TallymanV1IngestRejectedEvent struct {IDstring `json:"id"`Messagestring `json:"message"`Permanentbool   `json:"permanent"`}

TallymanV1IngestRejectedEvent is an event that was rejected by the TallymanAPI.

typeTallymanV1IngestRequest¶

type TallymanV1IngestRequest struct {Events []TallymanV1IngestEvent `json:"events"`}

TallymanV1IngestRequest is a request to the Tallyman API to ingest usageevents.

typeTallymanV1IngestResponse¶

type TallymanV1IngestResponse struct {AcceptedEvents []TallymanV1IngestAcceptedEvent `json:"accepted_events"`RejectedEvents []TallymanV1IngestRejectedEvent `json:"rejected_events"`}

TallymanV1IngestResponse is a response from the Tallyman API to ingest usageevents.

typeTallymanV1Response¶

type TallymanV1Response struct {Messagestring `json:"message"`}

TallymanV1Response is a generic response with a message from the TallymanAPI. It is typically returned when there is an error.

typeUnknownEventTypeError¶

type UnknownEventTypeError struct {EventTypestring}

UnknownEventTypeError is returned by ParseEventWithType when an unknown eventtype is encountered.

func (eUnknownEventTypeError) Error()string

typeUsageEventType¶

type UsageEventTypestring

UsageEventType is an enum of all usage event types. It mirrors the databasetype `usage_event_type`.

const (UsageEventTypeDCManagedAgentsV1UsageEventType = "dc_managed_agents_v1")

func (eUsageEventType) IsDiscrete()bool

func (eUsageEventType) IsHeartbeat()bool

func (eUsageEventType) Valid()bool