apmtraces.oracle.com/v1beta1¶
APIVersion: apmtraces.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 apmtraces.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| ScheduledQuery | Namespaced | Sample | - |
ScheduledQuery¶
Manage OCI Application Performance Monitoring scheduled trace queries.
Plural:scheduledqueriesScope:NamespacedAPIVersion:apmtraces.oracle.com/v1beta1Sample: Sample (config/samples/apmtraces_v1beta1_scheduledquery.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ScheduledQuerySpec defines the desired state of ScheduledQuery.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
apmDomainId |
The APM Domain ID the request is intended for. | string |
Yes | - | - |
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 | - | - |
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 | - | - |
scheduledQueryDescription |
Description for the scheduled query. | string |
No | - | - |
scheduledQueryMaximumRuntimeInSeconds |
Maximum runtime for the scheduled query in seconds. | integer (int64) |
No | - | - |
scheduledQueryName |
Name of the scheduled query. | string |
No | - | - |
scheduledQueryProcessingConfiguration |
ScheduledQueryProcessingConfiguration defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration. | object |
No | - | - |
scheduledQueryProcessingSubType |
Processing sub type of the scheduled query. | string |
No | - | - |
scheduledQueryProcessingType |
Type of the scheduled query. | string |
No | - | - |
scheduledQueryRetentionCriteria |
Retention criteria for the scheduled query. | string |
No | - | - |
scheduledQueryRetentionPeriodInMs |
Retention period for the scheduled query in milliseconds. | integer (int64) |
No | - | - |
scheduledQuerySchedule |
Schedule for the scheduled query. | string |
No | - | - |
scheduledQueryText |
Scheduled query to be run. | string |
No | - | - |
Spec.scheduledQueryProcessingConfiguration¶
ScheduledQueryProcessingConfiguration defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
customMetric |
ScheduledQueryProcessingConfigurationCustomMetric defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.CustomMetric. | object |
No | - | - |
objectStorage |
ScheduledQueryProcessingConfigurationObjectStorage defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.ObjectStorage. | object |
No | - | - |
streaming |
ScheduledQueryProcessingConfigurationStreaming defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.Streaming. | object |
No | - | - |
Spec.scheduledQueryProcessingConfiguration.customMetric¶
ScheduledQueryProcessingConfigurationCustomMetric defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.CustomMetric.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartment |
Compartment of the Monitoring Service. It defaults to the APM domain's compartment if not specified. If specified, the necessary OCI policies should be set to allow APM to write to that compartment. | string |
No | - | - |
description |
Description of the Custom Metric. | string |
No | - | - |
isAnomalyDetectionEnabled |
Indicates whether anomaly Detection should be performed on the generated metric. | boolean |
No | - | - |
isMetricPublished |
Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right OCI policies have been set to write to the specified namespace/compartment. | boolean |
No | - | - |
name |
Name of the Custom Metric. | string |
Yes | - | - |
namespace |
Namespace in the Custom Metric. It defaults to oracle_apm_custom if not specified. If specified, the necessary OCI policies should be set to allow APM to write to that namespace. |
string |
No | - | - |
resourceGroup |
Resource Group of the Custom Metric. | string |
No | - | - |
unit |
Unit in which the metric value is reported. For example 'ms'. | string |
No | - | - |
Spec.scheduledQueryProcessingConfiguration.objectStorage¶
ScheduledQueryProcessingConfigurationObjectStorage defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.ObjectStorage.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket name in the object store. | string |
No | - | - |
nameSpace |
Namespace in the object store. | string |
No | - | - |
objectNamePrefix |
Object name prefix in the object store. | string |
No | - | - |
Spec.scheduledQueryProcessingConfiguration.streaming¶
ScheduledQueryProcessingConfigurationStreaming defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.Streaming.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
streamId |
Stream Id. | string |
No | - | - |
Status¶
ScheduledQueryStatus defines the observed state of ScheduledQuery.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
apmDomainId |
The bound APM Domain ID used to address this scheduled query. | 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 | - | - |
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 | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the scheduled query . An OCID is generated when the scheduled query is created. | string |
No | - | - |
lifecycleState |
The current lifecycle state of the Scheduled Query. | string |
No | - | - |
scheduledQueryDescription |
Description for the scheduled query. | string |
No | - | - |
scheduledQueryInstances |
Scheduled query instances. | string |
No | - | - |
scheduledQueryMaximumRuntimeInSeconds |
Maximum runtime for the scheduled query in seconds. | integer (int64) |
No | - | - |
scheduledQueryName |
Name of the scheduled query. | string |
No | - | - |
scheduledQueryNextRunInMs |
Next run for the scheduled query. | integer (int64) |
No | - | - |
scheduledQueryProcessingConfiguration |
ScheduledQueryProcessingConfiguration defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration. | object |
No | - | - |
scheduledQueryProcessingSubType |
Processing sub type of the scheduled query. | string |
No | - | - |
scheduledQueryProcessingType |
Processing type of the scheduled query. | string |
No | - | - |
scheduledQueryRetentionCriteria |
Retention criteria for the scheduled query. | string |
No | - | - |
scheduledQueryRetentionPeriodInMs |
Retention period for the scheduled query in milliseconds. | integer (int64) |
No | - | - |
scheduledQuerySchedule |
Schedule for the scheduled query. | string |
No | - | - |
scheduledQueryText |
Scheduled query to be run. | 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 | - | - |
Status.scheduledQueryProcessingConfiguration¶
ScheduledQueryProcessingConfiguration defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
customMetric |
ScheduledQueryProcessingConfigurationCustomMetric defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.CustomMetric. | object |
No | - | - |
objectStorage |
ScheduledQueryProcessingConfigurationObjectStorage defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.ObjectStorage. | object |
No | - | - |
streaming |
ScheduledQueryProcessingConfigurationStreaming defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.Streaming. | object |
No | - | - |
Status.scheduledQueryProcessingConfiguration.customMetric¶
ScheduledQueryProcessingConfigurationCustomMetric defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.CustomMetric.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartment |
Compartment of the Monitoring Service. It defaults to the APM domain's compartment if not specified. If specified, the necessary OCI policies should be set to allow APM to write to that compartment. | string |
No | - | - |
description |
Description of the Custom Metric. | string |
No | - | - |
isAnomalyDetectionEnabled |
Indicates whether anomaly Detection should be performed on the generated metric. | boolean |
No | - | - |
isMetricPublished |
Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right OCI policies have been set to write to the specified namespace/compartment. | boolean |
No | - | - |
name |
Name of the Custom Metric. | string |
Yes | - | - |
namespace |
Namespace in the Custom Metric. It defaults to oracle_apm_custom if not specified. If specified, the necessary OCI policies should be set to allow APM to write to that namespace. |
string |
No | - | - |
resourceGroup |
Resource Group of the Custom Metric. | string |
No | - | - |
unit |
Unit in which the metric value is reported. For example 'ms'. | string |
No | - | - |
Status.scheduledQueryProcessingConfiguration.objectStorage¶
ScheduledQueryProcessingConfigurationObjectStorage defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.ObjectStorage.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Bucket name in the object store. | string |
No | - | - |
nameSpace |
Namespace in the object store. | string |
No | - | - |
objectNamePrefix |
Object name prefix in the object store. | string |
No | - | - |
Status.scheduledQueryProcessingConfiguration.streaming¶
ScheduledQueryProcessingConfigurationStreaming defines nested fields for ScheduledQuery.ScheduledQueryProcessingConfiguration.Streaming.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
streamId |
Stream Id. | string |
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 | - | - |