changetracking

Documentation

Overview

Code generated by tutone: DO NOT EDIT

Code generated by tutone: DO NOT EDIT

Index

• Constants
• Variables
• type ChangeTrackingCreateDeploymentQueryResponse
• type ChangeTrackingDataHandlingRules
• type ChangeTrackingDeployment
• type ChangeTrackingDeploymentInput
• type ChangeTrackingDeploymentType
• type ChangeTrackingRawCustomAttributesMap
• type ChangeTrackingValidationFlag
• type Changetracking
  • func New(config config.Config) Changetracking
  • func (a *Changetracking) ChangeTrackingCreateDeployment(dataHandlingRules ChangeTrackingDataHandlingRules, ...) (*ChangeTrackingDeployment, error)
  • func (a *Changetracking) ChangeTrackingCreateDeploymentWithContext(ctx context.Context, dataHandlingRules ChangeTrackingDataHandlingRules, ...) (*ChangeTrackingDeployment, error)

Constants

const ChangeTrackingCreateDeploymentMutation = `` /* 338-byte string literal not displayed */

Variables

var ChangeTrackingDeploymentTypeTypes = struct {
	// A vanilla deployment
	BASIC ChangeTrackingDeploymentType
	// Blue-green deployment
	BLUE_GREEN ChangeTrackingDeploymentType
	// Canary deployment
	CANARY ChangeTrackingDeploymentType
	// Other types of deployment.
	OTHER ChangeTrackingDeploymentType
	// Rolling deployment.
	ROLLING ChangeTrackingDeploymentType
	// Shadow deployment
	SHADOW ChangeTrackingDeploymentType
}{

	BASIC: "BASIC",

	BLUE_GREEN: "BLUE_GREEN",

	CANARY: "CANARY",

	OTHER: "OTHER",

	ROLLING: "ROLLING",

	SHADOW: "SHADOW",
}

var ChangeTrackingValidationFlagTypes = struct {
	// Will validate all string fields to be within max size limit. An error is returned and data is not saved if any of the fields exceeds max size limit.
	FAIL_ON_FIELD_LENGTH ChangeTrackingValidationFlag
	// For APM entities, a call is made to the legacy New Relic v2 REST API. When this flag is set, if the call fails for any reason, an error will be returned containing the failure message.
	FAIL_ON_REST_API_FAILURES ChangeTrackingValidationFlag
}{

	FAIL_ON_FIELD_LENGTH: "FAIL_ON_FIELD_LENGTH",

	FAIL_ON_REST_API_FAILURES: "FAIL_ON_REST_API_FAILURES",
}

Types

type ChangeTrackingCreateDeploymentQueryResponse

type ChangeTrackingCreateDeploymentQueryResponse struct {
	ChangeTrackingDeployment ChangeTrackingDeployment `json:"ChangeTrackingCreateDeployment"`
}

type ChangeTrackingDataHandlingRules

type ChangeTrackingDataHandlingRules struct {
	// Flags for validation, for example, ‘FAIL_ON_FIELD_LENGTH’.
	ValidationFlags []ChangeTrackingValidationFlag `json:"validationFlags"`
}

ChangeTrackingDataHandlingRules - Validation and data handling rules to be applied to deployment input data.

type ChangeTrackingDeployment

type ChangeTrackingDeployment struct {
	// A URL to the changelog or, if not linkable, a list of changes.
	Changelog string `json:"changelog,omitempty"`
	// The commit identifier, for example, a Git commit SHA.
	Commit string `json:"commit,omitempty"`
	// Represents key-value pairs of custom attributes in JSON format.
	CustomAttributes ChangeTrackingRawCustomAttributesMap `json:"customAttributes,omitempty"`
	// A link to the system that generated the deployment.
	DeepLink string `json:"deepLink,omitempty"`
	// A unique deployment identifier.
	DeploymentId string `json:"deploymentId,omitempty"`
	// The type of deployment, for example, ‘Blue green’ or ‘Rolling’.
	DeploymentType ChangeTrackingDeploymentType `json:"deploymentType,omitempty"`
	// A description of the deployment.
	Description string `json:"description,omitempty"`
	// The NR entity that was deployed.
	EntityGUID common.EntityGUID `json:"entityGuid"`
	// An identifier used to correlate two or more events.
	GroupId string `json:"groupId,omitempty"`
	// The start time of the deployment as the number of milliseconds since the Unix epoch.
	Timestamp nrtime.EpochMilliseconds `json:"timestamp"`
	// The username of the deployer or bot.
	User string `json:"user,omitempty"`
	// The version of the deployed software, for example, something like v1.1.
	Version string `json:"version"`
}

ChangeTrackingDeployment - A deployment.

type ChangeTrackingDeploymentInput

type ChangeTrackingDeploymentInput struct {
	// A URL for the changelog or, if not linkable, a list of changes.
	Changelog string `json:"changelog,omitempty"`
	// The commit identifier, for example, a Git commit SHA.
	Commit string `json:"commit,omitempty"`
	// Represents key-value pairs of custom attributes in JSON format. Attribute values can be of type string, boolean, or numeric.
	//
	// **Restricted attributes names:**  accountId, appID, changelog, commit, customAttributes, deepLink, deploymentType, description, entity.guid, entity.name, entity.type, entityGuid, entityName, eventType, groupId, timestamp, user, version
	//
	// **Restricted attribute name prefixes:**  'nr.', 'newrelic.'
	//
	// For more information on limitations, see [our docs](https://docs.newrelic.com/docs/change-tracking/change-tracking-graphql/)
	//
	// **Examples:**
	//
	//     • {cloudVendor : "vendorName", region : "us-east-1", environment : "staging"}
	//     • {isProd : true, region : "us-east-1", instances: 2, deployTime : 10.5}
	CustomAttributes ChangeTrackingRawCustomAttributesMap `json:"customAttributes,omitempty"`
	// A URL to the system that generated the deployment.
	DeepLink string `json:"deepLink,omitempty"`
	// The type of deployment, for example, ‘Blue green’ or ‘Rolling’.
	DeploymentType ChangeTrackingDeploymentType `json:"deploymentType,omitempty"`
	// A description of the deployment.
	Description string `json:"description,omitempty"`
	// The NR entity that was deployed.
	EntityGUID common.EntityGUID `json:"entityGuid"`
	// An identifier used to correlate two or more events.
	GroupId string `json:"groupId,omitempty"`
	// The start time of the deployment as the number of milliseconds since the Unix epoch. Should be within the boundary of the past or future 24 hours. Defaults to now.
	Timestamp nrtime.EpochMilliseconds `json:"timestamp,omitempty"`
	// The username of the deployer or bot.
	User string `json:"user,omitempty"`
	// The version of the deployed software, for example, something like v1.1
	Version string `json:"version"`
}

ChangeTrackingDeploymentInput - A deployment.

type ChangeTrackingDeploymentType

type ChangeTrackingDeploymentType string

ChangeTrackingDeploymentType - Type of deployment.

type ChangeTrackingRawCustomAttributesMap

type ChangeTrackingRawCustomAttributesMap map[string]interface{}

ChangeTrackingRawCustomAttributesMap - A JSON scalar

type ChangeTrackingValidationFlag

type ChangeTrackingValidationFlag string

ChangeTrackingValidationFlag - Validation flags to determine how we handle input data.

type Changetracking

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

func New

func New(config config.Config) Changetracking

func (*Changetracking) ChangeTrackingCreateDeployment

func (a *Changetracking) ChangeTrackingCreateDeployment(
	dataHandlingRules ChangeTrackingDataHandlingRules,
	deployment ChangeTrackingDeploymentInput,
) (*ChangeTrackingDeployment, error)

Creates a new deployment record in NRDB and its associated deployment marker.

func (*Changetracking) ChangeTrackingCreateDeploymentWithContext

func (a *Changetracking) ChangeTrackingCreateDeploymentWithContext(
	ctx context.Context,
	dataHandlingRules ChangeTrackingDataHandlingRules,
	deployment ChangeTrackingDeploymentInput,
) (*ChangeTrackingDeployment, error)

Creates a new deployment record in NRDB and its associated deployment marker.