install

Documentation

Index

• Variables
• func TestScenarioValues() []string
• type InstallerContext
  • func (i *InstallerContext) RecipeNamesProvided() bool
  • func (i *InstallerContext) RecipePathsProvided() bool
  • func (i *InstallerContext) RecipesProvided() bool
  • func (i *InstallerContext) ShouldInstallApm() bool
  • func (i *InstallerContext) ShouldInstallInfraAgent() bool
  • func (i *InstallerContext) ShouldInstallIntegrations() bool
  • func (i *InstallerContext) ShouldInstallLogging() bool
  • func (i *InstallerContext) ShouldRunDiscovery() bool
• type LicenseKeyFetcher
  • func NewServiceLicenseKeyFetcher(client recipes.NerdGraphClient) LicenseKeyFetcher
• type MockLicenseKeyFetcher
  • func NewMockLicenseKeyFetcher() *MockLicenseKeyFetcher
  • func (f *MockLicenseKeyFetcher) FetchLicenseKey(ctx context.Context) (string, error)
• type RecipeInstaller
  • func NewRecipeInstaller(ic InstallerContext, nrClient *newrelic.NewRelic) *RecipeInstaller
  • func (i *RecipeInstaller) Install() error
• type ScenarioBuilder
  • func NewScenarioBuilder(ic InstallerContext) *ScenarioBuilder
  • func (b *ScenarioBuilder) Basic() *RecipeInstaller
  • func (b *ScenarioBuilder) BuildScenario(s TestScenario) *RecipeInstaller
  • func (b *ScenarioBuilder) CanceledInstall() *RecipeInstaller
  • func (b *ScenarioBuilder) DisplayExplorerLink() *RecipeInstaller
  • func (b *ScenarioBuilder) Fail() *RecipeInstaller
  • func (b *ScenarioBuilder) LogMatches() *RecipeInstaller
  • func (b *ScenarioBuilder) StitchedPath() *RecipeInstaller
• type ServiceLicenseKeyFetcher
  • func (f *ServiceLicenseKeyFetcher) FetchLicenseKey(ctx context.Context) (string, error)
• type TestScenario

Variables

var Command = &cobra.Command{
	Use:   "install",
	Short: "Install New Relic.",
	Run: func(cmd *cobra.Command, args []string) {
		ic := InstallerContext{
			AssumeYes:          assumeYes,
			LocalRecipes:       localRecipes,
			RecipeNames:        recipeNames,
			RecipePaths:        recipePaths,
			SkipDiscovery:      skipDiscovery,
			SkipIntegrations:   skipIntegrations,
			SkipLoggingInstall: skipLoggingInstall,
			SkipApm:            skipApm,
			SkipInfra:          skipInfra,
		}

		config.InitFileLogger()

		client.WithClientAndProfile(func(nrClient *newrelic.NewRelic, profile *credentials.Profile) {
			if trace {
				log.SetLevel(log.TraceLevel)
				nrClient.SetLogLevel("trace")
			} else if debug {
				log.SetLevel(log.DebugLevel)
				nrClient.SetLogLevel("debug")
			}

			err := assertProfileIsValid(profile)
			if err != nil {
				log.Fatal(err)
			}

			i := NewRecipeInstaller(ic, nrClient)

			if err := i.Install(); err != nil {
				if err == types.ErrInterrupt {
					return
				}

				log.Fatalf("We encountered an error during the installation: %s. If this problem persists please visit the documentation and support page for additional help here: https://one.nr/06vjAeZLKjP", err)
			}
		})
	},
}

Command represents the install command.

var TestCommand = &cobra.Command{
	Use:    "installTest",
	Short:  "Run a UX test of the install command.",
	Hidden: true,
	Run: func(cmd *cobra.Command, args []string) {
		ic := InstallerContext{
			RecipePaths:        recipePaths,
			RecipeNames:        recipeNames,
			SkipDiscovery:      skipDiscovery,
			SkipIntegrations:   skipIntegrations,
			SkipLoggingInstall: skipLoggingInstall,
			SkipApm:            skipApm,
			AssumeYes:          assumeYes,
		}

		b := NewScenarioBuilder(ic)
		i := b.BuildScenario(TestScenario(testScenario))

		if i == nil {
			log.Fatalf("Scenario %s is not valid.  Valid values are %s", testScenario, strings.Join(TestScenarioValues(), ","))
		}

		if trace {
			log.SetLevel(log.TraceLevel)
		} else if debug {
			log.SetLevel(log.DebugLevel)
		}

		if err := i.Install(); err != nil {
			if err == types.ErrInterrupt {
				return
			}

			log.Fatalf("test failed: %s", err)
		}
	},
}

TestCommand represents the test command for the install command.

var (
	TestScenarios = []TestScenario{
		Basic,
		LogMatches,
		Fail,
		StitchedPath,
		Canceled,
		DisplayExplorerLink,
	}
)

Functions

func TestScenarioValues

func TestScenarioValues() []string

Types

type InstallerContext

type InstallerContext struct {
	AssumeYes   bool
	RecipeNames []string
	RecipePaths []string
	// LocalRecipes is the path to a local recipe directory from which to load recipes.
	LocalRecipes       string
	SkipDiscovery      bool
	SkipIntegrations   bool
	SkipLoggingInstall bool
	SkipApm            bool
	SkipInfra          bool
}

nolint: maligned

func (*InstallerContext) RecipeNamesProvided

func (i *InstallerContext) RecipeNamesProvided() bool

func (*InstallerContext) RecipePathsProvided

func (i *InstallerContext) RecipePathsProvided() bool

func (*InstallerContext) RecipesProvided

func (i *InstallerContext) RecipesProvided() bool

func (*InstallerContext) ShouldInstallApm

func (i *InstallerContext) ShouldInstallApm() bool

func (*InstallerContext) ShouldInstallInfraAgent

func (i *InstallerContext) ShouldInstallInfraAgent() bool

func (*InstallerContext) ShouldInstallIntegrations

func (i *InstallerContext) ShouldInstallIntegrations() bool

func (*InstallerContext) ShouldInstallLogging

func (i *InstallerContext) ShouldInstallLogging() bool

func (*InstallerContext) ShouldRunDiscovery

func (i *InstallerContext) ShouldRunDiscovery() bool

type LicenseKeyFetcher

type LicenseKeyFetcher interface {
	FetchLicenseKey(context.Context) (string, error)
}

func NewServiceLicenseKeyFetcher

func NewServiceLicenseKeyFetcher(client recipes.NerdGraphClient) LicenseKeyFetcher

type MockLicenseKeyFetcher

type MockLicenseKeyFetcher struct {
	FetchLicenseKeyFunc func(ctx context.Context) (string, error)
}

func NewMockLicenseKeyFetcher

func NewMockLicenseKeyFetcher() *MockLicenseKeyFetcher

func (*MockLicenseKeyFetcher) FetchLicenseKey

func (f *MockLicenseKeyFetcher) FetchLicenseKey(ctx context.Context) (string, error)

type RecipeInstaller

type RecipeInstaller struct {
	InstallerContext
	// contains filtered or unexported fields
}

func NewRecipeInstaller

func NewRecipeInstaller(ic InstallerContext, nrClient *newrelic.NewRelic) *RecipeInstaller

func (*RecipeInstaller) Install

func (i *RecipeInstaller) Install() error

type ScenarioBuilder

type ScenarioBuilder struct {
	// contains filtered or unexported fields
}

func NewScenarioBuilder

func NewScenarioBuilder(ic InstallerContext) *ScenarioBuilder

func (*ScenarioBuilder) Basic

func (b *ScenarioBuilder) Basic() *RecipeInstaller

func (*ScenarioBuilder) BuildScenario

func (b *ScenarioBuilder) BuildScenario(s TestScenario) *RecipeInstaller

func (*ScenarioBuilder) CanceledInstall

func (b *ScenarioBuilder) CanceledInstall() *RecipeInstaller

func (*ScenarioBuilder) DisplayExplorerLink

func (b *ScenarioBuilder) DisplayExplorerLink() *RecipeInstaller

func (*ScenarioBuilder) Fail

func (b *ScenarioBuilder) Fail() *RecipeInstaller

func (*ScenarioBuilder) LogMatches

func (b *ScenarioBuilder) LogMatches() *RecipeInstaller

func (*ScenarioBuilder) StitchedPath

func (b *ScenarioBuilder) StitchedPath() *RecipeInstaller

type ServiceLicenseKeyFetcher

type ServiceLicenseKeyFetcher struct {
	// contains filtered or unexported fields
}

relies on the Nerdgraph service

func (*ServiceLicenseKeyFetcher) FetchLicenseKey

func (f *ServiceLicenseKeyFetcher) FetchLicenseKey(ctx context.Context) (string, error)

type TestScenario

type TestScenario string

const (
	Basic               TestScenario = "BASIC"
	LogMatches          TestScenario = "LOG_MATCHES"
	Fail                TestScenario = "FAIL"
	StitchedPath        TestScenario = "STITCHED_PATH"
	Canceled            TestScenario = "CANCELED"
	DisplayExplorerLink TestScenario = "DISPLAY_EXPLORER_LINK"
)