release v2.0.1 (#1)

* release v2.0.1

* release v2.0.1

Author: KiranNadupuru

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change Log
+
+## 2.0.1 - 2022-02-15
+### Added
+- Added required ruby version in gemspec.
+- Added spec metadata (Documentation, Source code and Change log) details.
+- Added README.md.
+- Added CHANGELOG.md.
+- Added examples folder with sample config files for reference.
+### Changed
+- Optimized import of OCI modules to improve load times and memory usage.
+
+## 2.0.0 - 2022-01-17
+### Added
+- Initial Release.

Gemfile

@@ -0,0 +1,7 @@
+## Copyright (c) 2021, 2022  Oracle and/or its affiliates.
+## The Universal Permissive License (UPL), Version 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+source "https://rubygems.org"
+
+gemspec
+

LICENSE.txt

@@ -0,0 +1,36 @@
+Copyright (c) 2021, 2022  Oracle and/or its affiliates.
+
+The Universal Permissive License (UPL), Version 1.0
+
+Subject to the condition set forth below, permission is hereby granted to any
+person obtaining a copy of this software, associated documentation and/or data
+(collectively the "Software"), free of charge and under any and all copyright
+rights in the Software, and any and all patent rights owned or freely
+licensable by each licensor hereunder covering either (i) the unmodified
+Software as contributed to or provided by such licensor, or (ii) the Larger
+Works (as defined below), to deal in both
+
+(a) the Software, and
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+one is included with the Software (each a "Larger Work" to which the Software
+is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create
+derivative works of, display, perform, and distribute the Software and make,
+use, sell, offer for sale, import, export, have made, and have sold the
+Software and the Larger Work(s), and to sublicense the foregoing rights on
+either these or other terms.
+
+This license is subject to the following condition:
+
+The above copyright notice and either this complete permission notice or at
+a minimum a reference to the UPL must be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,100 @@
-# oci-logan-fluentd-output-plugin
+# OCI Logging Analytics Output Plugin
+
+
+## Overview
+
+OCI Logging Analytics Fluentd output plugin collects event logs, buffer into local file system, periodically creates payload and uploads it to OCI Logging Analytics.
+
+## Installation Instructions
+
+### Prerequisites
+
+Refer [Prerequisites](https://docs.oracle.com/en/learn/oci_logging_analytics_fluentd/#prerequisites)
+
+### Requirements
+
+<table>
+  <tr>
+    <th>fluent-plugin-oci-logging-analytics</th>
+    <th>fluentd</th>
+    <th>ruby</th>
+    <th>rubyzip</th>
+    <th>oci</th>
+  </tr>
+  <tr>
+    <td>>= 2.0.0</td>
+    <td>>= 0.14.10, < 2 </td>
+    <td>>= 2.6</td>
+    <td>~> 2.3.2 </td>
+    <td>~> 2.13</td>
+  </tr>
+</table>
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-oci-logging-analytics'
+   
+And then execute:
+
+    $ bundle
+   
+Or install it manually as:
+
+    $ gem install fluent-plugin-oci-logging-analytics --no-document
+    # If you need to install specific version, use -v option
+   
+
+## Configuration
+ 
+### Output Plugin Configuration
+
+   - [Output plugin configuration template](https://docs.oracle.com/en/learn/oci_logging_analytics_fluentd/#create-the-fluentd-configuration-file)
+
+   - [Output plugin configuration parameters](https://docs.oracle.com/en/learn/oci_logging_analytics_fluentd/#output-plugin-configuration-parameters)
+
+### Buffer Configuration
+
+   - [Buffer configuration parameters](https://docs.oracle.com/en/learn/oci_logging_analytics_fluentd/#buffer-configuration-parameters)
+
+### Input Plugin Configuration 
+
+The incoming log events must be in a specific format so that the Fluentd plugin provided by Oracle can process the log data, chunk them, and transfer them to OCI Logging Analytics.
+ 
+   - [Verify the format of the incoming log events](https://docs.oracle.com/en/learn/oci_logging_analytics_fluentd/#verify-the-format-of-the-incoming-log-events)
+   
+   - [Source configuration](https://docs.oracle.com/en/learn/oci_logging_analytics_fluentd/#source--input-plugin-configuration)
+
+### Filter Configuration
+
+Use filter plugin (record_transformer) to transform the input log events to add OCI Logging Analytics specific fields/metadata.
+
+   - [Filter configuration](https://docs.oracle.com/en/learn/oci_logging_analytics_fluentd/#filter-configuration)
+
+
+## Examples
+
+   - Example configuration that can be used for monitoring [syslog log](examples/syslog.conf)
+
+   - Example configuration that can be used for monitoring [apache error log](examples/apache.conf)
+
+   - Example configuration that can be used for monitoring [kafka log](examples/kafka.conf)
+
+
+
+## Start Viewing the Logs in Logging Analytics
+
+Refer [Viewing the Logs in Logging Analytics](https://docs.oracle.com/en/learn/oci_logging_analytics_fluentd/#start-viewing-the-logs-in-logging-analytics)
+
+
+## Changes
+
+See [CHANGELOG](CHANGELOG.md).
+
+## License
+
+Copyright (c) 2021, 2022  Oracle and/or its affiliates.
+
+See [LICENSE](LICENSE.txt) for more details.
+