Oracle Log Analytics destination plugin

The Oracle Log Analytics destination plugin lets you configure your Telemetry Pipeline to output log data to Oracle Log Analytics.

Configuration parameters

The Oracle Log Analytics destination plugin provides these configuration parameters. Items in the Name column display in the Calyptia Dashboard. Items in the Key column are the YAML keys to use in pipeline configuration files.

General

Name	Key	Description	Default
Configuration File Location	`config_file_location`	Required. The location of the configuration file containing OCI authentication details. See SDK and CLI Configuration File (opens in a new tab) for steps on generating the configuration file.	`~/.oci/config`
Profile Name	`profile_name`	Required. OCI Config Profile Name to be used from the configuration file.	`DEFAULT`
Namespace	`namespace`	Required. OCI Tenancy Namespace in which the collected log data is to be uploaded.	none
Proxy	`proxy`	Optional. Use to define proxy if required. Must be in the format `http://host:port`. Supports the HTTP protocol only.	none

Advanced

Name	Key	Description	Default
OCI Config in Record	`oci_la_log_group_id`	Optional. If set to `true`, the following `oci_la_*` parameters are read from the record itself instead of the output plugin configuration.	`false`
OCI Log Group ID	`oci_la_log_group_id`	Required. The OCID of the Logging Analytics Log Group where the logs must be stored.	none
OCI Log Source Name	`oci_la_log_source_name`	Required. The Logging Analytics Source that must be used to process the log records.	none
OCI Entity ID	`oci_la_entity_id`	The entity type of the Logging Analytics Entity.	none
OCI Log Path	`oci_la_log_path`	Specify the original location of the log files.	none
OCI Global Metadata	`oci_la_global_metadata`	Use this parameter to specify additional global metadata along with original log content to Logging Analytics. The format is `key value`. This option can be set multiple times.	none
OCI Metadata	`oci_la_metadata`	Use this parameter to specify additional metadata for a log event along with original log content to Logging Analytics. The format is `key value`. This option can be set multiple times.	none

Security and TLS

Name	Key	Description	Default
TLS	`tls`	Enable or disable TLS/SSL support.	none
TLS Certificate Validation	`tls.verify`	Turn TLS/SSL certificate validation on or off. TLS must be on for this setting to be enabled.	`on`
TLS Debug Level	`tls.debug`	Set TLS debug verbosity level. Accepted values: `0` (No debug), `1` (Error), `2` (State change), `3` (Informational), `4` (Verbose).	`1`
CA Certificate File Path	`tls.ca_file`	Absolute path to CA certificate file.	none
Certificate File Path	`tls.crt_file`	Absolute path to certificate file.	none
Private Key File Path	`tls.key_file`	Absolute path to private key file.	none
Private Key Path Password	`tls.key_passwd`	Optional password for `tls.key_file` file.	none
TLS SNI Hostname Extension	`tls.vhost`	Hostname to be used for TLS SNI extension.	none

Advanced Networking

Name	Key	Description	Default
DNS Mode	`net.dns.mode`	Select the primary DNS connection type, which can be `TCP` or `UDP`.	none
DNS Resolver	`net.dns.resolver`	Select the primary DNS connection type, which can be `LEGACY` or `ASYNC`.	none
Prefer IPv4	`net.dns.prefer_ipv4`	Prioritize IPv4 DNS results when trying to establish a connection. Valid values are `true` or `false`.	none
Keepalive	`net.keepalive`	Enable or disable Keepalive support. Valid values are `true` or `false`.	`true`
Keepalive Idle Timeout	`net.keepalive_idle_timeout`	Set maximum time allowed for an idle Keepalive connection.	`30s`
Max Connect Timeout	`net.connect_timeout`	Set maximum time allowed to establish a connection, which includes the TLS handshake.	`10s`
Max Connect Timeout Log Error	`net.connect_timeout_log_error`	On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message. Valid values are `true` or `false`.	`true`
Max Keepalive Recycle	`net.keepalive_max_recycle`	Set maximum number of times a keepalive connection can be used before it is retired.	`2000`
Source Address	`net.source_address`	Specify network address to bind for data traffic.	none

Example

The following YAML configuration defines a Fluent Bit input and an Oracle Log Analytics output.

pipeline:
  inputs:
    - Name: forward
      alias: Fluent_Bit
      port: "5170"
      tls.verify: on
      tls.debug: "1"
      tag: forward.0dd7a9e7-ed46-4c31-bbd3-40e8b607f501
  outputs:
    - Name: oracle_log_analytics
      config_file_location: ~/.oci/config
      profile_name: DEFAULT
      namespace: NAMESPACE
      proxy: http://host:port
      oci_la_log_group_id: log_group_id
      oci_la_log_source_name: REST API
      oci_la_entity_id: entity
      oci_la_entity_type: entity_type
      oci_la_log_path: log_path
      oci_la_global_metadata:
        - key1 value1
      oci_la_metadata:
        - key2 value2
      tls: true
      tls.verify: on
      tls.debug: "1"
      net.keepalive: true
      net.keepalive_idle_timeout: 30s
      net.connect_timeout: 10s
      net.connect_timeout_log_error: true
      net.keepalive_max_recycle: "2000"
      Match_Regex: .{0,}

Observe OpenSearch