Cadabra
Computer algebra system for field theory problems
Snoop.hh
Go to the documentation of this file.
1 
2 /*
3 
4  Snoop
5  Copyright (C) 2015-2016 Kasper Peeters
6  Available under the terms of the GPL v3.
7 
8  Snoop is a lightweight logging library which stores its log entries in
9  a local SQLite database or on a remote server.
10 
11  */
12 
13 #pragma once
14 
15 #include <string>
16 #include <sstream>
17 #include <sqlite3.h>
18 #include <stdint.h>
19 #include <mutex>
20 #include <json/json.h>
21 #include <thread>
22 
23 #ifndef _MSC_VER
24  #include <unistd.h>
25 #endif
26 
27 namespace snoop {
28 
29  class SnoopImpl;
30  class Flush {};
31  extern Flush flush;
32 
35 
36  class Snoop {
37  public:
38  Snoop();
39  ~Snoop();
40 
44 
45  void init(const std::string& app_name, const std::string& app_version,
46  std::string server="", std::string local_log_file="");
47 
52 
53  std::string get_user_uuid(const std::string& app_name);
54 
58 
59  Snoop& operator()(const std::string& type, std::string fl="", int loc=-1, std::string method="");
60 
62 
63  template<class T>
64  Snoop& operator<<(const T& obj) {
65  out_ <<(obj);
66  return *this;
67  }
68 
70 
71  Snoop& operator<<(const Flush&);
72 
74 
75  void set_sync_immediately(bool);
76 
81 
82  void sync_with_server(bool from_wsthread=false);
83 
85 
86  void sync_runs_with_server(bool from_wsthread=false);
87 
89 
90  void sync_logs_with_server(bool from_wsthread=false);
91 
92 
94 
95  class AppEntry {
96  public:
97  AppEntry();
98  AppEntry(const std::string& uuid_, uint64_t create_millis_, uint64_t receive_millis_, uint64_t pid_,
99  const std::string& ip_address_, const std::string& machine_id_,
100  const std::string& app_name_, const std::string& app_version_,
101  const std::string& user_id_,
102  int server_status_);
103 
104  std::string to_json(bool human_readable) const;
105  void from_json(const Json::Value&);
106 
107  int id;
108  std::string uuid;
109  uint64_t create_millis;
110  uint64_t receive_millis;
111  uint64_t pid;
112  std::string ip_address;
113  std::string machine_id;
114  std::string app_name;
115  std::string app_version;
116  std::string user_id;
117  int server_status; // 1: synced, 0 and negative: number of attempts at syncing made
118  bool connected;
119  };
120 
122 
123  class LogEntry {
124  public:
125  LogEntry();
126  LogEntry(int log_id_, int client_log_id_, int id_, const std::string&,
127  uint64_t, uint64_t, const std::string&, int, const std::string&,
128  const std::string& , const std::string&, int status);
129 
130  std::string to_json(bool human_readable) const;
131  void from_json(const Json::Value&);
132 
133  int log_id;
135  int id;
136  std::string uuid;
137  uint64_t create_millis;
138  uint64_t receive_millis;
139  std::string loc_file;
140  int loc_line;
141  std::string loc_method;
142  std::string type;
143  std::string message;
144  int server_status; // 1: synced, 0 and negative: number of attempts at syncing made
145  };
146 
147  protected:
148  std::ostringstream out_;
150 
152  friend SnoopImpl;
153 
154  };
155 
156  extern Snoop log;
157 
158  const char info[] ="info";
159  const char warn[] ="warning";
160  const char error[]="error";
161  const char fatal[]="fatal";
162  const char email[]="email";
163 }
164 
165 // set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D__FILENAME__='\"$(subst
166 // ${CMAKE_SOURCE_DIR}/,,$(abspath $<))\"'")
167 
168 #define LOC __FILE__, __LINE__, __func__
169 
Snoop & operator()(const std::string &type, std::string fl="", int loc=-1, std::string method="")
Operator to initialise a logging entry with the type of the log message as well as (optionally) the f...
Definition: Snoop.cc:850
std::string to_json(bool human_readable) const
Definition: Snoop.cc:917
SnoopImpl * impl
Definition: Snoop.hh:151
std::ostringstream out_
Definition: Snoop.hh:148
std::string get_user_uuid(const std::string &app_name)
Get a string which uniquely identifies the current user.
Definition: Snoop.cc:167
int log_id
Definition: Snoop.hh:133
const char fatal[]
Definition: Snoop.hh:161
uint64_t receive_millis
Definition: Snoop.hh:110
C++ representation of a run entry.
Definition: Snoop.hh:95
Snoop & operator<<(const T &obj)
Generic operator to log an object to the log message being constructed.
Definition: Snoop.hh:64
std::string app_version
Definition: Snoop.hh:115
bool connected
Definition: Snoop.hh:118
int server_status
Definition: Snoop.hh:117
Definition: SnoopPrivate.hh:17
void from_json(const Json::Value &)
Definition: Snoop.cc:1005
const char email[]
Definition: Snoop.hh:162
uint64_t create_millis
Definition: Snoop.hh:137
uint64_t create_millis
Definition: Snoop.hh:109
int client_log_id
Definition: Snoop.hh:134
Logging class with functionality to send log information to a remote server using a websocket connect...
Definition: Snoop.hh:36
int id
Definition: Snoop.hh:135
std::string machine_id
Definition: Snoop.hh:113
std::string uuid
Definition: Snoop.hh:136
void set_sync_immediately(bool)
Set to sync with server after every log line.
Definition: Snoop.cc:221
int id
Definition: Snoop.hh:107
std::string user_id
Definition: Snoop.hh:116
const char error[]
Definition: Snoop.hh:160
std::string message
Definition: Snoop.hh:143
Snoop log
Definition: Snoop.cc:48
void from_json(const Json::Value &)
Definition: Snoop.cc:1020
server
Definition: cadabra2_defaults.py:84
Definition: Snoop.hh:30
Snoop()
Definition: Snoop.cc:62
void sync_logs_with_server(bool from_wsthread=false)
As above, but only for log entries.
Definition: Snoop.cc:578
bool sync_immediately_
Definition: Snoop.hh:149
int server_status
Definition: Snoop.hh:144
Flush flush
Definition: Snoop.cc:49
uint64_t pid
Definition: Snoop.hh:111
~Snoop()
Definition: Snoop.cc:810
const char warn[]
Definition: Snoop.hh:159
void sync_runs_with_server(bool from_wsthread=false)
As above, but only for run entries.
Definition: Snoop.cc:496
void sync_with_server(bool from_wsthread=false)
Ensure that the local database is synchronised with the server (this sends multiple app or log entrie...
Definition: Snoop.cc:479
std::string loc_file
Definition: Snoop.hh:139
std::string type
Definition: Snoop.hh:142
const char info[]
Definition: Snoop.hh:158
std::string uuid
Definition: Snoop.hh:108
AppEntry()
Definition: Snoop.cc:955
LogEntry()
Definition: Snoop.cc:903
friend SnoopImpl
Definition: Snoop.hh:152
std::string ip_address
Definition: Snoop.hh:112
uint64_t receive_millis
Definition: Snoop.hh:138
void init(const std::string &app_name, const std::string &app_version, std::string server="", std::string local_log_file="")
Initialise the logging stream.
Definition: Snoop.cc:72
C++ representation of a log entry.
Definition: Snoop.hh:123
std::string loc_method
Definition: Snoop.hh:141
std::string app_name
Definition: Snoop.hh:114
int loc_line
Definition: Snoop.hh:140
std::string to_json(bool human_readable) const
Definition: Snoop.cc:971
Definition: Snoop.hh:27