Skip to content

logging.oracle.com/v1beta1

Back to API Reference

APIVersion: logging.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 logging.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
Log Namespaced Sample -
LogGroup Namespaced Sample -
LogSavedSearch Namespaced Sample -
UnifiedAgentConfiguration Namespaced Sample -

Log

Log is the Schema for the logs API.

  • Plural: logs
  • Scope: Namespaced
  • APIVersion: logging.oracle.com/v1beta1
  • Sample: Sample (config/samples/logging_v1beta1_log.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

LogSpec defines the desired state of Log.

Field Description Type Required Default Enum
configuration LogConfiguration defines nested fields for Log.Configuration. object No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information. string Yes - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
isEnabled Whether or not this resource is currently enabled. boolean No - -
logGroupId The OCID of the log group that owns this log. string Yes - -
logType The logType that the log object is for, whether custom or service. string Yes - -
retentionDuration Log retention duration in 30-day increments (30, 60, 90 and so on until 180). integer No - -

Spec.configuration

Back to Log spec

LogConfiguration defines nested fields for Log.Configuration.

Field Description Type Required Default Enum
archiving LogConfigurationArchiving defines nested fields for Log.Configuration.Archiving. object No - -
compartmentId The OCID of the compartment that the resource belongs to. string No - -
source LogConfigurationSource defines nested fields for Log.Configuration.Source. object Yes - -

Spec.configuration.archiving

Back to Log spec

LogConfigurationArchiving defines nested fields for Log.Configuration.Archiving.

Field Description Type Required Default Enum
isEnabled True if archiving enabled. This field is now deprecated, you should use Service Connector Hub to enable archiving. boolean No - -

Spec.configuration.source

Back to Log spec

LogConfigurationSource defines nested fields for Log.Configuration.Source.

Field Description Type Required Default Enum
category Log object category. string No - -
jsonData - string No - -
parameters Log category parameters are stored here. map[string, string] No - -
resource The unique identifier of the resource emitting the log. string No - -
service Service generating log. string No - -
sourceType - string No - -

Status

LogStatus defines the observed state of Log.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that the resource belongs to. string No - -
configuration LogConfiguration defines nested fields for Log.Configuration. object No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID of the resource. string No - -
isEnabled Whether or not this resource is currently enabled. boolean No - -
lifecycleState The pipeline state. string No - -
logGroupId Log group OCID. string No - -
logType The logType that the log object is for, whether custom or service. string No - -
retentionDuration Log retention duration in 30-day increments (30, 60, 90 and so on until 180). integer No - -
status - object Yes - -
tenancyId The OCID of the tenancy. string No - -
timeCreated Time the resource was created. string No - -
timeLastModified Time the resource was last modified. string No - -

Status.configuration

Back to Log status

LogConfiguration defines nested fields for Log.Configuration.

Field Description Type Required Default Enum
archiving LogConfigurationArchiving defines nested fields for Log.Configuration.Archiving. object No - -
compartmentId The OCID of the compartment that the resource belongs to. string No - -
source LogConfigurationSource defines nested fields for Log.Configuration.Source. object Yes - -

Status.configuration.archiving

Back to Log status

LogConfigurationArchiving defines nested fields for Log.Configuration.Archiving.

Field Description Type Required Default Enum
isEnabled True if archiving enabled. This field is now deprecated, you should use Service Connector Hub to enable archiving. boolean No - -

Status.configuration.source

Back to Log status

LogConfigurationSource defines nested fields for Log.Configuration.Source.

Field Description Type Required Default Enum
category Log object category. string No - -
jsonData - string No - -
parameters Log category parameters are stored here. map[string, string] No - -
resource The unique identifier of the resource emitting the log. string No - -
service Service generating log. string No - -
sourceType - string No - -

Status.status

Back to Log 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 Log 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 Log 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 Log status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

LogGroup

LogGroup is the Schema for the loggroups API.

  • Plural: loggroups
  • Scope: Namespaced
  • APIVersion: logging.oracle.com/v1beta1
  • Sample: Sample (config/samples/logging_v1beta1_loggroup.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

LogGroupSpec defines the desired state of LogGroup.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that the resource belongs to. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description Description for this resource. string No - -
displayName The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information. string Yes - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -

Status

LogGroupStatus defines the observed state of LogGroup.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that the resource belongs to. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description Description for this resource. string No - -
displayName The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID of the resource. string No - -
lifecycleState The log group object state. string No - -
status - object Yes - -
timeCreated Time the resource was created. string No - -
timeLastModified Time the resource was last modified. string No - -

Status.status

Back to LogGroup 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 LogGroup 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 LogGroup 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 LogGroup status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

LogSavedSearch

LogSavedSearch is the Schema for the logsavedsearches API.

  • Plural: logsavedsearches
  • Scope: Namespaced
  • APIVersion: logging.oracle.com/v1beta1
  • Sample: Sample (config/samples/logging_v1beta1_logsavedsearch.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

LogSavedSearchSpec defines the desired state of LogSavedSearch.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that the resource belongs to. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description Description for this resource. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
name The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information. string Yes - -
query The search query that is saved. string Yes - -

Status

LogSavedSearchStatus defines the observed state of LogSavedSearch.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that the resource belongs to. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description Description for this resource. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID of the resource. string No - -
lifecycleState The state of the LogSavedSearch string No - -
name The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information. string No - -
query The search query that is saved. string No - -
status - object Yes - -
timeCreated Time the resource was created. string No - -
timeLastModified Time the resource was last modified. string No - -

Status.status

Back to LogSavedSearch 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 LogSavedSearch 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 LogSavedSearch 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 LogSavedSearch status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

UnifiedAgentConfiguration

UnifiedAgentConfiguration is the Schema for the unifiedagentconfigurations API.

  • Plural: unifiedagentconfigurations
  • Scope: Namespaced
  • APIVersion: logging.oracle.com/v1beta1
  • Sample: Sample (config/samples/logging_v1beta1_unifiedagentconfiguration.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

UnifiedAgentConfigurationSpec defines the desired state of UnifiedAgentConfiguration.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that the resource belongs to. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description Description for this resource. string Yes - -
displayName The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information. string Yes - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
groupAssociation UnifiedAgentConfigurationGroupAssociation defines nested fields for UnifiedAgentConfiguration.GroupAssociation. object No - -
isEnabled Whether or not this resource is currently enabled. boolean Yes - -
serviceConfiguration UnifiedAgentConfigurationServiceConfiguration defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration. object Yes - -

Spec.groupAssociation

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationGroupAssociation defines nested fields for UnifiedAgentConfiguration.GroupAssociation.

Field Description Type Required Default Enum
groupList list of group/dynamic group ids associated with this configuration. list[string] No - -

Spec.serviceConfiguration

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfiguration defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.

Field Description Type Required Default Enum
applicationConfigurations Unified Agent monitoring application configuration details. list[object] No - -
configurationType - string No - -
destination UnifiedAgentConfigurationServiceConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination. object No - -
filter Logging filter object. list[object] No - -
jsonData - string No - -
sources Logging source object. list[object] No - -

Spec.serviceConfiguration.applicationConfigurations[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationApplicationConfiguration defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.

Field Description Type Required Default Enum
destination UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Destination. object No - -
filter UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationFilter defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Filter. object No - -
jsonData - string No - -
source UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Source. object No - -
sourceType - string No - -
sources Tail log source objects. list[object] No - -

Spec.serviceConfiguration.applicationConfigurations[].destination

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Destination.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that the resource belongs to. string Yes - -
metricsNamespace Namespace to which metrics will be emitted. string Yes - -

Spec.serviceConfiguration.applicationConfigurations[].filter

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationFilter defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Filter.

Field Description Type Required Default Enum
allowList List of metrics regex to be allowed. list[string] No - -
denyList List of metrics regex to be denied. list[string] No - -
name Unique name for the filter. string Yes - -

Spec.serviceConfiguration.applicationConfigurations[].source

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Source.

Field Description Type Required Default Enum
name Unique name for the source. string Yes - -
scrapeTargets List of UnifiedAgentKubernetesScrapeTarget. list[object] Yes - -

Spec.serviceConfiguration.applicationConfigurations[].source.scrapeTargets[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceScrapeTarget defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Source.ScrapeTarget.

Field Description Type Required Default Enum
k8sNamespace K8s namespace of the resource. string Yes - -
resourceGroup Resource group in OCI monitoring. string No - -
resourceType Type of resource to scrape metrics. string Yes - -
serviceName Name of the service prepended to the endpoints. string No - -

Spec.serviceConfiguration.applicationConfigurations[].sources[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Source.

Field Description Type Required Default Enum
name Unique name for the source. string Yes - -
scrapeTargets List of UnifiedAgentKubernetesScrapeTarget. list[object] Yes - -

Spec.serviceConfiguration.applicationConfigurations[].sources[].scrapeTargets[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceScrapeTarget defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Source.ScrapeTarget.

Field Description Type Required Default Enum
k8sNamespace K8s namespace of the resource. string Yes - -
resourceGroup Resource group in OCI monitoring. string No - -
resourceType Type of resource to scrape metrics. string Yes - -
serviceName Name of the service prepended to the endpoints. string No - -

Spec.serviceConfiguration.destination

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.

Field Description Type Required Default Enum
logObjectId The OCID of the resource. string Yes - -
operationalMetricsConfiguration UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfiguration defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration. object No - -

Spec.serviceConfiguration.destination.operationalMetricsConfiguration

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfiguration defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.

Field Description Type Required Default Enum
destination UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Destination. object Yes - -
source UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Source. object Yes - -

Spec.serviceConfiguration.destination.operationalMetricsConfiguration.destination

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Destination.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that the resource belongs to. string Yes - -

Spec.serviceConfiguration.destination.operationalMetricsConfiguration.source

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Source.

Field Description Type Required Default Enum
metrics List of unified monitoring agent operational metrics. list[string] No - -
recordInput UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSourceRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Source.RecordInput. object Yes - -
type Type of the unified monitoring agent operational metrics source object. string Yes - -

Spec.serviceConfiguration.destination.operationalMetricsConfiguration.source.recordInput

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSourceRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Source.RecordInput.

Field Description Type Required Default Enum
namespace Namespace to emit the operational metrics. string Yes - -
resourceGroup Resource group to emit the operational metrics. string No - -

Spec.serviceConfiguration.filter[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationFilter defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.

Field Description Type Required Default Enum
allowList A list of filtering rules to include logs list[object] No - -
customFilterType Type of the custom filter string No - -
customSections List of custom sections in custom filter list[object] No - -
denyList A list of filtering rules to reject logs list[object] No - -
emitInvalidRecordToError If true, emit invalid record to @ERROR label. Invalid cases are: 1) key does not exist; 2) the format does not match; or 3) an unexpected error. You can rescue unexpected format logs in the @ERROR lable. If you want to ignore these errors, set this to false. boolean No - -
filterType - string No - -
hashValueField Store the parsed values as a hash value in a field. string No - -
injectKeyPrefix Store the parsed values with the specified key name prefix. string No - -
isAutoTypecastEnabled If true, automatically casts the field types. boolean No - -
isRenewRecordEnabled If true, it modifies a new empty hash boolean No - -
isRubyEnabled When set to true, the full Ruby syntax is enabled in the ${} expression. boolean No - -
jsonData - string No - -
keepKeys A list of keys to keep. Only relevant if isRenewRecordEnabled is set to true list[string] No - -
keyName The field name in the record to parse. string No - -
name Unique name for the filter. string Yes - -
params Parameters of the custom filter map[string, string] No - -
parser UnifiedAgentConfigurationServiceConfigurationFilterParser defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.Parser. object No - -
recordList Add new key-value pairs in logs list[object] No - -
removeKeyNameField If true, remove the keyName field when parsing is succeeded. boolean No - -
removeKeys A list of keys to delete list[string] No - -
renewTimeKey Overwrites the time of logs with this value, this value must be a Unix timestamp. string No - -
replaceInvalidSequence If true, the invalid string is replaced with safe characters and is re-parsed. boolean No - -
reserveData If true, keep the original key-value pair in the parsed result. boolean No - -
reserveTime If true, keep the original event time in the parsed result. boolean No - -

Spec.serviceConfiguration.filter[].allowList[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationFilterAllowList defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.AllowList.

Field Description Type Required Default Enum
key The field name to which the regular expression is applied string No - -
pattern The regular expression string No - -

Spec.serviceConfiguration.filter[].customSections[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationFilterCustomSection defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.CustomSection.

Field Description Type Required Default Enum
name The name of the custom section string No - -
params Parameters in the custom section map[string, string] No - -

Spec.serviceConfiguration.filter[].denyList[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationFilterDenyList defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.DenyList.

Field Description Type Required Default Enum
key The field name to which the regular expression is applied string No - -
pattern The regular expression string No - -

Spec.serviceConfiguration.filter[].parser

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationFilterParser defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.Parser.

Field Description Type Required Default Enum
delimiter TSV delimiter. string No - -
expression Regex pattern. string No - -
fieldTimeKey Specifies the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
format Mutiline pattern format. list[string] No - -
formatFirstline First line pattern format. string No - -
grokFailureKey Grok failure key. string No - -
grokNameKey Grok name key. string No - -
isEstimateCurrentEvent If true, use Fluent::EventTime.now(current time) as a timestamp when the time_key is specified. boolean No - -
isKeepTimeKey If true, keep the time field in the record. boolean No - -
isMergeCriFields If you don't need stream or logtag fields, set this to false. boolean No - -
isNullEmptyString If true, an empty string field is replaced with a null value. boolean No - -
isSupportColonlessIdent Specifies whether or not to support colonless ident. Corresponds to the Fluentd support_colonless_ident parameter. boolean No - -
isWithPriority Specifies with priority or not. Corresponds to the Fluentd with_priority parameter. boolean No - -
jsonData - string No - -
keys TSV keys. list[string] No - -
messageFormat Syslog message format. string No - -
messageKey Specifies the field name to contain logs. string No - -
multiLineStartRegexp Multiline start regexp pattern. string No - -
nestedParser Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey. object No - -
nullValuePattern Specify the null value pattern. string No - -
parseNested If true, a separator parameter can be further defined. boolean No - -
parserType - string No - -
patterns Grok pattern object. list[object] No - -
recordInput UnifiedAgentConfigurationServiceConfigurationFilterParserRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.Parser.RecordInput. object No - -
rfc5424TimeFormat RFC 5424 time format. string No - -
separator Keys of adjacent levels are joined by the separator. string No - -
syslogParserType Syslog parser type. string No - -
timeFormat Process time value using the specified format. string No - -
timeType JSON parser time type. string No - -
timeoutInMilliseconds Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. integer No - -
types Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user time_key time This incoming event: "2013/02/28 12:00:00,192.168.0.1,111,-" is parsed as: 1362020400 (2013/02/28/ 12:00:00) record: map[string, string] No - -

Spec.serviceConfiguration.filter[].parser.nestedParser

Back to UnifiedAgentConfiguration spec

Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey.

Field Description Type Required Default Enum
fieldTimeKey Specifies the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
isEstimateCurrentEvent If true, use Fluent::EventTime.now(current time) as a timestamp when the time_key is specified. boolean No - -
isKeepTimeKey If true, keep the time field in the record. boolean No - -
isNullEmptyString If true, an empty string field is replaced with a null value. boolean No - -
nullValuePattern Specify the null value pattern. string No - -
parseNested If true, a separator parameter can be further defined. boolean No - -
separator Keys of adjacent levels are joined by the separator. string No - -
timeFormat Process time value using the specified format. string No - -
timeType JSON parser time type. string No - -
timeoutInMilliseconds Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. integer No - -
types Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user time_key time This incoming event: "2013/02/28 12:00:00,192.168.0.1,111,-" is parsed as: 1362020400 (2013/02/28/ 12:00:00) record: map[string, string] No - -

Spec.serviceConfiguration.filter[].parser.patterns[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationFilterParserPattern defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.Parser.Pattern.

Field Description Type Required Default Enum
fieldTimeFormat Process value using the specified format. This is available only when time_type is a string. string No - -
fieldTimeKey Specify the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
fieldTimeZone Use the specified time zone. The time value can be parsed or formatted in the specified time zone. string No - -
name The name key to tag this Grok pattern. string No - -
pattern The Grok pattern. string Yes - -

Spec.serviceConfiguration.filter[].parser.recordInput

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationFilterParserRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.Parser.RecordInput.

Field Description Type Required Default Enum
dimensions Dimensions to be added for metrics. map[string, string] No - -
namespace Namespace to emit metrics. string No - -
resourceGroup Resource group to emit metrics. string No - -

Spec.serviceConfiguration.filter[].recordList[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationFilterRecordList defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.RecordList.

Field Description Type Required Default Enum
key A new key string No - -
value A new value string No - -

Spec.serviceConfiguration.sources[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.

Field Description Type Required Default Enum
advancedOptions UnifiedAgentConfigurationServiceConfigurationSourceAdvancedOptions defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.AdvancedOptions. object No - -
channels Windows event log channels. list[string] No - -
customPlugin User customized source plugin. string No - -
jsonData - string No - -
name Unique name for the source. string Yes - -
parser UnifiedAgentConfigurationServiceConfigurationSourceParser defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.Parser. object No - -
paths Absolute paths for log source files. Wildcards can be used. list[string] No - -
sourceType - string No - -

Spec.serviceConfiguration.sources[].advancedOptions

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationSourceAdvancedOptions defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.AdvancedOptions.

Field Description Type Required Default Enum
isReadFromHead Starts to read the logs from the head of the file or the last read position recorded in pos_file, not tail. boolean No - -

Spec.serviceConfiguration.sources[].parser

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationSourceParser defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.Parser.

Field Description Type Required Default Enum
delimiter TSV delimiter. string No - -
expression Regex pattern. string No - -
fieldTimeKey Specifies the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
format Mutiline pattern format. list[string] No - -
formatFirstline First line pattern format. string No - -
grokFailureKey Grok failure key. string No - -
grokNameKey Grok name key. string No - -
isEstimateCurrentEvent If true, use Fluent::EventTime.now(current time) as a timestamp when the time_key is specified. boolean No - -
isKeepTimeKey If true, keep the time field in the record. boolean No - -
isMergeCriFields If you don't need stream or logtag fields, set this to false. boolean No - -
isNullEmptyString If true, an empty string field is replaced with a null value. boolean No - -
isSupportColonlessIdent Specifies whether or not to support colonless ident. Corresponds to the Fluentd support_colonless_ident parameter. boolean No - -
isWithPriority Specifies with priority or not. Corresponds to the Fluentd with_priority parameter. boolean No - -
jsonData - string No - -
keys TSV keys. list[string] No - -
messageFormat Syslog message format. string No - -
messageKey Specifies the field name to contain logs. string No - -
multiLineStartRegexp Multiline start regexp pattern. string No - -
nestedParser Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey. object No - -
nullValuePattern Specify the null value pattern. string No - -
parseNested If true, a separator parameter can be further defined. boolean No - -
parserType - string No - -
patterns Grok pattern object. list[object] No - -
recordInput UnifiedAgentConfigurationServiceConfigurationSourceParserRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.Parser.RecordInput. object No - -
rfc5424TimeFormat RFC 5424 time format. string No - -
separator Keys of adjacent levels are joined by the separator. string No - -
syslogParserType Syslog parser type. string No - -
timeFormat Process time value using the specified format. string No - -
timeType JSON parser time type. string No - -
timeoutInMilliseconds Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. integer No - -
types Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user time_key time This incoming event: "2013/02/28 12:00:00,192.168.0.1,111,-" is parsed as: 1362020400 (2013/02/28/ 12:00:00) record: map[string, string] No - -

Spec.serviceConfiguration.sources[].parser.nestedParser

Back to UnifiedAgentConfiguration spec

Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey.

Field Description Type Required Default Enum
fieldTimeKey Specifies the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
isEstimateCurrentEvent If true, use Fluent::EventTime.now(current time) as a timestamp when the time_key is specified. boolean No - -
isKeepTimeKey If true, keep the time field in the record. boolean No - -
isNullEmptyString If true, an empty string field is replaced with a null value. boolean No - -
nullValuePattern Specify the null value pattern. string No - -
parseNested If true, a separator parameter can be further defined. boolean No - -
separator Keys of adjacent levels are joined by the separator. string No - -
timeFormat Process time value using the specified format. string No - -
timeType JSON parser time type. string No - -
timeoutInMilliseconds Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. integer No - -
types Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user time_key time This incoming event: "2013/02/28 12:00:00,192.168.0.1,111,-" is parsed as: 1362020400 (2013/02/28/ 12:00:00) record: map[string, string] No - -

Spec.serviceConfiguration.sources[].parser.patterns[]

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationSourceParserPattern defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.Parser.Pattern.

Field Description Type Required Default Enum
fieldTimeFormat Process value using the specified format. This is available only when time_type is a string. string No - -
fieldTimeKey Specify the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
fieldTimeZone Use the specified time zone. The time value can be parsed or formatted in the specified time zone. string No - -
name The name key to tag this Grok pattern. string No - -
pattern The Grok pattern. string Yes - -

Spec.serviceConfiguration.sources[].parser.recordInput

Back to UnifiedAgentConfiguration spec

UnifiedAgentConfigurationServiceConfigurationSourceParserRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.Parser.RecordInput.

Field Description Type Required Default Enum
dimensions Dimensions to be added for metrics. map[string, string] No - -
namespace Namespace to emit metrics. string No - -
resourceGroup Resource group to emit metrics. string No - -

Status

UnifiedAgentConfigurationStatus defines the observed state of UnifiedAgentConfiguration.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that the resource belongs to. string No - -
configurationState State of unified agent service configuration. string No - -
configurationType Type of Unified Agent service configuration. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description Description for this resource. string No - -
displayName The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information. string No - -
freeformTags Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
groupAssociation UnifiedAgentConfigurationGroupAssociation defines nested fields for UnifiedAgentConfiguration.GroupAssociation. object No - -
id The OCID of the resource. string No - -
isEnabled Whether or not this resource is currently enabled. boolean No - -
lifecycleState The pipeline state. string No - -
serviceConfiguration UnifiedAgentConfigurationServiceConfiguration defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration. object No - -
status - object Yes - -
timeCreated Time the resource was created. string No - -
timeLastModified Time the resource was last modified. string No - -

Status.groupAssociation

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationGroupAssociation defines nested fields for UnifiedAgentConfiguration.GroupAssociation.

Field Description Type Required Default Enum
groupList list of group/dynamic group ids associated with this configuration. list[string] No - -

Status.serviceConfiguration

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfiguration defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.

Field Description Type Required Default Enum
applicationConfigurations Unified Agent monitoring application configuration details. list[object] No - -
configurationType - string No - -
destination UnifiedAgentConfigurationServiceConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination. object No - -
filter Logging filter object. list[object] No - -
jsonData - string No - -
sources Logging source object. list[object] No - -

Status.serviceConfiguration.applicationConfigurations[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationApplicationConfiguration defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.

Field Description Type Required Default Enum
destination UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Destination. object No - -
filter UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationFilter defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Filter. object No - -
jsonData - string No - -
source UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Source. object No - -
sourceType - string No - -
sources Tail log source objects. list[object] No - -

Status.serviceConfiguration.applicationConfigurations[].destination

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Destination.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that the resource belongs to. string Yes - -
metricsNamespace Namespace to which metrics will be emitted. string Yes - -

Status.serviceConfiguration.applicationConfigurations[].filter

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationFilter defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Filter.

Field Description Type Required Default Enum
allowList List of metrics regex to be allowed. list[string] No - -
denyList List of metrics regex to be denied. list[string] No - -
name Unique name for the filter. string Yes - -

Status.serviceConfiguration.applicationConfigurations[].source

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Source.

Field Description Type Required Default Enum
name Unique name for the source. string Yes - -
scrapeTargets List of UnifiedAgentKubernetesScrapeTarget. list[object] Yes - -

Status.serviceConfiguration.applicationConfigurations[].source.scrapeTargets[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceScrapeTarget defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Source.ScrapeTarget.

Field Description Type Required Default Enum
k8sNamespace K8s namespace of the resource. string Yes - -
resourceGroup Resource group in OCI monitoring. string No - -
resourceType Type of resource to scrape metrics. string Yes - -
serviceName Name of the service prepended to the endpoints. string No - -

Status.serviceConfiguration.applicationConfigurations[].sources[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Source.

Field Description Type Required Default Enum
name Unique name for the source. string Yes - -
scrapeTargets List of UnifiedAgentKubernetesScrapeTarget. list[object] Yes - -

Status.serviceConfiguration.applicationConfigurations[].sources[].scrapeTargets[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceScrapeTarget defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.ApplicationConfiguration.Source.ScrapeTarget.

Field Description Type Required Default Enum
k8sNamespace K8s namespace of the resource. string Yes - -
resourceGroup Resource group in OCI monitoring. string No - -
resourceType Type of resource to scrape metrics. string Yes - -
serviceName Name of the service prepended to the endpoints. string No - -

Status.serviceConfiguration.destination

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.

Field Description Type Required Default Enum
logObjectId The OCID of the resource. string Yes - -
operationalMetricsConfiguration UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfiguration defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration. object No - -

Status.serviceConfiguration.destination.operationalMetricsConfiguration

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfiguration defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.

Field Description Type Required Default Enum
destination UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Destination. object Yes - -
source UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Source. object Yes - -

Status.serviceConfiguration.destination.operationalMetricsConfiguration.destination

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationDestination defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Destination.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that the resource belongs to. string Yes - -

Status.serviceConfiguration.destination.operationalMetricsConfiguration.source

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Source.

Field Description Type Required Default Enum
metrics List of unified monitoring agent operational metrics. list[string] No - -
recordInput UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSourceRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Source.RecordInput. object Yes - -
type Type of the unified monitoring agent operational metrics source object. string Yes - -

Status.serviceConfiguration.destination.operationalMetricsConfiguration.source.recordInput

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSourceRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Destination.OperationalMetricsConfiguration.Source.RecordInput.

Field Description Type Required Default Enum
namespace Namespace to emit the operational metrics. string Yes - -
resourceGroup Resource group to emit the operational metrics. string No - -

Status.serviceConfiguration.filter[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationFilter defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.

Field Description Type Required Default Enum
allowList A list of filtering rules to include logs list[object] No - -
customFilterType Type of the custom filter string No - -
customSections List of custom sections in custom filter list[object] No - -
denyList A list of filtering rules to reject logs list[object] No - -
emitInvalidRecordToError If true, emit invalid record to @ERROR label. Invalid cases are: 1) key does not exist; 2) the format does not match; or 3) an unexpected error. You can rescue unexpected format logs in the @ERROR lable. If you want to ignore these errors, set this to false. boolean No - -
filterType - string No - -
hashValueField Store the parsed values as a hash value in a field. string No - -
injectKeyPrefix Store the parsed values with the specified key name prefix. string No - -
isAutoTypecastEnabled If true, automatically casts the field types. boolean No - -
isRenewRecordEnabled If true, it modifies a new empty hash boolean No - -
isRubyEnabled When set to true, the full Ruby syntax is enabled in the ${} expression. boolean No - -
jsonData - string No - -
keepKeys A list of keys to keep. Only relevant if isRenewRecordEnabled is set to true list[string] No - -
keyName The field name in the record to parse. string No - -
name Unique name for the filter. string Yes - -
params Parameters of the custom filter map[string, string] No - -
parser UnifiedAgentConfigurationServiceConfigurationFilterParser defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.Parser. object No - -
recordList Add new key-value pairs in logs list[object] No - -
removeKeyNameField If true, remove the keyName field when parsing is succeeded. boolean No - -
removeKeys A list of keys to delete list[string] No - -
renewTimeKey Overwrites the time of logs with this value, this value must be a Unix timestamp. string No - -
replaceInvalidSequence If true, the invalid string is replaced with safe characters and is re-parsed. boolean No - -
reserveData If true, keep the original key-value pair in the parsed result. boolean No - -
reserveTime If true, keep the original event time in the parsed result. boolean No - -

Status.serviceConfiguration.filter[].allowList[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationFilterAllowList defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.AllowList.

Field Description Type Required Default Enum
key The field name to which the regular expression is applied string No - -
pattern The regular expression string No - -

Status.serviceConfiguration.filter[].customSections[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationFilterCustomSection defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.CustomSection.

Field Description Type Required Default Enum
name The name of the custom section string No - -
params Parameters in the custom section map[string, string] No - -

Status.serviceConfiguration.filter[].denyList[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationFilterDenyList defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.DenyList.

Field Description Type Required Default Enum
key The field name to which the regular expression is applied string No - -
pattern The regular expression string No - -

Status.serviceConfiguration.filter[].parser

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationFilterParser defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.Parser.

Field Description Type Required Default Enum
delimiter TSV delimiter. string No - -
expression Regex pattern. string No - -
fieldTimeKey Specifies the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
format Mutiline pattern format. list[string] No - -
formatFirstline First line pattern format. string No - -
grokFailureKey Grok failure key. string No - -
grokNameKey Grok name key. string No - -
isEstimateCurrentEvent If true, use Fluent::EventTime.now(current time) as a timestamp when the time_key is specified. boolean No - -
isKeepTimeKey If true, keep the time field in the record. boolean No - -
isMergeCriFields If you don't need stream or logtag fields, set this to false. boolean No - -
isNullEmptyString If true, an empty string field is replaced with a null value. boolean No - -
isSupportColonlessIdent Specifies whether or not to support colonless ident. Corresponds to the Fluentd support_colonless_ident parameter. boolean No - -
isWithPriority Specifies with priority or not. Corresponds to the Fluentd with_priority parameter. boolean No - -
jsonData - string No - -
keys TSV keys. list[string] No - -
messageFormat Syslog message format. string No - -
messageKey Specifies the field name to contain logs. string No - -
multiLineStartRegexp Multiline start regexp pattern. string No - -
nestedParser Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey. object No - -
nullValuePattern Specify the null value pattern. string No - -
parseNested If true, a separator parameter can be further defined. boolean No - -
parserType - string No - -
patterns Grok pattern object. list[object] No - -
recordInput UnifiedAgentConfigurationServiceConfigurationFilterParserRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.Parser.RecordInput. object No - -
rfc5424TimeFormat RFC 5424 time format. string No - -
separator Keys of adjacent levels are joined by the separator. string No - -
syslogParserType Syslog parser type. string No - -
timeFormat Process time value using the specified format. string No - -
timeType JSON parser time type. string No - -
timeoutInMilliseconds Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. integer No - -
types Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user time_key time This incoming event: "2013/02/28 12:00:00,192.168.0.1,111,-" is parsed as: 1362020400 (2013/02/28/ 12:00:00) record: map[string, string] No - -

Status.serviceConfiguration.filter[].parser.nestedParser

Back to UnifiedAgentConfiguration status

Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey.

Field Description Type Required Default Enum
fieldTimeKey Specifies the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
isEstimateCurrentEvent If true, use Fluent::EventTime.now(current time) as a timestamp when the time_key is specified. boolean No - -
isKeepTimeKey If true, keep the time field in the record. boolean No - -
isNullEmptyString If true, an empty string field is replaced with a null value. boolean No - -
nullValuePattern Specify the null value pattern. string No - -
parseNested If true, a separator parameter can be further defined. boolean No - -
separator Keys of adjacent levels are joined by the separator. string No - -
timeFormat Process time value using the specified format. string No - -
timeType JSON parser time type. string No - -
timeoutInMilliseconds Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. integer No - -
types Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user time_key time This incoming event: "2013/02/28 12:00:00,192.168.0.1,111,-" is parsed as: 1362020400 (2013/02/28/ 12:00:00) record: map[string, string] No - -

Status.serviceConfiguration.filter[].parser.patterns[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationFilterParserPattern defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.Parser.Pattern.

Field Description Type Required Default Enum
fieldTimeFormat Process value using the specified format. This is available only when time_type is a string. string No - -
fieldTimeKey Specify the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
fieldTimeZone Use the specified time zone. The time value can be parsed or formatted in the specified time zone. string No - -
name The name key to tag this Grok pattern. string No - -
pattern The Grok pattern. string Yes - -

Status.serviceConfiguration.filter[].parser.recordInput

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationFilterParserRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.Parser.RecordInput.

Field Description Type Required Default Enum
dimensions Dimensions to be added for metrics. map[string, string] No - -
namespace Namespace to emit metrics. string No - -
resourceGroup Resource group to emit metrics. string No - -

Status.serviceConfiguration.filter[].recordList[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationFilterRecordList defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Filter.RecordList.

Field Description Type Required Default Enum
key A new key string No - -
value A new value string No - -

Status.serviceConfiguration.sources[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationSource defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.

Field Description Type Required Default Enum
advancedOptions UnifiedAgentConfigurationServiceConfigurationSourceAdvancedOptions defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.AdvancedOptions. object No - -
channels Windows event log channels. list[string] No - -
customPlugin User customized source plugin. string No - -
jsonData - string No - -
name Unique name for the source. string Yes - -
parser UnifiedAgentConfigurationServiceConfigurationSourceParser defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.Parser. object No - -
paths Absolute paths for log source files. Wildcards can be used. list[string] No - -
sourceType - string No - -

Status.serviceConfiguration.sources[].advancedOptions

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationSourceAdvancedOptions defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.AdvancedOptions.

Field Description Type Required Default Enum
isReadFromHead Starts to read the logs from the head of the file or the last read position recorded in pos_file, not tail. boolean No - -

Status.serviceConfiguration.sources[].parser

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationSourceParser defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.Parser.

Field Description Type Required Default Enum
delimiter TSV delimiter. string No - -
expression Regex pattern. string No - -
fieldTimeKey Specifies the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
format Mutiline pattern format. list[string] No - -
formatFirstline First line pattern format. string No - -
grokFailureKey Grok failure key. string No - -
grokNameKey Grok name key. string No - -
isEstimateCurrentEvent If true, use Fluent::EventTime.now(current time) as a timestamp when the time_key is specified. boolean No - -
isKeepTimeKey If true, keep the time field in the record. boolean No - -
isMergeCriFields If you don't need stream or logtag fields, set this to false. boolean No - -
isNullEmptyString If true, an empty string field is replaced with a null value. boolean No - -
isSupportColonlessIdent Specifies whether or not to support colonless ident. Corresponds to the Fluentd support_colonless_ident parameter. boolean No - -
isWithPriority Specifies with priority or not. Corresponds to the Fluentd with_priority parameter. boolean No - -
jsonData - string No - -
keys TSV keys. list[string] No - -
messageFormat Syslog message format. string No - -
messageKey Specifies the field name to contain logs. string No - -
multiLineStartRegexp Multiline start regexp pattern. string No - -
nestedParser Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey. object No - -
nullValuePattern Specify the null value pattern. string No - -
parseNested If true, a separator parameter can be further defined. boolean No - -
parserType - string No - -
patterns Grok pattern object. list[object] No - -
recordInput UnifiedAgentConfigurationServiceConfigurationSourceParserRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.Parser.RecordInput. object No - -
rfc5424TimeFormat RFC 5424 time format. string No - -
separator Keys of adjacent levels are joined by the separator. string No - -
syslogParserType Syslog parser type. string No - -
timeFormat Process time value using the specified format. string No - -
timeType JSON parser time type. string No - -
timeoutInMilliseconds Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. integer No - -
types Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user time_key time This incoming event: "2013/02/28 12:00:00,192.168.0.1,111,-" is parsed as: 1362020400 (2013/02/28/ 12:00:00) record: map[string, string] No - -

Status.serviceConfiguration.sources[].parser.nestedParser

Back to UnifiedAgentConfiguration status

Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey.

Field Description Type Required Default Enum
fieldTimeKey Specifies the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
isEstimateCurrentEvent If true, use Fluent::EventTime.now(current time) as a timestamp when the time_key is specified. boolean No - -
isKeepTimeKey If true, keep the time field in the record. boolean No - -
isNullEmptyString If true, an empty string field is replaced with a null value. boolean No - -
nullValuePattern Specify the null value pattern. string No - -
parseNested If true, a separator parameter can be further defined. boolean No - -
separator Keys of adjacent levels are joined by the separator. string No - -
timeFormat Process time value using the specified format. string No - -
timeType JSON parser time type. string No - -
timeoutInMilliseconds Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. integer No - -
types Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user time_key time This incoming event: "2013/02/28 12:00:00,192.168.0.1,111,-" is parsed as: 1362020400 (2013/02/28/ 12:00:00) record: map[string, string] No - -

Status.serviceConfiguration.sources[].parser.patterns[]

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationSourceParserPattern defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.Parser.Pattern.

Field Description Type Required Default Enum
fieldTimeFormat Process value using the specified format. This is available only when time_type is a string. string No - -
fieldTimeKey Specify the time field for the event time. If the event doesn't have this field, the current time is used. string No - -
fieldTimeZone Use the specified time zone. The time value can be parsed or formatted in the specified time zone. string No - -
name The name key to tag this Grok pattern. string No - -
pattern The Grok pattern. string Yes - -

Status.serviceConfiguration.sources[].parser.recordInput

Back to UnifiedAgentConfiguration status

UnifiedAgentConfigurationServiceConfigurationSourceParserRecordInput defines nested fields for UnifiedAgentConfiguration.ServiceConfiguration.Source.Parser.RecordInput.

Field Description Type Required Default Enum
dimensions Dimensions to be added for metrics. map[string, string] No - -
namespace Namespace to emit metrics. string No - -
resourceGroup Resource group to emit metrics. string No - -

Status.status

Back to UnifiedAgentConfiguration 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 UnifiedAgentConfiguration 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 UnifiedAgentConfiguration 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 UnifiedAgentConfiguration status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -