Add Sentry (#370)

* Add Sentry * add curl dep * add recursive * try to fix ci * try again * update linux ci
MisterTea · Jan 3, 2021 · b3512b6 · b3512b6
1 parent 5a5636a
commit b3512b6
Show file tree

Hide file tree

Showing 12 changed files with 163 additions and 53 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -9,14 +9,14 @@ jobs:
  command: mkdir -p ~/.ssh/ && echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  - run:
  name: Install system dependencies
- command: apt-get update; apt-get install -y libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++ openssh-server
+ command: apt-get update; apt-get install -y libcurl4-openssl-dev libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++ openssh-server
  - checkout
  - run:
  name: Set up ssh & known_hosts
  command: /etc/init.d/ssh start; rm -f ~/.ssh/id_rsa*; ssh-keygen -q -N "" -f ~/.ssh/id_rsa; cp ~/.ssh/id_rsa.pub ~/.ssh/authorized_keys; rm -f ~/.ssh/known_hosts; ssh -o "StrictHostKeyChecking no" localhost ls
  - run:
  name: Init submodules
- command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init; fi
+ command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init --recursive; fi
  - run:
  name: Build the root version of the project
  command: mkdir ../root_version; cp -Rf .git * ../root_version/; cd ../root_version; git checkout v6; mkdir build; cd build; cmake ../; make -j4
@@ -45,14 +45,14 @@ jobs:
  command: mkdir -p ~/.ssh/ && echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  - run:
  name: Install system dependencies
- command: apt-get update; apt-get install -y libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++ openssh-server
+ command: apt-get update; apt-get install -y libcurl4-openssl-dev libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++ openssh-server
  - checkout
  - run:
  name: Set up ssh & known_hosts
  command: /etc/init.d/ssh start; rm -f ~/.ssh/id_rsa*; ssh-keygen -q -N "" -f ~/.ssh/id_rsa; cp ~/.ssh/id_rsa.pub ~/.ssh/authorized_keys; rm -f ~/.ssh/known_hosts; ssh -o "StrictHostKeyChecking no" localhost ls
  - run:
  name: Init submodules
- command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init; fi
+ command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init --recursive; fi
  - run:
  name: Build the project
  command: mkdir build; cd build; cmake -DCMAKE_INSTALL_PREFIX=/usr ../; make -j4 install
@@ -72,11 +72,11 @@ jobs:
  command: mkdir -p ~/.ssh/ && echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  - run:
  name: Install system dependencies
- command: apt-get update; apt-get install -y libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
+ command: apt-get update; apt-get install -y libcurl4-openssl-dev libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
  - checkout
  - run:
  name: Init submodules
- command: git submodule update --init
+ command: git submodule update --init --recursive
  - run:
  name: Build the project with test
  command: mkdir build; cd build; cmake -DSANITIZE_MEMORY=ON ../; make -j4
@@ -92,11 +92,11 @@ jobs:
  command: mkdir -p ~/.ssh/ && echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  - run:
  name: Install system dependencies
- command: apt-get update; apt-get install -y libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
+ command: apt-get update; apt-get install -y libcurl4-openssl-dev libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
  - checkout
  - run:
  name: Init submodules
- command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init; fi
+ command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init --recursive; fi
  - run:
  name: Build the project with test
  command: mkdir build; cd build; cmake -DSANITIZE_ADDRESS=ON ../; make -j4
@@ -112,11 +112,11 @@ jobs:
  command: mkdir -p ~/.ssh/ && echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  - run:
  name: Install system dependencies
- command: apt-get update; apt-get install -y libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
+ command: apt-get update; apt-get install -y libcurl4-openssl-dev libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
  - checkout
  - run:
  name: Init submodules
- command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init; fi
+ command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init --recursive; fi
  - run:
  name: Build the project with test
  command: mkdir build; cd build; cmake -DSANITIZE_THREAD=ON ../; make -j4
@@ -132,11 +132,11 @@ jobs:
  command: mkdir -p ~/.ssh/ && echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  - run:
  name: Install system dependencies
- command: apt-get update; apt-get install -y libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
+ command: apt-get update; apt-get install -y libcurl4-openssl-dev libunwind-dev git cmake protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
  - checkout
  - run:
  name: Init submodules
- command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init; fi
+ command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init --recursive; fi
  - run:
  name: Build the project with test
  command: mkdir build; cd build; cmake -DSANITIZE_UNDEFINED=ON ../; make -j4
@@ -156,7 +156,7 @@ jobs:
  - checkout
  - run:
  name: Init submodules
- command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init; fi
+ command: if [ $CIRCLE_BRANCH != "release" ]; then git submodule update --init --recursive; fi
  - run:
  name: Build the project with test
  command: mkdir build; cd build; cmake -DSANITIZE_THREAD=ON ../; make -j4

diff --git a/.github/workflows/linux_ci.yml b/.github/workflows/linux_ci.yml
@@ -16,12 +16,11 @@ jobs:
  mkdir -p ~/.ssh/
  echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  sudo apt-get update
- sudo apt-get install -y libunwind-dev git cmake gdb protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
+ sudo apt-get install -y libcurl4-openssl-dev libunwind-dev git cmake gdb protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
  ACCEPT_EULA=Y sudo apt-get -y upgrade
  auth_header="$(git config --local --get http.https://github.com/.extraheader)"
  git submodule sync --recursive
- git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
- git submodule update --init
+ git submodule update --init --force --recursive
 
  - name: Test with ubsan
  run: |
@@ -44,12 +43,11 @@ jobs:
  mkdir -p ~/.ssh/
  echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  sudo apt-get update
- sudo apt-get install -y libunwind-dev git cmake gdb protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
+ sudo apt-get install -y libcurl4-openssl-dev libunwind-dev git cmake gdb protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
  ACCEPT_EULA=Y sudo apt-get -y upgrade
  auth_header="$(git config --local --get http.https://github.com/.extraheader)"
  git submodule sync --recursive
- git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
- git submodule update --init
+ git submodule update --init --force --recursive
 
  - name: Test with asan
  run: |
@@ -72,12 +70,11 @@ jobs:
  mkdir -p ~/.ssh/
  echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  sudo apt-get update
- sudo apt-get install -y libunwind-dev git cmake gdb protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
+ sudo apt-get install -y libcurl4-openssl-dev libunwind-dev git cmake gdb protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
  ACCEPT_EULA=Y sudo apt-get -y upgrade
  auth_header="$(git config --local --get http.https://github.com/.extraheader)"
  git submodule sync --recursive
- git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
- git submodule update --init
+ git submodule update --init --force --recursive
 
  - name: Test with msan
  run: |
@@ -100,12 +97,11 @@ jobs:
  mkdir -p ~/.ssh/
  echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  sudo apt-get update
- sudo apt-get install -y libunwind-dev git cmake gdb protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
+ sudo apt-get install -y libcurl4-openssl-dev libunwind-dev git cmake gdb protobuf-compiler libsodium-dev libgflags-dev libprotobuf-dev libutempter-dev g++
  ACCEPT_EULA=Y sudo apt-get -y upgrade
  auth_header="$(git config --local --get http.https://github.com/.extraheader)"
  git submodule sync --recursive
- git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
- git submodule update --init
+ git submodule update --init --force --recursive
 
  - name: Test with tsan
  run: |

diff --git a/.github/workflows/mac_ci.yml b/.github/workflows/mac_ci.yml
@@ -13,13 +13,12 @@ jobs:
  - name: Setup
  shell: bash
  run: |
- auth_header="$(git config --local --get http.https://github.com/.extraheader)"
- git submodule sync --recursive
- git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
- git submodule update --init
  mkdir -p ~/.ssh/
  echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  brew install cmake; brew install protobuf libsodium
+ auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+ git submodule sync --recursive
+ git submodule update --init --force --recursive
 
  - name: Test with ubsan
  run: |
@@ -41,8 +40,7 @@ jobs:
  run: |
  auth_header="$(git config --local --get http.https://github.com/.extraheader)"
  git submodule sync --recursive
- git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
- git submodule update --init
+ git submodule update --init --force --recursive
  mkdir -p ~/.ssh/
  echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  brew install cmake; brew install protobuf libsodium
@@ -67,8 +65,7 @@ jobs:
  run: |
  auth_header="$(git config --local --get http.https://github.com/.extraheader)"
  git submodule sync --recursive
- git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
- git submodule update --init
+ git submodule update --init --force --recursive
  mkdir -p ~/.ssh/
  echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  brew install cmake; brew install protobuf libsodium
@@ -93,8 +90,7 @@ jobs:
  run: |
  auth_header="$(git config --local --get http.https://github.com/.extraheader)"
  git submodule sync --recursive
- git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
- git submodule update --init
+ git submodule update --init --force --recursive
  mkdir -p ~/.ssh/
  echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
  brew install cmake; brew install protobuf libsodium

diff --git a/.gitmodules b/.gitmodules
@@ -25,3 +25,6 @@
 [submodule "external/vcpkg"]
  path = external/vcpkg
  url = https://github.com/microsoft/vcpkg.git
+[submodule "external/sentry-native"]
+ path = external/sentry-native
+ url = https://github.com/getsentry/sentry-native.git
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,8 +1,25 @@
 cmake_minimum_required (VERSION 3.0.2)
 project (EternalTCP VERSION 6.0.13)
 
+include(CMakeFindDependencyMacro)
+
+# Add cmake script directory.
+LIST(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 SET(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/external/sanitizers-cmake/cmake" ${CMAKE_MODULE_PATH})
-FIND_PACKAGE(Sanitizers)
+
+# Required packages
+FIND_PACKAGE(Sanitizers REQUIRED)
+find_package(Threads REQUIRED)
+find_package(sodium REQUIRED)
+find_package(Protobuf REQUIRED)
+
+# Optional packages
+find_package(UTempter)
+IF(LINUX)
+find_package(SELinux)
+ENDIF()
+
+add_subdirectory("external/sentry-native")
 
 SET(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/external/cotire/CMake" ${CMAKE_MODULE_PATH})
 INCLUDE(cotire)
@@ -15,7 +32,7 @@ option(DISABLE_CRASH_LOG "Disable installing easylogging crash handler" OFF)
 
 add_definitions(-DET_VERSION="${PROJECT_VERSION}")
 # For easylogging, disable default log file, enable crash log, ensure thread safe, and catch c++ exceptions
-SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DELPP_NO_DEFAULT_LOG_FILE -DELPP_FEATURE_CRASH_LOG -DELPP_THREAD_SAFE")
+SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DELPP_NO_DEFAULT_LOG_FILE -DELPP_FEATURE_CRASH_LOG -DELPP_THREAD_SAFE -DSENTRY_BUILD_STATIC")
 IF(CODE_COVERAGE)
  if(UNIX)
  SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-arcs -ftest-coverage")
@@ -52,25 +69,19 @@ if (CMAKE_SYSTEM_NAME MATCHES "NetBSD")
  set(NETBSD TRUE)
 endif (CMAKE_SYSTEM_NAME MATCHES "NetBSD")
 
-# Add cmake script directory.
-LIST(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
-
-# Required packages
-find_package(Threads REQUIRED)
-find_package(Protobuf REQUIRED)
-find_package(sodium REQUIRED)
-
-# Optional packages
-IF(LINUX)
-find_package(SELinux)
-ENDIF()
-find_package(UTempter)
-
 option(FULL_PROTOBUF "Link to full protobuf library instead of protobuf-lite" OFF)
 IF(FULL_PROTOBUF)
- SET(PROTOBUF_LIBS ${PROTOBUF_LIBRARIES})
+ IF(WIN32)
+ SET(PROTOBUF_LIBS protobuf::libprotobuf)
+ ELSE()
+ SET(PROTOBUF_LIBS ${PROTOBUF_LIBRARIES})
+ ENDIF()
 ELSE()
- SET(PROTOBUF_LIBS ${PROTOBUF_LITE_LIBRARIES})
+ IF(WIN32)
+ SET(PROTOBUF_LIBS protobuf::libprotobuf-lite)
+ ELSE()
+ SET(PROTOBUF_LIBS ${PROTOBUF_LITE_LIBRARIES})
+ ENDIF()
 ENDIF()
 
 IF(SELINUX_FOUND)
@@ -132,6 +143,7 @@ include_directories(
  external/cxxopts/include
  external/msgpack-c/include
  external/UniversalStacktrace/ust
+ external/sentry-native/include
  src/base
  src/terminal
  src/terminal/forwarding
@@ -241,6 +253,9 @@ add_library(
  src/terminal/UserJumphostHandler.hpp
  src/terminal/UserJumphostHandler.cpp
 
+ src/terminal/TelemetryService.hpp
+ src/terminal/TelemetryService.cpp
+
  ${ETERMINAL_SRCS} ${ETERMINAL_HDRS}
  )
 add_dependencies(
@@ -262,6 +277,7 @@ target_link_libraries (
  ${PROTOBUF_LIBS}
  ${sodium_LIBRARY_RELEASE}
  ${UTEMPTER_LIBRARIES}
+ sentry::sentry
  ${CORE_LIBRARIES}
 )
 DECORATE_TARGET(et)
@@ -289,6 +305,7 @@ target_link_libraries (
  ${sodium_LIBRARY_RELEASE}
  ${SELINUX_LIBRARIES}
  ${UTEMPTER_LIBRARIES}
+ sentry::sentry
  ${CORE_LIBRARIES}
 )
 DECORATE_TARGET(etserver)
@@ -307,6 +324,7 @@ target_link_libraries (
  ${sodium_LIBRARY_RELEASE}
  ${SELINUX_LIBRARIES}
  ${UTEMPTER_LIBRARIES}
+ sentry::sentry
  ${CORE_LIBRARIES}
 )
 DECORATE_TARGET(etterminal)
@@ -345,6 +363,7 @@ target_link_libraries (
  ${sodium_LIBRARY_RELEASE}
  ${SELINUX_LIBRARIES}
  ${UTEMPTER_LIBRARIES}
+ sentry::sentry
  ${CORE_LIBRARIES}
 )
 DECORATE_TARGET(htm)
@@ -365,6 +384,7 @@ target_link_libraries (
  ${sodium_LIBRARY_RELEASE}
  ${SELINUX_LIBRARIES}
  ${UTEMPTER_LIBRARIES}
+ sentry::sentry
  ${CORE_LIBRARIES}
 )
 DECORATE_TARGET(htmd)
@@ -391,6 +411,7 @@ target_link_libraries(
  ${sodium_LIBRARY_RELEASE}
  ${SELINUX_LIBRARIES}
  ${UTEMPTER_LIBRARIES}
+ sentry::sentry
  ${CORE_LIBRARIES}
  )
 add_test(

diff --git a/external/sentry-native b/external/sentry-native
diff --git a/src/base/Headers.hpp b/src/base/Headers.hpp
@@ -91,6 +91,8 @@ inline int close(int fd) { return ::closesocket(fd); }
 #include <utempter.h>
 #endif
 
+#include "sentry.h"
+
 #if WIN32
 #define popen _popen
 #define pclose _pclose

diff --git a/src/terminal/TelemetryService.cpp b/src/terminal/TelemetryService.cpp
@@ -0,0 +1,34 @@
+#include "TelemetryService.hpp"
+
+namespace et {
+TelemetryService::TelemetryService(bool _allow, const string& databasePath,
+ const string& environment)
+ : allowed(_allow) {
+ if (allowed) {
+ sentry_options_t* options = sentry_options_new();
+
+ // this is an example. for real usage, make sure to set this explicitly to
+ // an app specific cache location.
+ sentry_options_set_database_path(options, databasePath.c_str());
+ sentry_options_set_dsn(
+ options,
+ "https://[email protected]/"
+ "5574732");
+ sentry_options_set_symbolize_stacktraces(options, true);
+ sentry_options_set_release(options, "EternalTerminal@" ET_VERSION);
+ sentry_options_set_environment(options, environment.c_str());
+
+ sentry_init(options);
+ }
+}
+
+TelemetryService::~TelemetryService() { sentry_shutdown(); }
+
+void TelemetryService::log(sentry_level_e level, const std::string& message) {
+ if (!allowed) return;
+ sentry_capture_event(
+ sentry_value_new_message_event(level, "stderr", message.c_str()));
+}
+
+shared_ptr<TelemetryService> TelemetryService::telemetryServiceInstance;
+} // namespace et