loganalytics.oracle.com/v1beta1¶
APIVersion: loganalytics.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 loganalytics.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| IngestTimeRule | Namespaced | Sample | - |
| LogAnalyticsEmBridge | Namespaced | Sample | - |
| LogAnalyticsEntity | Namespaced | Sample | - |
| LogAnalyticsEntityType | Namespaced | Sample | - |
| LogAnalyticsLogGroup | Namespaced | Sample | - |
| LogAnalyticsObjectCollectionRule | Namespaced | Sample | - |
| ScheduledTask | Namespaced | Sample | - |
IngestTimeRule¶
IngestTimeRule is the Schema for the ingesttimerules API.
Plural:ingesttimerulesScope:NamespacedAPIVersion:loganalytics.oracle.com/v1beta1Sample: Sample (config/samples/loganalytics_v1beta1_ingesttimerule.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
IngestTimeRuleSpec defines the desired state of IngestTimeRule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actions |
The action(s) to be performed if the ingest time rule condition(s) are satisfied. | list[object] |
Yes | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
Yes | - | - |
conditions |
IngestTimeRuleConditions defines nested fields for IngestTimeRule.Conditions. | object |
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 | - | - |
description |
Description for this resource. | string |
No | - | - |
displayName |
The ingest time rule display name. | string |
Yes | - | - |
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 log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. | string |
Yes | - | - |
isEnabled |
A flag indicating whether or not the ingest time rule is enabled. | boolean |
No | - | - |
lifecycleState |
The current state of the ingest time rule. | string |
No | - | - |
timeCreated |
The date and time the resource was created, in the format defined by RFC3339. | string |
No | - | - |
timeUpdated |
The date and time the resource was last updated, in the format defined by RFC3339. | string |
No | - | - |
Spec.actions[]¶
IngestTimeRuleAction defines nested fields for IngestTimeRule.Action.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The compartment OCID (/iaas/Content/General/Concepts/identifiers.htm) of the extracted metric. | string |
No | - | - |
dimensions |
Additional dimensions to publish for the extracted metric. A valid list contains the source field names whose values are to be published as dimensions. The source name itself is specified using a special macro SOURCE_NAME | list[string] |
No | - | - |
jsonData |
- | string |
No | - | - |
metricName |
The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | string |
No | - | - |
namespace |
The namespace of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters and underscores (_). | string |
No | - | - |
resourceGroup |
The resourceGroup of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | string |
No | - | - |
type |
- | string |
No | - | - |
Spec.conditions¶
IngestTimeRuleConditions defines nested fields for IngestTimeRule.Conditions.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalConditions |
Optional additional condition(s) to be evaluated. | list[object] |
No | - | - |
fieldName |
The field name to be evaluated. | string |
No | - | - |
fieldOperator |
The operator to be used for evaluating the field. | string |
No | - | - |
fieldValue |
The field value to be evaluated. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
Spec.conditions.additionalConditions[]¶
IngestTimeRuleConditionsAdditionalCondition defines nested fields for IngestTimeRule.Conditions.AdditionalCondition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
conditionField |
The additional field name to be evaluated. | string |
Yes | - | - |
conditionOperator |
The operator to be used for evaluating the additional field. | string |
Yes | - | - |
conditionValue |
The additional field value to be evaluated. | string |
Yes | - | - |
Status¶
IngestTimeRuleStatus defines the observed state of IngestTimeRule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actions |
The action(s) to be performed if the ingest time rule condition(s) are satisfied. | list[object] |
No | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
conditionKind |
The ingest time rule condition kind. | string |
No | - | - |
conditions |
IngestTimeRuleConditions defines nested fields for IngestTimeRule.Conditions. | object |
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 |
Description for this resource. | string |
No | - | - |
displayName |
The ingest time rule display name. | string |
No | - | - |
fieldName |
The ingest time rule condition field name. | string |
No | - | - |
fieldValue |
The ingest time rule condition field value. | 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 log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. | string |
No | - | - |
isEnabled |
A flag indicating whether or not the ingest time rule is enabled. | boolean |
No | - | - |
lifecycleState |
The current state of the ingest time rule. | string |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
The date and time the resource was created, in the format defined by RFC3339. | string |
No | - | - |
timeUpdated |
The date and time the resource was last updated, in the format defined by RFC3339. | string |
No | - | - |
Status.actions[]¶
IngestTimeRuleAction defines nested fields for IngestTimeRule.Action.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The compartment OCID (/iaas/Content/General/Concepts/identifiers.htm) of the extracted metric. | string |
No | - | - |
dimensions |
Additional dimensions to publish for the extracted metric. A valid list contains the source field names whose values are to be published as dimensions. The source name itself is specified using a special macro SOURCE_NAME | list[string] |
No | - | - |
jsonData |
- | string |
No | - | - |
metricName |
The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | string |
No | - | - |
namespace |
The namespace of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters and underscores (_). | string |
No | - | - |
resourceGroup |
The resourceGroup of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | string |
No | - | - |
type |
- | string |
No | - | - |
Status.conditions¶
IngestTimeRuleConditions defines nested fields for IngestTimeRule.Conditions.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalConditions |
Optional additional condition(s) to be evaluated. | list[object] |
No | - | - |
fieldName |
The field name to be evaluated. | string |
No | - | - |
fieldOperator |
The operator to be used for evaluating the field. | string |
No | - | - |
fieldValue |
The field value to be evaluated. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
Status.conditions.additionalConditions[]¶
IngestTimeRuleConditionsAdditionalCondition defines nested fields for IngestTimeRule.Conditions.AdditionalCondition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
conditionField |
The additional field name to be evaluated. | string |
Yes | - | - |
conditionOperator |
The operator to be used for evaluating the additional field. | string |
Yes | - | - |
conditionValue |
The additional field value to be evaluated. | string |
Yes | - | - |
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 | - | - |
LogAnalyticsEmBridge¶
LogAnalyticsEmBridge is the Schema for the loganalyticsembridges API.
Plural:loganalyticsembridgesScope:NamespacedAPIVersion:loganalytics.oracle.com/v1beta1Sample: Sample (config/samples/loganalytics_v1beta1_loganalyticsembridge.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
LogAnalyticsEmBridgeSpec defines the desired state of LogAnalyticsEmBridge.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Object store bucket name where enterprise manager harvested entities will be uploaded. | string |
Yes | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | 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 | - | - |
description |
A description for log analytics enterprise manager bridge. | string |
No | - | - |
displayName |
Log analytics enterprise manager bridge display name. | string |
Yes | - | - |
emEntitiesCompartmentId |
Compartment for entities created from enterprise manager. | string |
Yes | - | - |
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 | - | - |
Status¶
LogAnalyticsEmBridgeStatus defines the observed state of LogAnalyticsEmBridge.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
Object store bucket name where enterprise manager harvested entities will be uploaded. | string |
No | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | 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 |
A description for log analytics enterprise manager bridge. | string |
No | - | - |
displayName |
Log analytics enterprise manager bridge display name. | string |
No | - | - |
emEntitiesCompartmentId |
Compartment for entities created from enterprise manager. | 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 enterprise manager bridge OCID. | string |
No | - | - |
lastImportProcessingDetails |
Processing status details of enterprise manager upload. This provides additional details for failed status | string |
No | - | - |
lastImportProcessingStatus |
The status from last processing status of enterprise manager upload. | string |
No | - | - |
lifecycleDetails |
lifecycleDetails has additional information regarding substeps such as verifying connection to object store. | string |
No | - | - |
lifecycleState |
The current state of the enterprise manager bridge. | string |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
The date and time the resource was created, in the format defined by RFC3339. | string |
No | - | - |
timeEmDataLastExtracted |
The timestamp of last enterprise manager upload to OCI Object Store. This is in the format defined by RFC3339 | string |
No | - | - |
timeImportLastProcessed |
The last time of enterprise manager upload was processed. This is in the format defined by RFC3339 | string |
No | - | - |
timeUpdated |
The date and time the resource was last updated, in the format defined by RFC3339. | string |
No | - | - |
Status.status¶
Back to LogAnalyticsEmBridge 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¶
Back to LogAnalyticsEmBridge status
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¶
Back to LogAnalyticsEmBridge status
| 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[]¶
Back to LogAnalyticsEmBridge status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
LogAnalyticsEntity¶
LogAnalyticsEntity is the Schema for the loganalyticsentities API.
Plural:loganalyticsentitiesScope:NamespacedAPIVersion:loganalytics.oracle.com/v1beta1Sample: Sample (config/samples/loganalytics_v1beta1_loganalyticsentity.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
LogAnalyticsEntitySpec defines the desired state of LogAnalyticsEntity.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
cloudResourceId |
The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity represents a non-cloud resource that the customer may have on their premises. | string |
No | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | 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 | - | - |
entityTypeName |
Log analytics entity type name. | string |
Yes | - | - |
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 | - | - |
hostname |
The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAME on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. |
string |
No | - | - |
managementAgentId |
The OCID of the Management Agent. | string |
No | - | - |
metadata |
LogAnalyticsEntityMetadata defines nested fields for LogAnalyticsEntity.Metadata. | object |
No | - | - |
name |
Log analytics entity name. | string |
Yes | - | - |
properties |
The name/value pairs for parameter values to be used in file patterns specified in log sources. | map[string, string] |
No | - | - |
sourceId |
This indicates the type of source. It is primarily for Enterprise Manager Repository ID. | string |
No | - | - |
timeLastDiscovered |
The date and time the resource was last discovered, in the format defined by RFC3339. | string |
No | - | - |
timezoneRegion |
The timezone region of the log analytics entity. | string |
No | - | - |
Spec.metadata¶
Back to LogAnalyticsEntity spec
LogAnalyticsEntityMetadata defines nested fields for LogAnalyticsEntity.Metadata.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
An array of entity metadata details. | list[object] |
No | - | - |
Spec.metadata.items[]¶
Back to LogAnalyticsEntity spec
LogAnalyticsEntityMetadataItem defines nested fields for LogAnalyticsEntity.Metadata.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The metadata name. | string |
No | - | - |
type |
The metadata type. | string |
No | - | - |
value |
The metadata value. | string |
No | - | - |
Status¶
LogAnalyticsEntityStatus defines the observed state of LogAnalyticsEntity.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
areLogsCollected |
The Boolean flag to indicate if logs are collected for an entity for log analytics usage. | boolean |
No | - | - |
associatedSourcesCount |
The count of associated log sources for a given log analytics entity. | integer |
No | - | - |
cloudResourceId |
The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity represents a non-cloud resource that the customer may have on their premises. | string |
No | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
creationSource |
LogAnalyticsEntityCreationSource defines nested fields for LogAnalyticsEntity.CreationSource. | object |
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 | - | - |
entityTypeInternalName |
Internal name for the log analytics entity type. | string |
No | - | - |
entityTypeName |
Log analytics entity type name. | 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 | - | - |
hostname |
The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAME on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely. |
string |
No | - | - |
id |
The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. | string |
No | - | - |
lifecycleDetails |
lifecycleDetails has additional information regarding substeps such as management agent plugin deployment. | string |
No | - | - |
lifecycleState |
The current state of the log analytics entity. | string |
No | - | - |
managementAgentCompartmentId |
Management agent (management-agents resource kind) compartment OCID | string |
No | - | - |
managementAgentDisplayName |
Management agent (management-agents resource kind) display name | string |
No | - | - |
managementAgentId |
The OCID of the Management Agent. | string |
No | - | - |
metadata |
LogAnalyticsEntityMetadata defines nested fields for LogAnalyticsEntity.Metadata. | object |
No | - | - |
name |
Log analytics entity name. | string |
No | - | - |
properties |
The name/value pairs for parameter values to be used in file patterns specified in log sources. | map[string, string] |
No | - | - |
sourceId |
This indicates the type of source. It is primarily for Enterprise Manager Repository ID. | string |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
The date and time the resource was created, in the format defined by RFC3339. | string |
No | - | - |
timeLastDiscovered |
The date and time the resource was last discovered, in the format defined by RFC3339. | string |
No | - | - |
timeUpdated |
The date and time the resource was last updated, in the format defined by RFC3339. | string |
No | - | - |
timezoneRegion |
The timezone region of the log analytics entity. | string |
No | - | - |
Status.creationSource¶
Back to LogAnalyticsEntity status
LogAnalyticsEntityCreationSource defines nested fields for LogAnalyticsEntity.CreationSource.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
details |
This will provide additional details for source of auto-creation. For example, if entity is auto-created by enterprise manager bridge, this field provides additional detail on enterprise manager that contributed to the entity auto-creation. | string |
No | - | - |
type |
Source that auto-created the entity. | string |
No | - | - |
Status.metadata¶
Back to LogAnalyticsEntity status
LogAnalyticsEntityMetadata defines nested fields for LogAnalyticsEntity.Metadata.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
An array of entity metadata details. | list[object] |
No | - | - |
Status.metadata.items[]¶
Back to LogAnalyticsEntity status
LogAnalyticsEntityMetadataItem defines nested fields for LogAnalyticsEntity.Metadata.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
The metadata name. | string |
No | - | - |
type |
The metadata type. | string |
No | - | - |
value |
The metadata value. | string |
No | - | - |
Status.status¶
Back to LogAnalyticsEntity 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¶
Back to LogAnalyticsEntity status
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¶
Back to LogAnalyticsEntity status
| 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[]¶
Back to LogAnalyticsEntity status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
LogAnalyticsEntityType¶
LogAnalyticsEntityType is the Schema for the loganalyticsentitytypes API.
Plural:loganalyticsentitytypesScope:NamespacedAPIVersion:loganalytics.oracle.com/v1beta1Sample: Sample (config/samples/loganalytics_v1beta1_loganalyticsentitytype.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
LogAnalyticsEntityTypeSpec defines the desired state of LogAnalyticsEntityType.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
category |
Log analytics entity type category. Category will be used for grouping and filtering. | string |
No | - | - |
name |
Log analytics entity type name. | string |
Yes | - | - |
properties |
Log analytics entity type property definition. | list[object] |
No | - | - |
Spec.properties[]¶
Back to LogAnalyticsEntityType spec
LogAnalyticsEntityTypeProperty defines nested fields for LogAnalyticsEntityType.Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
Description for the log analytics entity type property. | string |
No | - | - |
name |
Log analytics entity type property name. | string |
Yes | - | - |
Status¶
LogAnalyticsEntityTypeStatus defines the observed state of LogAnalyticsEntityType.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
category |
Log analytics entity type category. Category will be used for grouping and filtering. | string |
No | - | - |
cloudType |
Log analytics entity type group. That can be CLOUD (OCI) or NON_CLOUD otherwise. | string |
No | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | string |
No | - | - |
internalName |
Internal name for the log analytics entity type. | string |
No | - | - |
lifecycleState |
The current lifecycle state of the log analytics entity. | string |
No | - | - |
managementAgentEligibilityStatus |
This field indicates whether logs for entities of this type can be collected using a management agent. | string |
No | - | - |
name |
Log analytics entity type name. | string |
No | - | - |
properties |
The parameters used in file patterns specified in log sources for this log analytics entity type. | list[object] |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
Time the log analytics entity type was created. An RFC3339 formatted datetime string. | string |
No | - | - |
timeUpdated |
Time the log analytics entity type was updated. An RFC3339 formatted datetime string. | string |
No | - | - |
Status.properties[]¶
Back to LogAnalyticsEntityType status
LogAnalyticsEntityTypeProperty defines nested fields for LogAnalyticsEntityType.Property.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
Description for the log analytics entity type property. | string |
No | - | - |
name |
Log analytics entity type property name. | string |
Yes | - | - |
Status.status¶
Back to LogAnalyticsEntityType 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¶
Back to LogAnalyticsEntityType status
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¶
Back to LogAnalyticsEntityType status
| 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[]¶
Back to LogAnalyticsEntityType status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
LogAnalyticsLogGroup¶
LogAnalyticsLogGroup is the Schema for the loganalyticsloggroups API.
Plural:loganalyticsloggroupsScope:NamespacedAPIVersion:loganalytics.oracle.com/v1beta1Sample: Sample (config/samples/loganalytics_v1beta1_loganalyticsloggroup.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
LogAnalyticsLogGroupSpec defines the desired state of LogAnalyticsLogGroup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | 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 | - | - |
description |
Description for this resource. | string |
No | - | - |
displayName |
A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed. | string |
Yes | - | - |
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 | - | - |
Status¶
LogAnalyticsLogGroupStatus defines the observed state of LogAnalyticsLogGroup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | 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 |
Description for this resource. | string |
No | - | - |
displayName |
A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed. | 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 log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. | string |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
The date and time the resource was created, in the format defined by RFC3339. | string |
No | - | - |
timeUpdated |
The date and time the resource was last updated, in the format defined by RFC3339. | string |
No | - | - |
Status.status¶
Back to LogAnalyticsLogGroup 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¶
Back to LogAnalyticsLogGroup status
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¶
Back to LogAnalyticsLogGroup status
| 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[]¶
Back to LogAnalyticsLogGroup status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
LogAnalyticsObjectCollectionRule¶
LogAnalyticsObjectCollectionRule is the Schema for the loganalyticsobjectcollectionrules API.
Plural:loganalyticsobjectcollectionrulesScope:NamespacedAPIVersion:loganalytics.oracle.com/v1beta1Sample: Sample (config/samples/loganalytics_v1beta1_loganalyticsobjectcollectionrule.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
LogAnalyticsObjectCollectionRuleSpec defines the desired state of LogAnalyticsObjectCollectionRule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
charEncoding |
An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8859_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs. | string |
No | - | - |
collectionType |
The type of collection. | string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. | 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 | - | - |
description |
A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information. | string |
No | - | - |
entityId |
Log Analytics entity OCID. Associates the processed logs with the given entity (optional). | 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 | - | - |
isEnabled |
Whether or not this rule is currently enabled. | boolean |
No | - | - |
isForceHistoricCollection |
Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule | boolean |
No | - | - |
logGroupId |
Log Analytics Log group OCID to associate the processed logs with. | string |
Yes | - | - |
logSet |
The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex. | string |
No | - | - |
logSetExtRegex |
The regex to be applied against given logSetKey. Regex has to be in string escaped format. | string |
No | - | - |
logSetKey |
An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n/ |
string |
No | - | - |
logSourceName |
Name of the Log Analytics Source to use for the processing. | string |
No | - | - |
logType |
Type of files/objects in this object collection rule. | string |
No | - | - |
name |
A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified. | string |
Yes | - | - |
objectNameFilters |
When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see Event Filters (https://docs.oracle.com/en-us/iaas/Content/Events/Concepts/filterevents.htm). | list[string] |
No | - | - |
osBucketName |
Name of the Object Storage bucket. | string |
Yes | - | - |
osNamespace |
Object Storage namespace. | string |
Yes | - | - |
overrides |
The override is used to modify some important configuration properties for objects matching a specific pattern inside the bucket. Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are "contains". | map[string, list[object]] |
No | - | - |
pollSince |
The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC or HISTORIC_LIVE collection types. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error. | string |
No | - | - |
pollTill |
The newest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC collection type. When collectionType is LIVE or HISTORIC_LIVE, specifying pollTill will result in error. | string |
No | - | - |
streamCursorTime |
The time from which to consume the objects, if streamCursorType is AT_TIME. | string |
No | - | - |
streamCursorType |
Cursor type used to fetch messages from stream. When the streamCursorType is set to DEFAULT, the existing cursor position will be used if already set by any previous objection collection rule(s) using the same stream. Otherwise, the behaviour is to consume from the oldest available message in the stream. When the streamCursorType is set to TRIM_HORIZON, the behaviour is to start consuming from the oldest available message in the stream. When the streamCursorType is set to LATEST, the behavior is to start consuming messages that were published after the creation of this rule. When the streamCursorType is set to AT_TIME, the behavior is to start consuming from a given time. For more information on cursor types, see Stream Consumer Groups (https://docs.oracle.com/en-us/iaas/Content/Streaming/Tasks/using_consumer_groups.htm). | string |
No | - | - |
streamId |
A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Log Analytics while creating Event Rule and consume the event notifications created by the Object Storage. | string |
No | - | - |
timezone |
Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used. | string |
No | - | - |
Spec.overrides{}¶
Back to LogAnalyticsObjectCollectionRule spec
No documented fields in the checked-in CRD schema.
Status¶
LogAnalyticsObjectCollectionRuleStatus defines the observed state of LogAnalyticsObjectCollectionRule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
charEncoding |
An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8859_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs. | string |
No | - | - |
collectionType |
The type of log collection. | string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. | 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 |
A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information. | string |
No | - | - |
entityId |
Log Analytics entity OCID to associate the processed logs with. | 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 this rule. | string |
No | - | - |
isEnabled |
Whether or not this rule is currently enabled. | boolean |
No | - | - |
isForceHistoricCollection |
Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule | boolean |
No | - | - |
lastCollectedObject |
Last Collected Object for the rule | string |
No | - | - |
lifecycleDetails |
A detailed status of the life cycle state. | string |
No | - | - |
lifecycleState |
The current state of the rule. | string |
No | - | - |
logGroupId |
Log Analytics Log group OCID to associate the processed logs with. | string |
No | - | - |
logSet |
The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex. | string |
No | - | - |
logSetExtRegex |
The regex to be applied against given logSetKey. Regex has to be in string escaped format. | string |
No | - | - |
logSetKey |
An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n/ |
string |
No | - | - |
logSourceName |
Name of the Log Analytics Source to use for the processing. | string |
No | - | - |
logType |
Type of files/objects in this object collection rule. | string |
No | - | - |
name |
A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed. | string |
No | - | - |
objectNameFilters |
When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see Event Filters (https://docs.oracle.com/en-us/iaas/Content/Events/Concepts/filterevents.htm). | list[string] |
No | - | - |
osBucketName |
Name of the Object Storage bucket. | string |
No | - | - |
osNamespace |
Object Storage namespace. | string |
No | - | - |
overrides |
Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are "contains". | map[string, list[object]] |
No | - | - |
pollSince |
The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC or HISTORIC_LIVE collection types. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error. | string |
No | - | - |
pollTill |
The newest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC collection type. When collectionType is LIVE or HISTORIC_LIVE, specifying pollTill will result in error. | string |
No | - | - |
status |
- | object |
Yes | - | - |
streamCursorTime |
The time from which to consume the objects, if streamCursorType is AT_TIME. | string |
No | - | - |
streamCursorType |
Cursor type used to fetch messages from stream. When the streamCursorType is set to DEFAULT, the existing cursor position will be used if already set by any previous objection collection rule(s) using the same stream. Otherwise, the behaviour is to consume from the oldest available message in the stream. When the streamCursorType is set to TRIM_HORIZON, the behaviour is to start consuming from the oldest available message in the stream. When the streamCursorType is set to LATEST, the behavior is to start consuming messages that were published after the creation of this rule. When the streamCursorType is set to AT_TIME, the behavior is to start consuming from a given time. For more information on cursor types, see Stream Consumer Groups (https://docs.oracle.com/en-us/iaas/Content/Streaming/Tasks/using_consumer_groups.htm). | string |
No | - | - |
streamId |
A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Log Analytics while creating Event Rule and consume the event notifications created by the Object Storage. | string |
No | - | - |
timeCreated |
The time when this rule was created. An RFC3339 formatted datetime string. | string |
No | - | - |
timeUpdated |
The time when this rule was last updated. An RFC3339 formatted datetime string. | string |
No | - | - |
timezone |
Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used. | string |
No | - | - |
Status.overrides{}¶
Back to LogAnalyticsObjectCollectionRule status
No documented fields in the checked-in CRD schema.
Status.status¶
Back to LogAnalyticsObjectCollectionRule 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¶
Back to LogAnalyticsObjectCollectionRule status
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¶
Back to LogAnalyticsObjectCollectionRule status
| 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[]¶
Back to LogAnalyticsObjectCollectionRule status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
ScheduledTask¶
ScheduledTask is the Schema for the scheduledtasks API.
Plural:scheduledtasksScope:NamespacedAPIVersion:loganalytics.oracle.com/v1beta1Sample: Sample (config/samples/loganalytics_v1beta1_scheduledtask.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ScheduledTaskSpec defines the desired state of ScheduledTask.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
action |
ScheduledTaskAction defines nested fields for ScheduledTask.Action. | object |
No | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | 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 | - | - |
description |
Description for this resource. | string |
No | - | - |
displayName |
A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed. | 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 | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
savedSearchId |
The ManagementSavedSearch id [OCID] to be accelerated. | string |
No | - | - |
schedules |
Schedules, typically a single schedule. Note there may only be a single schedule for SAVED_SEARCH and PURGE scheduled tasks. | list[object] |
No | - | - |
taskType |
Task type. | string |
No | - | - |
Spec.action¶
ScheduledTaskAction defines nested fields for ScheduledTask.Action.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentIdInSubtree |
if true, purge child compartments data | boolean |
No | - | - |
dataType |
the type of the log data to be purged | string |
No | - | - |
jsonData |
- | string |
No | - | - |
metricExtraction |
ScheduledTaskActionMetricExtraction defines nested fields for ScheduledTask.Action.MetricExtraction. | object |
No | - | - |
purgeCompartmentId |
the compartment OCID under which the data will be purged | string |
No | - | - |
purgeDuration |
The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W). | string |
No | - | - |
queryString |
Purge query string. | string |
No | - | - |
savedSearchDuration |
The duration of data to be searched for SAVED_SEARCH tasks, used when the task fires to calculate the query time range. Duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The value should be positive. The largest supported unit (as opposed to value) is D, e.g. P14D (not P2W). There are restrictions on the maximum duration value relative to the task schedule value as specified in the following table. Schedule Interval Range | Maximum Duration | string |
No | - | - |
savedSearchId |
The ManagementSavedSearch id [OCID] utilized in the action. | string |
No | - | - |
templateDetails |
ScheduledTaskActionTemplateDetails defines nested fields for ScheduledTask.Action.TemplateDetails. | object |
No | - | - |
type |
- | string |
No | - | - |
Spec.action.metricExtraction¶
ScheduledTaskActionMetricExtraction defines nested fields for ScheduledTask.Action.MetricExtraction.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The compartment OCID (/iaas/Content/General/Concepts/identifiers.htm) of the extracted metric. | string |
No | - | - |
metricCollections |
Details for the metrics to be collected. | list[object] |
No | - | - |
metricName |
The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | string |
No | - | - |
namespace |
The namespace of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters and underscores (_). | string |
No | - | - |
resourceGroup |
The resourceGroup of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | string |
No | - | - |
Spec.action.metricExtraction.metricCollections[]¶
ScheduledTaskActionMetricExtractionMetricCollection defines nested fields for ScheduledTask.Action.MetricExtraction.MetricCollection.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dimensions |
Selected dimension fields for the metric collection. | list[object] |
Yes | - | - |
metricName |
The metric name for this metric collection. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | string |
Yes | - | - |
metricQueryFieldName |
Output field in the query to be used as the metric value. | string |
Yes | - | - |
queryTableName |
Output table in the query. | string |
No | - | - |
Spec.action.metricExtraction.metricCollections[].dimensions[]¶
ScheduledTaskActionMetricExtractionMetricCollectionDimension defines nested fields for ScheduledTask.Action.MetricExtraction.MetricCollection.Dimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dimensionName |
Dimension name to be stored with the metric. | string |
No | - | - |
queryFieldName |
Output field in the query to be used as the source for the metric dimension. | string |
Yes | - | - |
Spec.action.templateDetails¶
ScheduledTaskActionTemplateDetails defines nested fields for ScheduledTask.Action.TemplateDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
templateId |
The Config template Id of a particular template. | string |
Yes | - | - |
templateParams |
To store macro params. | list[object] |
No | - | - |
Spec.action.templateDetails.templateParams[]¶
ScheduledTaskActionTemplateDetailsTemplateParam defines nested fields for ScheduledTask.Action.TemplateDetails.TemplateParam.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
keyField |
Contains macro parameter's names. | string |
Yes | - | - |
valueField |
Contains macro parameter's value. | string |
Yes | - | - |
Spec.schedules[]¶
ScheduledTaskSchedule defines nested fields for ScheduledTask.Schedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
expression |
Value in cron format. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
misfirePolicy |
Schedule misfire retry policy. | string |
No | - | - |
queryOffsetSecs |
Number of seconds to offset the query time window by to accommodate capture late arriving data. For example, a schedule run at 12:00 with a 10 minute interval and queryOffsetSecs=120 will use the query time window of 11:48-11:58 rather than 11:50-12:00 without queryOffsetSecs. | integer |
No | - | - |
recurringInterval |
Recurring interval in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P14D (not P2W). The value must be at least 5 minutes (PT5M) and at most 3 weeks (P21D or PT30240M). | string |
No | - | - |
repeatCount |
Number of times (0-based) to execute until auto-stop. Default value -1 will execute indefinitely. Value 0 will execute once. | integer |
No | - | - |
timeEnd |
End time for the schedule, even if the schedule would otherwise have remaining executions. | string |
No | - | - |
timeOfFirstExecution |
The date and time the scheduled task should execute first time after create or update; thereafter the task will execute as specified in the schedule. | string |
No | - | - |
timeZone |
Time zone, by default UTC. | string |
No | - | - |
type |
- | string |
No | - | - |
Status¶
ScheduledTaskStatus defines the observed state of ScheduledTask.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
action |
ScheduledTaskAction defines nested fields for ScheduledTask.Action. | object |
No | - | - |
compartmentId |
Compartment Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). | 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 |
Description for this resource. | string |
No | - | - |
displayName |
A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed. | 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 data plane resource. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
kind |
- | string |
No | - | - |
lastExecutionStatus |
The most recent task execution status. | string |
No | - | - |
lifecycleState |
The current state of the scheduled task. | string |
No | - | - |
numOccurrences |
Number of execution occurrences. | integer (int64) |
No | - | - |
pauseReason |
reason for taskStatus PAUSED. | string |
No | - | - |
scheduleType |
Type of the task schedule | string |
No | - | - |
status |
- | object |
Yes | - | - |
targetService |
Target Service | string |
No | - | - |
taskStatus |
Status of the scheduled task. | string |
No | - | - |
taskType |
Task type. | string |
No | - | - |
timeCreated |
The date and time the scheduled task was created, in the format defined by RFC3339. | string |
No | - | - |
timeLastExecuted |
The date and time the scheduled task last executed, in the format defined by RFC3339. | string |
No | - | - |
timeOfNextExecution |
The date and time the scheduled task will execute next, in the format defined by RFC3339. | string |
No | - | - |
timeUpdated |
The date and time the scheduled task was last updated, in the format defined by RFC3339. | string |
No | - | - |
workRequestId |
most recent Work Request Identifier OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request. | string |
No | - | - |
Status.action¶
ScheduledTaskAction defines nested fields for ScheduledTask.Action.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentIdInSubtree |
if true, purge child compartments data | boolean |
No | - | - |
dataType |
the type of the log data to be purged | string |
No | - | - |
jsonData |
- | string |
No | - | - |
metricExtraction |
ScheduledTaskActionMetricExtraction defines nested fields for ScheduledTask.Action.MetricExtraction. | object |
No | - | - |
purgeCompartmentId |
the compartment OCID under which the data will be purged | string |
No | - | - |
purgeDuration |
The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W). | string |
No | - | - |
queryString |
Purge query string. | string |
No | - | - |
savedSearchDuration |
The duration of data to be searched for SAVED_SEARCH tasks, used when the task fires to calculate the query time range. Duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The value should be positive. The largest supported unit (as opposed to value) is D, e.g. P14D (not P2W). There are restrictions on the maximum duration value relative to the task schedule value as specified in the following table. Schedule Interval Range | Maximum Duration | string |
No | - | - |
savedSearchId |
The ManagementSavedSearch id [OCID] utilized in the action. | string |
No | - | - |
templateDetails |
ScheduledTaskActionTemplateDetails defines nested fields for ScheduledTask.Action.TemplateDetails. | object |
No | - | - |
type |
- | string |
No | - | - |
Status.action.metricExtraction¶
ScheduledTaskActionMetricExtraction defines nested fields for ScheduledTask.Action.MetricExtraction.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The compartment OCID (/iaas/Content/General/Concepts/identifiers.htm) of the extracted metric. | string |
No | - | - |
metricCollections |
Details for the metrics to be collected. | list[object] |
No | - | - |
metricName |
The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | string |
No | - | - |
namespace |
The namespace of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters and underscores (_). | string |
No | - | - |
resourceGroup |
The resourceGroup of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | string |
No | - | - |
Status.action.metricExtraction.metricCollections[]¶
ScheduledTaskActionMetricExtractionMetricCollection defines nested fields for ScheduledTask.Action.MetricExtraction.MetricCollection.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dimensions |
Selected dimension fields for the metric collection. | list[object] |
Yes | - | - |
metricName |
The metric name for this metric collection. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | string |
Yes | - | - |
metricQueryFieldName |
Output field in the query to be used as the metric value. | string |
Yes | - | - |
queryTableName |
Output table in the query. | string |
No | - | - |
Status.action.metricExtraction.metricCollections[].dimensions[]¶
ScheduledTaskActionMetricExtractionMetricCollectionDimension defines nested fields for ScheduledTask.Action.MetricExtraction.MetricCollection.Dimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dimensionName |
Dimension name to be stored with the metric. | string |
No | - | - |
queryFieldName |
Output field in the query to be used as the source for the metric dimension. | string |
Yes | - | - |
Status.action.templateDetails¶
ScheduledTaskActionTemplateDetails defines nested fields for ScheduledTask.Action.TemplateDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
templateId |
The Config template Id of a particular template. | string |
Yes | - | - |
templateParams |
To store macro params. | list[object] |
No | - | - |
Status.action.templateDetails.templateParams[]¶
ScheduledTaskActionTemplateDetailsTemplateParam defines nested fields for ScheduledTask.Action.TemplateDetails.TemplateParam.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
keyField |
Contains macro parameter's names. | string |
Yes | - | - |
valueField |
Contains macro parameter's value. | string |
Yes | - | - |
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 | - | - |