netmaker/logic/telemetry.go

package logic

import (
	"encoding/json"
	"os"
	"time"

	"github.com/gravitl/netmaker/database"
	"github.com/gravitl/netmaker/logger"
	"github.com/gravitl/netmaker/models"
	"github.com/gravitl/netmaker/servercfg"
	"github.com/posthog/posthog-go"
	"golang.org/x/exp/slog"
)

var (
	// flags to keep for telemetry
	isFreeTier      bool
	telServerRecord = models.Telemetry{}
)

// posthog_pub_key - Key for sending data to PostHog
const posthog_pub_key = "phc_1vEXhPOA1P7HP5jP2dVU9xDTUqXHAelmtravyZ1vvES"

// posthog_endpoint - Endpoint of PostHog server
const posthog_endpoint = "https://app.posthog.com"

// setFreeTierForTelemetry - store free tier flag without having an import cycle when used for telemetry
// (as the pro package needs the logic package as currently written).
func SetFreeTierForTelemetry(freeTierFlag bool) {
	isFreeTier = freeTierFlag
}

// sendTelemetry - gathers telemetry data and sends to posthog
func sendTelemetry() error {
	if servercfg.Telemetry() == "off" {
		return nil
	}

	var telRecord, err = FetchTelemetryRecord()
	if err != nil {
		return err
	}
	// get telemetry data
	d := FetchTelemetryData()
	// get tenant admin email
	adminEmail := os.Getenv("NM_EMAIL")
	client, err := posthog.NewWithConfig(posthog_pub_key, posthog.Config{Endpoint: posthog_endpoint})
	if err != nil {
		return err
	}
	defer client.Close()

	slog.Info("sending telemetry data to posthog", "data", d)

	// send to posthog
	return client.Enqueue(posthog.Capture{
		DistinctId: telRecord.UUID,
		Event:      "daily checkin",
		Properties: posthog.NewProperties().
			Set("nodes", d.Nodes).
			Set("hosts", d.Hosts).
			Set("servers", d.Servers).
			Set("non-server nodes", d.Count.NonServer).
			Set("extclients", d.ExtClients).
			Set("users", d.Users).
			Set("networks", d.Networks).
			Set("linux", d.Count.Linux).
			Set("darwin", d.Count.MacOS).
			Set("windows", d.Count.Windows).
			Set("freebsd", d.Count.FreeBSD).
			Set("docker", d.Count.Docker).
			Set("k8s", d.Count.K8S).
			Set("version", d.Version).
			Set("is_ee", d.IsPro). // TODO change is_ee to is_pro for consistency, but probably needs changes in posthog
			Set("is_free_tier", isFreeTier).
			Set("is_pro_trial", d.IsProTrial).
			Set("pro_trial_end_date", d.ProTrialEndDate.In(time.UTC).Format("2006-01-02")).
			Set("admin_email", adminEmail).
			Set("email", adminEmail). // needed for posthog intgration with hubspot. "admin_email" can only be removed if not used in posthog
			Set("is_saas_tenant", d.IsSaasTenant),
	})
}

// FetchTelemetryData - fetches telemetry data: count of various object types in DB
func FetchTelemetryData() telemetryData {
	var data telemetryData

	data.IsPro = servercfg.IsPro
	data.ExtClients = getDBLength(database.EXT_CLIENT_TABLE_NAME)
	data.Users = getDBLength(database.USERS_TABLE_NAME)
	data.Networks = getDBLength(database.NETWORKS_TABLE_NAME)
	data.Hosts = getDBLength(database.HOSTS_TABLE_NAME)
	data.Version = servercfg.GetVersion()
	data.Servers = getServerCount()
	nodes, _ := GetAllNodes()
	data.Nodes = len(nodes)
	data.Count = getClientCount(nodes)
	endDate, _ := GetTrialEndDate()
	data.ProTrialEndDate = endDate
	if endDate.After(time.Now()) {
		data.IsProTrial = true
	}
	data.IsSaasTenant = servercfg.DeployedByOperator()
	return data
}

// getServerCount returns number of servers from database
func getServerCount() int {
	data, err := database.FetchRecords(database.SERVER_UUID_TABLE_NAME)
	if err != nil {
		logger.Log(0, "error retrieving server data", err.Error())
	}
	return len(data)
}

// setTelemetryTimestamp - Give the entry in the DB a new timestamp
func setTelemetryTimestamp(telRecord *models.Telemetry) error {
	lastsend := time.Now().Unix()
	var serverTelData = models.Telemetry{
		UUID:           telRecord.UUID,
		LastSend:       lastsend,
		TrafficKeyPriv: telRecord.TrafficKeyPriv,
		TrafficKeyPub:  telRecord.TrafficKeyPub,
	}
	jsonObj, err := json.Marshal(&serverTelData)
	if err != nil {
		return err
	}
	err = database.Insert(database.SERVER_UUID_RECORD_KEY, string(jsonObj), database.SERVER_UUID_TABLE_NAME)
	if err == nil {
		telServerRecord = serverTelData
	}
	return err
}

// getClientCount - returns counts of nodes with various OS types and conditions
func getClientCount(nodes []models.Node) clientCount {
	var count clientCount
	for _, node := range nodes {
		host, err := GetHost(node.HostID.String())
		if err != nil {
			continue
		}
		switch host.OS {
		case "darwin":
			count.MacOS += 1
		case "windows":
			count.Windows += 1
		case "linux":
			count.Linux += 1
		case "freebsd":
			count.FreeBSD += 1
		}
	}
	return count
}

// FetchTelemetryRecord - get the existing UUID and Timestamp from the DB
func FetchTelemetryRecord() (models.Telemetry, error) {
	if telServerRecord.TrafficKeyPub != nil {
		return telServerRecord, nil
	}
	var rawData string
	var telObj models.Telemetry
	var err error
	rawData, err = database.FetchRecord(database.SERVER_UUID_TABLE_NAME, database.SERVER_UUID_RECORD_KEY)
	if err != nil {
		return telObj, err
	}
	err = json.Unmarshal([]byte(rawData), &telObj)
	if err == nil {
		telServerRecord = telObj
	}
	return telObj, err
}

// getDBLength - get length of DB to get count of objects
func getDBLength(dbname string) int {
	data, err := database.FetchRecords(dbname)
	if err != nil {
		return 0
	}
	return len(data)
}

// telemetryData - What data to send to posthog
type telemetryData struct {
	Nodes           int
	Hosts           int
	ExtClients      int
	Users           int
	Count           clientCount
	Networks        int
	Servers         int
	Version         string
	IsPro           bool
	IsFreeTier      bool
	IsProTrial      bool
	ProTrialEndDate time.Time
	IsSaasTenant    bool
}

// clientCount - What types of netclients we're tallying
type clientCount struct {
	MacOS     int
	Windows   int
	Linux     int
	FreeBSD   int
	K8S       int
	Docker    int
	NonServer int
}