web

Documentation

Index

• Variables
• type CalculatedWebMetric
  • func (me *CalculatedWebMetric) MarshalHCL(properties hcl.Properties) error
  • func (me *CalculatedWebMetric) Schema() map[string]*schema.Schema
  • func (me *CalculatedWebMetric) UnmarshalHCL(decoder hcl.Decoder) error
• type Dimension
  • func (me *Dimension) MarshalHCL(properties hcl.Properties) error
  • func (me *Dimension) Schema() map[string]*schema.Schema
  • func (me *Dimension) UnmarshalHCL(decoder hcl.Decoder) error
• type Dimensions
  • func (me Dimensions) MarshalHCL(properties hcl.Properties) error
  • func (me *Dimensions) Schema() map[string]*schema.Schema
  • func (me *Dimensions) UnmarshalHCL(decoder hcl.Decoder) error
• type MatchType
• type Metric
• type MetricDefinition
  • func (me *MetricDefinition) MarshalHCL(properties hcl.Properties) error
  • func (me *MetricDefinition) Schema() map[string]*schema.Schema
  • func (me *MetricDefinition) UnmarshalHCL(decoder hcl.Decoder) error
• type MetricDimension
• type UserActionFilter
  • func (me *UserActionFilter) MarshalHCL(properties hcl.Properties) error
  • func (me *UserActionFilter) Schema() map[string]*schema.Schema
  • func (me *UserActionFilter) UnmarshalHCL(decoder hcl.Decoder) error
• type UserActionProperties
  • func (me UserActionProperties) MarshalHCL(properties hcl.Properties) error
  • func (me *UserActionProperties) Schema() map[string]*schema.Schema
  • func (me *UserActionProperties) UnmarshalHCL(decoder hcl.Decoder) error
• type UserActionProperty
  • func (me *UserActionProperty) MarshalHCL(properties hcl.Properties) error
  • func (me *UserActionProperty) Schema() map[string]*schema.Schema
  • func (me *UserActionProperty) UnmarshalHCL(decoder hcl.Decoder) error

Variables

var MatchTypes = struct {
	Contains MatchType
	Equals   MatchType
}{
	"Contains",
	"Equals",
}

var MetricDimensions = struct {
	ApdexType      MetricDimension
	Browser        MetricDimension
	ErrorContext   MetricDimension
	ErrorOrigin    MetricDimension
	ErrorType      MetricDimension
	GeoLocation    MetricDimension
	StringProperty MetricDimension
	UserActionType MetricDimension
}{
	"ApdexType",
	"Browser",
	"ErrorContext",
	"ErrorOrigin",
	"ErrorType",
	"GeoLocation",
	"StringProperty",
	"UserActionType",
}

var Metrics = struct {
	Apdex                  Metric
	ApplicationCache       Metric
	Callback               Metric
	CumulativeLayoutShift  Metric
	DNSLookup              Metric
	DOMComplete            Metric
	DOMContentLoaded       Metric
	DOMInteractive         Metric
	DoubleProperty         Metric
	ErrorCount             Metric
	FirstContentfulPaint   Metric
	FirstInputDelay        Metric
	FirstInputStart        Metric
	FirstPaint             Metric
	HTMLDownloaded         Metric
	LargestContentfulPaint Metric
	LoadEventEnd           Metric
	LoadEventStart         Metric
	LongProperty           Metric
	LongTasksTime          Metric
	NavigationStart        Metric
	OnDOMContentLoaded     Metric
	OnLoad                 Metric
	Processing             Metric
	RedirectTime           Metric
	Request                Metric
	RequestStart           Metric
	Response               Metric
	SecureConnect          Metric
	SpeedIndex             Metric
	TCPConnect             Metric
	TimeToFirstByte        Metric
	UserActionDuration     Metric
	VisuallyComplete       Metric
}{
	"Apdex",
	"ApplicationCache",
	"Callback",
	"CumulativeLayoutShift",
	"DNSLookup",
	"DOMComplete",
	"DOMContentLoaded",
	"DOMInteractive",
	"DoubleProperty",
	"ErrorCount",
	"FirstContentfulPaint",
	"FirstInputDelay",
	"FirstInputStart",
	"FirstPaint",
	"HTMLDownloaded",
	"LargestContentfulPaint",
	"LoadEventEnd",
	"LoadEventStart",
	"LongProperty",
	"LongTasksTime",
	"NavigationStart",
	"OnDOMContentLoaded",
	"OnLoad",
	"Processing",
	"RedirectTime",
	"Request",
	"RequestStart",
	"Response",
	"SecureConnect",
	"SpeedIndex",
	"TCPConnect",
	"TimeToFirstByte",
	"UserActionDuration",
	"VisuallyComplete",
}

Metrics offers the known enum values

Types

type CalculatedWebMetric

type CalculatedWebMetric struct {
	Description      *string           `json:"description,omitempty"`      // Descriptor of a calculated web metric.
	AppIdentifier    string            `json:"applicationIdentifier"`      // The Dynatrace entity ID of the application to which the metric belongs.
	Name             string            `json:"name"`                       // The displayed name of the metric.
	MetricKey        string            `json:"metricKey"`                  // The unique key of the calculated web metric.
	Enabled          bool              `json:"enabled"`                    // The metric is enabled (`true`) or disabled (`false`).
	MetricDefinition *MetricDefinition `json:"metricDefinition"`           // The definition of a calculated web metric.
	Dimensions       Dimensions        `json:"dimensions,omitempty"`       // Parameters of a definition of a calculated web metric.
	UserActionFilter *UserActionFilter `json:"userActionFilter,omitempty"` // User actions filter of the calculated web application metric. Only user actions matching the provided criteria are used for metric calculation. A user action must match all the criteria.
}

CalculatedWebMetric Descriptor of a calculated web metric.

func (*CalculatedWebMetric) MarshalHCL

func (me *CalculatedWebMetric) MarshalHCL(properties hcl.Properties) error

func (*CalculatedWebMetric) Schema

func (me *CalculatedWebMetric) Schema() map[string]*schema.Schema

func (*CalculatedWebMetric) UnmarshalHCL

func (me *CalculatedWebMetric) UnmarshalHCL(decoder hcl.Decoder) error

type Dimension

type Dimension struct {
	TopX        int32           `json:"topX"`                  // The number of top values to be calculated.
	Dimension   MetricDimension `json:"dimension"`             // The dimension of the metric. Possible values are `ApdexType`, `Browser`, `ErrorContext`, `ErrorOrigin`, `ErrorType`, `GeoLocation`, `StringProperty`, `UserActionType`
	PropertyKey *string         `json:"propertyKey,omitempty"` // The key of the user action property. Only applicable for the StringProperty dimension.
}

Dimensions Parameters of a definition of a calculated web metric.

func (*Dimension) MarshalHCL

func (me *Dimension) MarshalHCL(properties hcl.Properties) error

func (*Dimension) Schema

func (me *Dimension) Schema() map[string]*schema.Schema

func (*Dimension) UnmarshalHCL

func (me *Dimension) UnmarshalHCL(decoder hcl.Decoder) error

type Dimensions

type Dimensions []*Dimension

func (Dimensions) MarshalHCL

func (me Dimensions) MarshalHCL(properties hcl.Properties) error

func (*Dimensions) Schema

func (me *Dimensions) Schema() map[string]*schema.Schema

func (*Dimensions) UnmarshalHCL

func (me *Dimensions) UnmarshalHCL(decoder hcl.Decoder) error

type MatchType

type MatchType string

type Metric

type Metric string

Metric The metric to be captured.

type MetricDefinition

type MetricDefinition struct {
	Metric      Metric  `json:"metric"`                // The type of the web application metric
	PropertyKey *string `json:"propertyKey,omitempty"` // The key of the user action property. Only applicable for DoubleProperty and LongProperty metrics.
}

dMetricDefinition The definition of a calculated web metric.

func (*MetricDefinition) MarshalHCL

func (me *MetricDefinition) MarshalHCL(properties hcl.Properties) error

func (*MetricDefinition) Schema

func (me *MetricDefinition) Schema() map[string]*schema.Schema

func (*MetricDefinition) UnmarshalHCL

func (me *MetricDefinition) UnmarshalHCL(decoder hcl.Decoder) error

type MetricDimension

type MetricDimension string

type UserActionFilter

type UserActionFilter struct {
	ActionDurationFromMilliseconds *int                  `json:"actionDurationFromMilliseconds,omitempty"` // Only actions with a duration more than or equal to this value (in milliseconds) are included in the metric calculation.
	ActionDurationToMilliseconds   *int                  `json:"actionDurationToMilliseconds,omitempty"`   // Only actions with a duration less than or equal to this value (in milliseconds) are included in the metric calculation.
	LoadAction                     *bool                 `json:"loadAction,omitempty"`                     // The status of load actions in the metric calculation: `true` or `false`
	XHRAction                      *bool                 `json:"xhrAction,omitempty"`                      // The status of xhr actions in the metric calculation: `true` or `false`
	XHRRouteChangeAction           *bool                 `json:"xhrRouteChangeAction,omitempty"`           // The status of route actions in the metric calculation: `true` or `false`
	CustomAction                   *bool                 `json:"customAction,omitempty"`                   // The status of custom actions in the metric calculation: `true` or `false`
	Apdex                          *string               `json:"apdex,omitempty"`                          // Only actions with the specified Apdex score are included in the metric calculation. Possible values: [ Frustrated, Satisfied, Tolerating, Unknown ]
	Domain                         *string               `json:"domain,omitempty"`                         // Only user actions coming from the specified domain are included in the metric calculation.
	UserActionName                 *string               `json:"userActionName,omitempty"`                 // Only actions with this name are included in the metric calculation.
	RealUser                       *bool                 `json:"realUser,omitempty"`                       // The status of actions coming from real users in the metric calculation: `true` or `false`
	Robot                          *bool                 `json:"robot,omitempty"`                          // The status of actions coming from robots in the metric calculation: `true` or `false`
	Synthetic                      *bool                 `json:"synthetic,omitempty"`                      // The status of actions coming from synthetic monitors in the metric calculation: `true` or `false`
	BrowserFamily                  *string               `json:"browserFamily,omitempty"`                  // Only user actions coming from the specified browser family are included in the metric calculation.
	BrowserType                    *string               `json:"browserType,omitempty"`                    // Only user actions coming from the specified browser type are included in the metric calculation.
	BrowserVersion                 *string               `json:"browserVersion,omitempty"`                 // Only user actions coming from the specified browser version are included in the metric calculation.
	HasCustomErrors                *bool                 `json:"hasCustomErrors,omitempty"`                // The custom error status of the actions to be included in the metric calculation: `true` or `false`
	HasAnyError                    *bool                 `json:"hasAnyError,omitempty"`                    // The error status of the actions to be included in the metric calculation: `true` or `false`
	HasHttpErrors                  *bool                 `json:"hasHttpErrors,omitempty"`                  // The request error status of the actions to be included in the metric calculation: `true` or `false`
	HasJavascriptErrors            *bool                 `json:"hasJavascriptErrors,omitempty"`            // The JavaScript error status of the actions to be included in the metric calculation: `true` or `false`
	City                           *string               `json:"city,omitempty"`                           // Only actions of users from this city are included in the metric calculation. Specify geolocation ID here.
	Continent                      *string               `json:"continent,omitempty"`                      // Only actions of users from this continent are included in the metric calculation. Specify geolocation ID here.
	Country                        *string               `json:"country,omitempty"`                        // Only actions of users from this country are included in the metric calculation. Specify geolocation ID here.
	Region                         *string               `json:"region,omitempty"`                         // Only actions of users from this region are included in the metric calculation. Specify geolocation ID here.
	IP                             *string               `json:"ip,omitempty"`                             // Only actions coming from this IP address are included in the metric calculation.
	IPV6Traffic                    *bool                 `json:"ipV6Traffic,omitempty"`                    // The IPv6 status of the actions to be included in the metric calculation: `true` or `false`
	OSFamily                       *string               `json:"osFamily,omitempty"`                       // Only actions coming from this OS family are included in the metric calculation.
	OSVersion                      *string               `json:"osVersion,omitempty"`                      // Only actions coming from this OS version are included in the metric calculation.
	HTTPErrorCode                  *int                  `json:"httpErrorCode,omitempty"`                  // The HTTP error status code of the actions to be included in the metric calculation.
	HTTPErrorCodeTo                *int                  `json:"httpErrorCodeTo,omitempty"`                // Can be used in combination with httpErrorCode to define a range of error codes that will be included in the metric calculation.
	HTTPPath                       *string               `json:"httpPath,omitempty"`                       // The request path that has been determined to be the origin of an HTTP error of the actions to be included in the metric calculation.
	CustomErrorType                *string               `json:"customErrorType,omitempty"`                // The custom error type of the actions to be included in the metric calculation.
	CustomErrorName                *string               `json:"customErrorName,omitempty"`                // The custom error name of the actions to be included in the metric calculation.
	UserActionProperties           *UserActionProperties `json:"userActionProperties,omitempty"`           // Only actions with the specified properties are included in the metric calculation.
	TargetViewName                 *string               `json:"targetViewName,omitempty"`                 // Only actions on the specified view are included in the metric calculation.
	TargetViewNameMatchType        *string               `json:"targetViewNameMatchType,omitempty"`        // Specifies the match type of the view name filter, e.g. using Contains or Equals. Defaults to Equals.
	TargetViewGroup                *string               `json:"targetViewGroup,omitempty"`                // Only actions on the specified group of views are included in the metric calculation.
	TargetViewGroupNameMatchType   *string               `json:"targetViewGroupNameMatchType,omitempty"`   // Specifies the match type of the view group filter, e.g. using Contains or Equals. Defaults to Equals.
}

User action filter of a calculated web metric.

func (*UserActionFilter) MarshalHCL

func (me *UserActionFilter) MarshalHCL(properties hcl.Properties) error

func (*UserActionFilter) Schema

func (me *UserActionFilter) Schema() map[string]*schema.Schema

func (*UserActionFilter) UnmarshalHCL

func (me *UserActionFilter) UnmarshalHCL(decoder hcl.Decoder) error

type UserActionProperties

type UserActionProperties []*UserActionProperty

func (UserActionProperties) MarshalHCL

func (me UserActionProperties) MarshalHCL(properties hcl.Properties) error

func (*UserActionProperties) Schema

func (me *UserActionProperties) Schema() map[string]*schema.Schema

func (*UserActionProperties) UnmarshalHCL

func (me *UserActionProperties) UnmarshalHCL(decoder hcl.Decoder) error

type UserActionProperty

type UserActionProperty struct {
	Key       *string    `json:"key,omitempty"`       // The key of the action property we're checking.
	Value     *string    `json:"value,omitempty"`     // Only actions that have this value in the specified property are included in the metric calculation.
	From      *float64   `json:"from,omitempty"`      // Only actions that have a value greater than or equal to this are included in the metric calculation.
	To        *float64   `json:"to,omitempty"`        // Only actions that have a value less than or equal to this are included in the metric calculation.
	MatchType *MatchType `json:"matchType,omitempty"` // Specifies the match type of a string filter, e.g. using Contains or Equals.
}

func (*UserActionProperty) MarshalHCL

func (me *UserActionProperty) MarshalHCL(properties hcl.Properties) error

func (*UserActionProperty) Schema

func (me *UserActionProperty) Schema() map[string]*schema.Schema

func (*UserActionProperty) UnmarshalHCL

func (me *UserActionProperty) UnmarshalHCL(decoder hcl.Decoder) error