models

Documentation

Overview

Package models contains telemetry models.

Index

• type AccountsCount
• type ActivateEndDevicesCount
• type ApplicationsCount
• type CLITelemetry
• type EndDevicesCount
• type EntitiesCount
• type GatewaysCount
• type OSTelemetry
• type OrganizationsCount
• type TelemetryMessage
• type UsersCount

Types

type AccountsCount

type AccountsCount struct {
	Users         UsersCount         `json:"users"`
	Organizations OrganizationsCount `json:"organizations"`
}

AccountsCount telemetry data about the amount of accounts, total and the amount on each type.

type ActivateEndDevicesCount

type ActivateEndDevicesCount struct {
	Total     uint64 `json:"total"`
	LastDay   uint64 `json:"last_day"`
	LastWeek  uint64 `json:"last_week"`
	LastMonth uint64 `json:"last_month"`
}

ActivateEndDevicesCount contains the amount of devices that are active respecting the described time frame.

type ApplicationsCount

type ApplicationsCount struct {
	Total uint64 `json:"total"`
}

ApplicationsCount telemetry data about the amount of applications.

type CLITelemetry

type CLITelemetry struct{}

CLITelemetry contains telemetry information about the CLI.

type EndDevicesCount

type EndDevicesCount struct {
	Total              uint64                  `json:"total"`
	ActivateEndDevices ActivateEndDevicesCount `json:"activate_end_devices"`
}

EndDevicesCount contains telemetry data regarding the amount of end devices and its different types.

type EntitiesCount

type EntitiesCount struct {
	Gateways     GatewaysCount     `json:"gateways"`
	EndDevices   EndDevicesCount   `json:"end_devices"`
	Applications ApplicationsCount `json:"applications"`
	Accounts     AccountsCount     `json:"accounts"`
}

EntitiesCount contains telemetry data regarding the amount of each entity and its different types.

type GatewaysCount

type GatewaysCount struct {
	Total                     uint64            `json:"total"`
	GatewaysByFrequencyPlanID map[string]uint64 `json:"gateways_by_frequency_plan_id"`
}

GatewaysCount contains telemetry data regarding the amount of gateways and some extra insights.

type OSTelemetry

type OSTelemetry struct {
	OperatingSystem string `json:"operating_system"`
	Arch            string `json:"arch"`
	BinaryVersion   string `json:"binary_version" `
	GolangVersion   string `json:"golang_version"`
}

OSTelemetry contains telemetry information about the operating system.

type OrganizationsCount

type OrganizationsCount struct {
	Total uint64 `json:"total"`
}

OrganizationsCount telemetry data about the total amount of orgainizations.

type TelemetryMessage

type TelemetryMessage struct {
	UID           string         `json:"uid"`
	OS            *OSTelemetry   `json:"os,omitempty"`
	CLI           *CLITelemetry  `json:"cli"`
	EntitiesCount *EntitiesCount `json:"entities_count"`
}

TelemetryMessage contains all the telemetry data that is to be exported by all services and CLI.

This message is not supposed to be sent in its fullest. Meaning that tasks related to EntitiesCount should send only data regarding the entity amount, while the CLI information should be empty.

type UsersCount

type UsersCount struct {
	Standard uint64 `json:"standard"`
	Admin    uint64 `json:"admin"`
}

UsersCount telemetry data about the amount of users, total and the amount on each type.