From 5f709c4c9f60dca22cfb8d510ab2e9b71aadf8db Mon Sep 17 00:00:00 2001
From: SujathaRamanMindera
<50447940+SujathaRamanMindera@users.noreply.github.com>
Date: Wed, 26 Jun 2019 10:26:48 +0530
Subject: [PATCH 1/2] Update 'host' and 'port' in README.md
Update of default values for the 'host' and 'port' parameters in the 'Global configuration' table.
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 8f02db4..f74f1c4 100644
--- a/README.md
+++ b/README.md
@@ -301,8 +301,8 @@ The custom options that can be set on config param are detailed below.
| _namespace_ | Defines the global namespace. | `String` | `application` | **NO** |
| _sampleRate_ | Defines the rate sampling. **Should be a number between [1, 100]**. | `int` | `100` | **NO** |
| _tags_ | Defines a list global tags. | `String`, `String` pairs | Empty list of tags | **NO** |
-| _host_ | Defines the host name to where the metrics should be sent. | `String` | `127.0.0.1` | **NO** |
-| _port_ | Defines the port. | `int` | `2013` | **NO** |
+| _host_ | Defines the host name to where the metrics should be sent. | `String` | `api.statful.com` | **NO** |
+| _port_ | Defines the port. | `int` | `443` | **NO** |
| _token_ | Defines the authentication token to be used. | `String` | **none** | **NO** |
| _timeout_ | Defines the timeout for the transport layers in **miliseconds**. Must be set inside _api_. | `long` | `2000` | **NO** |
| _secure_ | Enable or disables HTTPS. | `boolean` | `true` | **NO** |
From 34869557c60da2b8a1b17bf934e9f7e6e1a5a750 Mon Sep 17 00:00:00 2001
From: SujathaRamanMindera
<50447940+SujathaRamanMindera@users.noreply.github.com>
Date: Mon, 1 Jul 2019 12:28:00 +0530
Subject: [PATCH 2/2] Inclusion of review comments
Explanation on when to use UDP configuration.
---
README.md | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index f74f1c4..56517a5 100644
--- a/README.md
+++ b/README.md
@@ -24,21 +24,22 @@ Statful client for Java. This client is intended to gather metrics and send them
## Configuration
-Add one of the following snippets to your POM.xml file.
+Add one of the below configuration snippets (either HTTP or UDP Client), as applicable, to your POM.xml file.
+The UDP configuration should be used when the RELAY component in the Client Architecture serves as the gateway to Statful API.
-### Configuration for UDP client
+### Configuration for HTTP client
com.statful.client
- udp-client
+ http-client
${statful-client.version}
-
-### Configuration for HTTP client
+
+### Configuration for UDP client
com.statful.client
- http-client
+ udp-client
${statful-client.version}
@@ -296,7 +297,7 @@ The custom options that can be set on config param are detailed below.
|:---|:---|:---|:---|:---|
| _app_ | Defines the application global name. If specified sets a global tag `app=setValue`. | `String` | **none** | **NO** |
| _dryRun_ | Defines if metrics should be output to the logger instead of being sent. Log level is _DEBUG_. | `boolean` | `false` | **NO** |
-| _flushInterval_ | Defines the periodicity of buffer flushes in **miliseconds**. | `int` | `3000` | **NO** |
+| _flushInterval_ | Defines the periodicity of buffer flushes in **milliseconds**. | `int` | `3000` | **NO** |
| _flushSize_ | Defines the maximum buffer size before performing a flush. | `int` | `1000` | **NO** |
| _namespace_ | Defines the global namespace. | `String` | `application` | **NO** |
| _sampleRate_ | Defines the rate sampling. **Should be a number between [1, 100]**. | `int` | `100` | **NO** |
@@ -304,7 +305,7 @@ The custom options that can be set on config param are detailed below.
| _host_ | Defines the host name to where the metrics should be sent. | `String` | `api.statful.com` | **NO** |
| _port_ | Defines the port. | `int` | `443` | **NO** |
| _token_ | Defines the authentication token to be used. | `String` | **none** | **NO** |
-| _timeout_ | Defines the timeout for the transport layers in **miliseconds**. Must be set inside _api_. | `long` | `2000` | **NO** |
+| _timeout_ | Defines the timeout for the transport layers in **milliseconds**.| `long` | `2000` | **NO** |
| _secure_ | Enable or disables HTTPS. | `boolean` | `true` | **NO** |
| _connectTimeout_ | Connection timeout for http/tcp transports in **milliseconds**. | `long` | `500` | **NO** |
| _connectionPoolSize_ | Connection pool size. | `int` | `10` | **NO** |