Merge pull request #52 from logzio/in_memory_support

In memory support

README.md

@@ -5,14 +5,14 @@
 This appender sends logs to your [Logz.io](http://logz.io) account, using non-blocking threading, bulks, and HTTPS encryption. Please note that this appendr requires logback version 1.1.7 and up, and java 8 and up.
 
 ### Technical Information
-This appender uses [LogzioSender](https://github.com/logzio/logzio-java-sender) implementation. All logs are backed up to a local file system before being sent. Once you send a log, it will be enqueued in the buffer and 100% non-blocking. There is a background task that will handle the log shipment for you. This jar is an "Uber-Jar" that shades both BigQueue, Gson and Guava to avoid "dependency hell".
+This appender uses [LogzioSender](https://github.com/logzio/logzio-java-sender) implementation. All logs are backed up to a local file system before being sent. Once you send a log, it will be enqueued in the queue and 100% non-blocking. There is a background task that will handle the log shipment for you. This jar is an "Uber-Jar" that shades both BigQueue, Gson and Guava to avoid "dependency hell".
 
 ### Installation from maven
 ```xml
 <dependency>
     <groupId>io.logz.logback</groupId>
     <artifactId>logzio-logback-appender</artifactId>
-    <version>1.0.19</version>
+    <version>1.0.21</version>
 </dependency>
 ```
 
@@ -40,9 +40,7 @@ This appender uses [LogzioSender](https://github.com/logzio/logzio-java-sender)
 | **token**              | *None*                                 | Your Logz.io token, which can be found under "settings" in your account, If the value begins with `$` then the appender looks for an environment variable or system property with the name specified. For example: `$LOGZIO_TOKEN` will look for environment variable named `LOGZIO_TOKEN` |
 | **logzioType**               | *java*                                 | The [log type](http://support.logz.io/support/solutions/articles/6000103063-what-is-type-) for that appender, it must not contain spaces |
 | **logzioUrl**               | *https://listener.logz.io:8071*                                 | The url that the appender sends to.  If your account is in the EU you must use https://listener-eu.logz.io:8071 |
-| **drainTimeoutSec**       | *5*                                    | How often the appender should drain the buffer (in seconds) |
-| **fileSystemFullPercentThreshold** | *98*                                   | The percent of used file system space at which the appender will stop buffering. When we will reach that percentage, the file system in which the buffer rests will drop all new logs until the percentage of used space drops below that threshold. Set to -1 to never stop processing new logs |
-| **bufferDir**          | *System.getProperty("java.io.tmpdir")* | Where the appender should store the buffer |
+| **drainTimeoutSec**       | *5*                                    | How often the appender should drain the queue (in seconds) |
 | **socketTimeout**       | *10 * 1000*                                    | The socket timeout during log shipment |
 | **connectTimeout**       | *10 * 1000*                                    | The connection timeout during log shipment |
 | **addHostname**       | *false*                                    | Optional. If true, then a field named 'hostname' will be added holding the host name of the machine. If from some reason there's no defined hostname, this field won't be added |
@@ -52,6 +50,23 @@ This appender uses [LogzioSender](https://github.com/logzio/logzio-java-sender)
 | **compressRequests**       | *false*                                    | Boolean. `true` if logs are compressed in gzip format before sending. `false` if logs are sent uncompressed. |
 | **format** | *text*  | Optional. `json` if the logged message is to be parsed as a JSON (in such a way that each JSON node will be a field in logz.io) or `text` if the logged message is to be treated as plain text.
 
+#### Parameters for in-memory queue
+| Parameter          | Default                              | Explained  |
+| ------------------ | ------------------------------------ | ----- |
+| **inMemoryQueueCapacityBytes**       | *1024 * 1024 * 100*                                | The amount of memory(bytes) we are allowed to use for the memory queue. If the value is -1 the sender will not limit the queue size.|
+| **inMemoryLogsCountLimit**       | *-1*                                | Number of logs we are allowed to have in the queue before dropping logs. If the value is -1 the sender will not limit the number of logs allowed.|
+| **inMemoryQueue**       | *false*                                | Set to true if the appender uses in memory queue. By default the appender uses disk queue|
+
+
+#### Parameters for disk queue
+| Parameter          | Default                              | Explained  |
+| ------------------ | ------------------------------------ | ----- |
+| **fileSystemFullPercentThreshold** | *98*                                   | The percent of used file system space at which the sender will stop queueing. When we will reach that percentage, the file system in which the queue is stored will drop all new logs until the percentage of used space drops below that threshold. Set to -1 to never stop processing new logs |
+| **gcPersistedQueueFilesIntervalSeconds**       | *30*                                    | How often the disk queue should clean sent logs from disk |
+| **bufferDir**(deprecated, use queueDir)          | *System.getProperty("java.io.tmpdir")* | Where the appender should store the queue |
+| **queueDir**          | *System.getProperty("java.io.tmpdir")* | Where the appender should store the queue |
+
+
 ### Code Example
 ```java
 import org.slf4j.Logger;
@@ -123,7 +138,10 @@ Will send a log to Logz.io that looks like this:
 ```
 
 ### Release notes
- - 1.0.19: added json message format support
+ - 1.0.21
+   - added in memory queue support
+ - 1.0.19: 
+   - added json message format support
  - 1.0.18
    - added `compressRequests` parameter to enable gzip compression of the logs before they are sent.
    - added option to inject system property value into additionalFields, logzioUrl and token.

pom.xml

@@ -36,7 +36,7 @@
     </scm>
 
     <properties>
-        <logzio-sender-version>1.0.10</logzio-sender-version>
+        <logzio-sender-version>1.0.18</logzio-sender-version>
     </properties>
 
     <build>
@@ -181,5 +181,11 @@
             <version>9.3.9.M1</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>net.logstash.logback</groupId>
+            <artifactId>logstash-logback-encoder</artifactId>
+            <version>5.2</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>