web_api_v1.c 65 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680
  1. // SPDX-License-Identifier: GPL-3.0-or-later
  2. #include "web_api_v1.h"
  3. char *api_secret;
  4. static struct {
  5. const char *name;
  6. uint32_t hash;
  7. RRDR_OPTIONS value;
  8. } api_v1_data_options[] = {
  9. { "nonzero" , 0 , RRDR_OPTION_NONZERO}
  10. , {"flip" , 0 , RRDR_OPTION_REVERSED}
  11. , {"reversed" , 0 , RRDR_OPTION_REVERSED}
  12. , {"reverse" , 0 , RRDR_OPTION_REVERSED}
  13. , {"jsonwrap" , 0 , RRDR_OPTION_JSON_WRAP}
  14. , {"min2max" , 0 , RRDR_OPTION_MIN2MAX}
  15. , {"ms" , 0 , RRDR_OPTION_MILLISECONDS}
  16. , {"milliseconds" , 0 , RRDR_OPTION_MILLISECONDS}
  17. , {"abs" , 0 , RRDR_OPTION_ABSOLUTE}
  18. , {"absolute" , 0 , RRDR_OPTION_ABSOLUTE}
  19. , {"absolute_sum" , 0 , RRDR_OPTION_ABSOLUTE}
  20. , {"absolute-sum" , 0 , RRDR_OPTION_ABSOLUTE}
  21. , {"display_absolute" , 0 , RRDR_OPTION_DISPLAY_ABS}
  22. , {"display-absolute" , 0 , RRDR_OPTION_DISPLAY_ABS}
  23. , {"seconds" , 0 , RRDR_OPTION_SECONDS}
  24. , {"null2zero" , 0 , RRDR_OPTION_NULL2ZERO}
  25. , {"objectrows" , 0 , RRDR_OPTION_OBJECTSROWS}
  26. , {"google_json" , 0 , RRDR_OPTION_GOOGLE_JSON}
  27. , {"google-json" , 0 , RRDR_OPTION_GOOGLE_JSON}
  28. , {"percentage" , 0 , RRDR_OPTION_PERCENTAGE}
  29. , {"unaligned" , 0 , RRDR_OPTION_NOT_ALIGNED}
  30. , {"match_ids" , 0 , RRDR_OPTION_MATCH_IDS}
  31. , {"match-ids" , 0 , RRDR_OPTION_MATCH_IDS}
  32. , {"match_names" , 0 , RRDR_OPTION_MATCH_NAMES}
  33. , {"match-names" , 0 , RRDR_OPTION_MATCH_NAMES}
  34. , {"anomaly-bit" , 0 , RRDR_OPTION_ANOMALY_BIT}
  35. , {"selected-tier" , 0 , RRDR_OPTION_SELECTED_TIER}
  36. , {"raw" , 0 , RRDR_OPTION_RETURN_RAW}
  37. , {"jw-anomaly-rates" , 0 , RRDR_OPTION_RETURN_JWAR}
  38. , {"natural-points" , 0 , RRDR_OPTION_NATURAL_POINTS}
  39. , {"virtual-points" , 0 , RRDR_OPTION_VIRTUAL_POINTS}
  40. , {"all-dimensions" , 0 , RRDR_OPTION_ALL_DIMENSIONS}
  41. , {"plan" , 0 , RRDR_OPTION_SHOW_PLAN}
  42. , {NULL , 0 , 0}
  43. };
  44. static struct {
  45. const char *name;
  46. uint32_t hash;
  47. DATASOURCE_FORMAT value;
  48. } api_v1_data_formats[] = {
  49. { DATASOURCE_FORMAT_DATATABLE_JSON , 0 , DATASOURCE_DATATABLE_JSON}
  50. , {DATASOURCE_FORMAT_DATATABLE_JSONP, 0 , DATASOURCE_DATATABLE_JSONP}
  51. , {DATASOURCE_FORMAT_JSON , 0 , DATASOURCE_JSON}
  52. , {DATASOURCE_FORMAT_JSONP , 0 , DATASOURCE_JSONP}
  53. , {DATASOURCE_FORMAT_SSV , 0 , DATASOURCE_SSV}
  54. , {DATASOURCE_FORMAT_CSV , 0 , DATASOURCE_CSV}
  55. , {DATASOURCE_FORMAT_TSV , 0 , DATASOURCE_TSV}
  56. , {"tsv-excel" , 0 , DATASOURCE_TSV}
  57. , {DATASOURCE_FORMAT_HTML , 0 , DATASOURCE_HTML}
  58. , {DATASOURCE_FORMAT_JS_ARRAY , 0 , DATASOURCE_JS_ARRAY}
  59. , {DATASOURCE_FORMAT_SSV_COMMA , 0 , DATASOURCE_SSV_COMMA}
  60. , {DATASOURCE_FORMAT_CSV_JSON_ARRAY , 0 , DATASOURCE_CSV_JSON_ARRAY}
  61. , {DATASOURCE_FORMAT_CSV_MARKDOWN , 0 , DATASOURCE_CSV_MARKDOWN}
  62. , { NULL, 0, 0}
  63. };
  64. static struct {
  65. const char *name;
  66. uint32_t hash;
  67. DATASOURCE_FORMAT value;
  68. } api_v1_data_google_formats[] = {
  69. // this is not error - when google requests json, it expects javascript
  70. // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source#responseformat
  71. { "json" , 0 , DATASOURCE_DATATABLE_JSONP}
  72. , {"html" , 0 , DATASOURCE_HTML}
  73. , {"csv" , 0 , DATASOURCE_CSV}
  74. , {"tsv-excel", 0 , DATASOURCE_TSV}
  75. , { NULL, 0, 0}
  76. };
  77. void web_client_api_v1_init(void) {
  78. int i;
  79. for(i = 0; api_v1_data_options[i].name ; i++)
  80. api_v1_data_options[i].hash = simple_hash(api_v1_data_options[i].name);
  81. for(i = 0; api_v1_data_formats[i].name ; i++)
  82. api_v1_data_formats[i].hash = simple_hash(api_v1_data_formats[i].name);
  83. for(i = 0; api_v1_data_google_formats[i].name ; i++)
  84. api_v1_data_google_formats[i].hash = simple_hash(api_v1_data_google_formats[i].name);
  85. web_client_api_v1_init_grouping();
  86. uuid_t uuid;
  87. // generate
  88. uuid_generate(uuid);
  89. // unparse (to string)
  90. char uuid_str[37];
  91. uuid_unparse_lower(uuid, uuid_str);
  92. }
  93. char *get_mgmt_api_key(void) {
  94. char filename[FILENAME_MAX + 1];
  95. snprintfz(filename, FILENAME_MAX, "%s/netdata.api.key", netdata_configured_varlib_dir);
  96. char *api_key_filename=config_get(CONFIG_SECTION_REGISTRY, "netdata management api key file", filename);
  97. static char guid[GUID_LEN + 1] = "";
  98. if(likely(guid[0]))
  99. return guid;
  100. // read it from disk
  101. int fd = open(api_key_filename, O_RDONLY);
  102. if(fd != -1) {
  103. char buf[GUID_LEN + 1];
  104. if(read(fd, buf, GUID_LEN) != GUID_LEN)
  105. error("Failed to read management API key from '%s'", api_key_filename);
  106. else {
  107. buf[GUID_LEN] = '\0';
  108. if(regenerate_guid(buf, guid) == -1) {
  109. error("Failed to validate management API key '%s' from '%s'.",
  110. buf, api_key_filename);
  111. guid[0] = '\0';
  112. }
  113. }
  114. close(fd);
  115. }
  116. // generate a new one?
  117. if(!guid[0]) {
  118. uuid_t uuid;
  119. uuid_generate_time(uuid);
  120. uuid_unparse_lower(uuid, guid);
  121. guid[GUID_LEN] = '\0';
  122. // save it
  123. fd = open(api_key_filename, O_WRONLY|O_CREAT|O_TRUNC, 444);
  124. if(fd == -1) {
  125. error("Cannot create unique management API key file '%s'. Please adjust config parameter 'netdata management api key file' to a proper path and file.", api_key_filename);
  126. goto temp_key;
  127. }
  128. if(write(fd, guid, GUID_LEN) != GUID_LEN) {
  129. error("Cannot write the unique management API key file '%s'. Please adjust config parameter 'netdata management api key file' to a proper path and file with enough space left.", api_key_filename);
  130. close(fd);
  131. goto temp_key;
  132. }
  133. close(fd);
  134. }
  135. return guid;
  136. temp_key:
  137. info("You can still continue to use the alarm management API using the authorization token %s during this Netdata session only.", guid);
  138. return guid;
  139. }
  140. void web_client_api_v1_management_init(void) {
  141. api_secret = get_mgmt_api_key();
  142. }
  143. inline RRDR_OPTIONS web_client_api_request_v1_data_options(char *o) {
  144. RRDR_OPTIONS ret = 0x00000000;
  145. char *tok;
  146. while(o && *o && (tok = mystrsep(&o, ", |"))) {
  147. if(!*tok) continue;
  148. uint32_t hash = simple_hash(tok);
  149. int i;
  150. for(i = 0; api_v1_data_options[i].name ; i++) {
  151. if (unlikely(hash == api_v1_data_options[i].hash && !strcmp(tok, api_v1_data_options[i].name))) {
  152. ret |= api_v1_data_options[i].value;
  153. break;
  154. }
  155. }
  156. }
  157. return ret;
  158. }
  159. void web_client_api_request_v1_data_options_to_buffer(BUFFER *wb, RRDR_OPTIONS options) {
  160. RRDR_OPTIONS used = 0; // to prevent adding duplicates
  161. int added = 0;
  162. for(int i = 0; api_v1_data_options[i].name ; i++) {
  163. if (unlikely((api_v1_data_options[i].value & options) && !(api_v1_data_options[i].value & used))) {
  164. const char *name = api_v1_data_options[i].name;
  165. used |= api_v1_data_options[i].value;
  166. if(added) buffer_strcat(wb, ",");
  167. buffer_strcat(wb, name);
  168. added++;
  169. }
  170. }
  171. }
  172. void web_client_api_request_v1_data_options_to_string(char *buf, size_t size, RRDR_OPTIONS options) {
  173. char *write = buf;
  174. char *end = &buf[size - 1];
  175. RRDR_OPTIONS used = 0; // to prevent adding duplicates
  176. int added = 0;
  177. for(int i = 0; api_v1_data_options[i].name ; i++) {
  178. if (unlikely((api_v1_data_options[i].value & options) && !(api_v1_data_options[i].value & used))) {
  179. const char *name = api_v1_data_options[i].name;
  180. used |= api_v1_data_options[i].value;
  181. if(added && write < end)
  182. *write++ = ',';
  183. while(*name && write < end)
  184. *write++ = *name++;
  185. added++;
  186. }
  187. }
  188. *write = *end = '\0';
  189. }
  190. inline DATASOURCE_FORMAT web_client_api_request_v1_data_format(char *name) {
  191. uint32_t hash = simple_hash(name);
  192. int i;
  193. for(i = 0; api_v1_data_formats[i].name ; i++) {
  194. if (unlikely(hash == api_v1_data_formats[i].hash && !strcmp(name, api_v1_data_formats[i].name))) {
  195. return api_v1_data_formats[i].value;
  196. }
  197. }
  198. return DATASOURCE_JSON;
  199. }
  200. inline uint32_t web_client_api_request_v1_data_google_format(char *name) {
  201. uint32_t hash = simple_hash(name);
  202. int i;
  203. for(i = 0; api_v1_data_google_formats[i].name ; i++) {
  204. if (unlikely(hash == api_v1_data_google_formats[i].hash && !strcmp(name, api_v1_data_google_formats[i].name))) {
  205. return api_v1_data_google_formats[i].value;
  206. }
  207. }
  208. return DATASOURCE_JSON;
  209. }
  210. int web_client_api_request_v1_alarms_select (char *url) {
  211. int all = 0;
  212. while(url) {
  213. char *value = mystrsep(&url, "&");
  214. if (!value || !*value) continue;
  215. if(!strcmp(value, "all")) all = 1;
  216. else if(!strcmp(value, "active")) all = 0;
  217. }
  218. return all;
  219. }
  220. inline int web_client_api_request_v1_alarms(RRDHOST *host, struct web_client *w, char *url) {
  221. int all = web_client_api_request_v1_alarms_select(url);
  222. buffer_flush(w->response.data);
  223. w->response.data->contenttype = CT_APPLICATION_JSON;
  224. health_alarms2json(host, w->response.data, all);
  225. buffer_no_cacheable(w->response.data);
  226. return HTTP_RESP_OK;
  227. }
  228. inline int web_client_api_request_v1_alarms_values(RRDHOST *host, struct web_client *w, char *url) {
  229. int all = web_client_api_request_v1_alarms_select(url);
  230. buffer_flush(w->response.data);
  231. w->response.data->contenttype = CT_APPLICATION_JSON;
  232. health_alarms_values2json(host, w->response.data, all);
  233. buffer_no_cacheable(w->response.data);
  234. return HTTP_RESP_OK;
  235. }
  236. inline int web_client_api_request_v1_alarm_count(RRDHOST *host, struct web_client *w, char *url) {
  237. RRDCALC_STATUS status = RRDCALC_STATUS_RAISED;
  238. BUFFER *contexts = NULL;
  239. buffer_flush(w->response.data);
  240. buffer_sprintf(w->response.data, "[");
  241. while(url) {
  242. char *value = mystrsep(&url, "&");
  243. if(!value || !*value) continue;
  244. char *name = mystrsep(&value, "=");
  245. if(!name || !*name) continue;
  246. if(!value || !*value) continue;
  247. debug(D_WEB_CLIENT, "%llu: API v1 alarm_count query param '%s' with value '%s'", w->id, name, value);
  248. char* p = value;
  249. if(!strcmp(name, "status")) {
  250. while ((*p = toupper(*p))) p++;
  251. if (!strcmp("CRITICAL", value)) status = RRDCALC_STATUS_CRITICAL;
  252. else if (!strcmp("WARNING", value)) status = RRDCALC_STATUS_WARNING;
  253. else if (!strcmp("UNINITIALIZED", value)) status = RRDCALC_STATUS_UNINITIALIZED;
  254. else if (!strcmp("UNDEFINED", value)) status = RRDCALC_STATUS_UNDEFINED;
  255. else if (!strcmp("REMOVED", value)) status = RRDCALC_STATUS_REMOVED;
  256. else if (!strcmp("CLEAR", value)) status = RRDCALC_STATUS_CLEAR;
  257. }
  258. else if(!strcmp(name, "context") || !strcmp(name, "ctx")) {
  259. if(!contexts) contexts = buffer_create(255, &netdata_buffers_statistics.buffers_api);
  260. buffer_strcat(contexts, "|");
  261. buffer_strcat(contexts, value);
  262. }
  263. }
  264. health_aggregate_alarms(host, w->response.data, contexts, status);
  265. buffer_sprintf(w->response.data, "]\n");
  266. w->response.data->contenttype = CT_APPLICATION_JSON;
  267. buffer_no_cacheable(w->response.data);
  268. buffer_free(contexts);
  269. return 200;
  270. }
  271. inline int web_client_api_request_v1_alarm_log(RRDHOST *host, struct web_client *w, char *url) {
  272. uint32_t after = 0;
  273. char *chart = NULL;
  274. while(url) {
  275. char *value = mystrsep(&url, "&");
  276. if (!value || !*value) continue;
  277. char *name = mystrsep(&value, "=");
  278. if(!name || !*name) continue;
  279. if(!value || !*value) continue;
  280. if (!strcmp(name, "after")) after = (uint32_t)strtoul(value, NULL, 0);
  281. else if (!strcmp(name, "chart")) chart = value;
  282. }
  283. buffer_flush(w->response.data);
  284. w->response.data->contenttype = CT_APPLICATION_JSON;
  285. health_alarm_log2json(host, w->response.data, after, chart);
  286. return HTTP_RESP_OK;
  287. }
  288. inline int web_client_api_request_single_chart(RRDHOST *host, struct web_client *w, char *url, void callback(RRDSET *st, BUFFER *buf)) {
  289. int ret = HTTP_RESP_BAD_REQUEST;
  290. char *chart = NULL;
  291. buffer_flush(w->response.data);
  292. while(url) {
  293. char *value = mystrsep(&url, "&");
  294. if(!value || !*value) continue;
  295. char *name = mystrsep(&value, "=");
  296. if(!name || !*name) continue;
  297. if(!value || !*value) continue;
  298. // name and value are now the parameters
  299. // they are not null and not empty
  300. if(!strcmp(name, "chart")) chart = value;
  301. //else {
  302. /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
  303. // goto cleanup;
  304. //}
  305. }
  306. if(!chart || !*chart) {
  307. buffer_sprintf(w->response.data, "No chart id is given at the request.");
  308. goto cleanup;
  309. }
  310. RRDSET *st = rrdset_find(host, chart);
  311. if(!st) st = rrdset_find_byname(host, chart);
  312. if(!st) {
  313. buffer_strcat(w->response.data, "Chart is not found: ");
  314. buffer_strcat_htmlescape(w->response.data, chart);
  315. ret = HTTP_RESP_NOT_FOUND;
  316. goto cleanup;
  317. }
  318. w->response.data->contenttype = CT_APPLICATION_JSON;
  319. st->last_accessed_time_s = now_realtime_sec();
  320. callback(st, w->response.data);
  321. return HTTP_RESP_OK;
  322. cleanup:
  323. return ret;
  324. }
  325. inline int web_client_api_request_v1_alarm_variables(RRDHOST *host, struct web_client *w, char *url) {
  326. return web_client_api_request_single_chart(host, w, url, health_api_v1_chart_variables2json);
  327. }
  328. static RRDCONTEXT_TO_JSON_OPTIONS rrdcontext_to_json_parse_options(char *o) {
  329. RRDCONTEXT_TO_JSON_OPTIONS options = RRDCONTEXT_OPTION_NONE;
  330. char *tok;
  331. while(o && *o && (tok = mystrsep(&o, ", |"))) {
  332. if(!*tok) continue;
  333. if(!strcmp(tok, "full") || !strcmp(tok, "all"))
  334. options |= RRDCONTEXT_OPTIONS_ALL;
  335. else if(!strcmp(tok, "charts") || !strcmp(tok, "instances"))
  336. options |= RRDCONTEXT_OPTION_SHOW_INSTANCES;
  337. else if(!strcmp(tok, "dimensions") || !strcmp(tok, "metrics"))
  338. options |= RRDCONTEXT_OPTION_SHOW_METRICS;
  339. else if(!strcmp(tok, "queue"))
  340. options |= RRDCONTEXT_OPTION_SHOW_QUEUED;
  341. else if(!strcmp(tok, "flags"))
  342. options |= RRDCONTEXT_OPTION_SHOW_FLAGS;
  343. else if(!strcmp(tok, "uuids"))
  344. options |= RRDCONTEXT_OPTION_SHOW_UUIDS;
  345. else if(!strcmp(tok, "deleted"))
  346. options |= RRDCONTEXT_OPTION_SHOW_DELETED;
  347. else if(!strcmp(tok, "labels"))
  348. options |= RRDCONTEXT_OPTION_SHOW_LABELS;
  349. else if(!strcmp(tok, "deepscan"))
  350. options |= RRDCONTEXT_OPTION_DEEPSCAN;
  351. else if(!strcmp(tok, "hidden"))
  352. options |= RRDCONTEXT_OPTION_SHOW_HIDDEN;
  353. }
  354. return options;
  355. }
  356. static int web_client_api_request_v1_context(RRDHOST *host, struct web_client *w, char *url) {
  357. char *context = NULL;
  358. RRDCONTEXT_TO_JSON_OPTIONS options = RRDCONTEXT_OPTION_NONE;
  359. time_t after = 0, before = 0;
  360. const char *chart_label_key = NULL, *chart_labels_filter = NULL;
  361. BUFFER *dimensions = NULL;
  362. buffer_flush(w->response.data);
  363. while(url) {
  364. char *value = mystrsep(&url, "&");
  365. if(!value || !*value) continue;
  366. char *name = mystrsep(&value, "=");
  367. if(!name || !*name) continue;
  368. if(!value || !*value) continue;
  369. // name and value are now the parameters
  370. // they are not null and not empty
  371. if(!strcmp(name, "context") || !strcmp(name, "ctx")) context = value;
  372. else if(!strcmp(name, "after")) after = str2l(value);
  373. else if(!strcmp(name, "before")) before = str2l(value);
  374. else if(!strcmp(name, "options")) options = rrdcontext_to_json_parse_options(value);
  375. else if(!strcmp(name, "chart_label_key")) chart_label_key = value;
  376. else if(!strcmp(name, "chart_labels_filter")) chart_labels_filter = value;
  377. else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
  378. if(!dimensions) dimensions = buffer_create(100, &netdata_buffers_statistics.buffers_api);
  379. buffer_strcat(dimensions, "|");
  380. buffer_strcat(dimensions, value);
  381. }
  382. }
  383. if(!context || !*context) {
  384. buffer_sprintf(w->response.data, "No context is given at the request.");
  385. return HTTP_RESP_BAD_REQUEST;
  386. }
  387. SIMPLE_PATTERN *chart_label_key_pattern = NULL;
  388. SIMPLE_PATTERN *chart_labels_filter_pattern = NULL;
  389. SIMPLE_PATTERN *chart_dimensions_pattern = NULL;
  390. if(chart_label_key)
  391. chart_label_key_pattern = simple_pattern_create(chart_label_key, ",|\t\r\n\f\v", SIMPLE_PATTERN_EXACT);
  392. if(chart_labels_filter)
  393. chart_labels_filter_pattern = simple_pattern_create(chart_labels_filter, ",|\t\r\n\f\v", SIMPLE_PATTERN_EXACT);
  394. if(dimensions) {
  395. chart_dimensions_pattern = simple_pattern_create(buffer_tostring(dimensions), ",|\t\r\n\f\v", SIMPLE_PATTERN_EXACT);
  396. buffer_free(dimensions);
  397. }
  398. w->response.data->contenttype = CT_APPLICATION_JSON;
  399. int ret = rrdcontext_to_json(host, w->response.data, after, before, options, context, chart_label_key_pattern, chart_labels_filter_pattern, chart_dimensions_pattern);
  400. simple_pattern_free(chart_label_key_pattern);
  401. simple_pattern_free(chart_labels_filter_pattern);
  402. simple_pattern_free(chart_dimensions_pattern);
  403. return ret;
  404. }
  405. static int web_client_api_request_v1_contexts(RRDHOST *host, struct web_client *w, char *url) {
  406. RRDCONTEXT_TO_JSON_OPTIONS options = RRDCONTEXT_OPTION_NONE;
  407. time_t after = 0, before = 0;
  408. const char *chart_label_key = NULL, *chart_labels_filter = NULL;
  409. BUFFER *dimensions = NULL;
  410. buffer_flush(w->response.data);
  411. while(url) {
  412. char *value = mystrsep(&url, "&");
  413. if(!value || !*value) continue;
  414. char *name = mystrsep(&value, "=");
  415. if(!name || !*name) continue;
  416. if(!value || !*value) continue;
  417. // name and value are now the parameters
  418. // they are not null and not empty
  419. if(!strcmp(name, "after")) after = str2l(value);
  420. else if(!strcmp(name, "before")) before = str2l(value);
  421. else if(!strcmp(name, "options")) options = rrdcontext_to_json_parse_options(value);
  422. else if(!strcmp(name, "chart_label_key")) chart_label_key = value;
  423. else if(!strcmp(name, "chart_labels_filter")) chart_labels_filter = value;
  424. else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
  425. if(!dimensions) dimensions = buffer_create(100, &netdata_buffers_statistics.buffers_api);
  426. buffer_strcat(dimensions, "|");
  427. buffer_strcat(dimensions, value);
  428. }
  429. }
  430. SIMPLE_PATTERN *chart_label_key_pattern = NULL;
  431. SIMPLE_PATTERN *chart_labels_filter_pattern = NULL;
  432. SIMPLE_PATTERN *chart_dimensions_pattern = NULL;
  433. if(chart_label_key)
  434. chart_label_key_pattern = simple_pattern_create(chart_label_key, ",|\t\r\n\f\v", SIMPLE_PATTERN_EXACT);
  435. if(chart_labels_filter)
  436. chart_labels_filter_pattern = simple_pattern_create(chart_labels_filter, ",|\t\r\n\f\v", SIMPLE_PATTERN_EXACT);
  437. if(dimensions) {
  438. chart_dimensions_pattern = simple_pattern_create(buffer_tostring(dimensions), ",|\t\r\n\f\v", SIMPLE_PATTERN_EXACT);
  439. buffer_free(dimensions);
  440. }
  441. w->response.data->contenttype = CT_APPLICATION_JSON;
  442. int ret = rrdcontexts_to_json(host, w->response.data, after, before, options, chart_label_key_pattern, chart_labels_filter_pattern, chart_dimensions_pattern);
  443. simple_pattern_free(chart_label_key_pattern);
  444. simple_pattern_free(chart_labels_filter_pattern);
  445. simple_pattern_free(chart_dimensions_pattern);
  446. return ret;
  447. }
  448. inline int web_client_api_request_v1_charts(RRDHOST *host, struct web_client *w, char *url) {
  449. (void)url;
  450. buffer_flush(w->response.data);
  451. w->response.data->contenttype = CT_APPLICATION_JSON;
  452. charts2json(host, w->response.data, 0, 0);
  453. return HTTP_RESP_OK;
  454. }
  455. inline int web_client_api_request_v1_chart(RRDHOST *host, struct web_client *w, char *url) {
  456. return web_client_api_request_single_chart(host, w, url, rrd_stats_api_v1_chart);
  457. }
  458. void fix_google_param(char *s) {
  459. if(unlikely(!s)) return;
  460. for( ; *s ;s++) {
  461. if(!isalnum(*s) && *s != '.' && *s != '_' && *s != '-')
  462. *s = '_';
  463. }
  464. }
  465. // returns the HTTP code
  466. inline int web_client_api_request_v1_data(RRDHOST *host, struct web_client *w, char *url) {
  467. debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
  468. int ret = HTTP_RESP_BAD_REQUEST;
  469. BUFFER *dimensions = NULL;
  470. buffer_flush(w->response.data);
  471. char *google_version = "0.6",
  472. *google_reqId = "0",
  473. *google_sig = "0",
  474. *google_out = "json",
  475. *responseHandler = NULL,
  476. *outFileName = NULL;
  477. time_t last_timestamp_in_data = 0, google_timestamp = 0;
  478. char *chart = NULL;
  479. char *before_str = NULL;
  480. char *after_str = NULL;
  481. char *group_time_str = NULL;
  482. char *points_str = NULL;
  483. char *timeout_str = NULL;
  484. char *context = NULL;
  485. char *chart_label_key = NULL;
  486. char *chart_labels_filter = NULL;
  487. char *group_options = NULL;
  488. size_t tier = 0;
  489. RRDR_GROUPING group = RRDR_GROUPING_AVERAGE;
  490. DATASOURCE_FORMAT format = DATASOURCE_JSON;
  491. RRDR_OPTIONS options = 0;
  492. while(url) {
  493. char *value = mystrsep(&url, "&");
  494. if(!value || !*value) continue;
  495. char *name = mystrsep(&value, "=");
  496. if(!name || !*name) continue;
  497. if(!value || !*value) continue;
  498. debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
  499. // name and value are now the parameters
  500. // they are not null and not empty
  501. if(!strcmp(name, "context")) context = value;
  502. else if(!strcmp(name, "chart_label_key")) chart_label_key = value;
  503. else if(!strcmp(name, "chart_labels_filter")) chart_labels_filter = value;
  504. else if(!strcmp(name, "chart")) chart = value;
  505. else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
  506. if(!dimensions) dimensions = buffer_create(100, &netdata_buffers_statistics.buffers_api);
  507. buffer_strcat(dimensions, "|");
  508. buffer_strcat(dimensions, value);
  509. }
  510. else if(!strcmp(name, "show_dimensions")) options |= RRDR_OPTION_ALL_DIMENSIONS;
  511. else if(!strcmp(name, "after")) after_str = value;
  512. else if(!strcmp(name, "before")) before_str = value;
  513. else if(!strcmp(name, "points")) points_str = value;
  514. else if(!strcmp(name, "timeout")) timeout_str = value;
  515. else if(!strcmp(name, "gtime")) group_time_str = value;
  516. else if(!strcmp(name, "group_options")) group_options = value;
  517. else if(!strcmp(name, "group")) {
  518. group = web_client_api_request_v1_data_group(value, RRDR_GROUPING_AVERAGE);
  519. }
  520. else if(!strcmp(name, "format")) {
  521. format = web_client_api_request_v1_data_format(value);
  522. }
  523. else if(!strcmp(name, "options")) {
  524. options |= web_client_api_request_v1_data_options(value);
  525. }
  526. else if(!strcmp(name, "callback")) {
  527. responseHandler = value;
  528. }
  529. else if(!strcmp(name, "filename")) {
  530. outFileName = value;
  531. }
  532. else if(!strcmp(name, "tqx")) {
  533. // parse Google Visualization API options
  534. // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
  535. char *tqx_name, *tqx_value;
  536. while(value) {
  537. tqx_value = mystrsep(&value, ";");
  538. if(!tqx_value || !*tqx_value) continue;
  539. tqx_name = mystrsep(&tqx_value, ":");
  540. if(!tqx_name || !*tqx_name) continue;
  541. if(!tqx_value || !*tqx_value) continue;
  542. if(!strcmp(tqx_name, "version"))
  543. google_version = tqx_value;
  544. else if(!strcmp(tqx_name, "reqId"))
  545. google_reqId = tqx_value;
  546. else if(!strcmp(tqx_name, "sig")) {
  547. google_sig = tqx_value;
  548. google_timestamp = strtoul(google_sig, NULL, 0);
  549. }
  550. else if(!strcmp(tqx_name, "out")) {
  551. google_out = tqx_value;
  552. format = web_client_api_request_v1_data_google_format(google_out);
  553. }
  554. else if(!strcmp(tqx_name, "responseHandler"))
  555. responseHandler = tqx_value;
  556. else if(!strcmp(tqx_name, "outFileName"))
  557. outFileName = tqx_value;
  558. }
  559. }
  560. else if(!strcmp(name, "tier")) {
  561. tier = str2ul(value);
  562. if(tier < storage_tiers)
  563. options |= RRDR_OPTION_SELECTED_TIER;
  564. else
  565. tier = 0;
  566. }
  567. }
  568. // validate the google parameters given
  569. fix_google_param(google_out);
  570. fix_google_param(google_sig);
  571. fix_google_param(google_reqId);
  572. fix_google_param(google_version);
  573. fix_google_param(responseHandler);
  574. fix_google_param(outFileName);
  575. RRDSET *st = NULL;
  576. ONEWAYALLOC *owa = onewayalloc_create(0);
  577. QUERY_TARGET *qt = NULL;
  578. if(!is_valid_sp(chart) && !is_valid_sp(context)) {
  579. buffer_sprintf(w->response.data, "No chart or context is given.");
  580. goto cleanup;
  581. }
  582. if(chart && !context) {
  583. // check if this is a specific chart
  584. st = rrdset_find(host, chart);
  585. if (!st) st = rrdset_find_byname(host, chart);
  586. }
  587. long long before = (before_str && *before_str)?str2l(before_str):0;
  588. long long after = (after_str && *after_str) ?str2l(after_str):-600;
  589. int points = (points_str && *points_str)?str2i(points_str):0;
  590. int timeout = (timeout_str && *timeout_str)?str2i(timeout_str): 0;
  591. long group_time = (group_time_str && *group_time_str)?str2l(group_time_str):0;
  592. QUERY_TARGET_REQUEST qtr = {
  593. .after = after,
  594. .before = before,
  595. .host = host,
  596. .st = st,
  597. .hosts = NULL,
  598. .contexts = context,
  599. .charts = chart,
  600. .dimensions = (dimensions)?buffer_tostring(dimensions):NULL,
  601. .timeout = timeout,
  602. .points = points,
  603. .format = format,
  604. .options = options,
  605. .group_method = group,
  606. .group_options = group_options,
  607. .resampling_time = group_time,
  608. .tier = tier,
  609. .chart_label_key = chart_label_key,
  610. .charts_labels_filter = chart_labels_filter,
  611. .query_source = QUERY_SOURCE_API_DATA,
  612. .priority = STORAGE_PRIORITY_NORMAL,
  613. };
  614. qt = query_target_create(&qtr);
  615. if(!qt || !qt->query.used) {
  616. buffer_sprintf(w->response.data, "No metrics where matched to query.");
  617. ret = HTTP_RESP_NOT_FOUND;
  618. goto cleanup;
  619. }
  620. if (timeout) {
  621. struct timeval now;
  622. now_realtime_timeval(&now);
  623. int inqueue = (int)dt_usec(&w->tv_in, &now) / 1000;
  624. timeout -= inqueue;
  625. if (timeout <= 0) {
  626. buffer_flush(w->response.data);
  627. buffer_strcat(w->response.data, "Query timeout exceeded");
  628. ret = HTTP_RESP_BACKEND_FETCH_FAILED;
  629. goto cleanup;
  630. }
  631. }
  632. debug(D_WEB_CLIENT, "%llu: API command 'data' for chart '%s', dimensions '%s', after '%lld', before '%lld', points '%d', group '%u', format '%u', options '0x%08x'"
  633. , w->id, chart, (dimensions)?buffer_tostring(dimensions):"", after, before , points, group, format, options);
  634. if(outFileName && *outFileName) {
  635. buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
  636. debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
  637. }
  638. if(format == DATASOURCE_DATATABLE_JSONP) {
  639. if(responseHandler == NULL)
  640. responseHandler = "google.visualization.Query.setResponse";
  641. debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
  642. w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
  643. );
  644. buffer_sprintf(
  645. w->response.data,
  646. "%s({version:'%s',reqId:'%s',status:'ok',sig:'%"PRId64"',table:",
  647. responseHandler,
  648. google_version,
  649. google_reqId,
  650. (int64_t)st->last_updated.tv_sec);
  651. }
  652. else if(format == DATASOURCE_JSONP) {
  653. if(responseHandler == NULL)
  654. responseHandler = "callback";
  655. buffer_strcat(w->response.data, responseHandler);
  656. buffer_strcat(w->response.data, "(");
  657. }
  658. ret = data_query_execute(owa, w->response.data, qt, &last_timestamp_in_data);
  659. if(format == DATASOURCE_DATATABLE_JSONP) {
  660. if(google_timestamp < last_timestamp_in_data)
  661. buffer_strcat(w->response.data, "});");
  662. else {
  663. // the client already has the latest data
  664. buffer_flush(w->response.data);
  665. buffer_sprintf(w->response.data,
  666. "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
  667. responseHandler, google_version, google_reqId);
  668. }
  669. }
  670. else if(format == DATASOURCE_JSONP)
  671. buffer_strcat(w->response.data, ");");
  672. cleanup:
  673. if(qt && qt->used) {
  674. internal_error(true, "QUERY_TARGET: left non-released on query '%s'", qt->id);
  675. query_target_release(qt);
  676. }
  677. onewayalloc_destroy(owa);
  678. buffer_free(dimensions);
  679. return ret;
  680. }
  681. // Pings a netdata server:
  682. // /api/v1/registry?action=hello
  683. //
  684. // Access to a netdata registry:
  685. // /api/v1/registry?action=access&machine=${machine_guid}&name=${hostname}&url=${url}
  686. //
  687. // Delete from a netdata registry:
  688. // /api/v1/registry?action=delete&machine=${machine_guid}&name=${hostname}&url=${url}&delete_url=${delete_url}
  689. //
  690. // Search for the URLs of a machine:
  691. // /api/v1/registry?action=search&machine=${machine_guid}&name=${hostname}&url=${url}&for=${machine_guid}
  692. //
  693. // Impersonate:
  694. // /api/v1/registry?action=switch&machine=${machine_guid}&name=${hostname}&url=${url}&to=${new_person_guid}
  695. inline int web_client_api_request_v1_registry(RRDHOST *host, struct web_client *w, char *url) {
  696. static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
  697. hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
  698. hash_to = 0 /*, hash_redirects = 0 */;
  699. if(unlikely(!hash_action)) {
  700. hash_action = simple_hash("action");
  701. hash_access = simple_hash("access");
  702. hash_hello = simple_hash("hello");
  703. hash_delete = simple_hash("delete");
  704. hash_search = simple_hash("search");
  705. hash_switch = simple_hash("switch");
  706. hash_machine = simple_hash("machine");
  707. hash_url = simple_hash("url");
  708. hash_name = simple_hash("name");
  709. hash_delete_url = simple_hash("delete_url");
  710. hash_for = simple_hash("for");
  711. hash_to = simple_hash("to");
  712. /*
  713. hash_redirects = simple_hash("redirects");
  714. */
  715. }
  716. char person_guid[GUID_LEN + 1] = "";
  717. debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
  718. // TODO
  719. // The browser may send multiple cookies with our id
  720. char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
  721. if(cookie)
  722. strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
  723. char action = '\0';
  724. char *machine_guid = NULL,
  725. *machine_url = NULL,
  726. *url_name = NULL,
  727. *search_machine_guid = NULL,
  728. *delete_url = NULL,
  729. *to_person_guid = NULL;
  730. /*
  731. int redirects = 0;
  732. */
  733. // Don't cache registry responses
  734. buffer_no_cacheable(w->response.data);
  735. while(url) {
  736. char *value = mystrsep(&url, "&");
  737. if (!value || !*value) continue;
  738. char *name = mystrsep(&value, "=");
  739. if (!name || !*name) continue;
  740. if (!value || !*value) continue;
  741. debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
  742. uint32_t hash = simple_hash(name);
  743. if(hash == hash_action && !strcmp(name, "action")) {
  744. uint32_t vhash = simple_hash(value);
  745. if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
  746. else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
  747. else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
  748. else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
  749. else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
  750. #ifdef NETDATA_INTERNAL_CHECKS
  751. else error("unknown registry action '%s'", value);
  752. #endif /* NETDATA_INTERNAL_CHECKS */
  753. }
  754. /*
  755. else if(hash == hash_redirects && !strcmp(name, "redirects"))
  756. redirects = atoi(value);
  757. */
  758. else if(hash == hash_machine && !strcmp(name, "machine"))
  759. machine_guid = value;
  760. else if(hash == hash_url && !strcmp(name, "url"))
  761. machine_url = value;
  762. else if(action == 'A') {
  763. if(hash == hash_name && !strcmp(name, "name"))
  764. url_name = value;
  765. }
  766. else if(action == 'D') {
  767. if(hash == hash_delete_url && !strcmp(name, "delete_url"))
  768. delete_url = value;
  769. }
  770. else if(action == 'S') {
  771. if(hash == hash_for && !strcmp(name, "for"))
  772. search_machine_guid = value;
  773. }
  774. else if(action == 'W') {
  775. if(hash == hash_to && !strcmp(name, "to"))
  776. to_person_guid = value;
  777. }
  778. #ifdef NETDATA_INTERNAL_CHECKS
  779. else error("unused registry URL parameter '%s' with value '%s'", name, value);
  780. #endif /* NETDATA_INTERNAL_CHECKS */
  781. }
  782. if(unlikely(respect_web_browser_do_not_track_policy && web_client_has_donottrack(w))) {
  783. buffer_flush(w->response.data);
  784. buffer_sprintf(w->response.data, "Your web browser is sending 'DNT: 1' (Do Not Track). The registry requires persistent cookies on your browser to work.");
  785. return HTTP_RESP_BAD_REQUEST;
  786. }
  787. if(unlikely(action == 'H')) {
  788. // HELLO request, dashboard ACL
  789. analytics_log_dashboard();
  790. if(unlikely(!web_client_can_access_dashboard(w)))
  791. return web_client_permission_denied(w);
  792. }
  793. else {
  794. // everything else, registry ACL
  795. if(unlikely(!web_client_can_access_registry(w)))
  796. return web_client_permission_denied(w);
  797. }
  798. switch(action) {
  799. case 'A':
  800. if(unlikely(!machine_guid || !machine_url || !url_name)) {
  801. error("Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')", machine_guid ? machine_guid : "UNSET", machine_url ? machine_url : "UNSET", url_name ? url_name : "UNSET");
  802. buffer_flush(w->response.data);
  803. buffer_strcat(w->response.data, "Invalid registry Access request.");
  804. return HTTP_RESP_BAD_REQUEST;
  805. }
  806. web_client_enable_tracking_required(w);
  807. return registry_request_access_json(host, w, person_guid, machine_guid, machine_url, url_name, now_realtime_sec());
  808. case 'D':
  809. if(unlikely(!machine_guid || !machine_url || !delete_url)) {
  810. error("Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')", machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
  811. buffer_flush(w->response.data);
  812. buffer_strcat(w->response.data, "Invalid registry Delete request.");
  813. return HTTP_RESP_BAD_REQUEST;
  814. }
  815. web_client_enable_tracking_required(w);
  816. return registry_request_delete_json(host, w, person_guid, machine_guid, machine_url, delete_url, now_realtime_sec());
  817. case 'S':
  818. if(unlikely(!machine_guid || !machine_url || !search_machine_guid)) {
  819. error("Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')", machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
  820. buffer_flush(w->response.data);
  821. buffer_strcat(w->response.data, "Invalid registry Search request.");
  822. return HTTP_RESP_BAD_REQUEST;
  823. }
  824. web_client_enable_tracking_required(w);
  825. return registry_request_search_json(host, w, person_guid, machine_guid, machine_url, search_machine_guid, now_realtime_sec());
  826. case 'W':
  827. if(unlikely(!machine_guid || !machine_url || !to_person_guid)) {
  828. error("Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')", machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
  829. buffer_flush(w->response.data);
  830. buffer_strcat(w->response.data, "Invalid registry Switch request.");
  831. return HTTP_RESP_BAD_REQUEST;
  832. }
  833. web_client_enable_tracking_required(w);
  834. return registry_request_switch_json(host, w, person_guid, machine_guid, machine_url, to_person_guid, now_realtime_sec());
  835. case 'H':
  836. return registry_request_hello_json(host, w);
  837. default:
  838. buffer_flush(w->response.data);
  839. buffer_strcat(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
  840. return HTTP_RESP_BAD_REQUEST;
  841. }
  842. }
  843. static inline void web_client_api_request_v1_info_summary_alarm_statuses(RRDHOST *host, BUFFER *wb) {
  844. int alarm_normal = 0, alarm_warn = 0, alarm_crit = 0;
  845. RRDCALC *rc;
  846. foreach_rrdcalc_in_rrdhost_read(host, rc) {
  847. if(unlikely(!rc->rrdset || !rc->rrdset->last_collected_time.tv_sec))
  848. continue;
  849. switch(rc->status) {
  850. case RRDCALC_STATUS_WARNING:
  851. alarm_warn++;
  852. break;
  853. case RRDCALC_STATUS_CRITICAL:
  854. alarm_crit++;
  855. break;
  856. default:
  857. alarm_normal++;
  858. }
  859. }
  860. foreach_rrdcalc_in_rrdhost_done(rc);
  861. buffer_sprintf(wb, "\t\t\"normal\": %d,\n", alarm_normal);
  862. buffer_sprintf(wb, "\t\t\"warning\": %d,\n", alarm_warn);
  863. buffer_sprintf(wb, "\t\t\"critical\": %d\n", alarm_crit);
  864. }
  865. static inline void web_client_api_request_v1_info_mirrored_hosts(BUFFER *wb) {
  866. RRDHOST *host;
  867. int count = 0;
  868. buffer_strcat(wb, "\t\"mirrored_hosts\": [\n");
  869. rrd_rdlock();
  870. rrdhost_foreach_read(host) {
  871. if (count > 0)
  872. buffer_strcat(wb, ",\n");
  873. buffer_sprintf(wb, "\t\t\"%s\"", rrdhost_hostname(host));
  874. count++;
  875. }
  876. buffer_strcat(wb, "\n\t],\n\t\"mirrored_hosts_status\": [\n");
  877. count = 0;
  878. rrdhost_foreach_read(host)
  879. {
  880. if (count > 0)
  881. buffer_strcat(wb, ",\n");
  882. buffer_sprintf(
  883. wb, "\t\t{ \"guid\": \"%s\", \"hostname\": \"%s\", \"reachable\": %s, \"hops\": %d"
  884. , host->machine_guid
  885. , rrdhost_hostname(host)
  886. , (host == localhost || !rrdhost_flag_check(host, RRDHOST_FLAG_ORPHAN)) ? "true" : "false"
  887. , host->system_info ? host->system_info->hops : (host == localhost) ? 0 : 1
  888. );
  889. rrdhost_aclk_state_lock(host);
  890. if (host->aclk_state.claimed_id)
  891. buffer_sprintf(wb, ", \"claim_id\": \"%s\"", host->aclk_state.claimed_id);
  892. else
  893. buffer_strcat(wb, ", \"claim_id\": null");
  894. rrdhost_aclk_state_unlock(host);
  895. if (host->node_id) {
  896. char node_id_str[GUID_LEN + 1];
  897. uuid_unparse_lower(*host->node_id, node_id_str);
  898. buffer_sprintf(wb, ", \"node_id\": \"%s\" }", node_id_str);
  899. } else
  900. buffer_strcat(wb, ", \"node_id\": null }");
  901. count++;
  902. }
  903. rrd_unlock();
  904. buffer_strcat(wb, "\n\t],\n");
  905. }
  906. inline void host_labels2json(RRDHOST *host, BUFFER *wb, size_t indentation) {
  907. char tabs[11];
  908. if (indentation > 10)
  909. indentation = 10;
  910. tabs[0] = '\0';
  911. while (indentation) {
  912. strcat(tabs, "\t");
  913. indentation--;
  914. }
  915. rrdlabels_to_buffer(host->rrdlabels, wb, tabs, ":", "\"", ",\n", NULL, NULL, NULL, NULL);
  916. buffer_strcat(wb, "\n");
  917. }
  918. extern int aclk_connected;
  919. inline int web_client_api_request_v1_info_fill_buffer(RRDHOST *host, BUFFER *wb)
  920. {
  921. buffer_strcat(wb, "{\n");
  922. buffer_sprintf(wb, "\t\"version\": \"%s\",\n", rrdhost_program_version(host));
  923. buffer_sprintf(wb, "\t\"uid\": \"%s\",\n", host->machine_guid);
  924. web_client_api_request_v1_info_mirrored_hosts(wb);
  925. buffer_strcat(wb, "\t\"alarms\": {\n");
  926. web_client_api_request_v1_info_summary_alarm_statuses(host, wb);
  927. buffer_strcat(wb, "\t},\n");
  928. buffer_sprintf(wb, "\t\"os_name\": \"%s\",\n", (host->system_info->host_os_name) ? host->system_info->host_os_name : "");
  929. buffer_sprintf(wb, "\t\"os_id\": \"%s\",\n", (host->system_info->host_os_id) ? host->system_info->host_os_id : "");
  930. buffer_sprintf(wb, "\t\"os_id_like\": \"%s\",\n", (host->system_info->host_os_id_like) ? host->system_info->host_os_id_like : "");
  931. buffer_sprintf(wb, "\t\"os_version\": \"%s\",\n", (host->system_info->host_os_version) ? host->system_info->host_os_version : "");
  932. buffer_sprintf(wb, "\t\"os_version_id\": \"%s\",\n", (host->system_info->host_os_version_id) ? host->system_info->host_os_version_id : "");
  933. buffer_sprintf(wb, "\t\"os_detection\": \"%s\",\n", (host->system_info->host_os_detection) ? host->system_info->host_os_detection : "");
  934. buffer_sprintf(wb, "\t\"cores_total\": \"%s\",\n", (host->system_info->host_cores) ? host->system_info->host_cores : "");
  935. buffer_sprintf(wb, "\t\"total_disk_space\": \"%s\",\n", (host->system_info->host_disk_space) ? host->system_info->host_disk_space : "");
  936. buffer_sprintf(wb, "\t\"cpu_freq\": \"%s\",\n", (host->system_info->host_cpu_freq) ? host->system_info->host_cpu_freq : "");
  937. buffer_sprintf(wb, "\t\"ram_total\": \"%s\",\n", (host->system_info->host_ram_total) ? host->system_info->host_ram_total : "");
  938. if (host->system_info->container_os_name)
  939. buffer_sprintf(wb, "\t\"container_os_name\": \"%s\",\n", host->system_info->container_os_name);
  940. if (host->system_info->container_os_id)
  941. buffer_sprintf(wb, "\t\"container_os_id\": \"%s\",\n", host->system_info->container_os_id);
  942. if (host->system_info->container_os_id_like)
  943. buffer_sprintf(wb, "\t\"container_os_id_like\": \"%s\",\n", host->system_info->container_os_id_like);
  944. if (host->system_info->container_os_version)
  945. buffer_sprintf(wb, "\t\"container_os_version\": \"%s\",\n", host->system_info->container_os_version);
  946. if (host->system_info->container_os_version_id)
  947. buffer_sprintf(wb, "\t\"container_os_version_id\": \"%s\",\n", host->system_info->container_os_version_id);
  948. if (host->system_info->container_os_detection)
  949. buffer_sprintf(wb, "\t\"container_os_detection\": \"%s\",\n", host->system_info->container_os_detection);
  950. if (host->system_info->is_k8s_node)
  951. buffer_sprintf(wb, "\t\"is_k8s_node\": \"%s\",\n", host->system_info->is_k8s_node);
  952. buffer_sprintf(wb, "\t\"kernel_name\": \"%s\",\n", (host->system_info->kernel_name) ? host->system_info->kernel_name : "");
  953. buffer_sprintf(wb, "\t\"kernel_version\": \"%s\",\n", (host->system_info->kernel_version) ? host->system_info->kernel_version : "");
  954. buffer_sprintf(wb, "\t\"architecture\": \"%s\",\n", (host->system_info->architecture) ? host->system_info->architecture : "");
  955. buffer_sprintf(wb, "\t\"virtualization\": \"%s\",\n", (host->system_info->virtualization) ? host->system_info->virtualization : "");
  956. buffer_sprintf(wb, "\t\"virt_detection\": \"%s\",\n", (host->system_info->virt_detection) ? host->system_info->virt_detection : "");
  957. buffer_sprintf(wb, "\t\"container\": \"%s\",\n", (host->system_info->container) ? host->system_info->container : "");
  958. buffer_sprintf(wb, "\t\"container_detection\": \"%s\",\n", (host->system_info->container_detection) ? host->system_info->container_detection : "");
  959. if (host->system_info->cloud_provider_type)
  960. buffer_sprintf(wb, "\t\"cloud_provider_type\": \"%s\",\n", host->system_info->cloud_provider_type);
  961. if (host->system_info->cloud_instance_type)
  962. buffer_sprintf(wb, "\t\"cloud_instance_type\": \"%s\",\n", host->system_info->cloud_instance_type);
  963. if (host->system_info->cloud_instance_region)
  964. buffer_sprintf(wb, "\t\"cloud_instance_region\": \"%s\",\n", host->system_info->cloud_instance_region);
  965. buffer_strcat(wb, "\t\"host_labels\": {\n");
  966. host_labels2json(host, wb, 2);
  967. buffer_strcat(wb, "\t},\n");
  968. buffer_strcat(wb, "\t\"functions\": {\n");
  969. host_functions2json(host, wb, 2, "\"", "\"");
  970. buffer_strcat(wb, "\t},\n");
  971. buffer_strcat(wb, "\t\"collectors\": [");
  972. chartcollectors2json(host, wb);
  973. buffer_strcat(wb, "\n\t],\n");
  974. #ifdef DISABLE_CLOUD
  975. buffer_strcat(wb, "\t\"cloud-enabled\": false,\n");
  976. #else
  977. buffer_sprintf(wb, "\t\"cloud-enabled\": %s,\n",
  978. appconfig_get_boolean(&cloud_config, CONFIG_SECTION_GLOBAL, "enabled", 1) ? "true" : "false");
  979. #endif
  980. #ifdef ENABLE_ACLK
  981. buffer_strcat(wb, "\t\"cloud-available\": true,\n");
  982. #else
  983. buffer_strcat(wb, "\t\"cloud-available\": false,\n");
  984. #endif
  985. char *agent_id = get_agent_claimid();
  986. if (agent_id == NULL)
  987. buffer_strcat(wb, "\t\"agent-claimed\": false,\n");
  988. else {
  989. buffer_strcat(wb, "\t\"agent-claimed\": true,\n");
  990. freez(agent_id);
  991. }
  992. #ifdef ENABLE_ACLK
  993. if (aclk_connected) {
  994. buffer_strcat(wb, "\t\"aclk-available\": true,\n");
  995. }
  996. else
  997. #endif
  998. buffer_strcat(wb, "\t\"aclk-available\": false,\n"); // Intentionally valid with/without #ifdef above
  999. buffer_strcat(wb, "\t\"memory-mode\": ");
  1000. analytics_get_data(analytics_data.netdata_config_memory_mode, wb);
  1001. buffer_strcat(wb, ",\n");
  1002. buffer_strcat(wb, "\t\"multidb-disk-quota\": ");
  1003. analytics_get_data(analytics_data.netdata_config_multidb_disk_quota, wb);
  1004. buffer_strcat(wb, ",\n");
  1005. buffer_strcat(wb, "\t\"page-cache-size\": ");
  1006. analytics_get_data(analytics_data.netdata_config_page_cache_size, wb);
  1007. buffer_strcat(wb, ",\n");
  1008. buffer_strcat(wb, "\t\"stream-enabled\": ");
  1009. analytics_get_data(analytics_data.netdata_config_stream_enabled, wb);
  1010. buffer_strcat(wb, ",\n");
  1011. #ifdef ENABLE_COMPRESSION
  1012. if(host->sender){
  1013. buffer_strcat(wb, "\t\"stream-compression\": ");
  1014. buffer_strcat(wb, stream_has_capability(host->sender, STREAM_CAP_COMPRESSION) ? "true" : "false");
  1015. buffer_strcat(wb, ",\n");
  1016. }else{
  1017. buffer_strcat(wb, "\t\"stream-compression\": null,\n");
  1018. }
  1019. #else
  1020. buffer_strcat(wb, "\t\"stream-compression\": null,\n");
  1021. #endif //ENABLE_COMPRESSION
  1022. buffer_strcat(wb, "\t\"hosts-available\": ");
  1023. analytics_get_data(analytics_data.netdata_config_hosts_available, wb);
  1024. buffer_strcat(wb, ",\n");
  1025. buffer_strcat(wb, "\t\"https-enabled\": ");
  1026. analytics_get_data(analytics_data.netdata_config_https_enabled, wb);
  1027. buffer_strcat(wb, ",\n");
  1028. buffer_strcat(wb, "\t\"buildinfo\": ");
  1029. analytics_get_data(analytics_data.netdata_buildinfo, wb);
  1030. buffer_strcat(wb, ",\n");
  1031. buffer_strcat(wb, "\t\"release-channel\": ");
  1032. analytics_get_data(analytics_data.netdata_config_release_channel, wb);
  1033. buffer_strcat(wb, ",\n");
  1034. buffer_strcat(wb, "\t\"web-enabled\": ");
  1035. analytics_get_data(analytics_data.netdata_config_web_enabled, wb);
  1036. buffer_strcat(wb, ",\n");
  1037. buffer_strcat(wb, "\t\"notification-methods\": ");
  1038. analytics_get_data(analytics_data.netdata_notification_methods, wb);
  1039. buffer_strcat(wb, ",\n");
  1040. buffer_strcat(wb, "\t\"exporting-enabled\": ");
  1041. analytics_get_data(analytics_data.netdata_config_exporting_enabled, wb);
  1042. buffer_strcat(wb, ",\n");
  1043. buffer_strcat(wb, "\t\"exporting-connectors\": ");
  1044. analytics_get_data(analytics_data.netdata_exporting_connectors, wb);
  1045. buffer_strcat(wb, ",\n");
  1046. buffer_strcat(wb, "\t\"allmetrics-prometheus-used\": ");
  1047. analytics_get_data(analytics_data.netdata_allmetrics_prometheus_used, wb);
  1048. buffer_strcat(wb, ",\n");
  1049. buffer_strcat(wb, "\t\"allmetrics-shell-used\": ");
  1050. analytics_get_data(analytics_data.netdata_allmetrics_shell_used, wb);
  1051. buffer_strcat(wb, ",\n");
  1052. buffer_strcat(wb, "\t\"allmetrics-json-used\": ");
  1053. analytics_get_data(analytics_data.netdata_allmetrics_json_used, wb);
  1054. buffer_strcat(wb, ",\n");
  1055. buffer_strcat(wb, "\t\"dashboard-used\": ");
  1056. analytics_get_data(analytics_data.netdata_dashboard_used, wb);
  1057. buffer_strcat(wb, ",\n");
  1058. buffer_strcat(wb, "\t\"charts-count\": ");
  1059. analytics_get_data(analytics_data.netdata_charts_count, wb);
  1060. buffer_strcat(wb, ",\n");
  1061. buffer_strcat(wb, "\t\"metrics-count\": ");
  1062. analytics_get_data(analytics_data.netdata_metrics_count, wb);
  1063. #if defined(ENABLE_ML)
  1064. buffer_strcat(wb, ",\n");
  1065. char *ml_info = ml_get_host_info(host);
  1066. buffer_strcat(wb, "\t\"ml-info\": ");
  1067. buffer_strcat(wb, ml_info);
  1068. freez(ml_info);
  1069. #endif
  1070. buffer_strcat(wb, "\n}");
  1071. return 0;
  1072. }
  1073. #if defined(ENABLE_ML)
  1074. int web_client_api_request_v1_ml_info(RRDHOST *host, struct web_client *w, char *url) {
  1075. (void) url;
  1076. if (!netdata_ready)
  1077. return HTTP_RESP_BACKEND_FETCH_FAILED;
  1078. char *s = ml_get_host_runtime_info(host);
  1079. if (!s)
  1080. s = strdupz("{\"error\": \"json string is empty\" }\n");
  1081. BUFFER *wb = w->response.data;
  1082. buffer_flush(wb);
  1083. wb->contenttype = CT_APPLICATION_JSON;
  1084. buffer_strcat(wb, s);
  1085. buffer_no_cacheable(wb);
  1086. freez(s);
  1087. return HTTP_RESP_OK;
  1088. }
  1089. int web_client_api_request_v1_ml_models(RRDHOST *host, struct web_client *w, char *url) {
  1090. (void) url;
  1091. if (!netdata_ready)
  1092. return HTTP_RESP_BACKEND_FETCH_FAILED;
  1093. char *s = ml_get_host_models(host);
  1094. if (!s)
  1095. s = strdupz("{\"error\": \"json string is empty\" }\n");
  1096. BUFFER *wb = w->response.data;
  1097. buffer_flush(wb);
  1098. wb->contenttype = CT_APPLICATION_JSON;
  1099. buffer_strcat(wb, s);
  1100. buffer_no_cacheable(wb);
  1101. freez(s);
  1102. return HTTP_RESP_OK;
  1103. }
  1104. #endif
  1105. inline int web_client_api_request_v1_info(RRDHOST *host, struct web_client *w, char *url) {
  1106. (void)url;
  1107. if (!netdata_ready) return HTTP_RESP_BACKEND_FETCH_FAILED;
  1108. BUFFER *wb = w->response.data;
  1109. buffer_flush(wb);
  1110. wb->contenttype = CT_APPLICATION_JSON;
  1111. web_client_api_request_v1_info_fill_buffer(host, wb);
  1112. buffer_no_cacheable(wb);
  1113. return HTTP_RESP_OK;
  1114. }
  1115. static int web_client_api_request_v1_aclk_state(RRDHOST *host, struct web_client *w, char *url) {
  1116. UNUSED(url);
  1117. UNUSED(host);
  1118. if (!netdata_ready) return HTTP_RESP_BACKEND_FETCH_FAILED;
  1119. BUFFER *wb = w->response.data;
  1120. buffer_flush(wb);
  1121. char *str = aclk_state_json();
  1122. buffer_strcat(wb, str);
  1123. freez(str);
  1124. wb->contenttype = CT_APPLICATION_JSON;
  1125. buffer_no_cacheable(wb);
  1126. return HTTP_RESP_OK;
  1127. }
  1128. static int web_client_api_request_v1_weights_internal(RRDHOST *host, struct web_client *w, char *url, WEIGHTS_METHOD method, WEIGHTS_FORMAT format) {
  1129. if (!netdata_ready)
  1130. return HTTP_RESP_BACKEND_FETCH_FAILED;
  1131. long long baseline_after = 0, baseline_before = 0, after = 0, before = 0, points = 0;
  1132. RRDR_OPTIONS options = RRDR_OPTION_NOT_ALIGNED | RRDR_OPTION_NONZERO | RRDR_OPTION_NULL2ZERO;
  1133. int options_count = 0;
  1134. RRDR_GROUPING group = RRDR_GROUPING_AVERAGE;
  1135. int timeout = 0;
  1136. size_t tier = 0;
  1137. const char *group_options = NULL, *contexts_str = NULL;
  1138. while (url) {
  1139. char *value = mystrsep(&url, "&");
  1140. if (!value || !*value)
  1141. continue;
  1142. char *name = mystrsep(&value, "=");
  1143. if (!name || !*name)
  1144. continue;
  1145. if (!value || !*value)
  1146. continue;
  1147. if (!strcmp(name, "baseline_after"))
  1148. baseline_after = (long long) strtoul(value, NULL, 0);
  1149. else if (!strcmp(name, "baseline_before"))
  1150. baseline_before = (long long) strtoul(value, NULL, 0);
  1151. else if (!strcmp(name, "after") || !strcmp(name, "highlight_after"))
  1152. after = (long long) strtoul(value, NULL, 0);
  1153. else if (!strcmp(name, "before") || !strcmp(name, "highlight_before"))
  1154. before = (long long) strtoul(value, NULL, 0);
  1155. else if (!strcmp(name, "points") || !strcmp(name, "max_points"))
  1156. points = (long long) strtoul(value, NULL, 0);
  1157. else if (!strcmp(name, "timeout"))
  1158. timeout = (int) strtoul(value, NULL, 0);
  1159. else if(!strcmp(name, "group"))
  1160. group = web_client_api_request_v1_data_group(value, RRDR_GROUPING_AVERAGE);
  1161. else if(!strcmp(name, "options")) {
  1162. if(!options_count) options = RRDR_OPTION_NOT_ALIGNED | RRDR_OPTION_NULL2ZERO;
  1163. options |= web_client_api_request_v1_data_options(value);
  1164. options_count++;
  1165. }
  1166. else if(!strcmp(name, "method"))
  1167. method = weights_string_to_method(value);
  1168. else if(!strcmp(name, "context") || !strcmp(name, "contexts"))
  1169. contexts_str = value;
  1170. else if(!strcmp(name, "tier")) {
  1171. tier = str2ul(value);
  1172. if(tier < storage_tiers)
  1173. options |= RRDR_OPTION_SELECTED_TIER;
  1174. else
  1175. tier = 0;
  1176. }
  1177. }
  1178. BUFFER *wb = w->response.data;
  1179. buffer_flush(wb);
  1180. wb->contenttype = CT_APPLICATION_JSON;
  1181. SIMPLE_PATTERN *contexts = (contexts_str) ? simple_pattern_create(contexts_str, ",|\t\r\n\f\v", SIMPLE_PATTERN_EXACT) : NULL;
  1182. int ret = web_api_v1_weights(host, wb, method, format, group, group_options, baseline_after, baseline_before, after, before, points, options, contexts, tier, timeout);
  1183. simple_pattern_free(contexts);
  1184. return ret;
  1185. }
  1186. int web_client_api_request_v1_metric_correlations(RRDHOST *host, struct web_client *w, char *url) {
  1187. return web_client_api_request_v1_weights_internal(host, w, url, default_metric_correlations_method, WEIGHTS_FORMAT_CHARTS);
  1188. }
  1189. int web_client_api_request_v1_weights(RRDHOST *host, struct web_client *w, char *url) {
  1190. return web_client_api_request_v1_weights_internal(host, w, url, WEIGHTS_METHOD_ANOMALY_RATE, WEIGHTS_FORMAT_CONTEXTS);
  1191. }
  1192. int web_client_api_request_v1_function(RRDHOST *host, struct web_client *w, char *url) {
  1193. if (!netdata_ready)
  1194. return HTTP_RESP_BACKEND_FETCH_FAILED;
  1195. int timeout = 0;
  1196. const char *function = NULL;
  1197. while (url) {
  1198. char *value = mystrsep(&url, "&");
  1199. if (!value || !*value)
  1200. continue;
  1201. char *name = mystrsep(&value, "=");
  1202. if (!name || !*name)
  1203. continue;
  1204. if (!strcmp(name, "function"))
  1205. function = value;
  1206. else if (!strcmp(name, "timeout"))
  1207. timeout = (int) strtoul(value, NULL, 0);
  1208. }
  1209. BUFFER *wb = w->response.data;
  1210. buffer_flush(wb);
  1211. wb->contenttype = CT_APPLICATION_JSON;
  1212. buffer_no_cacheable(wb);
  1213. return rrd_call_function_and_wait(host, wb, timeout, function);
  1214. }
  1215. int web_client_api_request_v1_functions(RRDHOST *host, struct web_client *w, char *url __maybe_unused) {
  1216. if (!netdata_ready)
  1217. return HTTP_RESP_BACKEND_FETCH_FAILED;
  1218. BUFFER *wb = w->response.data;
  1219. buffer_flush(wb);
  1220. wb->contenttype = CT_APPLICATION_JSON;
  1221. buffer_no_cacheable(wb);
  1222. buffer_strcat(wb, "{\n");
  1223. host_functions2json(host, wb, 1, "\"", "\"");
  1224. buffer_strcat(wb, "}");
  1225. return HTTP_RESP_OK;
  1226. }
  1227. #ifndef ENABLE_DBENGINE
  1228. int web_client_api_request_v1_dbengine_stats(RRDHOST *host __maybe_unused, struct web_client *w __maybe_unused, char *url __maybe_unused) {
  1229. return HTTP_RESP_NOT_FOUND;
  1230. }
  1231. #else
  1232. static void web_client_api_v1_dbengine_stats_for_tier(BUFFER *wb, size_t tier) {
  1233. RRDENG_SIZE_STATS stats = rrdeng_size_statistics(multidb_ctx[tier]);
  1234. buffer_sprintf(wb,
  1235. "\n\t\t\"default_granularity_secs\":%zu"
  1236. ",\n\t\t\"sizeof_datafile\":%zu"
  1237. ",\n\t\t\"sizeof_page_in_cache\":%zu"
  1238. ",\n\t\t\"sizeof_point_data\":%zu"
  1239. ",\n\t\t\"sizeof_page_data\":%zu"
  1240. ",\n\t\t\"pages_per_extent\":%zu"
  1241. ",\n\t\t\"datafiles\":%zu"
  1242. ",\n\t\t\"extents\":%zu"
  1243. ",\n\t\t\"extents_pages\":%zu"
  1244. ",\n\t\t\"points\":%zu"
  1245. ",\n\t\t\"metrics\":%zu"
  1246. ",\n\t\t\"metrics_pages\":%zu"
  1247. ",\n\t\t\"extents_compressed_bytes\":%zu"
  1248. ",\n\t\t\"pages_uncompressed_bytes\":%zu"
  1249. ",\n\t\t\"pages_duration_secs\":%lld"
  1250. ",\n\t\t\"single_point_pages\":%zu"
  1251. ",\n\t\t\"first_t\":%ld"
  1252. ",\n\t\t\"last_t\":%ld"
  1253. ",\n\t\t\"database_retention_secs\":%lld"
  1254. ",\n\t\t\"average_compression_savings\":%0.2f"
  1255. ",\n\t\t\"average_point_duration_secs\":%0.2f"
  1256. ",\n\t\t\"average_metric_retention_secs\":%0.2f"
  1257. ",\n\t\t\"ephemeral_metrics_per_day_percent\":%0.2f"
  1258. ",\n\t\t\"average_page_size_bytes\":%0.2f"
  1259. ",\n\t\t\"estimated_concurrently_collected_metrics\":%zu"
  1260. ",\n\t\t\"currently_collected_metrics\":%zu"
  1261. ",\n\t\t\"disk_space\":%zu"
  1262. ",\n\t\t\"max_disk_space\":%zu"
  1263. , stats.default_granularity_secs
  1264. , stats.sizeof_datafile
  1265. , stats.sizeof_page_in_cache
  1266. , stats.sizeof_point_data
  1267. , stats.sizeof_page_data
  1268. , stats.pages_per_extent
  1269. , stats.datafiles
  1270. , stats.extents
  1271. , stats.extents_pages
  1272. , stats.points
  1273. , stats.metrics
  1274. , stats.metrics_pages
  1275. , stats.extents_compressed_bytes
  1276. , stats.pages_uncompressed_bytes
  1277. , (long long)stats.pages_duration_secs
  1278. , stats.single_point_pages
  1279. , stats.first_time_s
  1280. , stats.last_time_s
  1281. , (long long)stats.database_retention_secs
  1282. , stats.average_compression_savings
  1283. , stats.average_point_duration_secs
  1284. , stats.average_metric_retention_secs
  1285. , stats.ephemeral_metrics_per_day_percent
  1286. , stats.average_page_size_bytes
  1287. , stats.estimated_concurrently_collected_metrics
  1288. , stats.currently_collected_metrics
  1289. , stats.disk_space
  1290. , stats.max_disk_space
  1291. );
  1292. }
  1293. int web_client_api_request_v1_dbengine_stats(RRDHOST *host __maybe_unused, struct web_client *w, char *url __maybe_unused) {
  1294. if (!netdata_ready)
  1295. return HTTP_RESP_BACKEND_FETCH_FAILED;
  1296. BUFFER *wb = w->response.data;
  1297. buffer_flush(wb);
  1298. if(!dbengine_enabled) {
  1299. buffer_strcat(wb, "dbengine is not enabled");
  1300. return HTTP_RESP_NOT_FOUND;
  1301. }
  1302. wb->contenttype = CT_APPLICATION_JSON;
  1303. buffer_no_cacheable(wb);
  1304. buffer_strcat(wb, "{");
  1305. for(size_t tier = 0; tier < storage_tiers ;tier++) {
  1306. buffer_sprintf(wb, "%s\n\t\"tier%zu\": {", tier?",":"", tier);
  1307. web_client_api_v1_dbengine_stats_for_tier(wb, tier);
  1308. buffer_strcat(wb, "\n\t}");
  1309. }
  1310. buffer_strcat(wb, "\n}");
  1311. return HTTP_RESP_OK;
  1312. }
  1313. #endif
  1314. #ifdef NETDATA_DEV_MODE
  1315. #define ACL_DEV_OPEN_ACCESS WEB_CLIENT_ACL_DASHBOARD
  1316. #else
  1317. #define ACL_DEV_OPEN_ACCESS 0
  1318. #endif
  1319. static struct api_command {
  1320. const char *command;
  1321. uint32_t hash;
  1322. WEB_CLIENT_ACL acl;
  1323. int (*callback)(RRDHOST *host, struct web_client *w, char *url);
  1324. } api_commands[] = {
  1325. { "info", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_info },
  1326. { "data", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_data },
  1327. { "chart", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_chart },
  1328. { "charts", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_charts },
  1329. { "context", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_context },
  1330. { "contexts", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_contexts },
  1331. // registry checks the ACL by itself, so we allow everything
  1332. { "registry", 0, WEB_CLIENT_ACL_NOCHECK, web_client_api_request_v1_registry },
  1333. // badges can be fetched with both dashboard and badge permissions
  1334. { "badge.svg", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_BADGE | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_badge },
  1335. { "alarms", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_alarms },
  1336. { "alarms_values", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_alarms_values },
  1337. { "alarm_log", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_alarm_log },
  1338. { "alarm_variables", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_alarm_variables },
  1339. { "alarm_count", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_alarm_count },
  1340. { "allmetrics", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_allmetrics },
  1341. #if defined(ENABLE_ML)
  1342. { "ml_info", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_ml_info },
  1343. { "ml_models", 0, WEB_CLIENT_ACL_DASHBOARD, web_client_api_request_v1_ml_models },
  1344. #endif
  1345. { "manage/health", 0, WEB_CLIENT_ACL_MGMT | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_mgmt_health },
  1346. { "aclk", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_aclk_state },
  1347. { "metric_correlations", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_metric_correlations },
  1348. { "weights", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_weights },
  1349. { "function", 0, WEB_CLIENT_ACL_ACLK | ACL_DEV_OPEN_ACCESS, web_client_api_request_v1_function },
  1350. { "functions", 0, WEB_CLIENT_ACL_ACLK | ACL_DEV_OPEN_ACCESS, web_client_api_request_v1_functions },
  1351. { "dbengine_stats", 0, WEB_CLIENT_ACL_DASHBOARD | WEB_CLIENT_ACL_ACLK, web_client_api_request_v1_dbengine_stats },
  1352. // terminator
  1353. { NULL, 0, WEB_CLIENT_ACL_NONE, NULL },
  1354. };
  1355. inline int web_client_api_request_v1(RRDHOST *host, struct web_client *w, char *url) {
  1356. static int initialized = 0;
  1357. int i;
  1358. if(unlikely(initialized == 0)) {
  1359. initialized = 1;
  1360. for(i = 0; api_commands[i].command ; i++)
  1361. api_commands[i].hash = simple_hash(api_commands[i].command);
  1362. }
  1363. // get the command
  1364. if(url) {
  1365. debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, url);
  1366. uint32_t hash = simple_hash(url);
  1367. for(i = 0; api_commands[i].command ;i++) {
  1368. if(unlikely(hash == api_commands[i].hash && !strcmp(url, api_commands[i].command))) {
  1369. if(unlikely(api_commands[i].acl != WEB_CLIENT_ACL_NOCHECK) && !(w->acl & api_commands[i].acl))
  1370. return web_client_permission_denied(w);
  1371. //return api_commands[i].callback(host, w, url);
  1372. return api_commands[i].callback(host, w, (w->decoded_query_string + 1));
  1373. }
  1374. }
  1375. buffer_flush(w->response.data);
  1376. buffer_strcat(w->response.data, "Unsupported v1 API command: ");
  1377. buffer_strcat_htmlescape(w->response.data, url);
  1378. return HTTP_RESP_NOT_FOUND;
  1379. }
  1380. else {
  1381. buffer_flush(w->response.data);
  1382. buffer_sprintf(w->response.data, "Which API v1 command?");
  1383. return HTTP_RESP_BAD_REQUEST;
  1384. }
  1385. }