types

Documentation

Overview

Code generated by tutone: DO NOT EDIT

Index

• Variables
• type DiscoveryManifest
  • func (d *DiscoveryManifest) AddProcess(p GenericProcess)
• type GenericProcess
• type LogMatch
• type LogMatchAttributes
• type NRQL
• type OpenInstallationAttributes
• type OpenInstallationLogMatch
• type OpenInstallationOperatingSystem
• type OpenInstallationPlatform
• type OpenInstallationPlatformFamily
• type OpenInstallationPreInstallConfiguration
• type OpenInstallationRecipe
• type OpenInstallationRecipeInputVariable
• type OpenInstallationRecipeInstallTarget
• type OpenInstallationTargetType
• type Recipe
  • func (r *Recipe) AddVar(key string, value interface{})

Variables

var OpenInstallationOperatingSystemTypes = struct {
	// MacOS operating system
	DARWIN OpenInstallationOperatingSystem
	// Linux-based operating system
	LINUX OpenInstallationOperatingSystem
	// Windows operating system
	WINDOWS OpenInstallationOperatingSystem
}{

	DARWIN: "DARWIN",

	LINUX: "LINUX",

	WINDOWS: "WINDOWS",
}

var OpenInstallationPlatformFamilyTypes = struct {
	// Debian distribution family
	DEBIAN OpenInstallationPlatformFamily
	// RHEL distribution family
	RHEL OpenInstallationPlatformFamily
	// openSUSE distribution family
	SUSE OpenInstallationPlatformFamily
}{

	DEBIAN: "DEBIAN",

	RHEL: "RHEL",

	SUSE: "SUSE",
}

var OpenInstallationPlatformTypes = struct {
	// Amazon Linux operating system
	AMAZON OpenInstallationPlatform
	// CentOS operating system
	CENTOS OpenInstallationPlatform
	// Debian operating system
	DEBIAN OpenInstallationPlatform
	// RedHat Enterprise Linux operating system
	REDHAT OpenInstallationPlatform
	// SUSE operating system
	SUSE OpenInstallationPlatform
	// Ubuntu operating system
	UBUNTU OpenInstallationPlatform
}{

	AMAZON: "AMAZON",

	CENTOS: "CENTOS",

	DEBIAN: "DEBIAN",

	REDHAT: "REDHAT",

	SUSE: "SUSE",

	UBUNTU: "UBUNTU",
}

var OpenInstallationTargetTypeTypes = struct {
	// APM agent installation
	APPLICATION OpenInstallationTargetType
	// Cloud provider installation
	CLOUD OpenInstallationTargetType
	// Docker container installation
	DOCKER OpenInstallationTargetType
	// Bare metal, virtual machine, or host-based installation
	HOST OpenInstallationTargetType
	// Kubernetes installation
	KUBERNETES OpenInstallationTargetType
	// Serverless installation
	SERVERLESS OpenInstallationTargetType
}{

	APPLICATION: "APPLICATION",

	CLOUD: "CLOUD",

	DOCKER: "DOCKER",

	HOST: "HOST",

	KUBERNETES: "KUBERNETES",

	SERVERLESS: "SERVERLESS",
}

Types

type DiscoveryManifest

type DiscoveryManifest struct {
	Hostname        string           `json:"hostname"`
	KernelArch      string           `json:"kernelArch"`
	KernelVersion   string           `json:"kernelVersion"`
	OS              string           `json:"os"`
	Platform        string           `json:"platform"`
	PlatformFamily  string           `json:"platformFamily"`
	PlatformVersion string           `json:"platformVersion"`
	Processes       []GenericProcess `json:"processes"`
}

DiscoveryManifest contains the discovered information about the host.

func (*DiscoveryManifest) AddProcess

func (d *DiscoveryManifest) AddProcess(p GenericProcess)

AddProcess adds a discovered process to the underlying manifest.

type GenericProcess

type GenericProcess interface {
	Name() (string, error)
	PID() int32
}

GenericProcess is an abstracted representation of a process.

type LogMatch

type LogMatch struct {
	Name       string             `yaml:"name"`
	File       string             `yaml:"file"`
	Attributes LogMatchAttributes `yaml:"attributes,omitempty"`
	Pattern    string             `yaml:"pattern,omitempty"`
	Systemd    string             `yaml:"systemd,omitempty"`
}

LogMatch represents a pattern that may match one or more logs on the underlying host.

type LogMatchAttributes

type LogMatchAttributes struct {
	LogType string `yaml:"logtype"`
}

LogMatchAttributes contains metadata about its parent LogMatch.

type NRQL

type NRQL string

NRQL - This scalar represents a NRQL query string.

See the [NRQL Docs](https://docs.newrelic.com/docs/insights/nrql-new-relic-query-language/nrql-resources/nrql-syntax-components-functions) for more information about NRQL syntax.

type OpenInstallationAttributes

type OpenInstallationAttributes struct {
	// Built-in parsing rulesets
	Logtype string `json:"logtype"`
}

OpenInstallationAttributes - Custom event data attributes

type OpenInstallationLogMatch

type OpenInstallationLogMatch struct {
	// List of custom attributes, as key-value pairs, that can be used to send additional data with the logs which you can then query.
	Attributes OpenInstallationAttributes `json:"attributes"`
	// Path to the log file or files.
	File string `json:"file"`
	// Name of the log or logs.
	Name string `json:"name"`
	// Regular expression for filtering records.
	Pattern string `json:"pattern"`
	// Service name (Linux Only).
	Systemd string `json:"systemd"`
}

OpenInstallationLogMatch - Matches partial list of the Log forwarding parameters

type OpenInstallationOperatingSystem

type OpenInstallationOperatingSystem string

OpenInstallationOperatingSystem - Operating System of target environment

type OpenInstallationPlatform

type OpenInstallationPlatform string

OpenInstallationPlatform - Operating System distribution

type OpenInstallationPlatformFamily

type OpenInstallationPlatformFamily string

OpenInstallationPlatformFamily - Operating System distribution family

type OpenInstallationPreInstallConfiguration

type OpenInstallationPreInstallConfiguration struct {
	// Message/Docs notice displayed to user prior to running recipe
	Prompt string `json:"prompt"`
}

OpenInstallationPreInstallConfiguration - Optional pre-install configuration items

type OpenInstallationRecipe

type OpenInstallationRecipe struct {
	// Description of the recipe
	Description string `json:"description"`
	// The full contents of the recipe file (yaml)
	File string `json:"file"`
	// The ID
	ID string `json:"id"`
	// List of variables to prompt for input from the user
	InputVars []OpenInstallationRecipeInputVariable `json:"inputVars"`
	// Object representing the intended install target
	InstallTargets []OpenInstallationRecipeInstallTarget `json:"installTargets"`
	// Tags
	Keywords []string `json:"keywords"`
	// # Partial list of possible Log forwarding parameters
	LogMatch []OpenInstallationLogMatch `json:"logMatch"`
	// Friendly name of the recipe
	Name string `json:"name"`
	// Object representing optional pre-install configuration items
	PreInstall OpenInstallationPreInstallConfiguration `json:"preInstall"`
	// List of process definitions used to match CLI process detection
	ProcessMatch []string `json:"processMatch"`
	// Github repository url
	Repository string `json:"repository"`
	// NRQL the newrelic-cli uses to validate this recipe
	// is successfully sending data to New Relic
	ValidationNRQL NRQL `json:"validationNrql"`
}

OpenInstallationRecipe - Installation instructions and definition of an instrumentation integration

type OpenInstallationRecipeInputVariable

type OpenInstallationRecipeInputVariable struct {
	// Default value of variable
	Default string `json:"default"`
	// Name of the variable
	Name string `json:"name"`
	// Message to present to the user
	Prompt string `json:"prompt"`
	// Indicates a password field
	Secret bool `json:"secret"`
}

OpenInstallationRecipeInputVariable - Recipe input variable prompts displayed to the user prior to execution

type OpenInstallationRecipeInstallTarget

type OpenInstallationRecipeInstallTarget struct {
	// OS kernel architecture
	KernelArch string `json:"kernelArch"`
	// OS kernel version
	KernelVersion string `json:"kernelVersion"`
	// Operating system
	Os OpenInstallationOperatingSystem `json:"os"`
	// Operating System distribution
	Platform OpenInstallationPlatform `json:"platform"`
	// Operating System distribution family
	PlatformFamily OpenInstallationPlatformFamily `json:"platformFamily"`
	// OS distribution version
	PlatformVersion string `json:"platformVersion"`
	// Target type
	Type OpenInstallationTargetType `json:"type"`
}

OpenInstallationRecipeInstallTarget - Matrix of supported installation criteria for this recipe

type OpenInstallationTargetType

type OpenInstallationTargetType string

OpenInstallationTargetType - Installation target type

type Recipe

type Recipe struct {
	ID   string `json:"id"`
	File string `json:"file"`
	Name string `json:"name"`
	// TODO: sort out DisplayName vs Name
	// nolint:govet
	DisplayName    string     `json:"name"`
	Description    string     `json:"description"`
	Repository     string     `json:"repository"`
	Keywords       []string   `json:"keywords"`
	ProcessMatch   []string   `json:"processMatch"`
	LogMatch       []LogMatch `json:"logMatch"`
	ValidationNRQL string     `json:"validationNrql"`
	Vars           map[string]interface{}
}

func (*Recipe) AddVar

func (r *Recipe) AddVar(key string, value interface{})

AddVar is responsible for including a new variable on the recipe Vars struct, which is used by go-task executor.