Skip to content

Update 'host' and 'port' in README.md #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SujathaRamanMindera wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update 'host' and 'port' in README.md #32

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f709c4
Update 'host' and 'port' in README.md
SujathaRamanMindera Jun 26, 2019
3486955
Inclusion of review comments
SujathaRamanMindera Jul 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<dependency>
<groupId>com.statful.client</groupId>
<artifactId>udp-client</artifactId>
<artifactId>http-client</artifactId>
<version>${statful-client.version}</version>
</dependency>

### Configuration for HTTP client
### Configuration for UDP client

<dependency>
<groupId>com.statful.client</groupId>
<artifactId>http-client</artifactId>
<artifactId>udp-client</artifactId>
<version>${statful-client.version}</version>
</dependency>

Expand Down Expand Up @@ -296,15 +297,15 @@ 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** |
| _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** |
| _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** |
Expand Down