Class CreateLogAnalyticsObjectCollectionRuleDetails

The configuration details of collection rule to enable automatic log collection from an object storage bucket.

Inheritance
object
CreateLogAnalyticsObjectCollectionRuleDetails
Inherited Members
Namespace: Oci.LoganalyticsService.Models
Assembly: OCI.DotNetSDK.Loganalytics.dll
Syntax
public class CreateLogAnalyticsObjectCollectionRuleDetails

Properties

CharEncoding

Declaration
[JsonProperty(PropertyName = "charEncoding")]
public string CharEncoding { get; set; }
Property Value
Type Description
string

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.

CollectionType

Declaration
[JsonProperty(PropertyName = "collectionType")]
[JsonConverter(typeof(StringEnumConverter))]
public ObjectCollectionRuleCollectionTypes? CollectionType { get; set; }
Property Value
Type Description
ObjectCollectionRuleCollectionTypes?

The type of collection.

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment to which this rule belongs.
Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

EntityId

Declaration
[JsonProperty(PropertyName = "entityId")]
public string EntityId { get; set; }
Property Value
Type Description
string

Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsEnabled

Declaration
[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }
Property Value
Type Description
bool?

Whether or not this rule is currently enabled.

IsForceHistoricCollection

Declaration
[JsonProperty(PropertyName = "isForceHistoricCollection")]
public bool? IsForceHistoricCollection { get; set; }
Property Value
Type Description
bool?

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

LogGroupId

Declaration
[Required(ErrorMessage = "LogGroupId is required.")]
[JsonProperty(PropertyName = "logGroupId")]
public string LogGroupId { get; set; }
Property Value
Type Description
string

Logging Analytics Log group OCID to associate the processed logs with.
Remarks

Required

LogSet

Declaration
[JsonProperty(PropertyName = "logSet")]
public string LogSet { get; set; }
Property Value
Type Description
string

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.

LogSetExtRegex

Declaration
[JsonProperty(PropertyName = "logSetExtRegex")]
public string LogSetExtRegex { get; set; }
Property Value
Type Description
string

The regex to be applied against given logSetKey. Regex has to be in string escaped format.

LogSetKey

Declaration
[JsonProperty(PropertyName = "logSetKey")]
[JsonConverter(typeof(StringEnumConverter))]
public LogSetKeyTypes? LogSetKey { get; set; }
Property Value
Type Description
LogSetKeyTypes?

LogSourceName

Declaration
[Required(ErrorMessage = "LogSourceName is required.")]
[JsonProperty(PropertyName = "logSourceName")]
public string LogSourceName { get; set; }
Property Value
Type Description
string

Name of the Logging Analytics Source to use for the processing.
Remarks

Required

LogType

Declaration
[JsonProperty(PropertyName = "logType")]
[JsonConverter(typeof(StringEnumConverter))]
public LogTypes? LogType { get; set; }
Property Value
Type Description
LogTypes?

Type of files/objects in this object collection rule.

Name

Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.
Remarks

Required

ObjectNameFilters

Declaration
[JsonProperty(PropertyName = "objectNameFilters")]
public List<string> ObjectNameFilters { get; set; }
Property Value
Type Description
List<string>

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.

OsBucketName

Declaration
[Required(ErrorMessage = "OsBucketName is required.")]
[JsonProperty(PropertyName = "osBucketName")]
public string OsBucketName { get; set; }
Property Value
Type Description
string

Name of the Object Storage bucket.
Remarks

Required

OsNamespace

Declaration
[Required(ErrorMessage = "OsNamespace is required.")]
[JsonProperty(PropertyName = "osNamespace")]
public string OsNamespace { get; set; }
Property Value
Type Description
string

Object Storage namespace.
Remarks

Required

Overrides

Declaration
[JsonProperty(PropertyName = "overrides")]
public Dictionary<string, List<PropertyOverride>> Overrides { get; set; }
Property Value
Type Description
Dictionary<string, List<PropertyOverride>>

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".

PollSince

Declaration
[JsonProperty(PropertyName = "pollSince")]
public string PollSince { get; set; }
Property Value
Type Description
string

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.

PollTill

Declaration
[JsonProperty(PropertyName = "pollTill")]
public string PollTill { get; set; }
Property Value
Type Description
string

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.

Timezone

Declaration
[JsonProperty(PropertyName = "timezone")]
public string Timezone { get; set; }
Property Value
Type Description
string

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.