Cloudwatch integration demo

CMake/Dependencies/libawscpp-CMakeLists.txt

@@ -2,13 +2,28 @@ cmake_minimum_required(VERSION 3.6.3)
 project(libawscpp-download NONE)
 include(ExternalProject)
 
+if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+    message(STATUS "Configuring for Linux")
+    set(TARGET_ARCH LINUX)
+elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+    message(STATUS "Configuring for macOS")
+    set(TARGET_ARCH APPLE)
+elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows")
+    message(STATUS "Configuring for Windows")
+    set(TARGET_ARCH WINDOWS)
+endif()
+
 ExternalProject_Add(libawscpp-download
     GIT_REPOSITORY    https://github.com/aws/aws-sdk-cpp.git
     GIT_TAG           1.11.217
     LIST_SEPARATOR    "|"
-    CMAKE_ARGS       -DBUILD_SHARED_LIBS=OFF
-                     -DBUILD_ONLY=kinesisvideo|kinesis-video-webrtc-storage
+    CMAKE_ARGS       -DBUILD_SHARED_LIBS=ON
+                     -DENABLE_TESTING=OFF
+                     -DBUILD_ONLY=${BUILD_ONLY}
                      -DCMAKE_INSTALL_PREFIX=${OPEN_SRC_INSTALL_PREFIX}
+                     -DCMAKE_PREFIX_PATH=${OPEN_SRC_INSTALL_PREFIX}
+                     -DTARGET_ARCH=${TARGET_ARCH}
+                     -DCUSTOM_MEMORY_MANAGEMENT=OFF
     BUILD_ALWAYS      TRUE
     TEST_COMMAND      ""
 )

CMakeLists.txt

@@ -21,6 +21,7 @@ option(ENABLE_DATA_CHANNEL "Enable support for data channel" ON)
 option(ENABLE_KVS_THREADPOOL "Enable support for KVS thread pool in signaling" ON)
 option(INSTRUMENTED_ALLOCATORS "Enable memory instrumentation" OFF)
 option(ENABLE_AWS_SDK_IN_TESTS "Enable support for compiling AWS SDKs for tests" ON)
+option(ENABLE_AWS_SDK_INTEG "Enable building samples with cloudwatch" OFF)
 
 # Developer Flags
 option(BUILD_TEST "Build the testing tree." OFF)
@@ -233,9 +234,12 @@ if(BUILD_DEPENDENCIES)
 
   if(BUILD_TEST)
     build_dependency(gtest)
-
+    set(BUILD_ARGS
+            -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
+            -DCMAKE_C_FLAGS=${CMAKE_C_FLAGS}
+            -DBUILD_ONLY=kinesisvideo|kinesis-video-webrtc-storage)
     if(ENABLE_AWS_SDK_IN_TESTS)
-      build_dependency(awscpp)
+      build_dependency(awscpp ${BUILD_ARGS})
     endif()
 
   endif()
@@ -247,9 +251,18 @@ if(BUILD_DEPENDENCIES)
   if (LINK_PROFILER)
     build_dependency(gperftools)
   endif()
+
   message(STATUS "Finished building dependencies.")
 endif()
 
+if(ENABLE_AWS_SDK_INTEG)
+  set(BUILD_ARGS
+          -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
+          -DCMAKE_C_FLAGS=${CMAKE_C_FLAGS}
+          -DBUILD_ONLY=monitoring|logs)
+  build_dependency(awscpp ${BUILD_ARGS})
+endif()
+
 # building kvsCommonLws also builds kvspic
 set(BUILD_ARGS
         -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
@@ -481,6 +494,9 @@ if (BUILD_SAMPLE)
   add_subdirectory(samples)
 endif()
 
+if(ENABLE_AWS_SDK_INTEG)
+  add_subdirectory(cloudwatch-integ)
+endif()
 if(BUILD_TEST)
   # adding ZLIB because aws sdk static link seems to be broken when zlib is needed
   if(NOT WIN32)

README.md

@@ -251,11 +251,9 @@ The SDK also tracks entry and exit of functions which increases the verbosity of
 `add_definitions(-DLOG_STREAMING)`
 Note: This log level is extremely VERBOSE and could flood the files if using file based logging strategy.
 
-<details>
-  <summary>Time-to-first-frame breakdown metrics</summary>
+### Time-to-first-frame breakdown metrics to JS viewer
 
-There is a flag in the sample application which (pSampleConfiguration->enableSendingMetricsToViewerViaDc) can be set to TRUE to send metrics from the master to the [JS viewer](https://awslabs.github.io/amazon-kinesis-video-streams-webrtc-sdk-js/examples/index.html). This helps get a detailed breakdown of time-to-first-frame and all the processes and API calls on master and the viewer both. This is intended to be used with the KVS WebRTC C SDK running as the master and the JS SDK as the viewer. The master sends peer, ice-agent, signaling and data-channel metrics to the viewer which are plotted ~ 20 seconds after the viewer is started. Since the timeline plot is intended to understand the time-to-first-frame, the sample web page needs to be refreshed and the master needs to be restarted if a new / updated plot is needed. While using the SDK in this mode, it is expected that all datachannel messages are JSON messages. This feature is only meant to be used for a single viewer at a time.
-</details>
+There is a flag in the sample application which (`pSampleConfiguration->enableSendingMetricsToViewerViaDc`) can be set to TRUE to send metrics from the master to the [JS viewer](https://awslabs.github.io/amazon-kinesis-video-streams-webrtc-sdk-js/examples/index.html). This helps get a detailed breakdown of time-to-first-frame and all the processes and API calls on master and the viewer both. This is intended to be used with the KVS WebRTC C SDK running as the master and the JS SDK as the viewer. The master sends peer, ice-agent, signaling and data-channel metrics to the viewer which are plotted ~ 20 seconds after the viewer is started. Since the timeline plot is intended to understand the time-to-first-frame, the sample web page needs to be refreshed and the master needs to be restarted if a new / updated plot is needed. While using the SDK in this mode, it is expected that all datachannel messages are JSON messages. This feature is only meant to be used for a single viewer at a time.
 
 ### Set path to SSL CA certificate (**Optional**)
 
@@ -450,7 +448,7 @@ The certificate generating function ([createCertificateAndKey](https://awslabs.g
 **Important Note: It is recommended to rotate the certificates often - preferably for every peer connection to avoid a compromised client weakening the security of the new connections.**
 
 Take `kvsWebRTCClientMaster` as sample, add `RtcCertificate certificates[CERT_COUNT];` to **SampleConfiguration** in [Samples.h](./samples/Samples.h).
-Then pass in the pre-generated certificate in initializePeerConnection() in [Common.c](./samples/Common.c).
+Then pass in the pre-generated certificate in initializePeerConnection() in [Common.c](samples/lib/Common.c).
 
 ```c
 configuration.certificates[0].pCertificate = pSampleConfiguration->certificates[0].pCertificate;

cloudwatch-integ/CMakeLists.txt

@@ -0,0 +1,56 @@
+cmake_minimum_required(VERSION 3.6.3)
+
+project(KinesisVideoWebRTCClientSamplesCloudwatch LANGUAGES C CXX)
+set(CMAKE_CXX_STANDARD 11)
+
+message("OPEN_SRC_INSTALL_PREFIX=${OPEN_SRC_INSTALL_PREFIX}")
+
+include_directories(${OPEN_SRC_INSTALL_PREFIX}/include)
+include_directories(${OPEN_SRC_INCLUDE_DIRS})
+link_directories(${OPEN_SRC_INSTALL_PREFIX}/lib)
+
+find_package(ZLIB REQUIRED)
+find_package(AWSSDK REQUIRED COMPONENTS monitoring logs)
+
+set(CW_CONFIG_HEADER "configs/default_config.h" CACHE FILEPATH "Config header for the cloudwatch integrated demo")
+
+add_definitions(-DCW_CONFIG_HEADER="${CW_CONFIG_HEADER}")
+message(STATUS "Config header set to ${CW_CONFIG_HEADER}")
+
+add_executable(
+        kvsWebrtcClientMasterCW
+        Cloudwatch.cpp
+        CloudwatchLogs.cpp
+        CloudwatchMonitoring.cpp
+        ../samples/lib/Common.c
+        ../samples/lib/Utility.c
+        ../samples/lib/MetricsHandling.c
+        ../samples/lib/DataChannelHandling.c
+        ../samples/lib/SignalingMsgHandler.c
+        ../samples/lib/Media.c
+        kvsWebRTCClientMasterCloudwatch.cpp)
+target_link_libraries(kvsWebrtcClientMasterCW
+                      kvsWebrtcClient
+                      kvsWebrtcSignalingClient
+                      ${EXTRA_DEPS}
+                      kvsCommonLws kvspicUtils websockets kvssdp kvsstun
+                      ${AWSSDK_LINK_LIBRARIES})
+
+add_executable(
+        kvsWebrtcClientViewerCW
+        ../samples/lib/Common.c
+        ../samples/lib/Utility.c
+        ../samples/lib/MetricsHandling.c
+        ../samples/lib/DataChannelHandling.c
+        ../samples/lib/SignalingMsgHandler.c
+        ../samples/lib/Media.c
+        Cloudwatch.cpp
+        CloudwatchLogs.cpp
+        CloudwatchMonitoring.cpp
+        kvsWebRTCClientViewerCloudwatch.cpp)
+target_link_libraries(kvsWebrtcClientViewerCW
+        kvsWebrtcClient
+        kvsWebrtcSignalingClient
+        ${EXTRA_DEPS}
+        kvsCommonLws kvspicUtils websockets kvssdp kvsstun
+        ${AWSSDK_LINK_LIBRARIES})

cloudwatch-integ/Cloudwatch.cpp

@@ -0,0 +1,82 @@
+#include "Include.h"
+#include "Cloudwatch.h"
+
+namespace CppInteg {
+
+Cloudwatch::Cloudwatch(ClientConfiguration* pClientConfig)
+    : logs(pClientConfig), monitoring(pClientConfig), terminated(FALSE)
+{
+}
+
+STATUS Cloudwatch::init(PCHAR channelName, PCHAR region, BOOL isMaster, BOOL isStorage)
+{
+    ENTERS();
+    STATUS retStatus = STATUS_SUCCESS;
+    ClientConfiguration clientConfig;
+    CreateLogGroupRequest createLogGroupRequest;
+    Aws::CloudWatchLogs::Model::CreateLogStreamOutcome createLogStreamOutcome;
+    CreateLogStreamRequest createLogStreamRequest;
+
+    clientConfig.region = region;
+    auto& instance = getInstanceImpl(&clientConfig);
+
+    if (STATUS_FAILED(instance.logs.init(channelName, region, isMaster, isStorage))) {
+        DLOGW("Failed to create Cloudwatch logger");
+    } else {
+        globalCustomLogPrintFn = logger;
+    }
+
+    CHK_STATUS(instance.monitoring.init(channelName, region, isMaster, isStorage));
+
+CleanUp:
+
+    LEAVES();
+    return retStatus;
+}
+
+Cloudwatch& Cloudwatch::getInstance()
+{
+    return getInstanceImpl();
+}
+
+Cloudwatch& Cloudwatch::getInstanceImpl(ClientConfiguration* pClientConfig)
+{
+    static Cloudwatch instance{pClientConfig};
+    return instance;
+}
+
+VOID Cloudwatch::deinit()
+{
+    auto& instance = getInstance();
+    instance.logs.deinit();
+    instance.monitoring.deinit();
+    instance.terminated = TRUE;
+}
+
+VOID Cloudwatch::logger(UINT32 level, PCHAR tag, PCHAR fmt, ...)
+{
+    CHAR logFmtString[MAX_LOG_FORMAT_LENGTH + 1];
+    CHAR cwLogFmtString[MAX_LOG_FORMAT_LENGTH + 1];
+    UINT32 logLevel = GET_LOGGER_LOG_LEVEL();
+    UNUSED_PARAM(tag);
+
+    if (level >= logLevel) {
+        addLogMetadata(logFmtString, (UINT32) ARRAY_SIZE(logFmtString), fmt, level);
+
+        // Creating a copy to store the logFmtString for cloudwatch logging purpose
+        va_list valist, valist_cw;
+        va_start(valist_cw, fmt);
+        vsnprintf(cwLogFmtString, (SIZE_T) SIZEOF(cwLogFmtString), logFmtString, valist_cw);
+        va_end(valist_cw);
+        va_start(valist, fmt);
+        vprintf(logFmtString, valist);
+        va_end(valist);
+
+        auto& instance = getInstance();
+        if (!instance.terminated) {
+            instance.logs.push(cwLogFmtString);
+        }
+    }
+}
+
+} // namespace Canary

cloudwatch-integ/Cloudwatch.h

@@ -0,0 +1,31 @@
+#pragma once
+
+#include "Include.h"
+#include "CloudwatchLogs.h"
+#include "CloudwatchMonitoring.h"
+
+namespace CppInteg {
+
+class Cloudwatch {
+  public:
+    Cloudwatch() = delete;
+    Cloudwatch(Cloudwatch const&) = delete;
+    void operator=(Cloudwatch const&) = delete;
+
+    CloudwatchLogs logs;
+    CloudwatchMonitoring monitoring;
+
+    static Cloudwatch& getInstance();
+    static STATUS init(PCHAR channelName, PCHAR region, BOOL isMaster, BOOL isStorage);
+    static VOID deinit();
+    static VOID logger(UINT32, PCHAR, PCHAR, ...);
+
+  private:
+    static Cloudwatch& getInstanceImpl(ClientConfiguration* = nullptr);
+
+    Cloudwatch(ClientConfiguration*);
+    BOOL terminated;
+};
+typedef Cloudwatch* PCloudwatch;
+
+} // namespace Canary