apmconfig.oracle.com/v1beta1¶
APIVersion: apmconfig.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
No customer-visible package currently exposes apmconfig.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| Config | Namespaced | Sample | - |
Config¶
Manage OCI Application Performance Monitoring configuration items.
Plural:configsScope:NamespacedAPIVersion:apmconfig.oracle.com/v1beta1Sample: Sample (config/samples/apmconfig_v1beta1_config.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ConfigSpec defines the desired state of Config.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
agentVersion |
The version of the referenced agent bundle. | string |
No | - | - |
apmDomainId |
The APM Domain ID the request is intended for. | string |
Yes | - | - |
attachInstallDir |
The directory owned by runAsUser. | string |
No | - | - |
config |
ConfigFields defines nested fields for Config.Config. | object |
No | - | - |
configType |
The discriminator that selects which OCI Config subtype to create or update. Supported values are SPAN_FILTER, METRIC_GROUP, APDEX, OPTIONS, AGENT, and MACS_APM_EXTENSION. |
string |
Yes | - | AGENT, APDEX, MACS_APM_EXTENSION, METRIC_GROUP, OPTIONS, SPAN_FILTER |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
description |
An optional string that describes what the filter is intended or used for. | string |
No | - | - |
dimensions |
A list of dimensions for the metric. This variable should not be used. | list[object] |
No | - | - |
displayName |
The name by which a configuration entity is displayed to the end user. | string |
No | - | - |
filterId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created. | string |
No | - | - |
filterText |
The string that defines the Span Filter expression. | string |
No | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No | - | - |
group |
A string that specifies the group that an OPTIONS item belongs to. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
managementAgentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent that will provision the APM Agent. | string |
No | - | - |
matchAgentsWithAttributeValue |
The agent attribute VALUE by which an agent configuration is matched to an agent. Each agent configuration object must specify a different value. The attribute KEY corresponding to this VALUE is in the matchAgentsWithAttributeKey field. | string |
No | - | - |
metrics |
The list of metrics in this group. | list[object] |
No | - | - |
namespace |
The namespace to which the metrics are published. It must be one of several predefined namespaces. | string |
No | - | - |
options |
The options are stored here as JSON. Unknown nested fields are preserved. | object (preserves unknown fields) |
No | - | - |
overrides |
ConfigOverrides defines nested fields for Config.Overrides. | object |
No | - | - |
processFilter |
Filter patterns used to discover active Java processes for provisioning the APM Agent. | list[string] |
No | - | - |
rules |
- | list[object] |
No | - | - |
runAsUser |
The OS user that should be used to discover Java processes. | string |
No | - | - |
serviceName |
The name of the service being monitored. This argument enables you to filter by service and view traces and other signals in the APM Explorer user interface. | string |
No | - | - |
Spec.config¶
ConfigFields defines nested fields for Config.Config.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
configMap |
Map of agent configuration files, where keys are file names. | map[string, object] |
No | - | - |
Spec.config.configMap{}¶
ConfigConfigMap defines nested fields for Config.Config.ConfigMap.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
body |
The Base64 encoded agent configuration file. | string |
No | - | - |
contentType |
The MIME Content-Type that describes the content of the body field, for example, text/yaml or text/yaml; charset=utf-8 | string |
No | - | - |
Spec.dimensions[]¶
ConfigDimension defines nested fields for Config.Dimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the dimension. | string |
Yes | - | - |
valueSource |
The source to populate the dimension. This must not be specified. | string |
No | - | - |
Spec.metrics[]¶
ConfigMetric defines nested fields for Config.Metric.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
A description of the metric. | string |
No | - | - |
name |
The name of the metric. This must be a known metric name. | string |
Yes | - | - |
unit |
The unit of the metric. | string |
No | - | - |
valueSource |
This must not be set. | string |
No | - | - |
Spec.overrides¶
ConfigOverrides defines nested fields for Config.Overrides.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
overrideList |
- | list[object] |
No | - | - |
Spec.overrides.overrideList[]¶
ConfigOverridesOverrideList defines nested fields for Config.Overrides.OverrideList.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
agentFilter |
The string that defines the Agent Filter expression. | string |
No | - | - |
overrideMap |
A map whose key is a substitution variable specified within the configuration's body. For example, if below was specified in the configuration's body {{ isJfrEnabled | default false }} Then a valid map key would be "isJfrEnabled". The value is typically different than the default specified in the configuration's body. Thus, in this example, the map entry could be "isJfrEnabled": true | map[string, string] |
No | - | - |
Spec.rules[]¶
ConfigRule defines nested fields for Config.Rule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
displayName |
The name by which a configuration entity is displayed to the end user. | string |
No | - | - |
filterText |
The string that defines the Span Filter expression. | string |
Yes | - | - |
isApplyToErrorSpans |
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". | boolean |
No | - | - |
isEnabled |
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". | boolean |
No | - | - |
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. | integer |
Yes | - | - |
satisfiedResponseTime |
The maximum response time in milliseconds that is considered "satisfactory" for the end user. | integer |
No | - | - |
toleratingResponseTime |
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". | integer |
No | - | - |
Status¶
ConfigStatus defines the observed state of Config.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
agentVersion |
The version of the referenced agent bundle. | string |
No | - | - |
apmDomainId |
The bound APM Domain ID used to address this configuration item. | string |
No | - | - |
attachInstallDir |
The directory owned by runAsUser. | string |
No | - | - |
config |
ConfigFields defines nested fields for Config.Config. | object |
No | - | - |
configType |
- | string |
No | - | - |
createdBy |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a user. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
description |
An optional string that describes what the options are intended or used for. | string |
No | - | - |
dimensions |
A list of dimensions for the metric. This variable should not be used. | list[object] |
No | - | - |
displayName |
The name by which a configuration entity is displayed to the end user. | string |
No | - | - |
etag |
For optimistic concurrency control. See if-match. |
string |
No | - | - |
filterId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created. | string |
No | - | - |
filterText |
The string that defines the Span Filter expression. | string |
No | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No | - | - |
group |
A string that specifies the group that an OPTIONS item belongs to. | string |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated when the item is created. | string |
No | - | - |
inUseBy |
The list of configuration items that reference the span filter. | list[object] |
No | - | - |
jsonData |
- | string |
No | - | - |
managementAgentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent that will provision the APM Agent. | string |
No | - | - |
matchAgentsWithAttributeKey |
The agent attribute KEY by which an Agent configuration is matched to an agent. All agent configuration objects share the same key. It is [ServiceName, service.name] by default. The attribute VALUE corresponding to this KEY is in the matchAgentsWithAttributeValue field. | list[string] |
No | - | - |
matchAgentsWithAttributeValue |
The agent attribute VALUE by which an agent configuration is matched to an agent. Each agent configuration object must specify a different value. The attribute KEY corresponding to this VALUE is in the matchAgentsWithAttributeKey field. | string |
No | - | - |
metrics |
The list of metrics in this group. | list[object] |
No | - | - |
namespace |
The namespace to which the metrics are published. It must be one of several predefined namespaces. | string |
No | - | - |
options |
The options are stored here as JSON. Unknown nested fields are preserved. | object (preserves unknown fields) |
No | - | - |
overrides |
ConfigOverrides defines nested fields for Config.Overrides. | object |
No | - | - |
processFilter |
Filter patterns used to discover active Java processes for provisioning the APM Agent. | list[string] |
No | - | - |
rules |
- | list[object] |
No | - | - |
runAsUser |
The OS user that should be used to discover Java processes. | string |
No | - | - |
serviceName |
The name of the service being monitored. This argument enables you to filter by service and view traces and other signals in the APM Explorer user interface. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2020-02-12T22:47:12.613Z |
string |
No | - | - |
timeUpdated |
The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2020-02-13T22:47:12.613Z |
string |
No | - | - |
updatedBy |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a user. | string |
No | - | - |
Status.config¶
ConfigFields defines nested fields for Config.Config.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
configMap |
Map of agent configuration files, where keys are file names. | map[string, object] |
No | - | - |
Status.config.configMap{}¶
ConfigConfigMap defines nested fields for Config.Config.ConfigMap.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
body |
The Base64 encoded agent configuration file. | string |
No | - | - |
contentType |
The MIME Content-Type that describes the content of the body field, for example, text/yaml or text/yaml; charset=utf-8 | string |
No | - | - |
Status.dimensions[]¶
ConfigDimension defines nested fields for Config.Dimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The name of the dimension. | string |
Yes | - | - |
valueSource |
The source to populate the dimension. This must not be specified. | string |
No | - | - |
Status.inUseBy[]¶
ConfigInUseBy defines nested fields for Config.InUseBy.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
configType |
The type of configuration item. | string |
No | - | - |
displayName |
The name by which a configuration entity is displayed to the end user. | string |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated when the item is created. | string |
No | - | - |
optionsGroup |
A string that specifies the group that an OPTIONS item belongs to. | string |
No | - | - |
Status.metrics[]¶
ConfigMetric defines nested fields for Config.Metric.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
A description of the metric. | string |
No | - | - |
name |
The name of the metric. This must be a known metric name. | string |
Yes | - | - |
unit |
The unit of the metric. | string |
No | - | - |
valueSource |
This must not be set. | string |
No | - | - |
Status.overrides¶
ConfigOverrides defines nested fields for Config.Overrides.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
overrideList |
- | list[object] |
No | - | - |
Status.overrides.overrideList[]¶
ConfigOverridesOverrideList defines nested fields for Config.Overrides.OverrideList.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
agentFilter |
The string that defines the Agent Filter expression. | string |
No | - | - |
overrideMap |
A map whose key is a substitution variable specified within the configuration's body. For example, if below was specified in the configuration's body {{ isJfrEnabled | default false }} Then a valid map key would be "isJfrEnabled". The value is typically different than the default specified in the configuration's body. Thus, in this example, the map entry could be "isJfrEnabled": true | map[string, string] |
No | - | - |
Status.rules[]¶
ConfigRule defines nested fields for Config.Rule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
displayName |
The name by which a configuration entity is displayed to the end user. | string |
No | - | - |
filterText |
The string that defines the Span Filter expression. | string |
Yes | - | - |
isApplyToErrorSpans |
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". | boolean |
No | - | - |
isEnabled |
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". | boolean |
No | - | - |
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. | integer |
Yes | - | - |
satisfiedResponseTime |
The maximum response time in milliseconds that is considered "satisfactory" for the end user. | integer |
No | - | - |
toleratingResponseTime |
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". | integer |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |