installevents

package
v2.40.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 3, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Code generated by tutone: DO NOT EDIT

Code generated by tutone: DO NOT EDIT

Index

Constants

View Source 
const InstallationCreateInstallStatusMutation = `` /* 443-byte string literal not displayed */
View Source 
const InstallationCreateRecipeEventMutation = `` /* 467-byte string literal not displayed */

Variables

View Source 
var InstallationInstallStateTypeTypes = struct {
	// Defines a completed installation.
	COMPLETED InstallationInstallStateType
	// Defines an installation that has been started.
	STARTED InstallationInstallStateType
}{

	COMPLETED: "COMPLETED",

	STARTED: "STARTED",
}
View Source 
var InstallationRecipeStatusTypeTypes = struct {
	// Defines an available recipe when attempting to install.
	AVAILABLE InstallationRecipeStatusType
	// Defines a canceled recipe when attempting to install.
	CANCELED InstallationRecipeStatusType
	// Defines when New Relic instrumentation compatibility is detected.
	DETECTED InstallationRecipeStatusType
	// Defines a recipe that has failed during installation.
	FAILED InstallationRecipeStatusType
	// Defines a recipe that has been installed.
	INSTALLED InstallationRecipeStatusType
	// Defines a recipe currently being installed.
	INSTALLING InstallationRecipeStatusType
	// Defines a recipe that has been recommended during installation.
	RECOMMENDED InstallationRecipeStatusType
	// Defines a recipe that has been skipped during installation.
	SKIPPED InstallationRecipeStatusType
	// Defines a recipe that is unsupported.
	UNSUPPORTED InstallationRecipeStatusType
}{

	AVAILABLE: "AVAILABLE",

	CANCELED: "CANCELED",

	DETECTED: "DETECTED",

	FAILED: "FAILED",

	INSTALLED: "INSTALLED",

	INSTALLING: "INSTALLING",

	RECOMMENDED: "RECOMMENDED",

	SKIPPED: "SKIPPED",

	UNSUPPORTED: "UNSUPPORTED",
}

Functions

This section is empty.

Types

type InstallationCreateInstallStatusQueryResponse 

type InstallationCreateInstallStatusQueryResponse struct {
	InstallationInstallStatus InstallationInstallStatus `json:"InstallationCreateInstallStatus"`
}

type InstallationCreateRecipeEventQueryResponse 

type InstallationCreateRecipeEventQueryResponse struct {
	InstallationRecipeEvent InstallationRecipeEvent `json:"InstallationCreateRecipeEvent"`
}

type InstallationInstallStateType 

type InstallationInstallStateType string

InstallationInstallStateType - An enum that represent the installation state.

type InstallationInstallStatus 

type InstallationInstallStatus struct {
	// The version of the newrelic-cli that was used for a given installation attempt.
	CliVersion string `json:"cliVersion"`
	// Refers to the source of the installation.
	DeployedBy string `json:"deployedBy"`
	// Whether or not the installation is using a proxy.
	EnabledProxy bool `json:"enabledProxy"`
	// The error returned for a given installation attempt.
	Error InstallationStatusError `json:"error"`
	// The host name of the customer's machine.
	HostName string `json:"hostName"`
	// The unique ID that corresponds to an install status.
	InstallId string `json:"installId"`
	// The version of the open-install-library that is being used.
	InstallLibraryVersion string `json:"installLibraryVersion"`
	// Whether or not the installation is supported on the host machine.
	IsUnsupported bool `json:"isUnsupported"`
	// The kernel architecture of the customer's machine.
	KernelArch string `json:"kernelArch"`
	// The kernel version of the customer's machine.
	KernelVersion string `json:"kernelVersion"`
	// The path to the log file on the customer's host.
	LogFilePath string `json:"logFilePath"`
	// The OS of the customer's machine.
	Os string `json:"os"`
	// The platform name provided by the open-install-library.
	Platform string `json:"platform"`
	// The platform family name provided by the open-install-library.
	PlatformFamily string `json:"platformFamily"`
	// The platform version provided by the open-install-library.
	PlatformVersion string `json:"platformVersion"`
	// A URL generated by the newrelic-cli that redirects to the appropriate entity once an installation is complete.
	RedirectURL string `json:"redirectUrl"`
	// The state of the installation.
	State InstallationInstallStateType `json:"state"`
	// Whether or not the installation is a targeted install.
	TargetedInstall bool `json:"targetedInstall"`
	// The timestamp for when the install event occurred.
	Timestamp nrtime.EpochSeconds `json:"timestamp,omitempty"`
}

InstallationInstallStatus - An object that contains the overall installation status that is created from within the newrelic-cli.

type InstallationInstallStatusInput 

type InstallationInstallStatusInput struct {
	// The version of the newrelic-cli that was used for a given installation attempt.
	CliVersion string `json:"cliVersion"`
	// Refers to the source of the installation.
	DeployedBy string `json:"deployedBy,omitempty"`
	// Whether or not the installation is using a proxy.
	EnabledProxy bool `json:"enabledProxy"`
	// The error for a given installation attempt.
	Error InstallationStatusErrorInput `json:"error,omitempty"`
	// The host name of the customer's machine.
	HostName string `json:"hostName"`
	// The unique ID that corresponds to an install status.
	InstallId string `json:"installId"`
	// The version of the open-install-library that is being used.
	InstallLibraryVersion string `json:"installLibraryVersion"`
	// Whether or not the installation is supported on the host machine.
	IsUnsupported bool `json:"isUnsupported"`
	// The kernel architecture of the customer's machine.
	KernelArch string `json:"kernelArch"`
	// The kernel version of the customer's machine.
	KernelVersion string `json:"kernelVersion"`
	// The path to the log file on the customer's host.
	LogFilePath string `json:"logFilePath"`
	// The OS of the customer's machine.
	Os string `json:"os"`
	// The platform name provided by the open-install-library.
	Platform string `json:"platform"`
	// The platform family name provided by the open-install-library.
	PlatformFamily string `json:"platformFamily"`
	// The platform version provided by the open-install-library.
	PlatformVersion string `json:"platformVersion"`
	// A URL generated by the newrelic-cli that redirects to the appropriate entity once an installation is complete.
	RedirectURL string `json:"redirectUrl"`
	// The state of the installation.
	State InstallationInstallStateType `json:"state"`
	// Whether or not the installation is a targeted install.
	TargetedInstall bool `json:"targetedInstall"`
	// The timestamp for when the install event occurred.
	Timestamp nrtime.EpochSeconds `json:"timestamp,omitempty"`
}

InstallationInstallStatusInput - An object that contains the overall installation status to be created.

type InstallationRecipeEvent 

type InstallationRecipeEvent struct {
	// The version of the newrelic-cli that was used for a given recipe.
	CliVersion string `json:"cliVersion"`
	// Whether or not the recipe has been installed and all steps have been completed.
	Complete bool `json:"complete"`
	// The display name for a given recipe.
	DisplayName string `json:"displayName"`
	// The entity Guid for a given recipe.
	EntityGUID common.EntityGUID `json:"entityGuid"`
	// The error returned for a given recipe.
	Error InstallationStatusError `json:"error"`
	// The host name of the customer's machine.
	HostName string `json:"hostName"`
	// The unique ID that corresponds to an install event.
	InstallId string `json:"installId,omitempty"`
	// The version of the open-install-library that is being used.
	InstallLibraryVersion string `json:"installLibraryVersion,omitempty"`
	// The kernel architecture of the customer's machine.
	KernelArch string `json:"kernelArch"`
	// The kernel version of the customer's machine.
	KernelVersion string `json:"kernelVersion"`
	// The path to the log file on the customer's host.
	LogFilePath string `json:"logFilePath"`
	// Additional key:value data related to the environment where the installation occurred.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// The unique name for a given recipe.
	Name string `json:"name"`
	// The OS of the customer's machine.
	Os string `json:"os"`
	// The platform name provided by the open-install-library.
	Platform string `json:"platform"`
	// The platform family name provided by the open-install-library.
	PlatformFamily string `json:"platformFamily"`
	// The platform version provided by the open-install-library.
	PlatformVersion string `json:"platformVersion"`
	// The redirect URL created by the CLI used for redirecting to a particular entity.
	RedirectURL string `json:"redirectUrl,omitempty"`
	// The status for a given recipe.
	Status InstallationRecipeStatusType `json:"status"`
	// Whether or not the recipe being installed is a targeted install.
	TargetedInstall bool `json:"targetedInstall"`
	// The path to the installation task as defined in the open-install-library.
	TaskPath string `json:"taskPath,omitempty"`
	// The timestamp for when the recipe event occurred.
	Timestamp nrtime.EpochSeconds `json:"timestamp"`
	// The number of milliseconds it took to validate the recipe.
	ValidationDurationMilliseconds int64 `json:"validationDurationMilliseconds"`
}

InstallationRecipeEvent - An object that contains an installation event created from within the newrelic-cli.

type InstallationRecipeStatus 

type InstallationRecipeStatus struct {
	// The version of the newrelic-cli that was used for a given recipe.
	CliVersion string `json:"cliVersion"`
	// Whether or not the recipe has been installed and all steps have been completed.
	Complete bool `json:"complete"`
	// The display name for a given recipe.
	DisplayName string `json:"displayName"`
	// The entity Guid for a given recipe.
	EntityGUID common.EntityGUID `json:"entityGuid"`
	// The error returned for a given recipe.
	Error InstallationStatusErrorInput `json:"error,omitempty"`
	// The host name of the customer's machine.
	HostName string `json:"hostName"`
	// The unique ID that corresponds to an install event.
	InstallId string `json:"installId,omitempty"`
	// The version of the open-install-library that is being used.
	InstallLibraryVersion string `json:"installLibraryVersion,omitempty"`
	// The kernel architecture of the customer's machine.
	KernelArch string `json:"kernelArch"`
	// The kernel version of the customer's machine.
	KernelVersion string `json:"kernelVersion"`
	// The path to the log file on the customer's host.
	LogFilePath string `json:"logFilePath"`
	// Additional key:value data related to an error or related to the environment where the installation occurred.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// The unique name for a given recipe.
	Name string `json:"name"`
	// The OS of the customer's machine.
	Os string `json:"os"`
	// The platform name provided by the open-install-library.
	Platform string `json:"platform"`
	// The platform family name provided by the open-install-library.
	PlatformFamily string `json:"platformFamily"`
	// The platform version provided by the open-install-library.
	PlatformVersion string `json:"platformVersion"`
	// The redirect URL created by the CLI used for redirecting to a particular entity.
	RedirectURL string `json:"redirectUrl,omitempty"`
	// The status for a given recipe.
	Status InstallationRecipeStatusType `json:"status"`
	// Whether or not the recipe being installed is a targeted install.
	TargetedInstall bool `json:"targetedInstall"`
	// The path to the installation task as defined in the open-install-library.
	TaskPath string `json:"taskPath,omitempty"`
	// The number of milliseconds it took to validate the recipe.
	ValidationDurationMilliseconds int64 `json:"validationDurationMilliseconds"`
}

InstallationRecipeStatus - An object that represents a recipe status.

type InstallationRecipeStatusType 

type InstallationRecipeStatusType string

InstallationRecipeStatusType - An enum that represents the various recipe statuses.

type InstallationStatusError 

type InstallationStatusError struct {
	// Error details, if any.
	Details string `json:"details,omitempty"`
	// The actual error message.
	Message string `json:"message,omitempty"`
}

InstallationStatusError - An object that represents a status error whenever an recipe has failed to install.

type InstallationStatusErrorInput 

type InstallationStatusErrorInput struct {
	// Error details, if any.
	Details string `json:"details,omitempty"`
	// The actual error message.
	Message string `json:"message,omitempty"`
}

InstallationStatusErrorInput - An object that represents a status error whenever an recipe has failed to install.

type Installevents 

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

Installevents is used to communicate with the Install Events Service.

func New 

func New(config config.Config) Installevents

New returns a new client for sending Install Events.

func (*Installevents) InstallationCreateInstallStatus 

func (a *Installevents) InstallationCreateInstallStatus(
	accountID int,
	installStatus InstallationInstallStatusInput,
) (*InstallationInstallStatus, error)

Creates a new install status. An install status is created on behalf of the newrelic-cli whenever the CLI has started an installation and completed an installation.

Guided install: https://docs.newrelic.com/docs/full-stack-observability/observe-everything/get-started/new-relic-guided-install-overview/ newrelic-cli: https://github.com/newrelic/newrelic-cli

func (*Installevents) InstallationCreateInstallStatusWithContext 

func (a *Installevents) InstallationCreateInstallStatusWithContext(
	ctx context.Context,
	accountID int,
	installStatus InstallationInstallStatusInput,
) (*InstallationInstallStatus, error)

Creates a new install status. An install status is created on behalf of the newrelic-cli whenever the CLI has started an installation and completed an installation.

Guided install: https://docs.newrelic.com/docs/full-stack-observability/observe-everything/get-started/new-relic-guided-install-overview/ newrelic-cli: https://github.com/newrelic/newrelic-cli

func (*Installevents) InstallationCreateRecipeEvent 

func (a *Installevents) InstallationCreateRecipeEvent(
	accountID int,
	status InstallationRecipeStatus,
) (*InstallationRecipeEvent, error)

Creates a new recipe event. - A recipe event is created on behalf of the newrelic-cli whenever the CLI attempts to install the infrastructure-agent, for example. - A recipe event is appended to any existing recipe events, if there are any present in the cache.

Guided install: https://docs.newrelic.com/docs/full-stack-observability/observe-everything/get-started/new-relic-guided-install-overview/ newrelic-cli: https://github.com/newrelic/newrelic-cli

func (*Installevents) InstallationCreateRecipeEventWithContext 

func (a *Installevents) InstallationCreateRecipeEventWithContext(
	ctx context.Context,
	accountID int,
	status InstallationRecipeStatus,
) (*InstallationRecipeEvent, error)

Creates a new recipe event. - A recipe event is created on behalf of the newrelic-cli whenever the CLI attempts to install the infrastructure-agent, for example. - A recipe event is appended to any existing recipe events, if there are any present in the cache.

Guided install: https://docs.newrelic.com/docs/full-stack-observability/observe-everything/get-started/new-relic-guided-install-overview/ newrelic-cli: https://github.com/newrelic/newrelic-cli

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.