fluent-plugin-oci-logging-analytics 2.0.7 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b41804c02cd5e1dd39efc4c600f043cbed2a90972aabc39671c830fedcafe67
-  data.tar.gz: 24fc404d3f0f4d06f2e9f2167d7bc4fff337a235f9671e7e024ce71763750cb8
+  metadata.gz: fd5776c0bd11f46ba2366daaef22deeae726369f8f96071de570bb49ae6518bc
+  data.tar.gz: cd579f95bb5ca0fb80eaac9545f2b4658fed580dff45e3d6d7daa7fdb004eb94
 SHA512:
-  metadata.gz: a779a1971cabf78edf2c0b14ae6ba06235ce4113fe0ded3b264d626baba6c7f82f3aabdcb029890cb52697b2b01ae119691c7412e7920c79ada71ce8ed060fff
-  data.tar.gz: ef679bc249d8d16bc12a447f158c19faea8425c98170aecfbd7053da7d4081876f2b830f7c59dcef50e4abb9422d8e2cac30e91c16bffc4cf8e33072f931fe9c
+  metadata.gz: 3faf9d1372e1da861d7b3f5e32dc82b401379ffece838003cf5862ea380c52d6ed3d13b053470dc11bdbba18382fed71699188a832bf002635854c9f7ef47297
+  data.tar.gz: ba6c3e00de0cdf9843fc965249a1db4896b5a36632b5b6fa4a998f191ecd8247e9690aff5cde5379cb532418e94370ae8c4146f57c395d7435839b7f774cd28f

data/lib/fluent/dto/logEvents.rb

@@ -21,5 +21,4 @@ class LogEvents
       timezone:@timezone
     }.compact
   end
-
 end

data/lib/fluent/dto/logEventsJson.rb

@@ -20,5 +20,4 @@ class LogEventsJson
       end
     }.compact
   end
-
 end

data/lib/fluent/metrics/prometheusMetrics.rb

@@ -17,15 +17,15 @@ class PrometheusMetrics
   end
   def createMetrics
     gauge = Prometheus::Client::Gauge
-    @records_received = gauge.new(:oci_la_fluentd_output_plugin_records_received, docstring: 'Number of records received by the OCI Logging Analytics Fluentd output plugin.', labels: [:worker_id,:tag,:oci_la_log_group_id,:oci_la_log_source_name,:oci_la_log_set])
-    @records_valid = gauge.new(:oci_la_fluentd_output_plugin_records_valid, docstring: 'Number of valid records received by the OCI Logging Analytics Fluentd output plugin.', labels: [:worker_id,:tag,:oci_la_log_group_id,:oci_la_log_source_name,:oci_la_log_set])
-    @records_invalid = gauge.new(:oci_la_fluentd_output_plugin_records_invalid, docstring: 'Number of invalid records received by the OCI Logging Analytics Fluentd output plugin.', labels: [:worker_id,:tag,:oci_la_log_group_id,:oci_la_log_source_name,:oci_la_log_set,:reason])
-    @records_error = gauge.new(:oci_la_fluentd_output_plugin_records_post_error, docstring: 'Number of records failed posting to OCI Logging Analytics by the Fluentd output plugin.', labels: [:worker_id,:tag,:oci_la_log_group_id,:oci_la_log_source_name,:oci_la_log_set,:error_code, :reason])
-    @records_posted = gauge.new(:oci_la_fluentd_output_plugin_records_post_success, docstring: 'Number of records posted by the OCI Logging Analytics Fluentd output plugin.', labels: [:worker_id,:tag,:oci_la_log_group_id,:oci_la_log_source_name,:oci_la_log_set])
+    @records_received = gauge.new(:oci_la_fluentd_output_plugin_records_received, docstring: 'Number of records received by the OCI Log Analytics Fluentd output plugin.', labels: [:worker_id,:tag,:oci_la_log_group_id,:oci_la_log_source_name,:oci_la_log_set])
+    @records_valid = gauge.new(:oci_la_fluentd_output_plugin_records_valid, docstring: 'Number of valid records received by the OCI Log Analytics Fluentd output plugin.', labels: [:worker_id,:tag,:oci_la_log_group_id,:oci_la_log_source_name,:oci_la_log_set])
+    @records_invalid = gauge.new(:oci_la_fluentd_output_plugin_records_invalid, docstring: 'Number of invalid records received by the OCI Log Analytics Fluentd output plugin.', labels: [:worker_id,:tag,:oci_la_log_group_id,:oci_la_log_source_name,:oci_la_log_set,:reason])
+    @records_error = gauge.new(:oci_la_fluentd_output_plugin_records_post_error, docstring: 'Number of records failed posting to OCI Log Analytics by the Fluentd output plugin.', labels: [:worker_id,:tag,:oci_la_log_group_id,:oci_la_log_source_name,:oci_la_log_set,:error_code, :reason])
+    @records_posted = gauge.new(:oci_la_fluentd_output_plugin_records_post_success, docstring: 'Number of records posted by the OCI Log Analytics Fluentd output plugin.', labels: [:worker_id,:tag,:oci_la_log_group_id,:oci_la_log_source_name,:oci_la_log_set])
 
     histogram = Prometheus::Client::Histogram
-    @chunk_time_to_receive = histogram.new(:oci_la_fluentd_output_plugin_chunk_time_to_receive, docstring: 'Average time taken by Fluentd to deliver the collected records from Input plugin to OCI Logging Analytics output plugin.', labels: [:worker_id,:tag])
-    @chunk_time_to_upload = histogram.new(:oci_la_fluentd_output_plugin_chunk_time_to_post, docstring: 'Average time taken for posting the received records to OCI Logging Analytics by the Fluentd output plugin.', labels: [:worker_id,:oci_la_log_group_id])
+    @chunk_time_to_receive = histogram.new(:oci_la_fluentd_output_plugin_chunk_time_to_receive, docstring: 'Average time taken by Fluentd to deliver the collected records from Input plugin to OCI Log Analytics output plugin.', labels: [:worker_id,:tag])
+    @chunk_time_to_upload = histogram.new(:oci_la_fluentd_output_plugin_chunk_time_to_post, docstring: 'Average time taken for posting the received records to OCI Log Analytics by the Fluentd output plugin.', labels: [:worker_id,:oci_la_log_group_id])
   end
 
   def registerMetrics

data/lib/fluent/plugin/out_oci-logging-analytics.rb

@@ -92,6 +92,8 @@ module Fluent::Plugin
     config_param :endpoint,                    :string, :default => nil
     desc 'AuthType to be used.'
     config_param :auth_type,                    :string, :default => 'InstancePrincipal'
+    desc 'OCI Domain'
+    config_param :oci_domain,                    :string, :default => nil
     desc 'Enable local payload dump.'
     config_param :dump_zip_file,                    :bool, :default => false
     desc 'Payload zip File Location.'
@@ -241,7 +243,7 @@ module Fluent::Plugin
       rescue => ex
         @@logger = log
         @@logger.error {"Error while initializing logger:#{ex.inspect}"}
-        @@logger.info {"Redirecting oci logging analytics logs to STDOUT"}
+        @@logger.info {"Redirecting oci log analytics logs to STDOUT"}
       end
     end
 
@@ -249,34 +251,91 @@ module Fluent::Plugin
         if is_valid(@config_file_location)
             @auth_type = "ConfigFile"
         end
+
         case @auth_type
-          when "InstancePrincipal"
+        when "InstancePrincipal"
+          instance_principals_signer = nil
+          la_endpoint = nil
+          if is_valid(@oci_domain)
+            fedration_endpoint = "https://auth.#{@oci_domain}/v1/x509"
+            instance_principals_signer = OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner.new(
+              federation_endpoint: fedration_endpoint)
+            @@logger.info "Custom Federation Endpoint: #{fedration_endpoint}"
+          else
             instance_principals_signer = OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner.new
-            if is_valid(@endpoint)
-              @@loganalytics_client = OCI::LogAnalytics::LogAnalyticsClient.new(config: OCI::Config.new, endpoint: @endpoint, signer: instance_principals_signer)
-              @@logger.info {"loganalytics_client initialised with endpoint: #{@endpoint}"}
-            else
-              @@loganalytics_client = OCI::LogAnalytics::LogAnalyticsClient.new(config: OCI::Config.new, signer: instance_principals_signer)
-            end
-          when "WorkloadIdentity"
-            workload_identity_signer = OCI::Auth::Signers::oke_workload_resource_principal_signer
-            if is_valid(@endpoint)
-              @@loganalytics_client = OCI::LogAnalytics::LogAnalyticsClient.new(config: OCI::Config.new, endpoint: @endpoint, signer: workload_identity_signer)
-              @@logger.info {"loganalytics_client initialised with endpoint: #{@endpoint}"}
-            else
-              @@loganalytics_client = OCI::LogAnalytics::LogAnalyticsClient.new(config: OCI::Config.new, signer: workload_identity_signer)
-            end
-          when "ConfigFile"
-            my_config = OCI::ConfigFileLoader.load_config(config_file_location: @config_file_location, profile_name: @profile_name)
-            if is_valid(@endpoint)
-              @@loganalytics_client = OCI::LogAnalytics::LogAnalyticsClient.new(config: my_config, endpoint: @endpoint)
-              @@logger.info {"loganalytics_client initialised with endpoint: #{@endpoint}"}
-            else
-              @@loganalytics_client = OCI::LogAnalytics::LogAnalyticsClient.new(config:my_config)
+          end
+          if is_valid(@endpoint)
+            la_endpoint = @endpoint
+            @@logger.info "Initializing loganalytics_client with endpoint: #{la_endpoint}"
+          elsif is_valid(@oci_domain)
+            la_endpoint = "https://loganalytics.#{@oci_domain}"
+            @@logger.info "Initializing loganalytics_client with custom domain endpoint: #{la_endpoint}"
+          end
+          @@loganalytics_client = OCI::LogAnalytics::LogAnalyticsClient.new(
+            config: OCI::Config.new,
+            endpoint: la_endpoint,
+            signer: instance_principals_signer)
+          @@logger.info 'loganalytics_client initialized.'
+        when "WorkloadIdentity"
+          workload_identity_signer = OCI::Auth::Signers.oke_workload_resource_principal_signer
+          region = nil
+          config = OCI::Config.new
+
+          if is_valid(@oci_domain)
+            region_match = @oci_domain.match(/^([^.]+)\.oci\./)
+            region = region_match[1]
+            @@logger.info "Extracted region from oci_domain: #{region}"
+          else
+            begin
+              tmp_signer = OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner.new
+              if tmp_signer.region
+                region = tmp_signer.region
+                @@logger.info "Extracted region from IMDS: #{region}"
+              else
+                raise Fluent::ConfigError, "IMDS returned nil region. " \
+                    "Please provide 'oci_domain' parameter (e.g., us-ashburn-1.oci.oraclecloud.com)."
+              end
+            rescue Fluent::ConfigError
+              raise
+            rescue => e
+              raise Fluent::ConfigError, "Unable to determine region. " \
+              "IMDS not available: #{e.message}. " \
+              "Please provide 'oci_domain' parameter (e.g., us-ashburn-1.oci.oraclecloud.com)."
             end
+          end
+          if is_valid(@endpoint)
+            la_endpoint = @endpoint
+            @@logger.info "Using custom endpoint"
+          elsif is_valid(@oci_domain)
+            la_endpoint = "https://loganalytics.#{@oci_domain}"
+            @@logger.info "Using oci_domain endpoint"
           else
-            raise Fluent::ConfigError, "Invalid authType @auth_type, authType must be either InstancePrincipal or ConfigFile."
-            abort
+            la_endpoint = nil
+            @@logger.info "Using SDK default endpoint"
+          end
+          config.region = region
+
+          @@loganalytics_client = OCI::LogAnalytics::LogAnalyticsClient.new(
+            config: config,
+            endpoint: la_endpoint,
+            signer: workload_identity_signer)
+          @@logger.info 'loganalytics_client initialized with WorkloadIdentity.'
+        when "ConfigFile"
+          my_config = OCI::ConfigFileLoader.load_config(
+            config_file_location: @config_file_location,
+            profile_name: @profile_name)
+          la_endpoint = nil
+          if is_valid(@endpoint)
+            la_endpoint = @endpoint
+            @@logger.info "Initializing loganalytics_client with endpoint: #{la_endpoint}"
+          elsif is_valid(@oci_domain)
+            la_endpoint = "https://loganalytics.#{@oci_domain}"
+            @@logger.info "Initializing loganalytics_client with custom domain endpoint: #{la_endpoint}"
+          end
+          @@loganalytics_client = OCI::LogAnalytics::LogAnalyticsClient.new(config: my_config, endpoint: la_endpoint)
+          @@logger.info 'loganalytics_client initialised'
+        else
+          raise Fluent::ConfigError, "Invalid authType: #{@auth_type}, valid inputs are -  InstancePrincipal, ConfigFile, WorkloadIdentity"
         end
 
         if is_valid(@proxy_ip) && is_number(@proxy_port)
@@ -288,13 +347,19 @@ module Fluent::Plugin
         end
 
         rescue => ex
-                @@logger.error {"Error occurred while initializing LogAnalytics Client:
-                                  authType: #{@auth_type},
-                                  errorMessage: #{ex}"}
+          @@logger.error {"Error occurred while initializing LogAnalytics Client:
+                              authType: #{@auth_type},
+                              errorMessage: #{ex}"}
     end
 
     def configure(conf)
       super
+
+      if is_valid(@oci_domain) && !@oci_domain.match(/^[a-z0-9-]+\.oci\.[a-z0-9.]+[a-z0-9]$/i)
+        raise Fluent::ConfigError, "Invalid oci_domain: #{@oci_domain}, " \
+            "valid format: <region>.oci.<domain> (e.g., us-ashburn-1.oci.oraclecloud.com)"
+      end
+
       @@prometheusMetrics = PrometheusMetrics.instance
       initialize_logger
 

data/lib/fluent/version/version.rb

@@ -1,8 +1,8 @@
-## Copyright (c) 2024  Oracle and/or its affiliates.
+## Copyright (c) 2021, 2024  Oracle and/or its affiliates.
 ## The Universal Permissive License (UPL), Version 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 # frozen_string_literal: true
 
 module Version
-  VERSION = "2.0.7".freeze
+  VERSION = "2.1.0".freeze
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-oci-logging-analytics
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.1.0
 platform: ruby
 authors:
 - Oracle
 - 'OCI Observability: Logging Analytics'
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2026-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -121,8 +121,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.3
-description: OCI Logging Analytics Fluentd output plugin for ingesting the collected
-  log events to OCI Logging Analytics.
+description: Fluentd output plugin for ingesting the collected log events to OCI Log
+  Analytics (previously known as OCI Logging Analytics).
 email:
 - oci_la_plugins_grp@oracle.com
 executables: []
@@ -136,14 +136,14 @@ files:
 - lib/fluent/metrics/prometheusMetrics.rb
 - lib/fluent/plugin/out_oci-logging-analytics.rb
 - lib/fluent/version/version.rb
-homepage: 
+homepage:
 licenses:
 - UPL-1.0
 metadata:
   documentation_uri: https://docs.oracle.com/en/learn/oci_logging_analytics_fluentd/
   source_code_uri: https://github.com/oracle-quickstart/oci-logan-fluentd-output-plugin
   changelog_uri: https://github.com/oracle-quickstart/oci-logan-fluentd-output-plugin/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,8 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
-summary: Fluentd output plugin for OCI Logging Analytics.
+summary: Fluentd output plugin for OCI Log Analytics.
 test_files: []