reporter

Documentation

Index

• Constants
• func Init(user *codefresh.User, flow FlowType)
• type AnalyticsReporter
  • func G() AnalyticsReporter
• type CliStep
• type CliStepData
• type CliStepStatus
• type FlowType

Constants

const (

	// Install
	InstallPhasePreCheckStart                         CliStep = "install.pre-check.phase.start"
	InstallStepPreCheckValidateRuntimeVersion         CliStep = "install.pre-check.step.validate-runtime-version"
	InstallStepPreCheckGetRuntimeName                 CliStep = "install.pre-check.step.get-runtime-name"
	InstallStepPreCheckRuntimeNameValidation          CliStep = "install.pre-check.step.runtime-name-validation"
	InstallStepPreCheckGetKubeContext                 CliStep = "install.pre-check.step.get-kube-context"
	InstallStepPreCheckEnsureIngressClass             CliStep = "install.pre-check.step.ensure-ingress-class"
	InstallStepPreCheckEnsureIngressHost              CliStep = "install.pre-check.step.ensure-ingress-host"
	InstallStepPreCheckEnsureRuntimeRepo              CliStep = "install.pre-check.step.ensure-runtime-repo"
	InstallStepPreCheckEnsureGitToken                 CliStep = "install.pre-check.step.ensure-git-token"
	InstallStepPreCheckEnsureGitPAT                   CliStep = "install.pre-check.step.ensure-git-personal-access-token"
	InstallStepPreCheckShouldInstallDemoResources     CliStep = "install.pre-check.step.should-install-demo-resources"
	InstallPhasePreCheckFinish                        CliStep = "install.pre-check.phase.finish"
	InstallPhaseRunPreCheckStart                      CliStep = "install.run.pre-check.phase.start"
	InstallStepRunPreCheckDownloadRuntimeDefinition   CliStep = "install.run.pre-check.step.download-runtime-definition"
	InstallStepRunPreCheckEnsureCliVersion            CliStep = "install.run.pre-check.step.ensure-cli-version"
	InstallStepRunPreCheckRuntimeCollision            CliStep = "install.run.pre-check.step.runtime-collision"
	InstallStepRunPreCheckExisitingRuntimes           CliStep = "install.run.pre-check.step.existing-runtimes"
	InstallStepRunPreCheckValidateClusterRequirements CliStep = "install.run.pre-check.step.validate-cluster-requirements"
	InstallPhaseRunPreCheckFinish                     CliStep = "install.run.pre-check.phase.finish"
	InstallPhaseStart                                 CliStep = "install.run.phase.start"
	InstallStepDownloadRuntimeDefinition              CliStep = "install.run.step.download-runtime-definition"
	InstallStepGetServerAddress                       CliStep = "install.run.step.get-server-address"
	InstallStepCreateRuntimeOnPlatform                CliStep = "install.run.step.create-runtime-on-platform"
	InstallStepBootstrapRepo                          CliStep = "install.run.step.bootstrap-repo"
	InstallStepCreateProject                          CliStep = "install.run.step.create-project"
	InstallStepCreateConfigMap                        CliStep = "install.run.step.create-codefresh-cm"
	InstallStepCreateComponents                       CliStep = "install.run.step.create-components"
	InstallStepInstallComponenets                     CliStep = "install.run.step.install-components"
	InstallStepCreateGitsource                        CliStep = "install.run.step.create-gitsource"
	InstallStepCreateMarketplaceGitsource             CliStep = "install.run.step.create-marketplace-gitsource"
	InstallStepCompleteRuntimeInstallation            CliStep = "install.run.step.complete-runtime-installation"
	InstallStepCreateDefaultGitIntegration            CliStep = "install.run.step.create-default-git-integration"
	InstallStepRegisterToDefaultGitIntegration        CliStep = "install.run.step.register-to-default-git-integration"
	InstallPhaseFinish                                CliStep = "install.run.phase.finish"

	// Uninstall
	UninstallPhasePreCheckStart                CliStep = "uninstall.pre-check.phase.start"
	UninstallStepPreCheckGetKubeContext        CliStep = "uninstall.pre-check.step.get-kube-context"
	UninstallStepPreCheckEnsureRuntimeName     CliStep = "uninstall.pre-check.step.ensure-runtime-name"
	UninstallStepPreCheckRuntimeNameValidation CliStep = "uninstall.pre-check.step.runtime-name-validation"
	UninstallStepPreCheckEnsureRuntimeRepo     CliStep = "uninstall.pre-check.step.ensure-runtime-repo"
	UninstallStepPreCheckEnsureGitToken        CliStep = "uninstall.pre-check.step.ensure-git-token"
	UninstallPhasePreCheckFinish               CliStep = "uninstall.pre-check.phase.finish"
	UninstallPhaseStart                        CliStep = "uninstall.run.phase.start"
	UninstallStepCheckRuntimeExists            CliStep = "uninstall.run.step.check-runtime-exists"
	UninstallStepUninstallRepo                 CliStep = "uninstall.run.step.uninstall-repo"
	UninstallStepRemoveGitIntegrations         CliStep = "uninstall.run.step.remove-git-integrations"
	UninstallStepDeleteRuntimeFromPlatform     CliStep = "uninstall.run.step.delete-runtime-from-platform"
	UninstallPhaseFinish                       CliStep = "uninstall.run.phase.finish"

	// Upgrade
	UpgradePhasePreCheckStart              CliStep = "upgrade.pre-check.phase.start"
	UpgradeStepPreCheckEnsureRuntimeName   CliStep = "upgrade.pre-check.step.ensure-runtime-name"
	UpgradeStepPreCheckEnsureRuntimeRepo   CliStep = "upgrade.pre-check.step.ensure-runtime-repo"
	UpgradeStepPreCheckEnsureGitToken      CliStep = "upgrade.pre-check.step.ensure-git-token"
	UpgradePhasePreCheckFinish             CliStep = "upgrade.pre-check.phase.finish"
	UpgradePhaseStart                      CliStep = "upgrade.run.phase.start"
	UpgradeStepDownloadRuntimeDefinition   CliStep = "upgrade.run.step.download-runtime-definition"
	UpgradeStepRunPreCheckEnsureCliVersion CliStep = "upgrade.run.step.ensure-cli-version"
	UpgradeStepGetRepo                     CliStep = "upgrade.run.step.get-repo"
	UpgradeStepLoadRuntimeDefinition       CliStep = "upgrade.run.step.load-runtime-definition"
	UpgradeStepCompareRuntimeVersions      CliStep = "upgrade.run.step.compare-runtime-versions"
	UpgradeStepUpgradeRuntime              CliStep = "upgrade.run.step.upgrade-runtime"
	UpgradeStepPushRuntimeDefinition       CliStep = "upgrade.run.step.push-runtime-definition"
	UpgradeStepInstallNewComponents        CliStep = "upgrade.run.step.install-new-components"
	UpgradePhaseFinish                     CliStep = "upgrade.run.phase.finish"

	// General
	SIGNAL_TERMINATION CliStep = "signal-termination"
	FINISH             CliStep = "run.finish"

	SUCCESS           CliStepStatus = "SUCCESS"
	FAILURE           CliStepStatus = "FAILURE"
	CANCELED          CliStepStatus = "CANCELED"
	ABRUPTLY_CANCELED CliStepStatus = "ABRUPTLY_CANCELED"

	InstallFlow   FlowType = "installation"
	UninstallFlow FlowType = "uninstallation"
	UpgradeFlow   FlowType = "upgrade"
)

Functions

func Init

func Init(user *codefresh.User, flow FlowType)

Types

type AnalyticsReporter

type AnalyticsReporter interface {
	ReportStep(CliStepData)
	Close(step CliStepStatus, err error)
}

func G

func G() AnalyticsReporter

G returns the global reporter

type CliStep

type CliStep string

type CliStepData

type CliStepData struct {
	Step        CliStep
	Status      CliStepStatus
	Description string
	Err         error
}

type CliStepStatus

type CliStepStatus string

type FlowType

type FlowType string