oci_apm_config_config

This resource provides the Config resource in Oracle Cloud Infrastructure Apm Config service.

Creates a new configuration item.

Example Usage

resource "oci_apm_config_config" "test_config" {
	#Required
	apm_domain_id = oci_apm_apm_domain.test_apm_domain.id
	config_type = var.config_config_type
	display_name = var.config_display_name

	#Optional
	defined_tags = {"foo-namespace.bar-key"= "value"}
	description = var.config_description
	dimensions {

		#Optional
		name = var.config_dimensions_name
		value_source = var.config_dimensions_value_source
	}
	filter_id = oci_apm_config_filter.test_filter.id
	filter_text = var.config_filter_text
	freeform_tags = {"bar-key"= "value"}
	group = var.config_group
	metrics {

		#Optional
		description = var.config_metrics_description
		name = var.config_metrics_name
		unit = var.config_metrics_unit
		value_source = var.config_metrics_value_source
	}
	namespace = var.config_namespace
	opc_dry_run = var.config_opc_dry_run
	options = var.config_options
	rules {

		#Optional
		display_name = var.config_rules_display_name
		filter_text = var.config_rules_filter_text
		is_apply_to_error_spans = var.config_rules_is_apply_to_error_spans
		is_enabled = var.config_rules_is_enabled
		priority = var.config_rules_priority
		satisfied_response_time = var.config_rules_satisfied_response_time
		tolerating_response_time = var.config_rules_tolerating_response_time
	}
}

Argument Reference

The following arguments are supported:

apm_domain_id - (Required) (Updatable) The APM Domain ID the request is intended for.
config_type - (Required) (Updatable) The type of configuration item.
defined_tags - (Optional) (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description - (Applicable when config_type=OPTIONS | SPAN_FILTER) (Updatable) An optional string that describes what the options are intended or used for.
dimensions - (Applicable when config_type=METRIC_GROUP) (Updatable) A list of dimensions for the metric. This variable should not be used.
- name - (Required when config_type=METRIC_GROUP) (Updatable) The name of the dimension.
- value_source - (Applicable when config_type=METRIC_GROUP) (Updatable) The source to populate the dimension. This must not be specified.
display_name - (Required) (Updatable) The name by which a configuration entity is displayed to the end user.
filter_id - (Required when config_type=METRIC_GROUP) (Updatable) The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.
filter_text - (Required when config_type=SPAN_FILTER) (Updatable) The string that defines the Span Filter expression.
freeform_tags - (Optional) (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
group - (Applicable when config_type=OPTIONS) (Updatable) A string that specifies the group that an OPTIONS item belongs to.
metrics - (Required when config_type=METRIC_GROUP) (Updatable) The list of metrics in this group.
- description - (Applicable when config_type=METRIC_GROUP) (Updatable) A description of the metric.
- name - (Required when config_type=METRIC_GROUP) (Updatable) The name of the metric. This must be a known metric name.
- unit - (Applicable when config_type=METRIC_GROUP) (Updatable) The unit of the metric.
- value_source - (Applicable when config_type=METRIC_GROUP) (Updatable) This must not be set.
namespace - (Applicable when config_type=METRIC_GROUP) (Updatable) The namespace to which the metrics are published. It must be one of several predefined namespaces.
opc_dry_run - (Optional) (Updatable) Indicates that the request is a dry run, if set to “true”. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
options - (Applicable when config_type=OPTIONS) (Updatable) The options are stored here as JSON.
rules - (Required when config_type=APDEX) (Updatable)
- display_name - (Applicable when config_type=APDEX) (Updatable) The name by which a configuration entity is displayed to the end user.
- filter_text - (Required when config_type=APDEX) (Updatable) The string that defines the Span Filter expression.
- is_apply_to_error_spans - (Applicable when config_type=APDEX) (Updatable) Specifies whether an Apdex score should be computed for error spans. Setting it to “true” means that the Apdex score is computed in the usual way. Setting it to “false” skips the Apdex computation and sets the Apdex score to “frustrating” regardless of the configured thresholds. The default is “false”.
- is_enabled - (Applicable when config_type=APDEX) (Updatable) Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is “true”.
- priority - (Required when config_type=APDEX) (Updatable) The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
- satisfied_response_time - (Applicable when config_type=APDEX) (Updatable) The maximum response time in milliseconds that is considered “satisfactory” for the end user.
- tolerating_response_time - (Applicable when config_type=APDEX) (Updatable) The maximum response time in milliseconds that is considered “tolerable” for the end user. A response time beyond this threshold is considered “frustrating”. This value cannot be lower than “satisfiedResponseTime”.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Attributes Reference

The following attributes are exported:

config_type - The type of configuration item.
created_by - The OCID of a user.
defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description - An optional string that describes what the span filter is intended or used for.
dimensions - A list of dimensions for the metric. This variable should not be used.
- name - The name of the dimension.
- value_source - The source to populate the dimension. This must not be specified.
display_name - The name by which a configuration entity is displayed to the end user.
etag - For optimistic concurrency control. See if-match.
filter_id - The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.
filter_text - The string that defines the Span Filter expression.
freeform_tags - Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
group - A string that specifies the group that an OPTIONS item belongs to.
id - The OCID of the configuration item. An OCID is generated when the item is created.
in_use_by - The list of configuration items that reference the span filter.
- config_type - The type of configuration item.
- display_name - The name by which a configuration entity is displayed to the end user.
- id - The OCID of the configuration item. An OCID is generated when the item is created.
- options_group - A string that specifies the group that an OPTIONS item belongs to.
metrics - The list of metrics in this group.
- description - A description of the metric.
- name - The name of the metric. This must be a known metric name.
- unit - The unit of the metric.
- value_source - This must not be set.
namespace - The namespace to which the metrics are published. It must be one of several predefined namespaces.
options - The options are stored here as JSON.
rules -
- display_name - The name by which a configuration entity is displayed to the end user.
- filter_text - The string that defines the Span Filter expression.
- is_apply_to_error_spans - Specifies whether an Apdex score should be computed for error spans. Setting it to “true” means that the Apdex score is computed in the usual way. Setting it to “false” skips the Apdex computation and sets the Apdex score to “frustrating” regardless of the configured thresholds. The default is “false”.
- is_enabled - Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is “true”.
- priority - The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.
- satisfied_response_time - The maximum response time in milliseconds that is considered “satisfactory” for the end user.
- tolerating_response_time - The maximum response time in milliseconds that is considered “tolerable” for the end user. A response time beyond this threshold is considered “frustrating”. This value cannot be lower than “satisfiedResponseTime”.
time_created - The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
time_updated - The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
updated_by - The OCID of a user.

Timeouts

The timeouts block allows you to specify timeouts for certain operations: * create - (Defaults to 20 minutes), when creating the Config * update - (Defaults to 20 minutes), when updating the Config * delete - (Defaults to 20 minutes), when destroying the Config

Import

Configs can be imported using the id, e.g.

$ terraform import oci_apm_config_config.test_config "configs/{configId}/apmDomainId/{apmDomainId}"