logstash-input-oci 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d6c2451fc751fafbdb326bf47a615e2a98fe47f384ccc819f3849829fec9476
+  data.tar.gz: dd01921b08ea39b39cb58430c8849720969d67d4051834eea83f2b6a6ad598aa
+SHA512:
+  metadata.gz: 613b0946472b74351a27fb2207eed0ab2f293cf25ad13aa550449e56f050f79fbbff3ac7a2da0ab1c20bfea826e443ba4c33c61b930fe8a26e3eadc5a065bd3b
+  data.tar.gz: 0c80c285cd530f40d532e17b5c89db2cddf5a1dba4f98f9d8ee3766e212feff9f7ff233b5b046590db0779f7cb5037a01ca372fb9d8f6092392f052da0737b0f

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1
+  First Version

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-input-example
+Example input plugin. This should help bootstrap your effort to write your own input plugin!

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,91 @@
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-input-oci_object_storage.svg)](https://travis-ci.com/logstash-plugins/logstash-input-oci_object_storage)
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically build documentation for this plugin. We provide a template file, index.asciidoc, where you can add documentation. The contents of this file will be converted into html and then placed with other plugin documentation in a [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting config examples, you can use the asciidoc `[source,json]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Development and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone an existing one from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+- Run tests
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+* Edit Logstash Gemfile and add the local plugin path, for example:
+```sh
+gem "logstash-input-oci_object_storage", :path => "/your/local/logstash-input-oci_object_storage"
+```
+
+* Install plugin
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+```
+
+* Run Logstash with your plugin
+```sh
+bin/logstash -e 'input { oci_object_storage { namespace => "your_namespace" bucket_name => "your_bucket_name" config_path => "your_config_path" } }'
+```
+
+At this point, any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same 2.1 method to run your plugin in an installed Logstash by editing its Gemfile and pointing the :path to your local plugin development directory or you can build the gem and install it using:
+
+* Build your plugin gem
+```sh
+gem build logstash-input-oci_object_storage.gemspec
+```
+
+* Install the plugin from the Logstash home
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+```
+
+* Start Logstash and proceed to test the plugin
+
+## Contributing
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the CONTRIBUTING file.
+

data/lib/logstash/inputs/oci_object_storage.rb

@@ -0,0 +1,326 @@
+# frozen_string_literal: true
+
+require 'oci'
+require 'zlib'
+require 'date'
+require 'tmpdir'
+require 'stringio'
+require 'thread/pool'
+require 'stud/interval'
+require 'logstash/namespace'
+require 'logstash/inputs/base'
+
+# The ObjectStorageGetter class is a utility class used by the OciObjectStorage Logstash input
+# plugin to interact with Oracle Cloud Infrastructure (OCI) Object Storage.
+# It provides methods to retrieve, process, and archive files from a specified OCI Object Storage bucket.
+class ObjectStorageGetter
+  attr_reader :sincedb_time
+
+  # Archive an object in the Oracle Cloud Infrastructure (OCI) Object Storage.
+  # The archiving is performed based on the configuration specified in the `@archieve_after_read` attribute
+  # of the `ObjectStorageGetter` class.
+  #
+  # @param object [Object] The object containing metadata information. It represents a file in the OCI Object Storage.
+  def archieve_object(object)
+    return unless @archieve_after_read
+
+    parmeters = {
+      objectName: object.name,
+      storageTier: 'Archive'
+    }
+    @client.update_object_storage_tier(@namespace, @bucket_name, parmeters)
+  end
+
+  # Decodes the data of the given object using gzip decompression if the file has a `.gz` or `.gzip` extension.
+  # If the object's name does not match the pattern for gzip files, the data is returned as-is without decompression.
+  #
+  # @param object [Object] The object containing metadata information. It represents a file in the OCI Object Storage.
+  # @param response [Object] The response object containing the data of the object retrieved from the Object Storage.
+  # @return [String] The decoded data as a String.
+  def decode_gzip_file(object, response)
+    return response.data.to_s unless object.name.match(/gz(ip)?/i)
+
+    buffer = StringIO.new(response.data.to_s)
+    raw = Zlib::GzipReader.new(buffer)
+    raw.read
+  end
+
+  # Process the raw data using the specified Logstash codec and add metadata from the object to each event.
+  # After, includes this event on Logstash Queue.
+  #
+  # @param raw_data [String] The raw data to be processed. It represents the content of a file.
+  # @param object [Object] The object containing metadata information. It represents a file in the OCI Object Storage.
+  def process_data(raw_data, object)
+    meta = JSON.parse object.to_hash.to_json
+    @codec.decode(raw_data) do |event|
+      event.set('[@metadata][oci][object_storage]', meta)
+      @queue << event
+    end
+  end
+
+  # Download and process the data of the given object from the OCI Object Storage bucket.
+  #
+  # @param object [Object] The object containing metadata information. It represents a file in the OCI Object Storage.
+  def download_file(object)
+    response = @client.get_object(
+      @namespace,
+      @bucket_name,
+      object.name
+    )
+    raw_data = decode_gzip_file object, response
+    process_data raw_data, object
+    archieve_object object if @filter_strategy == 'archive'
+  rescue OCI::Errors::ServiceError => e
+    @logger.warn("The file #{object.name} cannot be downloaded: #{e} => #{object.to_hash}")
+  end
+
+  # Check whether the given object should be skipped or processed based on specific conditions.
+  #
+  # @param object [Object] The object containing metadata information. It represents a file in the OCI Object Storage.
+  # @param normalized_time [Time] The normalized time of the object's modification timestamp used for comparison.
+  def skip_file?(object, normalized_time)
+    if ['Archive'].include? object.storage_tier
+      true
+    elsif %w[Restoring Archived].include? object.archival_state
+      true
+    elsif (@sincedb_time > normalized_time) && (@filter_strategy == 'sincedb')
+      true
+    else
+      false
+    end
+  end
+
+  # Download and process filtered files from the OCI Object Storage bucket.
+  # Download and processing of objects are performed concurrently using a thread pool, with the number of threads
+  # specified by the `@threads` attribute of the `ObjectStorageGetter` class.
+  #
+  # @param buffer [Array] An array containing objects to be downloaded and processed. Each object represents a file.
+  def download_filtered_files(buffer)
+    time_buffer = []
+    pool = Thread.pool(@threads)
+    buffer.each do |object|
+      normalized_time = Time.parse(object.time_modified.to_s)
+      next if skip_file? object, normalized_time
+
+      time_buffer << normalized_time
+      @logger.info("Downloading file from #{object.name}")
+      pool.process { download_file object }
+    end
+    pool.shutdown
+    @sincedb_time = time_buffer.max unless time_buffer.empty? && (@filter_strategy == 'sincedb')
+  end
+
+  # Retrieve files from the OCI Object Storage bucket recursively based on specified parameters.
+  #
+  # @param parameters [Hash] A hash containing parameters for the OCI Object Storage API request.
+  # @param buffer [Array] An optional array that accumulates the retrieved objects. Each object represents a file.
+  # @return [Array] An array containing the retrieved objects after the recursive retrieval process.
+  def retrieve_files_recursive(parameters, buffer = [])
+    response = @client.list_objects(@namespace, @bucket_name, parameters)
+    buffer.push(*response.data.objects)
+    if response.data.next_start_with.nil?
+      @logger.debug('Nil pointer received!')
+      return buffer
+    end
+
+    @logger.info("Retriving next page: Last Page: #{@next_start} - Next Page: #{response.data.next_start_with}")
+    @next_start = response.data.next_start_with
+    parameters[:start] = @next_start
+    retrieve_files_recursive(parameters, buffer)
+  end
+
+  # Retrieve files from the OCI Object Storage bucket based on the specified prefix.
+  #
+  # @param prefix [String] An optional parameter to filter files based on that name prefix. Default is an empty string.
+  def retrieve_files(prefix = '')
+    parameters = {
+      prefix: prefix,
+      start: @next_start || '',
+      fields: 'name,timeCreated,timeModified,storageTier,archivalState'
+    }
+    buffer = retrieve_files_recursive parameters
+    download_filtered_files buffer
+  end
+
+  # Initialize a new instance of the ObjectStorageGetter class with the given parameters.
+  #
+  # Parameters:
+  # @param parameters [Hash] A hash containing configuration parameters for the ObjectStorageGetter instance.
+  #   - :queue [LogStash::Util::WrappedSynchronousQueue] The queue to which the processed events will be sent.
+  #   - :codec [Codec] The codec used to decode data from the retrieved objects in the OCI Object Storage bucket.
+  #   - :namespace [String] The OCI Object Storage namespace associated with the bucket.
+  #   - :bucket_name [String] The name of the OCI Object Storage bucket.
+  #   - :credentials [OCI::ConfigFile::Config] The OCI configuration used for authentication.
+  #   - :archieve_after_read [Boolean] A flag indicating whether the retrieved objects should be archived after read.
+  #   - :filter_strategy [String] Strategy used for filtering files during retrieval. Can be `archive` or `sincedb`.
+  #   - :sincedb_time [Time] Last modified timestamp recorded in the sincedb for filtering based on the 'sincedb'.
+  #   - :logger [Logger] Logger instance used to log information, warnings, and errors during the retrieval process.
+  #   - :threads [Integer] The number of threads used for concurrent processing of the retrieved objects.
+  def initialize(parameters)
+    @queue = parameters[:queue]
+    @codec = parameters[:codec]
+    @namespace = parameters[:namespace]
+    @bucket_name = parameters[:bucket_name]
+    @client = OCI::ObjectStorage::ObjectStorageClient.new(config: parameters[:credentials])
+    @archieve_after_read = parameters[:archieve_after_read]
+    @filter_strategy = parameters[:filter_strategy]
+    @sincedb_time = parameters[:sincedb_time] || Time.new(0)
+    @logger = parameters[:logger]
+    @threads = parameters[:threads]
+    @next_start = ''
+  end
+end
+
+# The LogStash module provides a namespace for all Logstash-related functionalities and classes.
+# It encapsulates the components required for data ingestion, processing, and output in the Logstash pipeline.
+# The module contains various submodules and classes that define inputs, filters, codecs, and outputs.
+# These components work together to collect, filter, and transform data from various sources, enabling data
+# ingestion into the Logstash pipeline.
+module LogStash
+  # The LogStash::Inputs module is a submodule of the LogStash module, specifically responsible for handling data
+  # input in the Logstash pipeline. It provides a namespace for all input-related functionalities, including various
+  # input plugins that enable Logstash to collect data from different sources. Each input plugin represents a specific
+  # data source or input type, such as files, databases, HTTP endpoints, message queues, and more.
+  module Inputs
+    # The OciObjectStorage class is a Logstash input plugin that enables Logstash to read data
+    # from Oracle Cloud Infrastructure (OCI) Object Storage.
+    # It periodically fetches files from a specified OCI Object Storage bucket and forwards
+    # the data to the Logstash pipeline for further processing.
+    class OciObjectStorage < LogStash::Inputs::Base
+      config_name 'oci_object_storage'
+
+      # If undefined, Logstash will complain, even if codec is unused.
+      default :codec, 'plain'
+
+      config :namespace, validate: :string, required: true
+      config :bucket_name, validate: :string, required: true
+      config :config_path, validate: :string, required: true
+
+      config :archieve_after_read, validate: :boolean, required: false, default: true
+      config :filter_strategy, validate: :string, required: false, default: 'archive'
+      config :threads, validate: :number, required: false, default: ::LogStash::Config::CpuCoreStrategy.maximum
+      config :interval, validate: :number, default: 30
+      config :sincedb_path, validate: :string, default: nil
+
+      # Get the folder path for the sincedb file used by the OCI Object Storage input plugin in Logstash.
+      #
+      # @return [String] The folder path for the sincedb file specific to the OCI Object Storage input plugin.
+      def sincedb_folder
+        logstash_path = LogStash::SETTINGS.get_value('path.data')
+        dir = File.join(logstash_path, 'plugins', 'inputs', 'oci_object_storage')
+        FileUtils.mkdir_p(dir)
+        dir
+      end
+
+      # Get the full path to the sincedb file for the OCI Object Storage input plugin in Logstash.
+      #
+      # @return [String] The full path to the sincedb file specific to the OCI Object Storage input plugin.
+      def sincedb_file
+        digest = Digest::MD5.hexdigest("#{@namespace}+#{@bucket_name}+#{@prefix}")
+        path = File.join(sincedb_folder, "sincedb_#{digest}")
+        if ENV['HOME']
+          old = File.join(ENV['HOME'], ".sincedb_#{digest}")
+          if File.exist?(old)
+            logger.info('Migrating old sincedb in $HOME to {path.data}')
+            FileUtils.mv(old, path)
+          end
+        end
+        path
+      end
+
+      # The register method is a lifecycle method in the OCIObjectStorage input plugin for Logstash.
+      # It is called once during the plugin initialization phase and is responsible for setting up sincedb
+      # functionality when the 'sincedb' filter strategy is enabled.
+      def register
+        return unless filter_strategy == 'sincedb'
+
+        if @sincedb_path.nil?
+          @logger.info('Using default generated file for the sincedb', filename: sincedb_file)
+          @sincedb = SinceDB::File.new(sincedb_file)
+        else
+          @logger.info('Using the provided sincedb_path', sincedb_path: @sincedb_path)
+          @sincedb = SinceDB::File.new(@sincedb_path)
+        end
+
+        @sincedb_time = @sincedb.read
+      end
+
+      # The run method is a lifecycle method in the OCIObjectStorage input plugin for Logstash.
+      # It is responsible for the main execution of the OCIObjectStorage input plugin and the retrieval and
+      # processing of files from the OCI Object Storage bucket.
+      #
+      # @param queue [LogStash::Util::WrappedSynchronousQueue] The queue to which the processed events will be sent.
+      def run(queue)
+        @logger.info("Loading config file: #{@config_path}")
+        parameters = {
+          namespace: @namespace,
+          bucket_name: @bucket_name,
+          credentials: OCI::ConfigFileLoader.load_config(config_file_location: @config_path),
+          queue: queue,
+          codec: @codec,
+          archieve_after_read: @archieve_after_read,
+          filter_strategy: @filter_strategy,
+          sincedb_time: @sincedb_time,
+          threads: @threads,
+          logger: @logger
+        }
+        @client = ObjectStorageGetter.new(parameters)
+        until stop?
+          @client.retrieve_files
+          @sincedb.write(@client.sincedb_time) if filter_strategy == 'sincedb'
+          Stud.stoppable_sleep(@interval) { stop? }
+        end
+      end
+
+      # The stop method is a lifecycle method in the OCIObjectStorage input plugin for Logstash.
+      # It is responsible for stopping the execution of the OCIObjectStorage input plugin and performing
+      # any necessary cleanup tasks before exiting.
+      #
+      # @return [Boolean] Always returns true to signal that the Logstash pipeline should be stopped.
+      def stop
+        @sincedb.write(@client.sincedb_time) if filter_strategy == 'sincedb'
+        true
+      end
+    end
+  end
+end
+
+# The SinceDB module provides a namespace for classes related to managing since database (sincedb) functionality.
+# The sincedb is a feature used to keep track of the progress in reading and processing files, ensuring that
+# Logstash resumes where it left off in case of interruptions or restarts. The module contains classes and methods
+# that handle reading and writing sincedb files, storing information about the last processed position in a file,
+# and updating it as new data is ingested.
+module SinceDB
+  # The SinceDB::File class represents a sincedb file used to track the progress of reading and processing files
+  # in Logstash. It provides methods to read and write sincedb information, which helps to maintain data integrity
+  # and support incremental data processing for file-based data sources in Logstash.
+  class File
+    # Constructor method to initialize a new instance of SinceDB::File.
+    #
+    # @param file [String] The path to the sincedb file to be managed by this instance.
+    def initialize(file)
+      @sincedb_path = file
+    end
+
+    # Read the sincedb file and return the last processed timestamp as a Time object.
+    #
+    # @return [Time] The last processed timestamp recorded in the sincedb file, represented as a Time object.
+    def read
+      if ::File.exist?(@sincedb_path)
+        content = ::File.read(@sincedb_path).chomp.strip
+        # If the file was created but we didn't have the time to write to it
+        content.empty? ? Time.new(0) : Time.parse(content)
+      else
+        Time.new(0)
+      end
+    end
+
+    # Write the provided timestamp to the sincedb file.
+    #
+    # @param since [Time] An optional parameter representing the timestamp. If not provided, Time.now is used.
+    def write(since = nil)
+      since = Time.now if since.nil?
+      ::File.open(@sincedb_path, 'w') { |file| file.write(since.to_s) }
+    end
+  end
+end

data/logstash-input-oci.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-input-oci'
+  s.version = '0.1.0'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "Collection of Logstash plugins that integrate with OCI."
+  s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
+  s.authors = ["Kalingth"]
+  s.email = 'wallace.faria@kalingth.com.br'
+  s.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'oci', '~> 2.18'
+  s.add_runtime_dependency 'thread', '>= 0.2.0'
+  s.add_runtime_dependency 'stud', '>= 0.0.22'
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/inputs/oci_object_storage.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/devutils/rspec/shared_examples"
+require "logstash/inputs/oci_object_storage"
+
+describe LogStash::Inputs::OciObjectStorage do
+
+  it_behaves_like "an interruptible input plugin" do
+    let(:config) { { "interval" => 100 } }
+  end
+
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-oci
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kalingth
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oci
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+- !ruby/object:Gem::Dependency
+  name: thread
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: stud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a Logstash plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
+  gem is not a stand-alone program
+email: wallace.faria@kalingth.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/inputs/oci_object_storage.rb
+- logstash-input-oci.gemspec
+- spec/inputs/oci_object_storage.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Collection of Logstash plugins that integrate with OCI.
+test_files:
+- spec/inputs/oci_object_storage.rb