restapi

package
v1.9.0 Latest Latest
Warning

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

Go to latest
Published: Sep 11, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const (
	//InstanaAPIBasePath path to Instana RESTful API
	InstanaAPIBasePath = "/api"
	//EventsBasePath path to Events resource of Instana RESTful API
	EventsBasePath = InstanaAPIBasePath + "/events"

	//EventSettingsBasePath path to Event Settings resource of Instana RESTful API
	EventSettingsBasePath = EventsBasePath + settingsPathElement
	//SettingsBasePath path to Event Settings resource of Instana RESTful API
	SettingsBasePath = InstanaAPIBasePath + settingsPathElement
	//RBACSettingsBasePath path to Role Based Access Control Settings resources of Instana RESTful API
	RBACSettingsBasePath = SettingsBasePath + "/rbac"
	//WebsiteMonitoringResourcePath path to website monitoring
	WebsiteMonitoringResourcePath = InstanaAPIBasePath + "/website-monitoring"
	//SyntheticSettingsBasePath path to synthetic monitoring
	SyntheticSettingsBasePath = InstanaAPIBasePath + "/synthetics" + settingsPathElement
	//SyntheticTestResourcePath path to synthetic monitoring tests
	SyntheticTestResourcePath = SyntheticSettingsBasePath + "/tests"
	//SyntheticLocationResourcePath path to synthetic monitoring tests
	SyntheticLocationResourcePath = SyntheticSettingsBasePath + "/locations"
)
View Source
const (
	//AccessTypeRead constant value for the READ AccessType
	AccessTypeRead = AccessType("READ")
	//AccessTypeReadWrite constant value for the READ_WRITE AccessType
	AccessTypeReadWrite = AccessType("READ_WRITE")
)
View Source
const (
	//SumAggregation constant value for the sum aggregation type
	SumAggregation = Aggregation("SUM")
	//MeanAggregation constant value for the mean aggregation type
	MeanAggregation = Aggregation("MEAN")
	//MaxAggregation constant value for the max aggregation type
	MaxAggregation = Aggregation("MAX")
	//MinAggregation constant value for the min aggregation type
	MinAggregation = Aggregation("MIN")
	//Percentile25Aggregation constant value for the 25th percentile aggregation type
	Percentile25Aggregation = Aggregation("P25")
	//Percentile50Aggregation constant value for the 50th percentile aggregation type
	Percentile50Aggregation = Aggregation("P50")
	//Percentile75Aggregation constant value for the 75th percentile aggregation type
	Percentile75Aggregation = Aggregation("P75")
	//Percentile90Aggregation constant value for the 90th percentile aggregation type
	Percentile90Aggregation = Aggregation("P90")
	//Percentile95Aggregation constant value for the 95th percentile aggregation type
	Percentile95Aggregation = Aggregation("P95")
	//Percentile98Aggregation constant value for the 98th percentile aggregation type
	Percentile98Aggregation = Aggregation("P98")
	//Percentile99Aggregation constant value for the 99th percentile aggregation type
	Percentile99Aggregation = Aggregation("P99")
	//Percentile99_9Aggregation constant value for the 99.9th percentile aggregation type
	Percentile99_9Aggregation = Aggregation("P99_9")
	//Percentile99_99Aggregation constant value for the 99.99th percentile aggregation type
	Percentile99_99Aggregation = Aggregation("P99_99")
	//DistributionAggregation constant value for the distribution aggregation type
	DistributionAggregation = Aggregation("DISTRIBUTION")
	//DistinctCountAggregation constant value for the distinct count aggregation type
	DistinctCountAggregation = Aggregation("DISTINCT_COUNT")
	//SumPositiveAggregation constant value for the sum positive aggregation type
	SumPositiveAggregation = Aggregation("SUM_POSITIVE")
)
View Source
const (
	//EmailChannelType constant value for alerting channel type EMAIL
	EmailChannelType = AlertingChannelType("EMAIL")
	//GoogleChatChannelType constant value for alerting channel type GOOGLE_CHAT
	GoogleChatChannelType = AlertingChannelType("GOOGLE_CHAT")
	//Office365ChannelType constant value for alerting channel type OFFICE_365
	Office365ChannelType = AlertingChannelType("OFFICE_365")
	//OpsGenieChannelType constant value for alerting channel type OPS_GENIE
	OpsGenieChannelType = AlertingChannelType("OPS_GENIE")
	//PagerDutyChannelType constant value for alerting channel type PAGER_DUTY
	PagerDutyChannelType = AlertingChannelType("PAGER_DUTY")
	//SlackChannelType constant value for alerting channel type SLACK
	SlackChannelType = AlertingChannelType("SLACK")
	//SplunkChannelType constant value for alerting channel type SPLUNK
	SplunkChannelType = AlertingChannelType("SPLUNK")
	//VictorOpsChannelType constant value for alerting channel type VICTOR_OPS
	VictorOpsChannelType = AlertingChannelType("VICTOR_OPS")
	//WebhookChannelType constant value for alerting channel type WEB_HOOK
	WebhookChannelType = AlertingChannelType("WEB_HOOK")
)
View Source
const (
	//EuOpsGenieRegion constatnt field for OpsGenie region type EU
	EuOpsGenieRegion = OpsGenieRegionType("EU")
	//UsOpsGenieRegion constatnt field for OpsGenie region type US
	UsOpsGenieRegion = OpsGenieRegionType("US")
)
View Source
const (
	//IncidentAlertEventType constant value for alert event type incident
	IncidentAlertEventType = AlertEventType("incident")
	//CriticalAlertEventType constant value for alert event type critical
	CriticalAlertEventType = AlertEventType("critical")
	//WarningAlertEventType constant value for alert event type warning
	WarningAlertEventType = AlertEventType("warning")
	//ChangeAlertEventType constant value for alert event type change
	ChangeAlertEventType = AlertEventType("change")
	//OnlineAlertEventType constant value for alert event type online
	OnlineAlertEventType = AlertEventType("online")
	//OfflineAlertEventType constant value for alert event type offline
	OfflineAlertEventType = AlertEventType("offline")
	//NoneAlertEventType constant value for alert event type none
	NoneAlertEventType = AlertEventType("none")
	//AgentMonitoringIssueEventType constant value for alert event type none
	AgentMonitoringIssueEventType = AlertEventType("agent_monitoring_issue")
)
View Source
const (
	//EvaluationTypePerApplication constant value for ApplicationAlertEvaluationType PER_AP
	EvaluationTypePerApplication = ApplicationAlertEvaluationType("PER_AP")
	//EvaluationTypePerApplicationService constant value for ApplicationAlertEvaluationType PER_AP_SERVICE
	EvaluationTypePerApplicationService = ApplicationAlertEvaluationType("PER_AP_SERVICE")
	//EvaluationTypePerApplicationEndpoint constant value for ApplicationAlertEvaluationType PER_AP_ENDPOINT
	EvaluationTypePerApplicationEndpoint = ApplicationAlertEvaluationType("PER_AP_ENDPOINT")
)
View Source
const (
	//ApplicationMonitoringBasePath path to application monitoring resource of Instana RESTful API
	ApplicationMonitoringBasePath = InstanaAPIBasePath + "/application-monitoring"
	//ApplicationMonitoringSettingsBasePath path to application monitoring settings resource of Instana RESTful API
	ApplicationMonitoringSettingsBasePath = ApplicationMonitoringBasePath + settingsPathElement
	//ApplicationConfigsResourcePath path to application config resource of Instana RESTful API
	ApplicationConfigsResourcePath = ApplicationMonitoringSettingsBasePath + "/application"
)
View Source
const (
	//ApplicationConfigScopeIncludeNoDownstream constant for the scope INCLUDE_NO_DOWNSTREAM
	ApplicationConfigScopeIncludeNoDownstream = ApplicationConfigScope("INCLUDE_NO_DOWNSTREAM")
	//ApplicationConfigScopeIncludeImmediateDownstreamDatabaseAndMessaging constant for the scope INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING
	ApplicationConfigScopeIncludeImmediateDownstreamDatabaseAndMessaging = ApplicationConfigScope("INCLUDE_IMMEDIATE_DOWNSTREAM_DATABASE_AND_MESSAGING")
	//ApplicationConfigScopeIncludeAllDownstream constant for the scope INCLUDE_ALL_DOWNSTREAM
	ApplicationConfigScopeIncludeAllDownstream = ApplicationConfigScope("INCLUDE_ALL_DOWNSTREAM")
)
View Source
const (
	//MatcherExpressionEntitySource const for a SOURCE matcher expression entity
	MatcherExpressionEntitySource = MatcherExpressionEntity("SOURCE")
	//MatcherExpressionEntityDestination const for a DESTINATION matcher expression entity
	MatcherExpressionEntityDestination = MatcherExpressionEntity("DESTINATION")
	//MatcherExpressionEntityNotApplicable const for a NOT_APPLICABLE matcher expression entity
	MatcherExpressionEntityNotApplicable = MatcherExpressionEntity("NOT_APPLICABLE")
)
View Source
const (
	//BoundaryScopeAll constant value for the boundary scope ALL of an application config of the Instana Web REST API
	BoundaryScopeAll = BoundaryScope("ALL")
	//BoundaryScopeInbound constant value for the boundary scope INBOUND of an application config of the Instana Web REST API
	BoundaryScopeInbound = BoundaryScope("INBOUND")
	//BoundaryScopeDefault constant value for the boundary scope DEFAULT of an application config of the Instana Web REST API
	BoundaryScopeDefault = BoundaryScope("DEFAULT")
)
View Source
const (
	//EventSpecificationBasePath path to Event Specification settings of Instana RESTful API
	EventSpecificationBasePath = EventSettingsBasePath + "/event-specifications"
	//CustomEventSpecificationResourcePath path to Custom Event Specification settings resource of Instana RESTful API
	CustomEventSpecificationResourcePath = EventSpecificationBasePath + "/custom"
)
View Source
const (
	//SystemRuleType const for rule type of System
	SystemRuleType = "system"
	//ThresholdRuleType const for rule type of Threshold
	ThresholdRuleType = "threshold"
	//EntityVerificationRuleType const for rule type of Entity Verification
	EntityVerificationRuleType = "entity_verification"
)
View Source
const (
	//AggregationSum const for a sum aggregation
	AggregationSum = AggregationType("sum")
	//AggregationAvg const for a avg aggregation
	AggregationAvg = AggregationType("avg")
	//AggregationMin const for a min aggregation
	AggregationMin = AggregationType("min")
	//AggregationMax const for a max aggregation
	AggregationMax = AggregationType("max")
)
View Source
const (
	//MetricPatternOperatorTypeIs constant value for the metric pattern operator type 'is'
	MetricPatternOperatorTypeIs = MetricPatternOperatorType("is")
	//MetricPatternOperatorTypeContains constant value for the metric pattern operator type 'contains'
	MetricPatternOperatorTypeContains = MetricPatternOperatorType("contains")
	//MetricPatternOperatorTypeAny constant value for the metric pattern operator type 'any'
	MetricPatternOperatorTypeAny = MetricPatternOperatorType("any")
	//MetricPatternOperatorTypeStartsWith constant value for the metric pattern operator type 'startsWith'
	MetricPatternOperatorTypeStartsWith = MetricPatternOperatorType("startsWith")
	//MetricPatternOperatorTypeEndsWith constant value for the metric pattern operator type 'endsWith'
	MetricPatternOperatorTypeEndsWith = MetricPatternOperatorType("endsWith")
)

Constant values of all supported MetricPatternOperatorTypes

View Source
const (
	//StaticCustomPayloadType constant value for the static CustomPayloadType
	StaticCustomPayloadType = CustomPayloadType("staticString")
	//DynamicCustomPayloadType constant value for the dynamic CustomPayloadType
	DynamicCustomPayloadType = CustomPayloadType("dynamic")
)
View Source
const (
	//DefaultRestResourceModeCreateAndUpdatePUT constant value for the DefaultRestResourceMode CREATE_PUT_UPDATE_PUT where create and update is implemented as an upsert using HTTP PUT method only
	DefaultRestResourceModeCreateAndUpdatePUT = DefaultRestResourceMode("CREATE_PUT_UPDATE_PUT")
	//DefaultRestResourceModeCreatePOSTUpdatePUT constant value for the DefaultRestResourceMode CREATE_POST_UPDATE_PUT where create is implemented as an HTTP POST method and update is implemented as HTTP PUT method
	DefaultRestResourceModeCreatePOSTUpdatePUT = DefaultRestResourceMode("CREATE_POST_UPDATE_PUT")
	//DefaultRestResourceModeCreateAndUpdatePOST constant value for the DefaultRestResourceMode CREATE_POST_UPDATE_POST where create is implemented as an HTTP POST method and update is implemented as HTTP PUT method
	DefaultRestResourceModeCreateAndUpdatePOST = DefaultRestResourceMode("CREATE_POST_UPDATE_POST")
)
View Source
const (
	//Granularity300000 constant value for granularity of 30sec
	Granularity300000 = Granularity(300000)
	//Granularity600000 constant value for granularity of 1min
	Granularity600000 = Granularity(600000)
	//Granularity900000 constant value for granularity of 1min 30sec
	Granularity900000 = Granularity(900000)
	//Granularity1200000 constant value for granularity of 2min
	Granularity1200000 = Granularity(1200000)
	//Granularity1800000 constant value for granularity of 3min
	Granularity1800000 = Granularity(1800000)
)
View Source
const (
	//PermissionCanConfigureApplications const for Instana permission CAN_CONFIGURE_APPLICATIONS
	PermissionCanConfigureApplications = InstanaPermission("CAN_CONFIGURE_APPLICATIONS")
	//PermissionCanSeeOnPremLiceneInformation const for Instana permission CAN_SEE_ON_PREM_LICENE_INFORMATION
	PermissionCanSeeOnPremLiceneInformation = InstanaPermission("CAN_SEE_ON_PREM_LICENE_INFORMATION")
	//PermissionCanConfigureEumApplications const for Instana permission CAN_CONFIGURE_EUM_APPLICATIONS
	PermissionCanConfigureEumApplications = InstanaPermission("CAN_CONFIGURE_EUM_APPLICATIONS")
	//PermissionCanConfigureAgents const for Instana permission CAN_CONFIGURE_AGENTS
	PermissionCanConfigureAgents = InstanaPermission("CAN_CONFIGURE_AGENTS")
	//PermissionCanViewTraceDetails const for Instana permission CAN_VIEW_TRACE_DETAILS
	PermissionCanViewTraceDetails = InstanaPermission("CAN_VIEW_TRACE_DETAILS")
	//PermissionCanViewLogs const for Instana permission CAN_VIEW_LOGS
	PermissionCanViewLogs = InstanaPermission("CAN_VIEW_LOGS")
	//PermissionCanConfigureSessionSettings const for Instana permission CAN_CONFIGURE_SESSION_SETTINGS
	PermissionCanConfigureSessionSettings = InstanaPermission("CAN_CONFIGURE_SESSION_SETTINGS")
	//PermissionCanConfigureIntegrations const for Instana permission CAN_CONFIGURE_INTEGRATIONS
	PermissionCanConfigureIntegrations = InstanaPermission("CAN_CONFIGURE_INTEGRATIONS")
	//PermissionCanConfigureGlobalAlertConfigs const for Instana permission CAN_CONFIGURE_GLOBAL_ALERT_CONFIGS
	PermissionCanConfigureGlobalAlertConfigs = InstanaPermission("CAN_CONFIGURE_GLOBAL_ALERT_CONFIGS")
	//PermissionCanConfigureGlobalAlertPayload const for Instana permission CAN_CONFIGURE_GLOBAL_ALERT_PAYLOAD
	PermissionCanConfigureGlobalAlertPayload = InstanaPermission("CAN_CONFIGURE_GLOBAL_ALERT_PAYLOAD")
	//PermissionCanConfigureMobileAppMonitoring const for Instana permission CAN_CONFIGURE_MOBILE_APP_MONITORING
	PermissionCanConfigureMobileAppMonitoring = InstanaPermission("CAN_CONFIGURE_MOBILE_APP_MONITORING")
	//PermissionCanConfigureAPITokens const for Instana permission CAN_CONFIGURE_API_TOKENS
	PermissionCanConfigureAPITokens = InstanaPermission("CAN_CONFIGURE_API_TOKENS")
	//PermissionCanConfigureServiceLevelIndicators const for Instana permission CAN_CONFIGURE_SERVICE_LEVEL_INDICATORS
	PermissionCanConfigureServiceLevelIndicators = InstanaPermission("CAN_CONFIGURE_SERVICE_LEVEL_INDICATORS")
	//PermissionCanConfigureAuthenticationMethods const for Instana permission CAN_CONFIGURE_AUTHENTICATION_METHODS
	PermissionCanConfigureAuthenticationMethods = InstanaPermission("CAN_CONFIGURE_AUTHENTICATION_METHODS")
	//PermissionCanConfigureReleases const for Instana permission CAN_CONFIGURE_RELEASES
	PermissionCanConfigureReleases = InstanaPermission("CAN_CONFIGURE_RELEASES")
	//PermissionCanViewAuditLog const for Instana permission CAN_VIEW_AUDIT_LOG
	PermissionCanViewAuditLog = InstanaPermission("CAN_VIEW_AUDIT_LOG")
	//PermissionCanConfigureCustomAlerts const for Instana permission CAN_CONFIGURE_CUSTOM_ALERTS
	PermissionCanConfigureCustomAlerts = InstanaPermission("CAN_CONFIGURE_CUSTOM_ALERTS")
	//PermissionCanConfigureAgentRunMode const for Instana permission CAN_CONFIGURE_AGENT_RUN_MODE
	PermissionCanConfigureAgentRunMode = InstanaPermission("CAN_CONFIGURE_AGENT_RUN_MODE")
	//PermissionCanConfigureServiceMapping const for Instana permission CAN_CONFIGURE_SERVICE_MAPPING
	PermissionCanConfigureServiceMapping = InstanaPermission("CAN_CONFIGURE_SERVICE_MAPPING")
	//PermissionCanSeeUsageInformation const for Instana permission CAN_SEE_USAGE_INFORMATION
	PermissionCanSeeUsageInformation = InstanaPermission("CAN_SEE_USAGE_INFORMATION")
	//PermissionCanEditAllAccessibleCustomDashboards const for Instana permission CAN_EDIT_ALL_ACCESSIBLE_CUSTOM_DASHBOARDS
	PermissionCanEditAllAccessibleCustomDashboards = InstanaPermission("CAN_EDIT_ALL_ACCESSIBLE_CUSTOM_DASHBOARDS")
	//PermissionCanConfigureUsers const for Instana permission CAN_CONFIGURE_USERS
	PermissionCanConfigureUsers = InstanaPermission("CAN_CONFIGURE_USERS")
	//PermissionCanInstallNewAgents const for Instana permission CAN_INSTALL_NEW_AGENTS
	PermissionCanInstallNewAgents = InstanaPermission("CAN_INSTALL_NEW_AGENTS")
	//PermissionCanConfigureTeams const for Instana permission CAN_CONFIGURE_TEAMS
	PermissionCanConfigureTeams = InstanaPermission("CAN_CONFIGURE_TEAMS")
	//PermissionCanCreatePublicCustomDashboards const for Instana permission CAN_CREATE_PUBLIC_CUSTOM_DASHBOARDS
	PermissionCanCreatePublicCustomDashboards = InstanaPermission("CAN_CREATE_PUBLIC_CUSTOM_DASHBOARDS")
	//PermissionCanConfigureLogManagement const for Instana permission CAN_CONFIGURE_LOG_MANAGEMENT
	PermissionCanConfigureLogManagement = InstanaPermission("CAN_CONFIGURE_LOG_MANAGEMENT")
	//PermissionCanViewAccountAndBillingInformation const for Instana permission CAN_VIEW_ACCOUNT_AND_BILLING_INFORMATION
	PermissionCanViewAccountAndBillingInformation = InstanaPermission("CAN_VIEW_ACCOUNT_AND_BILLING_INFORMATION")
)
View Source
const (
	//LogLevelWarning constant value for the warning log level
	LogLevelWarning = LogLevel("WARN")
	//LogLevelError constant value for the error log level
	LogLevelError = LogLevel("ERROR")
	//LogLevelAny constant value for the any log level
	LogLevelAny = LogLevel("ANY")
)
View Source
const (
	//LogicalAnd constant for logical AND conjunction
	LogicalAnd = LogicalOperatorType("AND")
	//LogicalOr constant for logical OR conjunction
	LogicalOr = LogicalOperatorType("OR")
)
View Source
const (
	//EqualsOperator constant for the EQUALS operator
	EqualsOperator = ExpressionOperator("EQUALS")
	//NotEqualOperator constant for the NOT_EQUAL operator
	NotEqualOperator = ExpressionOperator("NOT_EQUAL")
	//ContainsOperator constant for the CONTAINS operator
	ContainsOperator = ExpressionOperator("CONTAINS")
	//NotContainOperator constant for the NOT_CONTAIN operator
	NotContainOperator = ExpressionOperator("NOT_CONTAIN")

	//IsEmptyOperator constant for the IS_EMPTY operator
	IsEmptyOperator = ExpressionOperator("IS_EMPTY")
	//NotEmptyOperator constant for the NOT_EMPTY operator
	NotEmptyOperator = ExpressionOperator("NOT_EMPTY")
	//IsBlankOperator constant for the IS_BLANK operator
	IsBlankOperator = ExpressionOperator("IS_BLANK")
	//NotBlankOperator constant for the NOT_BLANK operator
	NotBlankOperator = ExpressionOperator("NOT_BLANK")

	//StartsWithOperator constant for the STARTS_WITH operator
	StartsWithOperator = ExpressionOperator("STARTS_WITH")
	//EndsWithOperator constant for the ENDS_WITH operator
	EndsWithOperator = ExpressionOperator("ENDS_WITH")
	//NotStartsWithOperator constant for the NOT_STARTS_WITH operator
	NotStartsWithOperator = ExpressionOperator("NOT_STARTS_WITH")
	//NotEndsWithOperator constant for the NOT_ENDS_WITH operator
	NotEndsWithOperator = ExpressionOperator("NOT_ENDS_WITH")
	//GreaterOrEqualThanOperator constant for the GREATER_OR_EQUAL_THAN operator
	GreaterOrEqualThanOperator = ExpressionOperator("GREATER_OR_EQUAL_THAN")
	//LessOrEqualThanOperator constant for the LESS_OR_EQUAL_THAN operator
	LessOrEqualThanOperator = ExpressionOperator("LESS_OR_EQUAL_THAN")
	//GreaterThanOperator constant for the GREATER_THAN operator
	GreaterThanOperator = ExpressionOperator("GREATER_THAN")
	//LessThanOperator constant for the LESS_THAN operator
	LessThanOperator = ExpressionOperator("LESS_THAN")
)
View Source
const (
	//RelationTypeUser constant value for the USER RelationType
	RelationTypeUser = RelationType("USER")
	//RelationTypeApiToken constant value for the API_TOKEN RelationType
	RelationTypeApiToken = RelationType("API_TOKEN")
	//RelationTypeRole constant value for the ROLE RelationType
	RelationTypeRole = RelationType("ROLE")
	//RelationTypeTeam constant value for the TEAM RelationType
	RelationTypeTeam = RelationType("TEAM")
	//RelationTypeGlobal constant value for the GLOBAL RelationType
	RelationTypeGlobal = RelationType("GLOBAL")
)
View Source
const (
	//TagFilterEntitySource const for a SOURCE matcher expression entity
	TagFilterEntitySource = TagFilterEntity("SOURCE")
	//TagFilterEntityDestination const for a DESTINATION matcher expression entity
	TagFilterEntityDestination = TagFilterEntity("DESTINATION")
	//TagFilterEntityNotApplicable const for a NOT_APPLICABLE matcher expression entity
	TagFilterEntityNotApplicable = TagFilterEntity("NOT_APPLICABLE")
)
View Source
const (
	//ThresholdOperatorGreaterThan constant value for the threshold operator > (greater than)
	ThresholdOperatorGreaterThan = ThresholdOperator(">")
	//ThresholdOperatorGreaterThanOrEqual constant value for the threshold operator >= (greater than or equal)
	ThresholdOperatorGreaterThanOrEqual = ThresholdOperator(">=")
	//ThresholdOperatorLessThan constant value for the threshold operator < (less than)
	ThresholdOperatorLessThan = ThresholdOperator("<")
	//ThresholdOperatorLessThanOrEqual constant value for the threshold operator <= (less than or equal)
	ThresholdOperatorLessThanOrEqual = ThresholdOperator("<=")
)
View Source
const (
	//ThresholdSeasonalityWeekly constant value for the threshold seasonality type weekly
	ThresholdSeasonalityWeekly = ThresholdSeasonality("WEEKLY")
	//ThresholdSeasonalityDaily constant value for the threshold seasonality type daily
	ThresholdSeasonalityDaily = ThresholdSeasonality("DAILY")
)
View Source
const (
	//WebsiteImpactMeasurementMethodAggregated constant value for the website impact measurement method aggregated
	WebsiteImpactMeasurementMethodAggregated = WebsiteImpactMeasurementMethod("AGGREGATED")
	//WebsiteImpactMeasurementMethodPerWindow constant value for the website impact measurement method per_window
	WebsiteImpactMeasurementMethodPerWindow = WebsiteImpactMeasurementMethod("PER_WINDOW")
)
View Source
const APITokensResourcePath = SettingsBasePath + "/api-tokens"

APITokensResourcePath path to API Tokens resource of Instana RESTful API

View Source
const AlertingChannelsResourcePath = EventSettingsBasePath + "/alertingChannels"

AlertingChannelsResourcePath path to Alerting channels resource of Instana RESTful API

View Source
const AlertsResourcePath = EventSettingsBasePath + "/alerts"

AlertsResourcePath path to Alerts resource of Instana RESTful API

View Source
const ApplicationAlertConfigsResourcePath = EventSettingsBasePath + "/application-alert-configs"

ApplicationAlertConfigsResourcePath the base path of the Instana REST API for application alert configs

View Source
const BuiltinEventSpecificationResourcePath = EventSpecificationBasePath + "/built-in"

BuiltinEventSpecificationResourcePath path to Builtin Event Specification settings resource of Instana RESTful API

View Source
const CustomDashboardsResourcePath = InstanaAPIBasePath + "/custom-dashboard"

CustomDashboardsResourcePath the API resource path for Custom Dashboards

View Source
const GlobalApplicationAlertConfigsResourcePath = EventSettingsBasePath + "/global-alert-configs/applications"

GlobalApplicationAlertConfigsResourcePath the base path of the Instana REST API for global application alert configs

View Source
const GroupsResourcePath = RBACSettingsBasePath + "/groups"

GroupsResourcePath path to Group resource of Instana RESTful API

View Source
const (
	//SliConfigResourcePath path to sli config resource of Instana RESTful API
	SliConfigResourcePath = SettingsBasePath + "/sli"
)
View Source
const WebsiteAlertConfigResourcePath = EventSettingsBasePath + "/website-alert-configs"

WebsiteAlertConfigResourcePath path to website alert config resource of Instana RESTful API

View Source
const WebsiteMonitoringConfigResourcePath = WebsiteMonitoringResourcePath + "/config"

WebsiteMonitoringConfigResourcePath path to website monitoring config resource of Instana RESTful API

Variables

View Source
var (
	//ConditionOperatorEquals const for a equals (==) condition operator
	ConditionOperatorEquals = newBasicConditionOperator("=", "==")
	//ConditionOperatorNotEqual const for a not equal (!=) condition operator
	ConditionOperatorNotEqual = newBasicConditionOperator("!=")
	//ConditionOperatorLessThan const for a less than (<) condition operator
	ConditionOperatorLessThan = newBasicConditionOperator("<")
	//ConditionOperatorLessThanOrEqual const for a less than or equal (<=) condition operator
	ConditionOperatorLessThanOrEqual = newBasicConditionOperator("<=")
	//ConditionOperatorGreaterThan const for a greater than (>) condition operator
	ConditionOperatorGreaterThan = newBasicConditionOperator(">")
	//ConditionOperatorGreaterThanOrEqual const for a greater than or equal (<=) condition operator
	ConditionOperatorGreaterThanOrEqual = newBasicConditionOperator(">=")
)
View Source
var (
	//MatchingOperatorIs const for IS condition operator
	MatchingOperatorIs = newBasicMatchingOperator("is")
	//MatchingOperatorContains const for CONTAINS condition operator
	MatchingOperatorContains = newBasicMatchingOperator("contains")
	//MatchingOperatorStartsWith const for STARTS_WITH condition operator
	MatchingOperatorStartsWith = newBasicMatchingOperator("startsWith", "starts_with")
	//MatchingOperatorEndsWith const for ENDS_WITH condition operator
	MatchingOperatorEndsWith = newBasicMatchingOperator("endsWith", "ends_with")
)
View Source
var ErrEntityNotFound = errors.New("failed to get resource from Instana API. 404 - Resource not found")

ErrEntityNotFound error message which is returned when the entity cannot be found at the server

View Source
var SeverityCritical = Severity{/* contains filtered or unexported fields */}

SeverityCritical representation of the critical severity

View Source
var SeverityWarning = Severity{/* contains filtered or unexported fields */}

SeverityWarning representation of the warning severity

SupportedAccessTypes list of all supported AccessType

SupportedAggregationTypes slice of supported aggregation types

SupportedAggregations list of all supported Aggregation

SupportedAlertEventTypes list of supported alert event types of Instana API

SupportedAlertingChannels list of supported calerting channels of Instana API

View Source
var SupportedApplicationAlertConfigBoundaryScopes = BoundaryScopes{BoundaryScopeAll, BoundaryScopeInbound}

SupportedApplicationAlertConfigBoundaryScopes supported BoundaryScopes of the Instana Web REST API

SupportedApplicationAlertEvaluationTypes list of all supported ApplicationAlertEvaluationTypes

View Source
var SupportedApplicationConfigBoundaryScopes = BoundaryScopes{BoundaryScopeAll, BoundaryScopeInbound, BoundaryScopeDefault}

SupportedApplicationConfigBoundaryScopes supported BoundaryScopes of the Instana Web REST API

SupportedApplicationConfigScopes supported ApplicationConfigScopes of the Instana Web REST API

SupportedComparisonOperators list of supported comparison operators of Instana API

SupportedConditionOperators slice of supported condition operator types

SupportedCustomPayloadTypes list of all supported CustomPayloadType

SupportedExpressionOperators list of all supported operators of Instana API

SupportedGranularities list of all supported Granularities

SupportedInstanaPermissions slice of all supported Permissions of the Instana API

SupportedLogLevels list of all supported LogLevel

View Source
var SupportedLogicalOperatorTypes = LogicalOperatorTypes{LogicalAnd, LogicalOr}

SupportedLogicalOperatorTypes list of supported logical operators of Instana API

SupportedMatcherExpressionEntities slice of supported matcher expression entity types

SupportedMatchingOperators slice of supported matching operatorTypes types

SupportedMetricPatternOperatorTypes slice of all supported MetricPatternOperatorTypes of the Instana Web Rest API

SupportedOpsGenieRegions list of supported OpsGenie regions of Instana API

SupportedRelationTypes list of all supported RelationType

SupportedSeverities slice of all supported severities of the Instana REST API

SupportedTagFilterEntities slice of supported matcher expression entity types

SupportedThresholdOperators list of all supported ThresholdOperator

SupportedThresholdSeasonalities list of all supported ThresholdSeasonality

SupportedUnaryExpressionOperators list of supported unary expression operators of Instana API

SupportedWebsiteImpactMeasurementMethods list of all supported WebsiteImpactMeasurementMethod

Functions

func IsSupportedAggregationType added in v0.2.0

func IsSupportedAggregationType(aggregation AggregationType) bool

IsSupportedAggregationType check if the provided aggregation type is supported

func IsSupportedAlertEventType added in v0.8.0

func IsSupportedAlertEventType(t AlertEventType) bool

IsSupportedAlertEventType checks if the given alert type is supported by Instana API

func IsSupportedOpsGenieRegionType added in v0.8.0

func IsSupportedOpsGenieRegionType(regionType OpsGenieRegionType) bool

IsSupportedOpsGenieRegionType checks if the given OpsGenie region is supported by Instana

Types

type APIMember added in v1.1.0

type APIMember struct {
	UserID string  `json:"userId"`
	Email  *string `json:"email"`
}

APIMember data structure for the Instana API model for group members

type APIPermissionSetWithRoles added in v1.1.0

type APIPermissionSetWithRoles struct {
	ApplicationIDs          []ScopeBinding      `json:"applicationIds"`
	InfraDFQFilter          *ScopeBinding       `json:"infraDfqFilter"`
	KubernetesClusterUUIDs  []ScopeBinding      `json:"kubernetesClusterUUIDs"`
	KubernetesNamespaceUIDs []ScopeBinding      `json:"kubernetesNamespaceUIDs"`
	MobileAppIDs            []ScopeBinding      `json:"mobileAppIds"`
	WebsiteIDs              []ScopeBinding      `json:"websiteIds"`
	Permissions             []InstanaPermission `json:"permissions"`
}

APIPermissionSetWithRoles data structure for the Instana API model for permissions with roles

func (*APIPermissionSetWithRoles) IsEmpty added in v1.1.0

func (m *APIPermissionSetWithRoles) IsEmpty() bool

IsEmpty returns true when no permission or scope is assigned

type APIToken added in v1.0.0

type APIToken struct {
	ID                                   string `json:"id"`
	AccessGrantingToken                  string `json:"accessGrantingToken"`
	InternalID                           string `json:"internalId"`
	Name                                 string `json:"name"`
	CanConfigureServiceMapping           bool   `json:"canConfigureServiceMapping"`
	CanConfigureEumApplications          bool   `json:"canConfigureEumApplications"`
	CanConfigureMobileAppMonitoring      bool   `json:"canConfigureMobileAppMonitoring"` //NEW
	CanConfigureUsers                    bool   `json:"canConfigureUsers"`
	CanInstallNewAgents                  bool   `json:"canInstallNewAgents"`
	CanSeeUsageInformation               bool   `json:"canSeeUsageInformation"`
	CanConfigureIntegrations             bool   `json:"canConfigureIntegrations"`
	CanSeeOnPremiseLicenseInformation    bool   `json:"canSeeOnPremLicenseInformation"`
	CanConfigureCustomAlerts             bool   `json:"canConfigureCustomAlerts"`
	CanConfigureAPITokens                bool   `json:"canConfigureApiTokens"`
	CanConfigureAgentRunMode             bool   `json:"canConfigureAgentRunMode"`
	CanViewAuditLog                      bool   `json:"canViewAuditLog"`
	CanConfigureAgents                   bool   `json:"canConfigureAgents"`
	CanConfigureAuthenticationMethods    bool   `json:"canConfigureAuthenticationMethods"`
	CanConfigureApplications             bool   `json:"canConfigureApplications"`
	CanConfigureTeams                    bool   `json:"canConfigureTeams"`
	CanConfigureReleases                 bool   `json:"canConfigureReleases"`
	CanConfigureLogManagement            bool   `json:"canConfigureLogManagement"`
	CanCreatePublicCustomDashboards      bool   `json:"canCreatePublicCustomDashboards"`
	CanViewLogs                          bool   `json:"canViewLogs"`
	CanViewTraceDetails                  bool   `json:"canViewTraceDetails"`
	CanConfigureSessionSettings          bool   `json:"canConfigureSessionSettings"`
	CanConfigureServiceLevelIndicators   bool   `json:"canConfigureServiceLevelIndicators"`
	CanConfigureGlobalAlertPayload       bool   `json:"canConfigureGlobalAlertPayload"`
	CanConfigureGlobalAlertConfigs       bool   `json:"canConfigureGlobalAlertConfigs"`
	CanViewAccountAndBillingInformation  bool   `json:"canViewAccountAndBillingInformation"`
	CanEditAllAccessibleCustomDashboards bool   `json:"canEditAllAccessibleCustomDashboards"`
}

APIToken is the representation of a API Token in Instana

func (*APIToken) GetIDForResourcePath added in v1.0.0

func (r *APIToken) GetIDForResourcePath() string

GetIDForResourcePath implemention of the interface InstanaDataObject

func (*APIToken) Validate added in v1.0.0

func (r *APIToken) Validate() error

Validate implementation of the interface InstanaDataObject to verify if data object is correct

type AccessRule added in v1.5.0

type AccessRule struct {
	AccessType   AccessType   `json:"accessType"`
	RelatedID    *string      `json:"relatedId"`
	RelationType RelationType `json:"relationType"`
}

type AccessType added in v1.5.0

type AccessType string

AccessType custom type for access type

type AccessTypes added in v1.5.0

type AccessTypes []AccessType

AccessTypes custom type for a slice of AccessType

func (AccessTypes) IsSupported added in v1.5.0

func (types AccessTypes) IsSupported(tpy AccessType) bool

IsSupported check if the provided AccessType is supported

func (AccessTypes) ToStringSlice added in v1.5.0

func (types AccessTypes) ToStringSlice() []string

ToStringSlice Returns the corresponding string representations

type Aggregation added in v1.3.0

type Aggregation string

Aggregation custom type for an Aggregation

type AggregationType added in v0.2.0

type AggregationType string

AggregationType custom type representing an aggregation of a custom event specification rule

type AggregationTypes added in v0.2.0

type AggregationTypes []AggregationType

AggregationTypes custom type representing a slice of AggregationType

func (AggregationTypes) ToStringSlice added in v0.2.0

func (types AggregationTypes) ToStringSlice() []string

ToStringSlice Returns the string representations fo the aggregations

type Aggregations added in v1.3.0

type Aggregations []Aggregation

Aggregations custom type for a slice of Aggregation

func (Aggregations) IsSupported added in v1.3.0

func (aggregations Aggregations) IsSupported(aggregation Aggregation) bool

IsSupported check if the provided Aggregation is supported

func (Aggregations) ToStringSlice added in v1.3.0

func (aggregations Aggregations) ToStringSlice() []string

ToStringSlice Returns the corresponding string representations

type AlertEventType added in v0.8.0

type AlertEventType string

AlertEventType type definition of EventTypes of an Instana Alert

func (AlertEventType) Equals added in v0.8.0

func (t AlertEventType) Equals(other AlertEventType) bool

Equals checks if the alert event type is equal to the provided alert event type. It compares the string representation of both case insensitive

type AlertingChannel added in v0.8.0

type AlertingChannel struct {
	ID                    string              `json:"id"`
	Name                  string              `json:"name"`
	Kind                  AlertingChannelType `json:"kind"`
	Emails                []string            `json:"emails"`
	WebhookURL            *string             `json:"webhookUrl"`
	APIKey                *string             `json:"apiKey"`
	Tags                  *string             `json:"tags"`
	Region                *OpsGenieRegionType `json:"region"`
	RoutingKey            *string             `json:"routingKey"`
	ServiceIntegrationKey *string             `json:"serviceIntegrationKey"`
	IconURL               *string             `json:"iconUrl"`
	Channel               *string             `json:"channel"`
	URL                   *string             `json:"url"`
	Token                 *string             `json:"token"`
	WebhookURLs           []string            `json:"webhookUrls"`
	Headers               []string            `json:"headers"`
}

AlertingChannel is the representation of an alerting channel in Instana

func (*AlertingChannel) GetIDForResourcePath added in v1.0.0

func (r *AlertingChannel) GetIDForResourcePath() string

GetIDForResourcePath implemention of the interface InstanaDataObject

func (*AlertingChannel) Validate added in v0.8.0

func (r *AlertingChannel) Validate() error

Validate implementation of the interface InstanaDataObject to verify if data object is correct

type AlertingChannelDS added in v1.7.0

type AlertingChannelDS struct {
	AlertingChannel
}

AlertingChannelDS is embedding AlertingChannel so we could satisfy the restapi.InstanaDataObject interface for datasource read operations.

func (AlertingChannelDS) GetIDForResourcePath added in v1.7.0

func (r AlertingChannelDS) GetIDForResourcePath() string

GetIDForResourcePath implemention of the interface InstanaDataObject

func (AlertingChannelDS) Validate added in v1.7.0

func (r AlertingChannelDS) Validate() error

Validate implementation of the interface InstanaDataObject to verify if data object is correct

type AlertingChannelType added in v0.8.0

type AlertingChannelType string

AlertingChannelType type of the alerting channel

type AlertingConfiguration added in v0.8.0

type AlertingConfiguration struct {
	ID                          string                      `json:"id"`
	AlertName                   string                      `json:"alertName"`
	IntegrationIDs              []string                    `json:"integrationIds"`
	EventFilteringConfiguration EventFilteringConfiguration `json:"eventFilteringConfiguration"`
}

AlertingConfiguration type definition of an Alertinng Configruation in Instana REST API

func (*AlertingConfiguration) GetIDForResourcePath added in v1.0.0

func (c *AlertingConfiguration) GetIDForResourcePath() string

GetIDForResourcePath implementation of the interface InstanaDataObject

func (*AlertingConfiguration) Validate added in v0.8.0

func (c *AlertingConfiguration) Validate() error

Validate implementation of the interface InstanaDataObject to verify if data object is correct

type ApplicationAlertConfig added in v1.3.0

type ApplicationAlertConfig struct {
	ID                    string                         `json:"id"`
	Name                  string                         `json:"name"`
	Description           string                         `json:"description"`
	Severity              int                            `json:"severity"`
	Triggering            bool                           `json:"triggering"`
	Applications          map[string]IncludedApplication `json:"applications"`
	BoundaryScope         BoundaryScope                  `json:"boundaryScope"`
	TagFilterExpression   interface{}                    `json:"tagFilterExpression"`
	IncludeInternal       bool                           `json:"includeInternal"`
	IncludeSynthetic      bool                           `json:"includeSynthetic"`
	EvaluationType        ApplicationAlertEvaluationType `json:"evaluationType"`
	AlertChannelIDs       []string                       `json:"alertChannelIds"`
	Granularity           Granularity                    `json:"granularity"`
	CustomerPayloadFields []CustomPayloadField[any]      `json:"customPayloadFields"`
	Rule                  ApplicationAlertRule           `json:"rule"`
	Threshold             Threshold                      `json:"threshold"`
	TimeThreshold         TimeThreshold                  `json:"timeThreshold"`
}

ApplicationAlertConfig is the representation of an application alert configuration in Instana

func (*ApplicationAlertConfig) GetIDForResourcePath added in v1.3.0

func (a *ApplicationAlertConfig) GetIDForResourcePath() string

GetIDForResourcePath implementation of the interface InstanaDataObject

func (*ApplicationAlertConfig) Validate added in v1.3.0

func (a *ApplicationAlertConfig) Validate() error

Validate implementation of the interface InstanaDataObject for ApplicationConfig

type ApplicationAlertEvaluationType added in v1.3.0

type ApplicationAlertEvaluationType string

ApplicationAlertEvaluationType custom type representing the application alert evaluation type from the instana API

type ApplicationAlertEvaluationTypes added in v1.3.0

type ApplicationAlertEvaluationTypes []ApplicationAlertEvaluationType

ApplicationAlertEvaluationTypes custom type representing a slice of ApplicationAlertEvaluationType

func (ApplicationAlertEvaluationTypes) IsSupported added in v1.3.0

IsSupported check if the provided evaluation type is supported

func (ApplicationAlertEvaluationTypes) ToStringSlice added in v1.3.0

func (types ApplicationAlertEvaluationTypes) ToStringSlice() []string

ToStringSlice Returns the corresponding string representations

type ApplicationAlertRule added in v1.3.0

type ApplicationAlertRule struct {
	AlertType   string      `json:"alertType"`
	MetricName  string      `json:"metricName"`
	Aggregation Aggregation `json:"aggregation"`
	StableHash  *int32      `json:"stableHash"`

	StatusCodeStart *int32 `json:"statusCodeStart"`
	StatusCodeEnd   *int32 `json:"statusCodeEnd"`

	Level    *LogLevel           `json:"level"`
	Message  *string             `json:"message"`
	Operator *ExpressionOperator `json:"operator"`
}

ApplicationAlertRule is the representation of an application alert rule in Instana

type ApplicationConfig added in v0.2.0

type ApplicationConfig struct {
	ID                  string                 `json:"id"`
	Label               string                 `json:"label"`
	MatchSpecification  interface{}            `json:"matchSpecification"`
	TagFilterExpression interface{}            `json:"tagFilterExpression"`
	Scope               ApplicationConfigScope `json:"scope"`
	BoundaryScope       BoundaryScope          `json:"boundaryScope"`
}

ApplicationConfig is the representation of a application perspective configuration in Instana

func (*ApplicationConfig) GetIDForResourcePath added in v1.0.0

func (a *ApplicationConfig) GetIDForResourcePath() string

GetIDForResourcePath implementation of the interface InstanaDataObject

func (*ApplicationConfig) Validate added in v0.2.0

func (a *ApplicationConfig) Validate() error

Validate implementation of the interface InstanaDataObject for ApplicationConfig

type ApplicationConfigResource added in v0.2.0

type ApplicationConfigResource interface {
	GetOne(id string) (ApplicationConfig, error)
	Upsert(rule ApplicationConfig) (ApplicationConfig, error)
	Delete(rule ApplicationConfig) error
	DeleteByID(applicationID string) error
}

ApplicationConfigResource represents the REST resource of application perspective configuration at Instana

type ApplicationConfigScope added in v0.9.0

type ApplicationConfigScope string

ApplicationConfigScope type definition of the application config scope of the Instana Web REST API

type ApplicationConfigScopes added in v0.9.0

type ApplicationConfigScopes []ApplicationConfigScope

ApplicationConfigScopes type definition of slice of ApplicationConfigScope

func (ApplicationConfigScopes) IsSupported added in v0.9.0

func (scopes ApplicationConfigScopes) IsSupported(s ApplicationConfigScope) bool

IsSupported checks if the given ApplicationConfigScope is defined as a supported ApplicationConfigScope of the underlying slice

func (ApplicationConfigScopes) ToStringSlice added in v0.9.0

func (scopes ApplicationConfigScopes) ToStringSlice() []string

ToStringSlice returns a slice containing the string representations of the given scopes

type BinaryOperator added in v0.2.0

type BinaryOperator struct {
	Dtype       MatchExpressionType `json:"type"`
	Left        interface{}         `json:"left"`
	Right       interface{}         `json:"right"`
	Conjunction LogicalOperatorType `json:"conjunction"`
}

BinaryOperator is the representation of a binary operator expression in Instana

func (*BinaryOperator) GetType added in v0.2.0

func (b *BinaryOperator) GetType() MatchExpressionType

GetType implementation of the interface MatchExpression for BinaryOperator

func (*BinaryOperator) Validate added in v0.2.0

func (b *BinaryOperator) Validate() error

Validate implementation of the interface MatchExpression for BinaryOperator

type BoundaryScope added in v0.9.0

type BoundaryScope string

BoundaryScope type definition of the application config boundary scope of the Instana Web REST API

type BoundaryScopes added in v0.9.0

type BoundaryScopes []BoundaryScope

BoundaryScopes type definition of slice of BoundaryScopes

func (BoundaryScopes) IsSupported added in v0.9.0

func (scopes BoundaryScopes) IsSupported(s BoundaryScope) bool

IsSupported checks if the given BoundaryScope is defined as a supported BoundaryScope of the underlying slice

func (BoundaryScopes) ToStringSlice added in v0.9.0

func (scopes BoundaryScopes) ToStringSlice() []string

ToStringSlice returns a slice containing the string representations of the given boundary scopes

type BuiltinEventSpecification added in v0.11.0

type BuiltinEventSpecification struct {
	ID            string  `json:"id"`
	ShortPluginID string  `json:"shortPluginId"`
	Name          string  `json:"name"`
	Description   *string `json:"description"`
	Severity      int     `json:"severity"`
	Triggering    bool    `json:"triggering"`
	Enabled       bool    `json:"enabled"`
}

BuiltinEventSpecification is the representation of a builtin event specification in Instana

func (BuiltinEventSpecification) GetIDForResourcePath added in v1.0.0

func (spec BuiltinEventSpecification) GetIDForResourcePath() string

GetIDForResourcePath implemention of the interface InstanaDataObject

func (BuiltinEventSpecification) Validate added in v0.11.0

func (spec BuiltinEventSpecification) Validate() error

Validate implementation of the interface InstanaDataObject to verify if data object is correct. As this is read only datasource no validation is applied

type ConditionOperator added in v0.9.1

type ConditionOperator interface {
	InstanaAPIValue() string
	TerraformSupportedValues() []string
}

ConditionOperator representation of a ConditionOperator of a threshold rule of a custom event specification of the Instana Web REST API

type ConditionOperators added in v0.9.1

type ConditionOperators []ConditionOperator

ConditionOperators custom type representing a slice of ConditionOperatorType

func (ConditionOperators) FromInstanaAPIValue added in v0.9.1

func (types ConditionOperators) FromInstanaAPIValue(instanaAPIvalue string) (ConditionOperator, error)

FromInstanaAPIValue returns the ConditionOperator for the given instana apistring value or an error if the operator type does not exist

func (ConditionOperators) FromTerraformValue added in v0.9.1

func (types ConditionOperators) FromTerraformValue(terraformRepresentation string) (ConditionOperator, error)

FromTerraformValue returns the ConditionOperator for the given terraform string value or an error if the operator type does not exist

func (ConditionOperators) InstanaAPISupportedValues added in v0.9.1

func (types ConditionOperators) InstanaAPISupportedValues() []string

InstanaAPISupportedValues Returns the terraform string representations fo the condition operators

func (ConditionOperators) IsSupportedInstanaAPIConditionOperator added in v0.9.1

func (types ConditionOperators) IsSupportedInstanaAPIConditionOperator(operator string) bool

IsSupportedInstanaAPIConditionOperator check if the provided condition operator type is a supported instana api value

func (ConditionOperators) TerrafromSupportedValues added in v0.9.1

func (types ConditionOperators) TerrafromSupportedValues() []string

TerrafromSupportedValues Returns the terraform string representations fo the condition operators

type CustomDashboard added in v1.5.0

type CustomDashboard struct {
	ID          string          `json:"id"`
	Title       string          `json:"title"`
	AccessRules []AccessRule    `json:"accessRules"`
	Widgets     json.RawMessage `json:"widgets"`
}

func (*CustomDashboard) GetIDForResourcePath added in v1.5.0

func (a *CustomDashboard) GetIDForResourcePath() string

GetIDForResourcePath implementation of the interface InstanaDataObject for CustomDashboard

func (*CustomDashboard) Validate added in v1.5.0

func (a *CustomDashboard) Validate() error

Validate implementation of the interface InstanaDataObject for CustomDashboard

type CustomEventSpecification added in v0.2.0

type CustomEventSpecification struct {
	ID             string              `json:"id"`
	Name           string              `json:"name"`
	EntityType     string              `json:"entityType"`
	Query          *string             `json:"query"`
	Triggering     bool                `json:"triggering"`
	Description    *string             `json:"description"`
	ExpirationTime *int                `json:"expirationTime"`
	Enabled        bool                `json:"enabled"`
	Rules          []RuleSpecification `json:"rules"`
}

CustomEventSpecification is the representation of a custom event specification in Instana

func (*CustomEventSpecification) GetIDForResourcePath added in v1.0.0

func (spec *CustomEventSpecification) GetIDForResourcePath() string

GetIDForResourcePath implemention of the interface InstanaDataObject

func (*CustomEventSpecification) Validate added in v0.2.0

func (spec *CustomEventSpecification) Validate() error

Validate implementation of the interface InstanaDataObject to verify if data object is correct

type CustomPayloadField added in v1.3.0

type CustomPayloadField[T any] struct {
	Type  CustomPayloadType `json:"type"`
	Key   string            `json:"key"`
	Value T                 `json:"value"`
}

CustomPayloadField custom type to represent static fields with a string value for custom payloads

type CustomPayloadType added in v1.3.0

type CustomPayloadType string

CustomPayloadType custom type for the type of a custom payload

type CustomPayloadTypes added in v1.3.0

type CustomPayloadTypes []CustomPayloadType

CustomPayloadTypes custom type for a slice of CustomPayloadType

func (CustomPayloadTypes) IsSupported added in v1.3.0

func (types CustomPayloadTypes) IsSupported(cpt CustomPayloadType) bool

IsSupported check if the provided CustomPayloadType is supported

func (CustomPayloadTypes) ToStringSlice added in v1.3.0

func (types CustomPayloadTypes) ToStringSlice() []string

ToStringSlice Returns the corresponding string representations

type DataFilterFunc added in v0.11.0

type DataFilterFunc func(o InstanaDataObject) bool

DataFilterFunc function definition for filtering data received from Instana API

type DefaultRestResourceMode added in v1.0.0

type DefaultRestResourceMode string

DefaultRestResourceMode custom type for create/update behavior of the defaultRestResource

type DynamicCustomPayloadFieldValue added in v1.3.0

type DynamicCustomPayloadFieldValue struct {
	Key     *string `json:"key"`
	TagName string  `json:"tagName"`
}

DynamicCustomPayloadFieldValue type for dynamic values of custom payload field

type EventFilteringConfiguration added in v0.8.0

type EventFilteringConfiguration struct {
	Query      *string          `json:"query"`
	RuleIDs    []string         `json:"ruleIds"`
	EventTypes []AlertEventType `json:"eventTypes"`
}

EventFilteringConfiguration type definiton of an EventFilteringConfiguration of a AlertingConfiguration of the Instana ReST AOI

func (EventFilteringConfiguration) Validate added in v0.8.0

func (c EventFilteringConfiguration) Validate() error

Validate implementation of the interface InstanaDataObject to verify if data object is correct

type ExpressionOperator added in v1.3.0

type ExpressionOperator string

ExpressionOperator custom type for tag matcher operators

type ExpressionOperators added in v1.3.0

type ExpressionOperators []ExpressionOperator

ExpressionOperators custom type representing a slice of ExpressionOperator

func (ExpressionOperators) IsSupported added in v1.3.0

func (operators ExpressionOperators) IsSupported(o ExpressionOperator) bool

IsSupported check if the provided tag filter operator is supported

func (ExpressionOperators) ToStringSlice added in v1.3.0

func (operators ExpressionOperators) ToStringSlice() []string

ToStringSlice Returns the corresponding string representations

type Granularities added in v1.3.0

type Granularities []Granularity

Granularities custom type for a slice of Granularity

func (Granularities) IsSupported added in v1.3.0

func (granularities Granularities) IsSupported(granularity Granularity) bool

IsSupported check if the provided Granularity is supported

func (Granularities) ToIntSlice added in v1.3.0

func (granularities Granularities) ToIntSlice() []int

ToIntSlice Returns the corresponding int representations

type Granularity added in v1.3.0

type Granularity int32

Granularity custom type for an Alter Granularity

type Group added in v1.1.0

type Group struct {
	ID            string                    `json:"id"`
	Name          string                    `json:"name"`
	Members       []APIMember               `json:"members"`
	PermissionSet APIPermissionSetWithRoles `json:"permissionSet"`
}

Group data structure for the Instana API model for groups

func (*Group) GetIDForResourcePath added in v1.1.0

func (c *Group) GetIDForResourcePath() string

GetIDForResourcePath implementation of the interface InstanaDataObject

func (*Group) Validate added in v1.1.0

func (c *Group) Validate() error

Validate implementation of the interface InstanaDataObject to verify if data object is correct

type IncludedApplication added in v1.3.0

type IncludedApplication struct {
	ApplicationID string `json:"applicationId"`
	Inclusive     bool   `json:"inclusive"`

	Services map[string]IncludedService `json:"services"`
}

IncludedApplication custom type to include specific applications in an alert config

type IncludedEndpoint added in v1.3.0

type IncludedEndpoint struct {
	EndpointID string `json:"endpointId"`
	Inclusive  bool   `json:"inclusive"`
}

IncludedEndpoint custom type to include of a specific endpoint in an alert config

type IncludedService added in v1.3.0

type IncludedService struct {
	ServiceID string `json:"serviceId"`
	Inclusive bool   `json:"inclusive"`

	Endpoints map[string]IncludedEndpoint `json:"endpoints"`
}

IncludedService custom type to include of a specific service in an alert config

type InstanaAPI

type InstanaAPI interface {
	CustomEventSpecifications() RestResource
	BuiltinEventSpecifications() ReadOnlyRestResource
	APITokens() RestResource
	ApplicationConfigs() RestResource
	ApplicationAlertConfigs() RestResource
	GlobalApplicationAlertConfigs() RestResource
	AlertingChannels() RestResource
	AlertingChannelsDS() ReadOnlyRestResource
	AlertingConfigurations() RestResource
	SliConfigs() RestResource
	WebsiteMonitoringConfig() RestResource
	WebsiteAlertConfig() RestResource
	Groups() RestResource
	CustomDashboards() RestResource
	SyntheticTest() RestResource
	SyntheticLocation() ReadOnlyRestResource
}

InstanaAPI is the interface to all resources of the Instana Rest API

func NewInstanaAPI added in v0.8.0

func NewInstanaAPI(apiToken string, endpoint string, skipTlsVerification bool) InstanaAPI

NewInstanaAPI creates a new instance of the instana API

type InstanaDataObject

type InstanaDataObject interface {
	GetIDForResourcePath() string
	Validate() error
}

InstanaDataObject is a marker interface for any data object provided by any resource of the Instana REST API

type InstanaPermission added in v1.1.0

type InstanaPermission string

InstanaPermission data type representing an Instana permission string

type InstanaPermissions added in v1.1.0

type InstanaPermissions []InstanaPermission

InstanaPermissions data type representing a slice of Instana permissions

func (InstanaPermissions) IsSupported added in v1.1.0

func (permissions InstanaPermissions) IsSupported(toBeChecked InstanaPermission) bool

IsSupported checks if the provided InstanaPermission is a supported Instana permission

func (InstanaPermissions) ToStringSlice added in v1.1.0

func (permissions InstanaPermissions) ToStringSlice() []string

ToStringSlice converts the slice of InstanaPermissions to its string representation

type JSONUnmarshaller added in v0.11.0

type JSONUnmarshaller interface {
	//Unmarshal converts the provided json bytes into the go data data structure as provided in the target
	Unmarshal(data []byte) (interface{}, error)
}

JSONUnmarshaller interface definition for unmarshalling that unmarshalls JSON to go data structures

func NewApplicationAlertConfigUnmarshaller added in v1.3.0

func NewApplicationAlertConfigUnmarshaller() JSONUnmarshaller

NewApplicationAlertConfigUnmarshaller creates a new Unmarshaller instance for ApplicationAlertConfigs

func NewApplicationConfigUnmarshaller added in v0.8.0

func NewApplicationConfigUnmarshaller() JSONUnmarshaller

NewApplicationConfigUnmarshaller creates a new Unmarshaller instance for application configs

func NewDefaultJSONUnmarshaller added in v0.11.0

func NewDefaultJSONUnmarshaller(objectType interface{}) JSONUnmarshaller

NewDefaultJSONUnmarshaller creates a new instance of a generic JSONUnmarshaller without specific nested marshalling

func NewWebsiteAlertConfigUnmarshaller added in v1.4.0

func NewWebsiteAlertConfigUnmarshaller() JSONUnmarshaller

NewWebsiteAlertConfigUnmarshaller creates a new Unmarshaller instance for WebsiteAlertConfigs

type LogLevel added in v1.3.0

type LogLevel string

LogLevel custom type for log level

type LogLevels added in v1.3.0

type LogLevels []LogLevel

LogLevels custom type for a slice of LogLevel

func (LogLevels) IsSupported added in v1.3.0

func (levels LogLevels) IsSupported(level LogLevel) bool

IsSupported check if the provided LogLevel is supported

func (LogLevels) ToStringSlice added in v1.3.0

func (levels LogLevels) ToStringSlice() []string

ToStringSlice Returns the corresponding string representations

type LogicalOperatorType added in v1.1.0

type LogicalOperatorType string

LogicalOperatorType custom type for logical operators

type LogicalOperatorTypes added in v1.1.0

type LogicalOperatorTypes []LogicalOperatorType

LogicalOperatorTypes custom type for slice of logical operators

func (LogicalOperatorTypes) IsSupported added in v1.1.0

func (operators LogicalOperatorTypes) IsSupported(o LogicalOperatorType) bool

IsSupported check if the provided logical operator is supported

type MatchExpression added in v0.2.0

type MatchExpression interface {
	GetType() MatchExpressionType
	Validate() error
}

MatchExpression is the interface definition of a match expression in Instana

func NewBinaryOperator added in v0.2.0

func NewBinaryOperator(left MatchExpression, conjunction LogicalOperatorType, right MatchExpression) MatchExpression

NewBinaryOperator creates and new binary operator MatchExpression

func NewComparisonExpression added in v1.1.0

func NewComparisonExpression(key string, entity MatcherExpressionEntity, operator ExpressionOperator, value string) MatchExpression

NewComparisonExpression creates and new tag matcher expression for a comparision

func NewUnaryOperationExpression added in v0.2.0

func NewUnaryOperationExpression(key string, entity MatcherExpressionEntity, operator ExpressionOperator) MatchExpression

NewUnaryOperationExpression creates and new tag matcher expression for a unary operation

type MatchExpressionType added in v0.2.0

type MatchExpressionType string

MatchExpressionType type for MatchExpression discriminator type

const (
	//BinaryOperatorExpressionType discriminator type for binary operations
	BinaryOperatorExpressionType MatchExpressionType = "BINARY_OP"
	//LeafExpressionType discriminator type for leaf operations
	LeafExpressionType MatchExpressionType = "LEAF"
)

type MatcherExpressionEntities added in v0.10.0

type MatcherExpressionEntities []MatcherExpressionEntity

MatcherExpressionEntities custom type representing a slice of MatcherExpressionEntity

func (MatcherExpressionEntities) IsSupported added in v0.10.0

func (entities MatcherExpressionEntities) IsSupported(entity MatcherExpressionEntity) bool

IsSupported check if the provided matcher expression entity is supported

func (MatcherExpressionEntities) ToStringSlice added in v0.10.0

func (entities MatcherExpressionEntities) ToStringSlice() []string

ToStringSlice Returns the string representations fo the aggregations

type MatcherExpressionEntity added in v0.10.0

type MatcherExpressionEntity string

MatcherExpressionEntity type representing the matcher expression entity of a Matcher Expression (either source or destination or not applicable)

type MatchingOperator added in v0.9.0

type MatchingOperator interface {
	InstanaAPIValue() string
	TerraformSupportedValues() []string
}

MatchingOperator representation of a MatchingOperator of a threshold rule of a custom event specification of the Instana Web REST API

type MatchingOperators added in v0.9.0

type MatchingOperators []MatchingOperator

MatchingOperators custom type representing a slice of MatchingOperatorType

func (MatchingOperators) FromInstanaAPIValue added in v0.9.0

func (types MatchingOperators) FromInstanaAPIValue(instanaAPIvalue string) (MatchingOperator, error)

FromInstanaAPIValue returns the MatchingOperator for the given instana apistring value or an error if the operator type does not exist

func (MatchingOperators) FromTerraformValue added in v0.9.0

func (types MatchingOperators) FromTerraformValue(terraformRepresentation string) (MatchingOperator, error)

FromTerraformValue returns the MatchingOperator for the given terraform string value or an error if the operator type does not exist

func (MatchingOperators) InstanaAPISupportedValues added in v0.9.0

func (types MatchingOperators) InstanaAPISupportedValues() []string

InstanaAPISupportedValues Returns the terraform string representations fo the matching operators

func (MatchingOperators) IsSupportedInstanaAPIMatchingOperator added in v0.9.0

func (types MatchingOperators) IsSupportedInstanaAPIMatchingOperator(operator string) bool

IsSupportedInstanaAPIMatchingOperator check if the provided matching operator type is a supported instana api value

func (MatchingOperators) TerrafromSupportedValues added in v0.9.0

func (types MatchingOperators) TerrafromSupportedValues() []string

TerrafromSupportedValues Returns the terraform string representations fo the matching operators

type MetricConfiguration added in v0.10.0

type MetricConfiguration struct {
	Name        string  `json:"metricName"`
	Aggregation string  `json:"metricAggregation"`
	Threshold   float64 `json:"threshold"`
}

MetricConfiguration represents the nested object metric configuration of the sli config REST resource at Instana

func (MetricConfiguration) Validate added in v0.10.0

func (m MetricConfiguration) Validate() error

Validate implemention of the interface InstanaDataObject for MetricConfiguration

type MetricPattern added in v0.9.0

type MetricPattern struct {
	Prefix      string                    `json:"prefix"`
	Postfix     *string                   `json:"postfix"`
	Placeholder *string                   `json:"placeholder"`
	Operator    MetricPatternOperatorType `json:"operator"`
}

MetricPattern representation of a metric pattern for dynamic built-in metrics for CustomEventSpecification

func (*MetricPattern) Validate added in v0.9.0

func (m *MetricPattern) Validate() error

Validate checks if the given MetricPattern is consistent

type MetricPatternOperatorType added in v0.9.0

type MetricPatternOperatorType string

MetricPatternOperatorType the operator type of the metric pattern of a dynamic built-in metric

type MetricPatternOperatorTypes added in v0.9.0

type MetricPatternOperatorTypes []MetricPatternOperatorType

MetricPatternOperatorTypes type definition of a slice of MetricPatternOperatorType

func (MetricPatternOperatorTypes) IsSupported added in v0.9.0

IsSupported checks if the given value is a valid representation of a supported MetricPatternOperatorType

func (MetricPatternOperatorTypes) ToStringSlice added in v0.9.0

func (types MetricPatternOperatorTypes) ToStringSlice() []string

ToStringSlice Returns the string representations of the metric pattern operator types

type OpsGenieRegionType added in v0.8.0

type OpsGenieRegionType string

OpsGenieRegionType type of the OpsGenie region

type ReadOnlyRestResource added in v0.11.0

type ReadOnlyRestResource interface {
	GetAll() (*[]InstanaDataObject, error)
	GetOne(id string) (InstanaDataObject, error)
}

ReadOnlyRestResource interface definition for a read only REST resource. The resource at instana might implement more methods but the implementation of the provider is limited to read only.

func NewReadOnlyRestResource added in v0.11.0

func NewReadOnlyRestResource(resourcePath string, objectUnmarshaller JSONUnmarshaller, arrayUnmarshaller JSONUnmarshaller, client RestClient) ReadOnlyRestResource

NewReadOnlyRestResource creates a new instance of ReadOnlyRestResource

type RelationType added in v1.5.0

type RelationType string

RelationType custom type for relation type

type RelationTypes added in v1.5.0

type RelationTypes []RelationType

RelationTypes custom type for a slice of RelationType

func (RelationTypes) IsSupported added in v1.5.0

func (types RelationTypes) IsSupported(tpy RelationType) bool

IsSupported check if the provided RelationType is supported

func (RelationTypes) ToStringSlice added in v1.5.0

func (types RelationTypes) ToStringSlice() []string

ToStringSlice Returns the corresponding string representations

type RestClient

type RestClient interface {
	Get(resourcePath string) ([]byte, error)
	GetOne(id string, resourcePath string) ([]byte, error)
	Post(data InstanaDataObject, resourcePath string) ([]byte, error)
	PostWithID(data InstanaDataObject, resourcePath string) ([]byte, error)
	Put(data InstanaDataObject, resourcePath string) ([]byte, error)
	Delete(resourceID string, resourceBasePath string) error
	PostByQuery(resourcePath string, queryParams map[string]string) ([]byte, error)
	PutByQuery(resourcePath string, is string, queryParams map[string]string) ([]byte, error)
}

RestClient interface to access REST resources of the Instana API

func NewClient added in v0.8.0

func NewClient(apiToken string, host string, skipTlsVerification bool) RestClient

NewClient creates a new instance of the Instana REST API client

type RestResource added in v0.8.0

type RestResource interface {
	GetOne(id string) (InstanaDataObject, error)
	Create(data InstanaDataObject) (InstanaDataObject, error)
	Update(data InstanaDataObject) (InstanaDataObject, error)
	Delete(data InstanaDataObject) error
	DeleteByID(id string) error
}

RestResource interface definition of a instana REST resource.

func NewCreatePOSTUpdatePOSTRestResource added in v1.3.0

func NewCreatePOSTUpdatePOSTRestResource(resourcePath string, unmarshaller JSONUnmarshaller, client RestClient) RestResource

NewCreatePOSTUpdatePOSTRestResource creates a new REST resource using the provided unmarshaller function to convert the response from the REST API to the corresponding InstanaDataObject. The REST resource is using POST as operation for create and update

func NewCreatePOSTUpdatePUTRestResource added in v1.0.0

func NewCreatePOSTUpdatePUTRestResource(resourcePath string, unmarshaller JSONUnmarshaller, client RestClient) RestResource

NewCreatePOSTUpdatePUTRestResource creates a new REST resource using the provided unmarshaller function to convert the response from the REST API to the corresponding InstanaDataObject. The REST resource is using POST as operation for create and PUT for update

func NewCreatePUTUpdatePUTRestResource added in v1.0.0

func NewCreatePUTUpdatePUTRestResource(resourcePath string, unmarshaller JSONUnmarshaller, client RestClient) RestResource

NewCreatePUTUpdatePUTRestResource creates a new REST resource using the provided unmarshaller function to convert the response from the REST API to the corresponding InstanaDataObject. The REST resource is using PUT as operation for create and update

func NewSyntheticTestRestResource added in v1.6.0

func NewSyntheticTestRestResource(unmarshaller JSONUnmarshaller, client RestClient) RestResource

NewSyntheticTestRestResource creates a new REST resource using the provided unmarshaller function to convert the response from the REST API to the corresponding InstanaDataObject. The REST resource is using PUT as operation for create and update

func NewWebsiteMonitoringConfigRestResource added in v0.10.0

func NewWebsiteMonitoringConfigRestResource(unmarshaller JSONUnmarshaller, client RestClient) RestResource

NewWebsiteMonitoringConfigRestResource creates a new REST for the website monitoring config

type RuleSpecification added in v0.2.0

type RuleSpecification struct {
	//Common Fields
	DType    string `json:"ruleType"`
	Severity int    `json:"severity"`

	//System Rule fields
	SystemRuleID *string `json:"systemRuleId"`

	//Threshold Rule fields
	MetricName        *string          `json:"metricName"`
	Rollup            *int             `json:"rollup"`
	Window            *int             `json:"window"`
	Aggregation       *AggregationType `json:"aggregation"`
	ConditionOperator *string          `json:"conditionOperator"`
	ConditionValue    *float64         `json:"conditionValue"`
	MetricPattern     *MetricPattern   `json:"metricPattern"`

	//Entity Verification Rule
	MatchingEntityType  *string `json:"matchingEntityType"`
	MatchingOperator    *string `json:"matchingOperator"`
	MatchingEntityLabel *string `json:"matchingEntityLabel"`
	OfflineDuration     *int    `json:"offlineDuration"`
}

RuleSpecification representation of a rule specification for a CustomEventSpecification

func NewEntityVerificationRuleSpecification added in v0.7.0

func NewEntityVerificationRuleSpecification(matchingEntityLabel string, matchingEntityType string, matchingOperator string, offlineDuration int, severity int) RuleSpecification

NewEntityVerificationRuleSpecification creates a new instance of Entity Verification Rule

func NewSystemRuleSpecification added in v0.2.0

func NewSystemRuleSpecification(systemRuleID string, severity int) RuleSpecification

NewSystemRuleSpecification creates a new instance of System Rule

func (*RuleSpecification) ConditionOperatorType added in v0.9.1

func (r *RuleSpecification) ConditionOperatorType() (ConditionOperator, error)

ConditionOperatorType returns the ConditionOperator for the given Instana Web REST API representation when available. In case of invalid values an error will be returned

func (*RuleSpecification) MatchingOperatorType added in v0.9.0

func (r *RuleSpecification) MatchingOperatorType() (MatchingOperator, error)

MatchingOperatorType returns the MatchingOperatorType for the given Instana Web REST API representation when available. In case of invalid values an error will be returned

func (*RuleSpecification) Validate added in v0.2.0

func (r *RuleSpecification) Validate() error

Validate Rule interface implementation for SystemRule

type ScopeBinding added in v1.1.0

type ScopeBinding struct {
	ScopeID     string  `json:"scopeId"`
	ScopeRoleID *string `json:"scopeRoleId"`
}

ScopeBinding data structure for the Instana API model for scope bindings

type Severities added in v1.3.0

type Severities []Severity

Severities custom type representing a slice of Severity

func (Severities) APIRepresentations added in v1.3.0

func (severities Severities) APIRepresentations() []int

APIRepresentations returns the corresponding Instana API representations as int slice

func (Severities) IsSupported added in v1.3.0

func (severities Severities) IsSupported(severity Severity) bool

IsSupported check if the provided Severity is supported

func (Severities) TerraformRepresentations added in v1.3.0

func (severities Severities) TerraformRepresentations() []string

TerraformRepresentations returns the corresponding Terraform representations as string slice

type Severity added in v0.2.0

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

Severity representation of the severity in both worlds Instana API and Terraform Provider

func (Severity) GetAPIRepresentation added in v0.2.0

func (s Severity) GetAPIRepresentation() int

GetAPIRepresentation returns the integer representation of the Instana API

func (Severity) GetTerraformRepresentation added in v0.2.0

func (s Severity) GetTerraformRepresentation() string

GetTerraformRepresentation returns the string representation of the Terraform Provider

type SliConfig added in v0.10.0

type SliConfig struct {
	ID                         string              `json:"id"`
	Name                       string              `json:"sliName"`
	InitialEvaluationTimestamp int                 `json:"initialEvaluationTimestamp"`
	MetricConfiguration        MetricConfiguration `json:"metricConfiguration"`
	SliEntity                  SliEntity           `json:"sliEntity"`
}

SliConfig represents the REST resource of sli configuration at Instana

func (*SliConfig) GetIDForResourcePath added in v1.0.0

func (s *SliConfig) GetIDForResourcePath() string

GetIDForResourcePath implemention of the interface InstanaDataObject

func (*SliConfig) Validate added in v0.10.0

func (s *SliConfig) Validate() error

Validate implemention of the interface InstanaDataObject for SliConfig

type SliEntity added in v0.10.0

type SliEntity struct {
	Type          string `json:"sliType"`
	ApplicationID string `json:"applicationId"`
	ServiceID     string `json:"serviceId"`
	EndpointID    string `json:"endpointId"`
	BoundaryScope string `json:"boundaryScope"`
}

SliEntity represents the nested object sli entity of the sli config REST resource at Instana

func (SliEntity) Validate added in v0.10.0

func (s SliEntity) Validate() error

Validate implemention of the interface InstanaDataObject for SliEntity

type StaticStringCustomPayloadFieldValue added in v1.3.0

type StaticStringCustomPayloadFieldValue string

StaticStringCustomPayloadFieldValue type for static string values of custom payload field

type SyntheticLocation added in v1.6.0

type SyntheticLocation struct {
	ID           string `json:"id"`
	Label        string `json:"label"`
	Description  string `json:"description"`
	LocationType string `json:"locationType"`
}

func (SyntheticLocation) GetIDForResourcePath added in v1.6.0

func (s SyntheticLocation) GetIDForResourcePath() string

GetIDForResourcePath implementation of the interface InstanaDataObject for SyntheticLocation

func (SyntheticLocation) Validate added in v1.6.0

func (s SyntheticLocation) Validate() error

Validate implementation of the interface InstanaDataObject for SyntheticLocation

type SyntheticTest added in v1.6.0

type SyntheticTest struct {
	ID               string                 `json:"id"`
	Label            string                 `json:"label"`
	Description      string                 `json:"description"`
	Active           bool                   `json:"active"`
	Configuration    SyntheticTestConfig    `json:"configuration"`
	CustomProperties map[string]interface{} `json:"customProperties"`
	Locations        []string               `json:"locations"`
	PlaybackMode     string                 `json:"playbackMode"`
	TestFrequency    int32                  `json:"testFrequency"`
}

func (*SyntheticTest) GetIDForResourcePath added in v1.6.0

func (s *SyntheticTest) GetIDForResourcePath() string

GetIDForResourcePath implementation of the interface InstanaDataObject for SyntheticTest

func (*SyntheticTest) Validate added in v1.6.0

func (s *SyntheticTest) Validate() error

Validate implementation of the interface InstanaDataObject for SyntheticTest

type SyntheticTestConfig added in v1.6.0

type SyntheticTestConfig struct {
	MarkSyntheticCall bool   `json:"markSyntheticCall"`
	Retries           int32  `json:"retries"`
	RetryInterval     int32  `json:"retryInterval"`
	SyntheticType     string `json:"syntheticType"`
	Timeout           string `json:"timeout"`
	// HttpAction
	URL              string                 `json:"url"`
	Operation        string                 `json:"operation"`
	Headers          map[string]interface{} `json:"headers"`
	Body             string                 `json:"body"`
	ValidationString string                 `json:"validationString"`
	FollowRedirect   bool                   `json:"followRedirect"`
	AllowInsecure    bool                   `json:"allowInsecure"`
	ExpectStatus     int32                  `json:"expectStatus"`
	ExpectMatch      string                 `json:"expectMatch"`
	// HttpScript
	Script string `json:"script"`
}

type SyntheticTestRestResource added in v1.6.0

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

func (*SyntheticTestRestResource) Create added in v1.6.0

func (*SyntheticTestRestResource) Delete added in v1.6.0

func (*SyntheticTestRestResource) DeleteByID added in v1.6.0

func (r *SyntheticTestRestResource) DeleteByID(id string) error

func (*SyntheticTestRestResource) GetOne added in v1.6.0

func (*SyntheticTestRestResource) Update added in v1.6.0

type TagFilter added in v1.1.0

type TagFilter struct {
	Entity       TagFilterEntity                `json:"entity"`
	Name         string                         `json:"name"`
	Operator     ExpressionOperator             `json:"operator"`
	BooleanValue *bool                          `json:"booleanValue"`
	NumberValue  *int64                         `json:"numberValue"`
	StringValue  *string                        `json:"stringValue"`
	Key          *string                        `json:"key"`
	Value        interface{}                    `json:"value"`
	Type         TagFilterExpressionElementType `json:"type"`
}

TagFilter data structure of a Tag Filter from the Instana API

func NewBooleanTagFilter added in v1.1.0

func NewBooleanTagFilter(entity TagFilterEntity, name string, operator ExpressionOperator, value bool) *TagFilter

NewBooleanTagFilter creates a new TagFilter for comparing tags

func NewNumberTagFilter added in v1.1.0

func NewNumberTagFilter(entity TagFilterEntity, name string, operator ExpressionOperator, value int64) *TagFilter

NewNumberTagFilter creates a new TagFilter for comparing number values

func NewStringTagFilter added in v1.1.0

func NewStringTagFilter(entity TagFilterEntity, name string, operator ExpressionOperator, value string) *TagFilter

NewStringTagFilter creates a new TagFilter for comparing string values

func NewTagTagFilter added in v1.1.0

func NewTagTagFilter(entity TagFilterEntity, name string, operator ExpressionOperator, key string, value string) *TagFilter

NewTagTagFilter creates a new TagFilter for comparing tags

func NewUnaryTagFilter added in v1.1.0

func NewUnaryTagFilter(entity TagFilterEntity, name string, operator ExpressionOperator) *TagFilter

NewUnaryTagFilter creates a new TagFilter for unary expressions

func NewUnaryTagFilterWithTagKey added in v1.1.4

func NewUnaryTagFilterWithTagKey(entity TagFilterEntity, name string, tagKey *string, operator ExpressionOperator) *TagFilter

NewUnaryTagFilterWithTagKey creates a new TagFilter for unary expressions supporting tagKeys

func (*TagFilter) GetType added in v1.1.0

GetType Implementation of the TagFilterExpressionElement type

func (*TagFilter) Validate added in v1.1.0

func (f *TagFilter) Validate() error

Validate Implementation of the TagFilterExpressionElement type

type TagFilterEntities added in v1.1.0

type TagFilterEntities []TagFilterEntity

TagFilterEntities custom type representing a slice of TagFilterEntity

func (TagFilterEntities) IsSupported added in v1.1.0

func (entities TagFilterEntities) IsSupported(entity TagFilterEntity) bool

IsSupported check if the provided tag filter entity is supported

func (TagFilterEntities) ToStringSlice added in v1.1.0

func (entities TagFilterEntities) ToStringSlice() []string

ToStringSlice Returns the string representations fo the aggregations

type TagFilterEntity added in v1.1.0

type TagFilterEntity string

TagFilterEntity type representing the matcher expression entity of a Matcher Expression (either source or destination or not applicable)

type TagFilterExpression added in v1.1.0

type TagFilterExpression struct {
	Elements        []TagFilterExpressionElement   `json:"elements"`
	LogicalOperator LogicalOperatorType            `json:"logicalOperator"`
	Type            TagFilterExpressionElementType `json:"type"`
}

TagFilterExpression data structure of an Instana tag filter expression

func NewLogicalAndTagFilter added in v1.1.0

func NewLogicalAndTagFilter(elements []TagFilterExpressionElement) *TagFilterExpression

NewLogicalAndTagFilter creates a new logical AND expression

func NewLogicalOrTagFilter added in v1.1.0

func NewLogicalOrTagFilter(elements []TagFilterExpressionElement) *TagFilterExpression

NewLogicalOrTagFilter creates a new logical OR expression

func (*TagFilterExpression) GetType added in v1.1.0

GetType Implementation of the TagFilterExpressionElement type

func (*TagFilterExpression) PrependElement added in v1.1.0

func (e *TagFilterExpression) PrependElement(element TagFilterExpressionElement)

PrependElement adds a TagFilterExpressionElement to the end of the list of elements

func (*TagFilterExpression) Validate added in v1.1.0

func (e *TagFilterExpression) Validate() error

Validate Implementation of the TagFilterExpressionElement type

type TagFilterExpressionElement added in v1.1.0

type TagFilterExpressionElement interface {
	GetType() TagFilterExpressionElementType
	Validate() error
}

TagFilterExpressionElement interface for the Instana API type TagFilterExpressionElement

type TagFilterExpressionElementType added in v1.1.0

type TagFilterExpressionElementType string

TagFilterExpressionElementType type for TagFilterExpressionElement discriminator type

const (
	//TagFilterExpressionType discriminator type for expression TagFilterExpressionElement
	TagFilterExpressionType TagFilterExpressionElementType = "EXPRESSION"
	//TagFilterType discriminator type for leaf tag_filter TagFilterExpressionElementType
	TagFilterType TagFilterExpressionElementType = "TAG_FILTER"
)

type TagFilterUnmarshaller added in v1.3.0

type TagFilterUnmarshaller interface {
	Unmarshal(raw json.RawMessage) (TagFilterExpressionElement, error)
}

TagFilterUnmarshaller interface for the unmarshaller for TagFilterExpressions

func NewTagFilterUnmarshaller added in v1.3.0

func NewTagFilterUnmarshaller() TagFilterUnmarshaller

NewTagFilterUnmarshaller creates a new instance of TagFilterUnmarshaller

type TagMatcherExpression added in v0.2.0

type TagMatcherExpression struct {
	Dtype    MatchExpressionType     `json:"type"`
	Key      string                  `json:"key"`
	Entity   MatcherExpressionEntity `json:"entity"`
	Operator ExpressionOperator      `json:"operator"`
	Value    *string                 `json:"value"`
}

TagMatcherExpression is the representation of a tag matcher expression in Instana

func (*TagMatcherExpression) GetType added in v0.2.0

GetType implementation of the interface MatchExpression for TagMatcherExpression

func (*TagMatcherExpression) Validate added in v0.2.0

func (t *TagMatcherExpression) Validate() error

Validate implementation of the interface MatchExpression for TagMatcherExpression

type Threshold added in v1.3.0

type Threshold struct {
	Type            string                `json:"type"`
	Operator        ThresholdOperator     `json:"operator"`
	Baseline        *[][]float64          `json:"baseline"`
	DeviationFactor *float32              `json:"deviationFactor"`
	LastUpdated     *int64                `json:"lastUpdated"`
	Seasonality     *ThresholdSeasonality `json:"seasonality"`
	Value           *float64              `json:"value"`
}

Threshold custom data structure representing the threshold type of the instana API

type ThresholdOperator added in v1.3.0

type ThresholdOperator string

ThresholdOperator custom type for the operator of a threshold data structure

type ThresholdOperators added in v1.3.0

type ThresholdOperators []ThresholdOperator

ThresholdOperators custom type for a slice of LogLevel

func (ThresholdOperators) IsSupported added in v1.3.0

func (operators ThresholdOperators) IsSupported(operator ThresholdOperator) bool

IsSupported check if the provided ThresholdOperator is supported

func (ThresholdOperators) ToStringSlice added in v1.3.0

func (operators ThresholdOperators) ToStringSlice() []string

ToStringSlice Returns the corresponding string representations

type ThresholdSeasonalities added in v1.3.0

type ThresholdSeasonalities []ThresholdSeasonality

ThresholdSeasonalities custom type for a slice of ThresholdSeasonality

func (ThresholdSeasonalities) IsSupported added in v1.3.0

func (seasonalities ThresholdSeasonalities) IsSupported(seasonality ThresholdSeasonality) bool

IsSupported check if the provided ThresholdSeasonality is supported

func (ThresholdSeasonalities) ToStringSlice added in v1.3.0

func (seasonalities ThresholdSeasonalities) ToStringSlice() []string

ToStringSlice Returns the corresponding string representations

type ThresholdSeasonality added in v1.3.0

type ThresholdSeasonality string

ThresholdSeasonality custom type for the seasonality of a threshold data structure

type TimeThreshold added in v1.3.0

type TimeThreshold struct {
	Type       string `json:"type"`
	TimeWindow int64  `json:"timeWindow"`
	Requests   *int32 `json:"requests"`
	Violations *int32 `json:"violations"`
}

TimeThreshold custom data structure representing the time threshold type of the instana API

type WebsiteAlertConfig added in v1.4.0

type WebsiteAlertConfig struct {
	ID                    string                                                    `json:"id"`
	Name                  string                                                    `json:"name"`
	Description           string                                                    `json:"description"`
	Severity              int                                                       `json:"severity"`
	Triggering            bool                                                      `json:"triggering"`
	WebsiteID             string                                                    `json:"websiteId"`
	TagFilterExpression   interface{}                                               `json:"tagFilterExpression"`
	AlertChannelIDs       []string                                                  `json:"alertChannelIds"`
	Granularity           Granularity                                               `json:"granularity"`
	CustomerPayloadFields []CustomPayloadField[StaticStringCustomPayloadFieldValue] `json:"customPayloadFields"`
	Rule                  WebsiteAlertRule                                          `json:"rule"`
	Threshold             Threshold                                                 `json:"threshold"`
	TimeThreshold         WebsiteTimeThreshold                                      `json:"timeThreshold"`
}

WebsiteAlertConfig is the representation of an website alert configuration in Instana

func (*WebsiteAlertConfig) GetIDForResourcePath added in v1.4.0

func (r *WebsiteAlertConfig) GetIDForResourcePath() string

GetIDForResourcePath implementation of the interface InstanaDataObject

func (*WebsiteAlertConfig) Validate added in v1.4.0

func (r *WebsiteAlertConfig) Validate() error

Validate implementation of the interface InstanaDataObject to verify if data object is correct

type WebsiteAlertRule added in v1.4.0

type WebsiteAlertRule struct {
	AlertType   string              `json:"alertType"`
	MetricName  string              `json:"metricName"`
	Aggregation *Aggregation        `json:"aggregation"`
	Operator    *ExpressionOperator `json:"operator"`
	Value       *string             `json:"value"`
}

WebsiteAlertRule struct representing the API model of a website alert rule

type WebsiteImpactMeasurementMethod added in v1.4.0

type WebsiteImpactMeasurementMethod string

WebsiteImpactMeasurementMethod custom type for impact measurement method of website alert rules

type WebsiteImpactMeasurementMethods added in v1.4.0

type WebsiteImpactMeasurementMethods []WebsiteImpactMeasurementMethod

WebsiteImpactMeasurementMethods custom type for a slice of WebsiteImpactMeasurementMethod

func (WebsiteImpactMeasurementMethods) IsSupported added in v1.4.0

IsSupported check if the provided WebsiteImpactMeasurementMethod is supported

func (WebsiteImpactMeasurementMethods) ToStringSlice added in v1.4.0

func (methods WebsiteImpactMeasurementMethods) ToStringSlice() []string

ToStringSlice Returns the corresponding string representations

type WebsiteMonitoringConfig added in v0.10.0

type WebsiteMonitoringConfig struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	AppName string `json:"appName"`
}

WebsiteMonitoringConfig data structure of a Website Monitoring Configuration of the Instana API

func (*WebsiteMonitoringConfig) GetIDForResourcePath added in v1.0.0

func (r *WebsiteMonitoringConfig) GetIDForResourcePath() string

GetIDForResourcePath implemention of the interface InstanaDataObject

func (*WebsiteMonitoringConfig) Validate added in v0.10.0

func (r *WebsiteMonitoringConfig) Validate() error

Validate implementation of the interface InstanaDataObject to verify if data object is correct

type WebsiteTimeThreshold added in v1.4.0

type WebsiteTimeThreshold struct {
	Type                    string                          `json:"type"`
	TimeWindow              *int64                          `json:"timeWindow"`
	Violations              *int32                          `json:"violations"`
	ImpactMeasurementMethod *WebsiteImpactMeasurementMethod `json:"impactMeasurementMethod"`
	UserPercentage          *float64                        `json:"userPercentage"`
	Users                   *int32                          `json:"users"`
}

WebsiteTimeThreshold struct representing the API model of a website time threshold

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL