log_producer_config.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  1. #ifndef LOG_SDK_LOG_PRODUCER_CONFIG_H
  2. #define LOG_SDK_LOG_PRODUCER_CONFIG_H
  3. #include "log_define.h"
  4. #include "log_producer_common.h"
  5. #include <stdio.h>
  6. #include <stddef.h>
  7. #include <stdint.h>
  8. #include "log_multi_thread.h"
  9. LOG_CPP_START
  10. #define MAX_TOKEN_LEN 256
  11. typedef void (*Log_GetTokenCallBack)(char*, char*, char*, char*);
  12. typedef struct _log_producer_config
  13. {
  14. //守护上传:代替其他实体上传日志
  15. int enableGuarder;
  16. //天眼要求字段
  17. char* skyeyeServName;
  18. char* skyeyeCmptId;
  19. char* skyeyeCmptName;
  20. char* skyeyeTerminalNo;
  21. char* skyeyeVersion;
  22. char* skyeyeSn;
  23. char* skyeyeItem;
  24. char* skyeyeEntityName;
  25. //统一日志要求字段
  26. char* unitedAppName;
  27. char* unitedVersion;
  28. int unitedNeedArchived;
  29. char* unitedDeployUnitId;
  30. char* unitedServiceUnitId;
  31. char* endpoint;
  32. char* skyeye_user_topic;
  33. char* skyeye_sys_topic;
  34. char* beidou_topic;
  35. char* business_user_topic;
  36. char* business_sys_topic;
  37. char* vtmweb_topic;
  38. int32_t sendThreadCount;
  39. int32_t sendThreadWaitMs;
  40. int32_t logCountPerPackage;
  41. int32_t logBytesPerPackage;
  42. int32_t maxBufferBytes;
  43. int32_t connectTimeoutSec;
  44. int32_t sendTimeoutSec;
  45. int32_t destroyFlusherWaitTimeoutSec;
  46. int32_t destroySenderWaitTimeoutSec;
  47. int32_t compressType; // 0 no compress, 1 lz4
  48. int32_t ntpTimeOffset;
  49. int using_https; // 0 http, 1 https
  50. // for persistent feature
  51. int32_t usePersistent; // 0 no, 1 yes
  52. char* persistentFilePath;
  53. int32_t maxPersistentLogCount;
  54. int32_t usePersistentEncrypt; // 0 no, 1 yes
  55. char* PersistentEncryptPassword;
  56. int32_t openDB; // 0 no, 1 yes
  57. char debugMode;
  58. char useMemoryType;
  59. Log_GetTokenCallBack tokenFun;
  60. }log_producer_config;
  61. extern unsigned long g_upload_TerminalSys_Suc;
  62. extern unsigned long g_upload_TerminalUser_Suc;
  63. extern unsigned long g_upload_BussinessSys_Suc;
  64. extern unsigned long g_upload_BussinessUser_Suc;
  65. extern unsigned long g_upload_beidou_Suc;
  66. extern unsigned long g_upload_TerminalSys_Err;
  67. extern unsigned long g_upload_TerminalUser_Err;
  68. extern unsigned long g_upload_BussinessSys_Err;
  69. extern unsigned long g_upload_BussinessUser_Err;
  70. extern unsigned long g_upload_beidou_Err;
  71. /**
  72. * create a empty producer config, should set config params manually
  73. * @return empty producer config
  74. */
  75. LOG_EXPORT log_producer_config* create_log_producer_config();
  76. /**
  77. * 是否启用守护上传(代替其他实体上传日志)
  78. */
  79. LOG_EXPORT void log_producer_config_set_enable_guard(log_producer_config* config, int enable);
  80. /**
  81. * 设置getToken回调,一般只有send需要设置
  82. */
  83. LOG_EXPORT void log_producer_config_set_tokenCallBack(log_producer_config* config, Log_GetTokenCallBack fun);
  84. /**
  85. * 天眼日志必填要求字段:应用所在服务器名称
  86. */
  87. LOG_EXPORT void log_producer_config_set_skyeye_servname(log_producer_config* config, char* servname);
  88. /**
  89. * 天眼日志必填要求字段:当前应用的组件ID,为系统/子系统名(GroupId),如LA04、LA03.01。 只能用英文字符和数字,不能含下划线。
  90. */
  91. LOG_EXPORT void log_producer_config_set_skyeye_cmptId(log_producer_config* config, char* cmptId);
  92. /**
  93. * 天眼日志必填要求字段:当前应用的组件名称,为发布单元名(ArtifactId),可根据该发布单元功能自由定义,一般是模块名。只能用英文字符和数字。如Cmb_Netpay,APPSVRS_MobileHtml
  94. */
  95. LOG_EXPORT void log_producer_config_set_skyeye_cmptname(log_producer_config* config, char* cmptname);
  96. /**
  97. * 天眼日志必填要求字段: 终端号
  98. */
  99. LOG_EXPORT void log_producer_config_set_skyeye_terminalNo(log_producer_config* config, char* terminalNo);
  100. /**
  101. * 天眼日志必填要求字段: 日志版本号
  102. */
  103. LOG_EXPORT void log_producer_config_set_skyeye_version(log_producer_config* config, char* version);
  104. /**
  105. * 天眼日志必填要求字段: 终端UUID,终端唯一标识,例如:260ABB7100040505
  106. */
  107. LOG_EXPORT void log_producer_config_set_skyeye_sn(log_producer_config* config, char* sn);
  108. /**
  109. * 天眼日志必填要求字段:实体ID,例如:13
  110. */
  111. LOG_EXPORT void log_producer_config_set_skyeye_item(log_producer_config* config, char* item);
  112. /**
  113. * 天眼日志必填要求字段:实体名称,例如:SelfChecker
  114. */
  115. LOG_EXPORT void log_producer_config_set_skyeye_entityname(log_producer_config* config, char* entityname);
  116. LOG_EXPORT void log_producer_config_set_united_appname(log_producer_config* config, char* appname);
  117. LOG_EXPORT void log_producer_config_set_united_version(log_producer_config* config, char* version);
  118. LOG_EXPORT void log_producer_config_set_united_needArchived(log_producer_config* config, int needArchived);
  119. LOG_EXPORT void log_producer_config_set_united_deployUnitId(log_producer_config* config, char* deployUnitId);
  120. LOG_EXPORT void log_producer_config_set_united_serviceUnitId(log_producer_config* config, char* serviceUnitId);
  121. LOG_EXPORT void log_producer_config_get_upload_info(unsigned long *t_upload_TerminalSys_Suc, unsigned long *t_upload_TerminalUser_Suc,
  122. unsigned long *t_upload_BussinessSys_Suc, unsigned long *t_upload_BussinessUser_Suc, unsigned long *t_upload_beidou_Suc,
  123. unsigned long* t_upload_TerminalSys_Err, unsigned long* t_upload_TerminalUser_Err,
  124. unsigned long* t_upload_BussinessSys_Err, unsigned long* t_upload_BussinessUser_Err, unsigned long* t_upload_beidou_Err);
  125. typedef void (*dbg_callback)(const char*);
  126. extern dbg_callback g_callback;
  127. // 日志回调函数
  128. LOG_EXPORT void log_producer_config_set_dbgFun(dbg_callback t_callback);
  129. LOG_EXPORT void log_producer_config_set_send_thread_wait_ms(log_producer_config* config, int32_t ts);
  130. /**
  131. * set producer config endpoint
  132. * @note if endpoint start with "https", then set using_https 1
  133. * @note strlen(endpoint) must >= 8
  134. * @param config
  135. * @param endpoint
  136. */
  137. LOG_EXPORT void log_producer_config_set_endpoint(log_producer_config* config, const char* endpoint);
  138. /**
  139. * default http, 0 http, 1 https
  140. * @param config
  141. * @param using_https
  142. */
  143. LOG_EXPORT void log_producer_config_set_using_http(log_producer_config* config, int32_t using_https);
  144. /**
  145. * set producer config topic
  146. * @param config
  147. * @param topic
  148. */
  149. LOG_EXPORT void log_producer_config_set_skyeye_user_topic(log_producer_config* config, const char* topic);
  150. LOG_EXPORT void log_producer_config_set_skyeye_sys_topic(log_producer_config* config, const char* topic);
  151. LOG_EXPORT void log_producer_config_set_beidou_topic(log_producer_config* config, const char* topic);
  152. LOG_EXPORT void log_producer_config_set_business_user_topic(log_producer_config* config, const char* topic);
  153. LOG_EXPORT void log_producer_config_set_business_sys_topic(log_producer_config* config, const char* topic);
  154. LOG_EXPORT void log_producer_config_set_vtmweb_topic(log_producer_config* config, const char* topic);
  155. /**
  156. * set loggroup max log count, if loggoup's logs count >= log_count, current loggroup will been flushed out
  157. * @param config
  158. * @param log_count
  159. */
  160. LOG_EXPORT void log_producer_config_set_packet_log_count(log_producer_config* config, int32_t log_count);
  161. /**
  162. * set loggroup max log bytes, if loggoup's log bytes >= log_bytes, current loggroup will been flushed out
  163. * @param config
  164. * @param log_bytes
  165. */
  166. LOG_EXPORT void log_producer_config_set_packet_log_bytes(log_producer_config* config, int32_t log_bytes);
  167. /**
  168. * set max buffer size, if total buffer size > max_buffer_bytes, all send will fail immediately
  169. * @param config
  170. * @param max_buffer_bytes
  171. */
  172. LOG_EXPORT void log_producer_config_set_max_buffer_limit(log_producer_config* config, int64_t max_buffer_bytes);
  173. /**
  174. * set send thread count, default is 0.
  175. * @note if thread count is 0, flusher thread is in the charge of send logs.
  176. * @note if thread count > 1, then producer will create $(thread_count) threads to send logs.
  177. * @param config
  178. * @param thread_count
  179. */
  180. LOG_EXPORT void log_producer_config_set_send_thread_count(log_producer_config* config, int32_t thread_count);
  181. /**
  182. * set connect timeout seconds
  183. * @param config
  184. * @param connect_timeout_sec
  185. */
  186. LOG_EXPORT void log_producer_config_set_connect_timeout_sec(log_producer_config* config, int32_t connect_timeout_sec);
  187. /**
  188. * set send timeout seconds
  189. * @param config
  190. * @param send_timeout_sec
  191. */
  192. LOG_EXPORT void log_producer_config_set_send_timeout_sec(log_producer_config* config, int32_t send_timeout_sec);
  193. /**
  194. * set wait seconds when destroy flusher
  195. * @param config
  196. * @param destroy_flusher_wait_sec
  197. */
  198. LOG_EXPORT void log_producer_config_set_destroy_flusher_wait_sec(log_producer_config* config, int32_t destroy_flusher_wait_sec);
  199. /**
  200. * set wait seconds when destroy sender
  201. * @param config
  202. * @param destroy_sender_wait_sec
  203. */
  204. LOG_EXPORT void log_producer_config_set_destroy_sender_wait_sec(log_producer_config* config, int32_t destroy_sender_wait_sec);
  205. /**
  206. * set compress type, default 1 (lz4)
  207. * @param config
  208. * @param compress_type only support 1 or 0. 1 -> lz4, 0 -> no compress
  209. */
  210. LOG_EXPORT void log_producer_config_set_compress_type(log_producer_config* config, int32_t compress_type);
  211. /**
  212. * set time offset between local time and server ntp time
  213. * @param config
  214. * @param ntp_time_diff
  215. */
  216. LOG_EXPORT void log_producer_config_set_ntp_time_offset(log_producer_config* config, int32_t ntp_time_offset);
  217. /**
  218. * set persistent flag, 0 disable, 1 enable
  219. * @param config
  220. * @param persistent
  221. */
  222. LOG_EXPORT void log_producer_config_set_persistent(log_producer_config* config, int32_t persistent);
  223. LOG_EXPORT void log_producer_config_set_persistent_encrypt(log_producer_config* config, int32_t enable);
  224. LOG_EXPORT void log_producer_config_set_persistent_encrypt_password(log_producer_config* config, char* password);
  225. LOG_EXPORT void log_producer_config_set_openDb(log_producer_config* config, int32_t openDB);
  226. /**
  227. * set persistent file path
  228. * @param config
  229. * @param file_path full file path, eg : "app\\test\\data"
  230. * @note the file dir must exist
  231. */
  232. LOG_EXPORT void log_producer_config_set_persistent_file_path(log_producer_config* config, const char* file_path);
  233. /**
  234. * set max log count saved in disk
  235. * @param config
  236. * @param max_log_count
  237. */
  238. LOG_EXPORT void log_producer_config_set_persistent_max_log_count(log_producer_config* config, int32_t max_log_count);
  239. LOG_EXPORT void log_producer_config_switch_debug_mode(log_producer_config* config, int32_t switch_on);
  240. /*
  241. * param:memory_deal_type
  242. 0: open only
  243. 1: create if not exist and then open
  244. 2: create, if it has exists before, re-create and open it
  245. */
  246. LOG_EXPORT void log_producer_config_memory_deal_type(log_producer_config* config, int32_t memory_deal_type);
  247. /**
  248. * destroy config, this will free all memory allocated by this config
  249. * @param config
  250. */
  251. LOG_EXPORT void destroy_log_producer_config(log_producer_config* config);
  252. #ifdef LOG_PRODUCER_DEBUG
  253. /**
  254. * print this config
  255. * @param config
  256. */
  257. void log_producer_config_print(log_producer_config* config, FILE* pFile);
  258. #endif
  259. /**
  260. * check if given config is valid
  261. * @param config
  262. * @return 1 valid, 0 invalid
  263. */
  264. LOG_EXPORT int log_producer_config_is_valid(log_producer_config* config);
  265. /**
  266. *
  267. * @return
  268. */
  269. LOG_EXPORT int log_producer_persistent_config_is_enabled(log_producer_config* config);
  270. LOG_CPP_END
  271. #endif