Merge branch 'release/0.0.3'

Author: Vincent Thiery

.gitignore

@@ -1 +1 @@
-build/
+bin

.travis.yml

@@ -0,0 +1,48 @@
+language: cpp
+
+matrix:
+  include:
+    - os: linux
+      addons:
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-7
+      env:
+         - MATRIX_EVAL="BUILD_MODE=Debug && CC=gcc-7 && CXX=g++-7 && CMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS} -std=c++17"
+
+    - os: linux
+      addons:
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-7
+      env:
+         - MATRIX_EVAL="BUILD_MODE=Release && CC=gcc-7 && CXX=g++-7 && CMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS} -std=c++17"
+
+    - os: linux
+      addons:
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-7
+      env:
+         - MATRIX_EVAL="BUILD_MODE=Debug && CC=gcc-7 && CXX=g++-7 && CMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS} -std=c++14"
+
+    - os: linux
+      addons:
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-7
+      env:
+         - MATRIX_EVAL="BUILD_MODE=Release && CC=gcc-7 && CXX=g++-7 && CMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS} -std=c++14"
+
+before_install:
+    - eval "${MATRIX_EVAL}"
+
+script: make test

CMakeLists.txt

@@ -0,0 +1,14 @@
+cmake_minimum_required(VERSION 3.2)
+
+project(StatsdClient)
+
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src)
+
+install(FILES src/* DESTINATION include)
+
+find_package (Threads)
+add_executable(testStatsdClient ${CMAKE_CURRENT_SOURCE_DIR}/tests/testStatsdClient.cpp)
+target_link_libraries(testStatsdClient ${CMAKE_THREAD_LIBS_INIT})
+
+enable_testing()
+add_test(testSuite testStatsdClient)

Makefile

@@ -0,0 +1,18 @@
+# simple makefile to build, test and clean
+
+BUILD_MODE ?= Release
+
+build: clean
+	@echo "Build in ${BUILD_MODE} mode"
+	mkdir -p bin/${BUILD_MODE}
+	@cd bin/${BUILD_MODE}; cmake ../../ -DCMAKE_BUILD_TYPE=${BUILD_MODE}
+	@cd bin/${BUILD_MODE}; make
+
+test: build
+	@cd bin/${BUILD_MODE}; make test
+
+install: build
+	@cd bin/${BUILD_MODE}; make install
+
+clean:
+	@rm -rf bin

README.md

@@ -1,5 +1,10 @@
 # C++ StatsD Client
 
+[ ![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)
+[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/vthiery/cpp-statsd-client.svg)](http://isitmaintained.com/project/vthiery/cpp-statsd-client "Average time to resolve an issue")
+
 A header-only StatsD client implemented in C++.
 The client allows:
 - batching,
@@ -16,7 +21,7 @@ using namespace Statsd;
 int main()
 {
     // Define the client
-    StatsdClient client{ "127.0.0.1", 5005, "myPrefix_", true };
+    StatsdClient client{ "127.0.0.1", 5005, "myPrefix.", 3 };
 
     // Increment "coco"
     client.increment("coco");

src/StatsdClient.hpp

@@ -1,6 +1,7 @@
 #ifndef STATSD_CLIENT_HPP
 #define STATSD_CLIENT_HPP
 
+#include <cstdlib>
 #include <experimental/optional>
 #include <string>
 #include "UDPSender.hpp"
@@ -33,9 +34,6 @@ class StatsdClient
         const std::string& prefix,
         const std::experimental::optional<uint64_t> batchsize = std::experimental::nullopt) noexcept;
 
-    //! Default destructor
-    ~StatsdClient() = default;
-
     //!@}
 
     //!@name Methods
@@ -67,16 +65,6 @@ class StatsdClient
 
     //!@}
 
-private:
-
-    // @name Private methods
-    // @{
-
-    //! Returns a cleaned key
-    inline std::string clean(const std::string& key) const noexcept;
-
-    // @}
-
 private:
 
     //! The prefix to be used for metrics
@@ -96,7 +84,7 @@ StatsdClient(
 , m_sender(host, port, batchsize)
 {
     // Initialize the randorm generator to be used for sampling
-    srandom(time(NULL));
+    std::srand(time(nullptr));
 }
 
 void
@@ -162,48 +150,29 @@ send(const std::string& key, const int value, const std::string& type, const flo
     // Test if one should send or not, according to the frequency rate
     if (!isFrequencyOne(frequency))
     {
-        if (frequency < (float)random() / RAND_MAX)
+        if (frequency < static_cast<float>(std::rand()) / RAND_MAX)
         {
             return;
         }
     }
 
-    // Clean the key
-    clean(key);
-
     // Prepare the buffer, with a sampling rate if specified different from 1.0f
     char buffer[256];
     if (isFrequencyOne(frequency))
     {
         // Sampling rate is 1.0f, no need to specify it
-        snprintf(buffer, sizeof(buffer), "%s%s:%zd|%s", m_prefix.c_str(), key.c_str(), static_cast<signed size_t>(value), type.c_str());
+        snprintf(buffer, sizeof(buffer), "%s%s:%zd|%s", m_prefix.c_str(), key.c_str(), static_cast<int64_t>(value), type.c_str());
     }
     else
     {
         // Sampling rate is different from 1.0f, hence specify it
-        snprintf(buffer, sizeof(buffer), "%s%s:%zd|%s|@%.2f", m_prefix.c_str(), key.c_str(), static_cast<signed size_t>(value), type.c_str(), frequency);
+        snprintf(buffer, sizeof(buffer), "%s%s:%zd|%s|@%.2f", m_prefix.c_str(), key.c_str(), static_cast<int64_t>(value), type.c_str(), frequency);
     }
 
     // Send the message via the UDP sender
     m_sender.send(buffer);
 }
 
-std::string
-StatsdClient::
-clean(const std::string& key) const noexcept
-{
-    std::string cleanKey = key;
-    size_t pos = key.find_first_of(":|@");
-
-    // Add the '_' appropriately to the key
-    while (pos != std::string::npos)
-    {
-        cleanKey[pos] = '_';
-        pos = cleanKey.find_first_of(":|@");
-    }
-    return cleanKey;
-}
-
 }
 
 #endif

src/UDPSender.hpp

@@ -143,7 +143,7 @@ UDPSender(
         m_batchsize = batchsize.value();
 
         // Define the batching thread
-        m_batchingThread = std::thread([this] {
+        m_batchingThread = std::thread([this, batchingWait] {
             while (!m_mustExit)
             {
                 std::deque<std::string> stagedMessageQueue;
@@ -232,6 +232,8 @@ bool
 UDPSender::
 initialize() noexcept
 {
+    using namespace std::string_literals;
+
     if (m_isInitialized)
     {
         return true;
@@ -241,9 +243,7 @@ initialize() noexcept
     m_socket = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
     if (m_socket == -1)
     {
-        char buffer[256];
-        snprintf(buffer, sizeof(buffer), "Could not create socket, err=%m");
-        m_errorMessage = std::string(buffer);
+        m_errorMessage = "Could not create socket, err="s + std::strerror(errno);
         return false;
     }
 
@@ -263,17 +263,13 @@ initialize() noexcept
 
         // Get the address info using the hints
         struct addrinfo* results = nullptr;
-        const int ret = getaddrinfo(m_host.c_str(), nullptr, &hints, &results);
+        const int ret{ getaddrinfo(m_host.c_str(), nullptr, &hints, &results) };
         if (ret != 0)
         {
             // An error code has been returned by getaddrinfo
             close(m_socket);
             m_socket = -1;
-
-            char buffer[256];
-            snprintf(buffer, sizeof(buffer), "getaddrinfo failed: error=%d, msg=%s", ret, gai_strerror(ret));
-            m_errorMessage = std::string(buffer);
-
+            m_errorMessage = "getaddrinfo failed: error="s + std::to_string(ret) + ", msg=" + gai_strerror(ret);
             return false;
         }
 
@@ -286,7 +282,6 @@ initialize() noexcept
     }
 
     m_isInitialized = true;
-
     return true;
 }
 
@@ -301,12 +296,11 @@ sendToDaemon(const std::string& message) noexcept
     }
 
     // Try sending the message
-    const int ret = sendto(m_socket, message.data(), message.size(), 0, (struct sockaddr *)&m_server, sizeof(m_server));
+    const long int ret{ sendto(m_socket, message.data(), message.size(), 0, (struct sockaddr *)&m_server, sizeof(m_server)) };
     if (ret == -1)
     {
-        char buffer[256];
-        snprintf(buffer, sizeof(buffer), "sendto server failed: host=%s:%d, err=%m", m_host.c_str(), m_port);
-        m_errorMessage = std::string(buffer);
+        using namespace std::string_literals;
+        m_errorMessage = "sendto server failed: host="s + m_host + ":" + std::to_string(m_port) + ", err=" + std::strerror(errno);
     }
 }
 

tests/testStatsdClient.cpp

@@ -0,0 +1,38 @@
+#include <StatsdClient.hpp>
+#include <cassert>
+
+using namespace Statsd;
+
+int main()
+{
+    StatsdClient client{ "localhost", 8080, "myPrefix.", 1 };
+
+    // set a new config with a different port
+    client.setConfig("localhost", 80, "myPrefix.");
+
+    // Increment "coco"
+    client.increment("coco");
+    assert(!client.errorMessage());
+
+    // Decrement "kiki"
+    client.decrement("kiki");
+    assert(!client.errorMessage());
+
+    // Adjusts "toto" by +3
+    client.count("toto", 2, 0.1f);
+    assert(!client.errorMessage());
+
+    // Record a gauge "titi" to 3
+    client.gauge("titi", 3);
+    assert(!client.errorMessage());
+
+    // Record a timing of 2ms for "myTiming"
+    client.timing("myTiming", 2, 0.1f);
+    assert(!client.errorMessage());
+
+    // Send a metric explicitly
+    client.send("tutu", 4, "c", 2.0f);
+    assert(!client.errorMessage());
+
+    return EXIT_SUCCESS;
+}