Merge branch 'release/0.0.5'

Author: vthiery

.clang-format

@@ -0,0 +1,105 @@
+AccessModifierOffset: -4
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortFunctionsOnASingleLine: Empty
+BinPackArguments: false
+BinPackParameters: false
+ColumnLimit:     120
+IndentCaseLabels: false
+IndentWidth:     4
+
+---
+Language:        Cpp
+# BasedOnStyle:  Google
+#AccessModifierOffset: -1
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlinesLeft: true
+AlignOperands:   true
+AlignTrailingComments: true
+#AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+#AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: true
+AllowShortLoopsOnASingleLine: true
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: true
+#BinPackArguments: true
+#BinPackParameters: true
+BraceWrapping:
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+#ColumnLimit:     80
+CommentPragmas:  '^ IWYU pragma:'
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: true
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+ForEachMacros:   [ foreach, Q_FOREACH, BOOST_FOREACH ]
+IncludeCategories:
+  - Regex:           '^<.*\.h>'
+    Priority:        1
+  - Regex:           '^<.*'
+    Priority:        2
+  - Regex:           '.*'
+    Priority:        3
+IncludeIsMainRegex: '([-_](test|unittest))?$'
+#IndentCaseLabels: true
+#IndentWidth:     2
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: false
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PointerAlignment: Left
+ReflowComments:  true
+SortIncludes:    true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Auto
+TabWidth:        8
+UseTab:          Never
+...
+

CMakeLists.txt

@@ -2,9 +2,9 @@ cmake_minimum_required(VERSION 3.2)
 
 project(StatsdClient)
 
-include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src)
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include/cpp-statsd-client)
 
-install(FILES src/* DESTINATION include)
+install(FILES UDPSender.hpp StatsdClient.hpp DESTINATION include)
 
 find_package(Threads)
 add_executable(testStatsdClient ${CMAKE_CURRENT_SOURCE_DIR}/tests/testStatsdClient.cpp)

README.md

@@ -1,5 +1,7 @@
 # C++ StatsD Client
 
+![logo](https://raw.githubusercontent.com/vthiery/cpp-statsd-client/develop/images/logo.svg?sanitize=true)
+
 [ ![Download](https://api.bintray.com/packages/vthiery/conan-packages/statsdclient%3Avthiery/images/download.svg) ](https://bintray.com/vthiery/conan-packages/statsdclient%3Avthiery/_latestVersion)
 [![Build Status](https://travis-ci.org/vthiery/cpp-statsd-client.svg?branch=develop)](https://travis-ci.org/vthiery/cpp-statsd-client)
 [![Github Issues](https://img.shields.io/github/issues/vthiery/cpp-statsd-client.svg)](https://github.com/vthiery/cpp-statsd-client/issues)
@@ -9,9 +11,30 @@ A header-only StatsD client implemented in C++.
 The client allows:
 - batching,
 - change of configuration at runtime,
-- user-define frequency rate.
+- user-defined frequency rate.
+
+## Install and Test
+
+### Makefile
+
+In order to install the header files and/or run the tests, simply use the Makefile and execute
+
+```
+ make install
+ ```
+
+and
+
+```
+ make test
+ ```
+
+### Conan
+
+If you are using [Conan](https://www.conan.io/) to manage your dependencies, merely add statsdclient/x.y.z@vthiery/stable to your conanfile.py's requires, where x.y.z is the release version you want to use. Please file issues here if you experience problems with the packages. You can also directly download the latest version [here](https://bintray.com/vthiery/conan-packages/statsdclient%3Avthiery/_latestVersion).
 
 ## Usage
+### Example
 A simple example of how to use the client:
 
 ```cpp
@@ -20,13 +43,13 @@ using namespace Statsd;
 
 int main()
 {
-    // Define the client
-    StatsdClient client{ "127.0.0.1", 5005, "myPrefix.", 3 };
+    // Define the client on localhost, with port 8080, using a prefix and a batching size of 20 bytes
+    StatsdClient client{ "127.0.0.1", 8080, "myPrefix.", 20 };
 
-    // Increment "coco"
+    // Increment the metric "coco"
     client.increment("coco");
 
-    // Decrement "kiki"
+    // Decrement the metric "kiki"
     client.decrement("kiki");
 
     // Adjusts "toto" by +3
@@ -43,5 +66,46 @@ int main()
 }
 ```
 
+### Configuration
+
+The configuration of the client must be input when one instantiates it. Nevertheless, the API allows the configuration ot change afterwards. For example, one can do the following:
+
+```cpp
+#include "StatsdClient.hpp"
+using namespace Statsd;
+
+int main()
+{
+    // Define the client on localhost, with port 8080, using a prefix and a batching size of 20 bytes
+    StatsdClient client{ "127.0.0.1", 8080, "myPrefix.", 20 };
+
+    client.increment("coco");
+
+    // Set a new configuration, using a different port and a different prefix
+    client.setConfig("127.0.0.1", 8000, "anotherPrefix.");
+
+    client.decrement("kiki");
+}
+```
+
+The batchsize is the only parameter that cannot be changed for the time being.
+
+### Batching
+
+The client supports batching of the metrics:
+* the unit of the batching parameter is bytes,
+* it is optional and not setting it will result in an immediate send of any metrics,
+
+If set, the UDP sender will spawn a thread sending the metrics to the server every 1 second by aggregates. The aggregation logic is as follows:
+* if the last message has already reached the batching limit, add a new element in a message queue;
+* otherwise, append the message to the last one, separated by a `\n`.
+
+### Frequency rate
+
+When sending a metric, a frequency rate can be set in order to limit the metrics' sampling. By default, the frequency rate is set to one and won't affect the sampling. If set to a value `epsilon` (0.0001 for the time being) close to one, the sampling is not affected either.
+
+If the frequency rate is set and `epsilon` different from one, the sending will be rejected randomly (the higher the frequency rate, the lower the probability of rejection).
+
+
 ## License
 This library is under MIT license.