telemetry

Documentation

Index

• Constants
• Variables
• type PosthogClient
  • func NewPosthogClient(logger *zap.SugaredLogger) (*PosthogClient, error)
• type SummaryDto
• type TelemetryEventClient
• type TelemetryEventClientImpl
  • func NewTelemetryEventClientImpl(logger *zap.SugaredLogger, client *http.Client, ...) (*TelemetryEventClientImpl, error)
  • func (impl *TelemetryEventClientImpl) GetTelemetryMetaInfo() (*TelemetryMetaInfo, error)
  • func (impl *TelemetryEventClientImpl) HeartbeatEventForTelemetry()
  • func (impl *TelemetryEventClientImpl) StopCron()
  • func (impl *TelemetryEventClientImpl) SummaryEventForTelemetry()
• type TelemetryEventDto
• type TelemetryEventType
• type TelemetryMetaInfo

Constants

const (
	TelemetryApiKeyEndpoint   string = "aHR0cHM6Ly90ZWxlbWV0cnkuZGV2dHJvbi5haS9kZXZ0cm9uL3RlbGVtZXRyeS9hcGlrZXk="
	TelemetryOptOutApiBaseUrl string = "aHR0cHM6Ly90ZWxlbWV0cnkuZGV2dHJvbi5haS9kZXZ0cm9uL3RlbGVtZXRyeS9vcHQtb3V0"
)

const DevtronUniqueClientIdConfigMap = "devtron-ucid"

const DevtronUniqueClientIdConfigMapKey = "UCID"

const InstallEventKey = "installEvent"

Variables

var (
	PosthogApiKey        string = ""
	PosthogEndpoint      string = "https://app.posthog.com"
	SummaryCronExpr      string = "0 0 * * *" // Run once a day, midnight
	HeartbeatCronExpr    string = "0 0/6 * * *"
	CacheExpiry          int    = 1440
	PosthogEncodedApiKey string = ""
	IsOptOut             bool   = false
)

Types

type PosthogClient

type PosthogClient struct {
	Client posthog.Client
	// contains filtered or unexported fields
}

func NewPosthogClient

func NewPosthogClient(logger *zap.SugaredLogger) (*PosthogClient, error)

type SummaryDto

type SummaryDto struct {
	ProdAppCount            int `json:"prodAppCount,omitempty"`
	NonProdAppCount         int `json:"nonProdAppCount,omitempty"`
	UserCount               int `json:"userCount,omitempty"`
	EnvironmentCount        int `json:"environmentCount,omitempty"`
	ClusterCount            int `json:"clusterCount,omitempty"`
	CiCountPerDay           int `json:"ciCountPerDay,omitempty"`
	CdCountPerDay           int `json:"cdCountPerDay,omitempty"`
	HelmChartCount          int `json:"helmChartCount,omitempty"`
	SecurityScanCountPerDay int `json:"securityScanCountPerDay,omitempty"`
}

type TelemetryEventClient

type TelemetryEventClient interface {
	GetTelemetryMetaInfo() (*TelemetryMetaInfo, error)
}

type TelemetryEventClientImpl

type TelemetryEventClientImpl struct {
	K8sUtil *util2.K8sUtil

	PosthogClient *PosthogClient
	// contains filtered or unexported fields
}

func NewTelemetryEventClientImpl

func NewTelemetryEventClientImpl(logger *zap.SugaredLogger, client *http.Client, clusterService cluster.ClusterService,
	K8sUtil *util2.K8sUtil, aCDAuthConfig *user.ACDAuthConfig,
	environmentService cluster.EnvironmentService, userService user.UserService,
	appListingRepository repository.AppListingRepository, PosthogClient *PosthogClient,
	ciPipelineRepository pipelineConfig.CiPipelineRepository, pipelineRepository pipelineConfig.PipelineRepository) (*TelemetryEventClientImpl, error)

func (*TelemetryEventClientImpl) GetTelemetryMetaInfo

func (impl *TelemetryEventClientImpl) GetTelemetryMetaInfo() (*TelemetryMetaInfo, error)

func (*TelemetryEventClientImpl) HeartbeatEventForTelemetry

func (impl *TelemetryEventClientImpl) HeartbeatEventForTelemetry()

func (*TelemetryEventClientImpl) StopCron

func (impl *TelemetryEventClientImpl) StopCron()

func (*TelemetryEventClientImpl) SummaryEventForTelemetry

func (impl *TelemetryEventClientImpl) SummaryEventForTelemetry()

type TelemetryEventDto

type TelemetryEventDto struct {
	UCID           string             `json:"ucid"` //unique client id
	Timestamp      time.Time          `json:"timestamp"`
	EventMessage   string             `json:"eventMessage,omitempty"`
	EventType      TelemetryEventType `json:"eventType"`
	Summary        *SummaryDto        `json:"summary,omitempty"`
	ServerVersion  string             `json:"serverVersion,omitempty"`
	DevtronVersion string             `json:"devtronVersion,omitempty"`
}

type TelemetryEventType

type TelemetryEventType string

const (
	Heartbeat                    TelemetryEventType = "Heartbeat"
	InstallationStart            TelemetryEventType = "InstallationStart"
	InstallationInProgress       TelemetryEventType = "InstallationInProgress"
	InstallationInterrupt        TelemetryEventType = "InstallationInterrupt"
	InstallationSuccess          TelemetryEventType = "InstallationSuccess"
	InstallationFailure          TelemetryEventType = "InstallationFailure"
	UpgradeStart                 TelemetryEventType = "UpgradeStart"
	UpgradeInProgress            TelemetryEventType = "UpgradeInProgress"
	UpgradeInterrupt             TelemetryEventType = "UpgradeInterrupt"
	UpgradeSuccess               TelemetryEventType = "UpgradeSuccess"
	UpgradeFailure               TelemetryEventType = "UpgradeFailure"
	Summary                      TelemetryEventType = "Summary"
	InstallationApplicationError TelemetryEventType = "InstallationApplicationError"
)

type TelemetryMetaInfo

type TelemetryMetaInfo struct {
	Url    string `json:"url,omitempty"`
	UCID   string `json:"ucid,omitempty"`
	ApiKey string `json:"apiKey,omitempty"`
}