servicelevel

package
v2.37.1 Latest Latest
Warning

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

 Go to latest Published: Jun 12, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Experimental. For NR internal use only.

Code generated by tutone: DO NOT EDIT

Code generated by tutone: DO NOT EDIT

Index

Constants

View Source 
const ServiceLevelCreateMutation = `` /* 751-byte string literal not displayed */
View Source 
const ServiceLevelDeleteMutation = `` /* 660-byte string literal not displayed */

id optional field manually removed in favor of guid to favor it's deprecation

View Source 
const ServiceLevelUpdateMutation = `` /* 732-byte string literal not displayed */

id optional field manually removed in favor of guid to favor it's deprecation

Variables

View Source 
var ServiceLevelEventsQuerySelectFunctionTypes = struct {
	// Use on events and unaggregated data.
	COUNT ServiceLevelEventsQuerySelectFunction
	// Use on distribution metric types.
	GET_CDF_COUNT ServiceLevelEventsQuerySelectFunction
	// Use in valid events combined with GET_CDF_COUNT.
	GET_FIELD ServiceLevelEventsQuerySelectFunction
	// Use on aggregated counts.
	SUM ServiceLevelEventsQuerySelectFunction
}{

	COUNT: "COUNT",

	GET_CDF_COUNT: "GET_CDF_COUNT",

	GET_FIELD: "GET_FIELD",

	SUM: "SUM",
}
View Source 
var ServiceLevelObjectiveRollingTimeWindowUnitTypes = struct {
	// Day.
	DAY ServiceLevelObjectiveRollingTimeWindowUnit
}{

	DAY: "DAY",
}

Functions

This section is empty.

Types

type Actor 

type Actor struct {
	// Fetch a single entity.
	//
	// For more details on entities, visit our [entity docs](https://docs.newrelic.com/docs/apis/graphql-api/tutorials/use-new-relic-graphql-api-query-entities).
	Entity EntityInterface `json:"entity,omitempty"`
	// The authenticated `User` who made this request.
	User User `json:"user,omitempty"`
}

Actor - The `Actor` object contains fields that are scoped to the API user's access level.

type Entity 

type Entity struct {
	// The New Relic account ID associated with this entity.
	AccountID int `json:"accountId,omitempty"`
	// The entity's domain
	Domain string `json:"domain,omitempty"`
	// The name of this entity.
	Name string `json:"name,omitempty"`
	// The url to the entity.
	Permalink string `json:"permalink,omitempty"`
	// The service level defined for the entity.
	ServiceLevel ServiceLevelDefinition `json:"serviceLevel,omitempty"`
	// The entity's type
	Type string `json:"type,omitempty"`
}

Entity - The `Entity` interface allows fetching detailed entity information for a single entity.

To understand more about entities and entity types, look at [our docs](https://docs.newrelic.com/docs/what-are-new-relic-entities).

type EntityInterface 

type EntityInterface struct {
	// The New Relic account ID associated with this entity.
	AccountID int `json:"accountId,omitempty"`
	// The entity's domain
	Domain string `json:"domain,omitempty"`
	// The name of this entity.
	Name string `json:"name,omitempty"`
	// The url to the entity.
	Permalink string `json:"permalink,omitempty"`
	// The service level defined for the entity.
	ServiceLevel ServiceLevelDefinition `json:"serviceLevel,omitempty"`
	// The entity's type
	Type string `json:"type,omitempty"`
}

type Float 

type Float string

Float - The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_754).

type ID 

type ID string

ID - The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.

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 ServiceLevelCreateQueryResponse 

type ServiceLevelCreateQueryResponse struct {
	ServiceLevelIndicator ServiceLevelIndicator `json:"ServiceLevelCreate"`
}

type ServiceLevelDefinition 

type ServiceLevelDefinition struct {
	// The SLIs attached to the entity.
	Indicators []ServiceLevelIndicator `json:"indicators"`
}

ServiceLevelDefinition - The service level defined for a specific entity.

type ServiceLevelDeleteQueryResponse 

type ServiceLevelDeleteQueryResponse struct {
	ServiceLevelIndicator ServiceLevelIndicator `json:"ServiceLevelDelete"`
}

type ServiceLevelEvents 

type ServiceLevelEvents struct {
	// The New Relic account to fetch the events from.
	Account accounts.AccountReference `json:"account,omitempty"`
	// The definition of bad events.
	BadEvents *ServiceLevelEventsQuery `json:"badEvents,omitempty"`
	// The definition of good events.
	GoodEvents *ServiceLevelEventsQuery `json:"goodEvents,omitempty"`
	// The definition of valid events.
	ValidEvents *ServiceLevelEventsQuery `json:"validEvents"`
}

ServiceLevelEvents - The events that define the SLI.

type ServiceLevelEventsCreateInput 

type ServiceLevelEventsCreateInput struct {
	// The New Relic account ID where the events are fetched from.
	AccountID int `json:"accountId"`
	// The definition of bad events.
	BadEvents *ServiceLevelEventsQueryCreateInput `json:"badEvents,omitempty"`
	// The definition of good events.
	GoodEvents *ServiceLevelEventsQueryCreateInput `json:"goodEvents,omitempty"`
	// The definition of valid events.
	ValidEvents *ServiceLevelEventsQueryCreateInput `json:"validEvents,omitempty"`
}

ServiceLevelEventsCreateInput - The events that define the SLI.

type ServiceLevelEventsQuery 

type ServiceLevelEventsQuery struct {
	// The NRDB event to fetch the data from.
	From NRQL `json:"from"`
	// The NRQL SELECT clause to aggregate events.
	Select ServiceLevelEventsQuerySelect `json:"select,omitempty"`
	// The NRQL condition to filter the events.
	Where NRQL `json:"where,omitempty"`
}

ServiceLevelEventsQuery - The query that represents the events to fetch.

type ServiceLevelEventsQueryCreateInput 

type ServiceLevelEventsQueryCreateInput struct {
	// The NRDB event to fetch the data from.
	From NRQL `json:"from"`
	// The NRQL SELECT clause to aggregate events. Default is COUNT(*).
	Select *ServiceLevelEventsQuerySelectCreateInput `json:"select,omitempty"`
	// The NRQL condition to filter the events.
	Where NRQL `json:"where,omitempty"`
}

ServiceLevelEventsQueryCreateInput - The query that represents the events to fetch.

type ServiceLevelEventsQuerySelect 

type ServiceLevelEventsQuerySelect struct {
	// The attribute used in the selected function.
	Attribute string `json:"attribute,omitempty"`
	// The function to use in the SELECT clause.
	Function ServiceLevelEventsQuerySelectFunction `json:"function"`
	// The threshold used in the selected function.
	Threshold float64 `json:"threshold,omitempty"`
}

ServiceLevelEventsQuerySelect - The resulting NRQL SELECT clause to aggregate events.

type ServiceLevelEventsQuerySelectCreateInput 

type ServiceLevelEventsQuerySelectCreateInput struct {
	// The attribute used in the selected function. Only use it in combination with the SUM, GET_FIELD and GET_CDF_COUNT functions.
	Attribute string `json:"attribute,omitempty"`
	// The function to use in the SELECT clause.
	Function ServiceLevelEventsQuerySelectFunction `json:"function"`
	// The threshold used in the selected function. Only use it in combination with the GET_CDF_COUNT function.
	Threshold float64 `json:"threshold,omitempty"`
}

ServiceLevelEventsQuerySelectCreateInput - The NRQL SELECT clause to aggregate events.

type ServiceLevelEventsQuerySelectFunction 

type ServiceLevelEventsQuerySelectFunction string

ServiceLevelEventsQuerySelectFunction - The function to use in the SELECT clause.

type ServiceLevelEventsQuerySelectUpdateInput 

type ServiceLevelEventsQuerySelectUpdateInput struct {
	// The attribute used in the selected function. Only use it in combination with the SUM, GET_FIELD and GET_CDF_COUNT functions.
	Attribute string `json:"attribute,omitempty"`
	// The function to use in the SELECT clause.
	Function ServiceLevelEventsQuerySelectFunction `json:"function"`
	// The threshold used in the selected function. Only use it in combination with the GET_CDF_COUNT function.
	Threshold float64 `json:"threshold,omitempty"`
}

ServiceLevelEventsQuerySelectUpdateInput - The NRQL SELECT clause to aggregate events.

type ServiceLevelEventsQueryUpdateInput 

type ServiceLevelEventsQueryUpdateInput struct {
	// The NRDB event to fetch the data from.
	From NRQL `json:"from"`
	// The NRQL SELECT clause to aggregate events. Default is COUNT(*).
	Select *ServiceLevelEventsQuerySelectUpdateInput `json:"select,omitempty"`
	// The NRQL condition to filter the events.
	Where NRQL `json:"where,omitempty"`
}

ServiceLevelEventsQueryUpdateInput - The query that represents the events to fetch.

type ServiceLevelEventsUpdateInput 

type ServiceLevelEventsUpdateInput struct {
	// The definition of bad events.
	BadEvents *ServiceLevelEventsQueryUpdateInput `json:"badEvents,omitempty"`
	// The definition of good events.
	GoodEvents *ServiceLevelEventsQueryUpdateInput `json:"goodEvents,omitempty"`
	// The definition of valid events.
	ValidEvents *ServiceLevelEventsQueryUpdateInput `json:"validEvents,omitempty"`
}

ServiceLevelEventsUpdateInput - The events that define the SLI.

type ServiceLevelIndicator 

type ServiceLevelIndicator struct {
	// The date when the SLI was created represented in the number of milliseconds since the Unix epoch.
	CreatedAt *nrtime.EpochMilliseconds `json:"createdAt"`
	// The user who created the SLI.
	CreatedBy UserReference `json:"createdBy,omitempty"`
	// The description of the SLI.
	Description string `json:"description,omitempty"`
	// The entity which the SLI is attached to.
	EntityGUID common.EntityGUID `json:"entityGuid"`
	// The events that define the SLI.
	Events ServiceLevelEvents `json:"events"`
	// The unique entity identifier of the SLI.
	GUID common.EntityGUID `json:"guid"`
	// The unique identifier of the SLI.
	ID string `json:"id"`
	// The name of the SLI.
	Name string `json:"name"`
	// A list of objective definitions.
	Objectives []ServiceLevelObjective `json:"objectives"`
	// The date when the SLI was last updated represented in the number of milliseconds since the Unix epoch.
	UpdatedAt *nrtime.EpochMilliseconds `json:"updatedAt,omitempty"`
	// The user who last update the SLI.
	UpdatedBy UserReference `json:"updatedBy,omitempty"`
}

ServiceLevelIndicator - The definition of the SLI.

type ServiceLevelIndicatorCreateInput 

type ServiceLevelIndicatorCreateInput struct {
	// The description of the SLI.
	Description string `json:"description,omitempty"`
	// The events that define the SLI.
	Events ServiceLevelEventsCreateInput `json:"events,omitempty"`
	// The name of the SLI.
	Name string `json:"name"`
	// A list of objective definitions.
	Objectives []ServiceLevelObjectiveCreateInput `json:"objectives,omitempty"`
}

ServiceLevelIndicatorCreateInput - The input object that represents the SLI that will be created.

type ServiceLevelIndicatorResultQueries 

type ServiceLevelIndicatorResultQueries struct {
	// The NRQL query that measures the good events.
	GoodEvents ServiceLevelResultQuery `json:"goodEvents"`
	// The NRQL query that measures the value of the SLI.
	Indicator ServiceLevelResultQuery `json:"indicator"`
	// The NRQL query that measures the valid events.
	ValidEvents ServiceLevelResultQuery `json:"validEvents"`
}

ServiceLevelIndicatorResultQueries - The resulting NRQL queries that help consume the metrics of the SLI.

type ServiceLevelIndicatorUpdateInput 

type ServiceLevelIndicatorUpdateInput struct {
	// The description of the SLI.
	Description string `json:"description,omitempty"`
	// The events that define the SLI.
	Events *ServiceLevelEventsUpdateInput `json:"events,omitempty"`
	// The name of the SLI.
	Name string `json:"name,omitempty"`
	// A list of objective definitions.
	Objectives []ServiceLevelObjectiveUpdateInput `json:"objectives,omitempty"`
}

ServiceLevelIndicatorUpdateInput - The input object that represents the SLI that will be updated.

type ServiceLevelObjective 

type ServiceLevelObjective struct {
	// The description of the SLO.
	Description string `json:"description,omitempty"`
	// The name of the SLO.
	Name string `json:"name,omitempty"`
	// The target percentage of the SLO.
	Target float64 `json:"target"`
	// The time window configuration of the SLO.
	TimeWindow ServiceLevelObjectiveTimeWindow `json:"timeWindow"`
}

ServiceLevelObjective - An objective definition.

type ServiceLevelObjectiveCreateInput 

type ServiceLevelObjectiveCreateInput struct {
	// The description of the SLO.
	Description string `json:"description,omitempty"`
	// The name of the SLO.
	Name string `json:"name,omitempty"`
	// The target percentage of the SLO. Maximum value is 100.
	Target float64 `json:"target"`
	// The time window configuration of the SLO.
	TimeWindow ServiceLevelObjectiveTimeWindowCreateInput `json:"timeWindow,omitempty"`
}

ServiceLevelObjectiveCreateInput - The input object that represents an objective definition.

type ServiceLevelObjectiveResultQueries 

type ServiceLevelObjectiveResultQueries struct {
	// The NRQL query that measures the attainment of the SLO target.
	Attainment ServiceLevelResultQuery `json:"attainment"`
}

ServiceLevelObjectiveResultQueries - The resulting NRQL queries that help consume the metrics of the SLO.

type ServiceLevelObjectiveRollingTimeWindow 

type ServiceLevelObjectiveRollingTimeWindow struct {
	// The count of time units.
	Count int `json:"count"`
	// The time unit.
	Unit ServiceLevelObjectiveRollingTimeWindowUnit `json:"unit"`
}

ServiceLevelObjectiveRollingTimeWindow - The rolling time window configuration of the SLO.

type ServiceLevelObjectiveRollingTimeWindowCreateInput 

type ServiceLevelObjectiveRollingTimeWindowCreateInput struct {
	// The count of time units. Accepted values are 1, 7 and 28 days.
	Count int `json:"count"`
	// The time unit.
	Unit ServiceLevelObjectiveRollingTimeWindowUnit `json:"unit"`
}

ServiceLevelObjectiveRollingTimeWindowCreateInput - The rolling time window configuration of the SLO.

type ServiceLevelObjectiveRollingTimeWindowUnit 

type ServiceLevelObjectiveRollingTimeWindowUnit string

ServiceLevelObjectiveRollingTimeWindowUnit - The rolling time window units.

type ServiceLevelObjectiveRollingTimeWindowUpdateInput 

type ServiceLevelObjectiveRollingTimeWindowUpdateInput struct {
	// The count of time units. Accepted values are 1, 7 and 28 days.
	Count int `json:"count"`
	// The time unit.
	Unit ServiceLevelObjectiveRollingTimeWindowUnit `json:"unit"`
}

ServiceLevelObjectiveRollingTimeWindowUpdateInput - The rolling time window configuration of the SLO.

type ServiceLevelObjectiveTimeWindow 

type ServiceLevelObjectiveTimeWindow struct {
	// The rolling time window configuration of the SLO.
	Rolling ServiceLevelObjectiveRollingTimeWindow `json:"rolling,omitempty"`
}

ServiceLevelObjectiveTimeWindow - The time window configuration of the SLO.

type ServiceLevelObjectiveTimeWindowCreateInput 

type ServiceLevelObjectiveTimeWindowCreateInput struct {
	// The rolling time window configuration of the SLO.
	Rolling ServiceLevelObjectiveRollingTimeWindowCreateInput `json:"rolling,omitempty"`
}

ServiceLevelObjectiveTimeWindowCreateInput - The time window configuration of the SLO.

type ServiceLevelObjectiveTimeWindowUpdateInput 

type ServiceLevelObjectiveTimeWindowUpdateInput struct {
	// The rolling time window configuration of the SLO.
	Rolling ServiceLevelObjectiveRollingTimeWindowUpdateInput `json:"rolling,omitempty"`
}

ServiceLevelObjectiveTimeWindowUpdateInput - The time window configuration of the SLO.

type ServiceLevelObjectiveUpdateInput 

type ServiceLevelObjectiveUpdateInput struct {
	// The description of the SLO.
	Description string `json:"description,omitempty"`
	// The name of the SLO.
	Name string `json:"name,omitempty"`
	// The target percentage of the SLO. Maximum value is 100.
	Target float64 `json:"target"`
	// The time window configuration of the SLO.
	TimeWindow ServiceLevelObjectiveTimeWindowUpdateInput `json:"timeWindow,omitempty"`
}

ServiceLevelObjectiveUpdateInput - The input object that represents an objective definition.

type ServiceLevelResultQuery 

type ServiceLevelResultQuery struct {
	// A NRQL query.
	NRQL NRQL `json:"nrql"`
}

ServiceLevelResultQuery - A resulting query.

type ServiceLevelUpdateQueryResponse 

type ServiceLevelUpdateQueryResponse struct {
	ServiceLevelIndicator ServiceLevelIndicator `json:"ServiceLevelUpdate"`
}

type Servicelevel 

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

func New 

func New(config config.Config) Servicelevel

func (*Servicelevel) GetIndicators 

func (a *Servicelevel) GetIndicators(
	entityGUID common.EntityGUID,
) (*[]ServiceLevelIndicator, error)

The SLIs attached to the entity.

func (*Servicelevel) GetIndicatorsWithContext 

func (a *Servicelevel) GetIndicatorsWithContext(
	ctx context.Context,
	entityGUID common.EntityGUID,
) (*[]ServiceLevelIndicator, error)

The SLIs attached to the entity.

func (*Servicelevel) ServiceLevelCreate 

func (a *Servicelevel) ServiceLevelCreate(
	entityGUID common.EntityGUID,
	indicator ServiceLevelIndicatorCreateInput,
) (*ServiceLevelIndicator, error)

Creates a new SLI.

func (*Servicelevel) ServiceLevelCreateWithContext 

func (a *Servicelevel) ServiceLevelCreateWithContext(
	ctx context.Context,
	entityGUID common.EntityGUID,
	indicator ServiceLevelIndicatorCreateInput,
) (*ServiceLevelIndicator, error)

Creates a new SLI.

func (*Servicelevel) ServiceLevelDelete 

func (a *Servicelevel) ServiceLevelDelete(
	gUID common.EntityGUID,
) (*ServiceLevelIndicator, error)

Deletes an existing SLI by the GUID. iD optional field manually removed in favor of gUID to favor it's deprecation

func (*Servicelevel) ServiceLevelDeleteWithContext 

func (a *Servicelevel) ServiceLevelDeleteWithContext(
	ctx context.Context,
	gUID common.EntityGUID,
) (*ServiceLevelIndicator, error)

Deletes an existing SLI by the GUID. iD optional field manually removed in favor of gUID to favor it's deprecation

func (*Servicelevel) ServiceLevelUpdate 

func (a *Servicelevel) ServiceLevelUpdate(
	gUID common.EntityGUID,
	indicator ServiceLevelIndicatorUpdateInput,
) (*ServiceLevelIndicator, error)

Updates an existing SLI by the GUID. iD optional field manually removed in favor of gUID to favor it's deprecation

func (*Servicelevel) ServiceLevelUpdateWithContext 

func (a *Servicelevel) ServiceLevelUpdateWithContext(
	ctx context.Context,
	gUID common.EntityGUID,
	indicator ServiceLevelIndicatorUpdateInput,
) (*ServiceLevelIndicator, error)

Updates an existing SLI by the GUID. iD optional field manually removed in favor of gUID to favor it's deprecation

type User added in v2.17.0 

type User struct {
	//
	Email string `json:"email,omitempty"`
	//
	ID int `json:"id,omitempty"`
	//
	Name string `json:"name,omitempty"`
}

User - The `User` object provides general data about the user.

type UserReference 

type UserReference struct {
	//
	Email string `json:"email,omitempty"`
	//
	Gravatar string `json:"gravatar,omitempty"`
	//
	ID int `json:"id,omitempty"`
	//
	Name string `json:"name,omitempty"`
}

UserReference - The `UserReference` object provides basic identifying information about the user.

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.