install

Documentation

Index

• Variables
• type ConfigValidator
• type Discoverer
• type FileFilterer
• type LicenseKeyFetcher
  • func NewServiceLicenseKeyFetcher(client recipes.NerdGraphClient) LicenseKeyFetcher
• type MockLicenseKeyFetcher
  • func NewMockLicenseKeyFetcher() *MockLicenseKeyFetcher
  • func (f *MockLicenseKeyFetcher) FetchLicenseKey(ctx context.Context) (string, error)
• type Prompter
• type RecipeFileFetcher
• type RecipeFilterRunner
• type RecipeInstallFunc
• type RecipeInstaller
  • func NewRecipeInstaller(ic types.InstallerContext, nrClient *newrelic.NewRelic) *RecipeInstaller
  • func (i *RecipeInstaller) Install() error
• type RecipeRepository
• type RecipeValidator
• type RecipeVarPreparer
• type ServiceLicenseKeyFetcher
  • func (f *ServiceLicenseKeyFetcher) FetchLicenseKey(ctx context.Context) (string, error)

Variables

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

		logLevel := configAPI.GetLogLevel()
		config.InitFileLogger(logLevel)

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

		i := NewRecipeInstaller(ic, client.NRClient)

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

			if _, ok := err.(*types.UpdateRequiredError); ok {
				return
			}

			fallbackErrorMsg := fmt.Sprintf("We encountered an issue during the installation: %s.", err)
			fallbackHelpMsg := "If this problem persists, visit the documentation and support page for additional help here at https://one.newrelic.com/-/06vjAeZLKjP."

			if _, ok := err.(*types.UncaughtError); ok {
				fmt.Print(fallbackErrorMsg)
				fmt.Printf("\nFor more information about about what happened, rerun the command using the --debug flag.\n")
				fmt.Print("\n  newrelic install --debug \n\n")
				fmt.Print(fallbackHelpMsg)
			} else {
				log.Debug(fallbackErrorMsg)
				log.Debug(fallbackHelpMsg)
			}

			fmt.Print("\n\n")
		}
	},
}

Command represents the install command.

Types

type ConfigValidator

type ConfigValidator interface {
	Validate(ctx context.Context) error
}

type Discoverer

type Discoverer interface {
	Discover(context.Context) (*types.DiscoveryManifest, error)
}

Discoverer is responsible for discovering informataion about the host system.

type FileFilterer

type FileFilterer interface {
	Filter(context.Context, []types.OpenInstallationRecipe) ([]types.OpenInstallationLogMatch, error)
}

FileFilterer determines the existence of files on the underlying filesystem.

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 Prompter

type Prompter interface {
	PromptYesNo(msg string) (bool, error)
	MultiSelect(msg string, options []string) ([]string, error)
}

type RecipeFileFetcher

type RecipeFileFetcher interface {
	FetchRecipeFile(recipeURL *url.URL) (*types.OpenInstallationRecipe, error)
	LoadRecipeFile(filename string) (*types.OpenInstallationRecipe, error)
}

type RecipeFilterRunner

type RecipeFilterRunner interface {
	RunFilterAll(ctx context.Context, r []types.OpenInstallationRecipe, m *types.DiscoveryManifest) []types.OpenInstallationRecipe
	EnsureDoesNotFilter(ctx context.Context, r []types.OpenInstallationRecipe, m *types.DiscoveryManifest) error
}

type RecipeInstallFunc

type RecipeInstallFunc func(ctx context.Context, i *RecipeInstaller, m *types.DiscoveryManifest, r *types.OpenInstallationRecipe, recipes []types.OpenInstallationRecipe) error

type RecipeInstaller

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

func NewRecipeInstaller

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

func (*RecipeInstaller) Install

func (i *RecipeInstaller) Install() error

type RecipeRepository

type RecipeRepository interface {
	FindAll(m types.DiscoveryManifest) []types.OpenInstallationRecipe
}

type RecipeValidator

type RecipeValidator interface {
	ValidateRecipe(context.Context, types.DiscoveryManifest, types.OpenInstallationRecipe) (entityGUID string, err error)
}

RecipeValidator validates installation of a recipe.

type RecipeVarPreparer

type RecipeVarPreparer interface {
	Prepare(m types.DiscoveryManifest, r types.OpenInstallationRecipe, assumeYes bool, licenseKey string) (types.RecipeVars, error)
}

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)