Explore.tsx 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019
  1. import React from 'react';
  2. import { hot } from 'react-hot-loader';
  3. import Select from 'react-select';
  4. import _ from 'lodash';
  5. import { DataSource } from 'app/types/datasources';
  6. import {
  7. ExploreState,
  8. ExploreUrlState,
  9. QueryTransaction,
  10. ResultType,
  11. QueryHintGetter,
  12. QueryHint,
  13. } from 'app/types/explore';
  14. import { RawTimeRange, DataQuery } from 'app/types/series';
  15. import store from 'app/core/store';
  16. import {
  17. DEFAULT_RANGE,
  18. calculateResultsFromQueryTransactions,
  19. ensureQueries,
  20. getIntervals,
  21. generateKey,
  22. generateQueryKeys,
  23. hasNonEmptyQuery,
  24. makeTimeSeriesList,
  25. updateHistory,
  26. } from 'app/core/utils/explore';
  27. import ResetStyles from 'app/core/components/Picker/ResetStyles';
  28. import PickerOption from 'app/core/components/Picker/PickerOption';
  29. import IndicatorsContainer from 'app/core/components/Picker/IndicatorsContainer';
  30. import NoOptionsMessage from 'app/core/components/Picker/NoOptionsMessage';
  31. import TableModel from 'app/core/table_model';
  32. import { DatasourceSrv } from 'app/features/plugins/datasource_srv';
  33. import Panel from './Panel';
  34. import QueryRows from './QueryRows';
  35. import Graph from './Graph';
  36. import Logs from './Logs';
  37. import Table from './Table';
  38. import ErrorBoundary from './ErrorBoundary';
  39. import TimePicker from './TimePicker';
  40. interface ExploreProps {
  41. datasourceSrv: DatasourceSrv;
  42. onChangeSplit: (split: boolean, state?: ExploreState) => void;
  43. onSaveState: (key: string, state: ExploreState) => void;
  44. position: string;
  45. split: boolean;
  46. splitState?: ExploreState;
  47. stateKey: string;
  48. urlState: ExploreUrlState;
  49. }
  50. /**
  51. * Explore provides an area for quick query iteration for a given datasource.
  52. * Once a datasource is selected it populates the query section at the top.
  53. * When queries are run, their results are being displayed in the main section.
  54. * The datasource determines what kind of query editor it brings, and what kind
  55. * of results viewers it supports.
  56. *
  57. * QUERY HANDLING
  58. *
  59. * TLDR: to not re-render Explore during edits, query editing is not "controlled"
  60. * in a React sense: values need to be pushed down via `initialQueries`, while
  61. * edits travel up via `this.modifiedQueries`.
  62. *
  63. * By default the query rows start without prior state: `initialQueries` will
  64. * contain one empty DataQuery. While the user modifies the DataQuery, the
  65. * modifications are being tracked in `this.modifiedQueries`, which need to be
  66. * used whenever a query is sent to the datasource to reflect what the user sees
  67. * on the screen. Query rows can be initialized or reset using `initialQueries`,
  68. * by giving the respective row a new key. This wipes the old row and its state.
  69. * This property is also used to govern how many query rows there are (minimum 1).
  70. *
  71. * This flow makes sure that a query row can be arbitrarily complex without the
  72. * fear of being wiped or re-initialized via props. The query row is free to keep
  73. * its own state while the user edits or builds a query. Valid queries can be sent
  74. * up to Explore via the `onChangeQuery` prop.
  75. *
  76. * DATASOURCE REQUESTS
  77. *
  78. * A click on Run Query creates transactions for all DataQueries for all expanded
  79. * result viewers. New runs are discarding previous runs. Upon completion a transaction
  80. * saves the result. The result viewers construct their data from the currently existing
  81. * transactions.
  82. *
  83. * The result viewers determine some of the query options sent to the datasource, e.g.,
  84. * `format`, to indicate eventual transformations by the datasources' result transformers.
  85. */
  86. export class Explore extends React.PureComponent<ExploreProps, ExploreState> {
  87. el: any;
  88. /**
  89. * Current query expressions of the rows including their modifications, used for running queries.
  90. * Not kept in component state to prevent edit-render roundtrips.
  91. */
  92. modifiedQueries: DataQuery[];
  93. /**
  94. * Local ID cache to compare requested vs selected datasource
  95. */
  96. requestedDatasourceId: string;
  97. scanTimer: NodeJS.Timer;
  98. /**
  99. * Timepicker to control scanning
  100. */
  101. timepickerRef: React.RefObject<TimePicker>;
  102. constructor(props) {
  103. super(props);
  104. const splitState: ExploreState = props.splitState;
  105. let initialQueries: DataQuery[];
  106. if (splitState) {
  107. // Split state overrides everything
  108. this.state = splitState;
  109. initialQueries = splitState.initialQueries;
  110. } else {
  111. const { datasource, queries, range } = props.urlState as ExploreUrlState;
  112. initialQueries = ensureQueries(queries);
  113. const initialRange = range || { ...DEFAULT_RANGE };
  114. // Millies step for helper bar charts
  115. const initialGraphInterval = 15 * 1000;
  116. this.state = {
  117. datasource: null,
  118. datasourceError: null,
  119. datasourceLoading: null,
  120. datasourceMissing: false,
  121. datasourceName: datasource,
  122. exploreDatasources: [],
  123. graphInterval: initialGraphInterval,
  124. graphResult: [],
  125. initialQueries,
  126. history: [],
  127. logsResult: null,
  128. queryTransactions: [],
  129. range: initialRange,
  130. scanning: false,
  131. showingGraph: true,
  132. showingLogs: true,
  133. showingStartPage: false,
  134. showingTable: true,
  135. supportsGraph: null,
  136. supportsLogs: null,
  137. supportsTable: null,
  138. tableResult: new TableModel(),
  139. };
  140. }
  141. this.modifiedQueries = initialQueries.slice();
  142. this.timepickerRef = React.createRef();
  143. }
  144. async componentDidMount() {
  145. const { datasourceSrv } = this.props;
  146. const { datasourceName } = this.state;
  147. if (!datasourceSrv) {
  148. throw new Error('No datasource service passed as props.');
  149. }
  150. const datasources = datasourceSrv.getExploreSources();
  151. const exploreDatasources = datasources.map(ds => ({
  152. value: ds.name,
  153. label: ds.name,
  154. }));
  155. if (datasources.length > 0) {
  156. this.setState({ datasourceLoading: true, exploreDatasources });
  157. // Priority: datasource in url, default datasource, first explore datasource
  158. let datasource;
  159. if (datasourceName) {
  160. datasource = await datasourceSrv.get(datasourceName);
  161. } else {
  162. datasource = await datasourceSrv.get();
  163. }
  164. if (!datasource.meta.explore) {
  165. datasource = await datasourceSrv.get(datasources[0].name);
  166. }
  167. await this.setDatasource(datasource);
  168. } else {
  169. this.setState({ datasourceMissing: true });
  170. }
  171. }
  172. componentWillUnmount() {
  173. clearTimeout(this.scanTimer);
  174. }
  175. async setDatasource(datasource: any, origin?: DataSource) {
  176. const { initialQueries, range } = this.state;
  177. const supportsGraph = datasource.meta.metrics;
  178. const supportsLogs = datasource.meta.logs;
  179. const supportsTable = datasource.meta.metrics;
  180. const datasourceId = datasource.meta.id;
  181. let datasourceError = null;
  182. // Keep ID to track selection
  183. this.requestedDatasourceId = datasourceId;
  184. try {
  185. const testResult = await datasource.testDatasource();
  186. datasourceError = testResult.status === 'success' ? null : testResult.message;
  187. } catch (error) {
  188. datasourceError = (error && error.statusText) || 'Network error';
  189. }
  190. if (datasourceId !== this.requestedDatasourceId) {
  191. // User already changed datasource again, discard results
  192. return;
  193. }
  194. const historyKey = `grafana.explore.history.${datasourceId}`;
  195. const history = store.getObject(historyKey, []);
  196. if (datasource.init) {
  197. datasource.init();
  198. }
  199. // Check if queries can be imported from previously selected datasource
  200. let modifiedQueries = this.modifiedQueries;
  201. if (origin) {
  202. if (origin.meta.id === datasource.meta.id) {
  203. // Keep same queries if same type of datasource
  204. modifiedQueries = [...this.modifiedQueries];
  205. } else if (datasource.importQueries) {
  206. // Datasource-specific importers
  207. modifiedQueries = await datasource.importQueries(this.modifiedQueries, origin.meta);
  208. } else {
  209. // Default is blank queries
  210. modifiedQueries = ensureQueries();
  211. }
  212. }
  213. // Reset edit state with new queries
  214. const nextQueries = initialQueries.map((q, i) => ({
  215. ...modifiedQueries[i],
  216. ...generateQueryKeys(i),
  217. }));
  218. this.modifiedQueries = modifiedQueries;
  219. // Custom components
  220. const StartPage = datasource.pluginExports.ExploreStartPage;
  221. // Calculate graph bucketing interval
  222. const graphInterval = getIntervals(range, datasource, this.el ? this.el.offsetWidth : 0).intervalMs;
  223. this.setState(
  224. {
  225. StartPage,
  226. datasource,
  227. datasourceError,
  228. graphInterval,
  229. history,
  230. supportsGraph,
  231. supportsLogs,
  232. supportsTable,
  233. datasourceLoading: false,
  234. datasourceName: datasource.name,
  235. initialQueries: nextQueries,
  236. logsHighlighterExpressions: undefined,
  237. showingStartPage: Boolean(StartPage),
  238. },
  239. () => {
  240. if (datasourceError === null) {
  241. this.onSubmit();
  242. }
  243. }
  244. );
  245. }
  246. getRef = el => {
  247. this.el = el;
  248. };
  249. onAddQueryRow = index => {
  250. // Local cache
  251. this.modifiedQueries[index + 1] = { ...generateQueryKeys(index + 1) };
  252. this.setState(state => {
  253. const { initialQueries, queryTransactions } = state;
  254. const nextQueries = [
  255. ...initialQueries.slice(0, index + 1),
  256. { ...this.modifiedQueries[index + 1] },
  257. ...initialQueries.slice(index + 1),
  258. ];
  259. // Ongoing transactions need to update their row indices
  260. const nextQueryTransactions = queryTransactions.map(qt => {
  261. if (qt.rowIndex > index) {
  262. return {
  263. ...qt,
  264. rowIndex: qt.rowIndex + 1,
  265. };
  266. }
  267. return qt;
  268. });
  269. return {
  270. initialQueries: nextQueries,
  271. logsHighlighterExpressions: undefined,
  272. queryTransactions: nextQueryTransactions,
  273. };
  274. });
  275. };
  276. onChangeDatasource = async option => {
  277. const origin = this.state.datasource;
  278. this.setState({
  279. datasource: null,
  280. datasourceError: null,
  281. datasourceLoading: true,
  282. queryTransactions: [],
  283. });
  284. const datasourceName = option.value;
  285. const datasource = await this.props.datasourceSrv.get(datasourceName);
  286. this.setDatasource(datasource as any, origin);
  287. };
  288. onChangeQuery = (value: DataQuery, index: number, override?: boolean) => {
  289. // Null value means reset
  290. if (value === null) {
  291. value = { ...generateQueryKeys(index) };
  292. }
  293. // Keep current value in local cache
  294. this.modifiedQueries[index] = value;
  295. if (override) {
  296. this.setState(state => {
  297. // Replace query row by injecting new key
  298. const { initialQueries, queryTransactions } = state;
  299. const query: DataQuery = {
  300. ...value,
  301. ...generateQueryKeys(index),
  302. };
  303. const nextQueries = [...initialQueries];
  304. nextQueries[index] = query;
  305. this.modifiedQueries = [...nextQueries];
  306. // Discard ongoing transaction related to row query
  307. const nextQueryTransactions = queryTransactions.filter(qt => qt.rowIndex !== index);
  308. return {
  309. initialQueries: nextQueries,
  310. queryTransactions: nextQueryTransactions,
  311. };
  312. }, this.onSubmit);
  313. } else if (this.state.datasource.getHighlighterExpression && this.modifiedQueries.length === 1) {
  314. // Live preview of log search matches. Can only work on single row query for now
  315. this.updateLogsHighlights(value);
  316. }
  317. };
  318. onChangeTime = (nextRange: RawTimeRange, scanning?: boolean) => {
  319. const range: RawTimeRange = {
  320. ...nextRange,
  321. };
  322. if (this.state.scanning && !scanning) {
  323. this.onStopScanning();
  324. }
  325. this.setState({ range, scanning }, () => this.onSubmit());
  326. };
  327. onClickClear = () => {
  328. this.onStopScanning();
  329. this.modifiedQueries = ensureQueries();
  330. this.setState(
  331. prevState => ({
  332. initialQueries: [...this.modifiedQueries],
  333. queryTransactions: [],
  334. showingStartPage: Boolean(prevState.StartPage),
  335. }),
  336. this.saveState
  337. );
  338. };
  339. onClickCloseSplit = () => {
  340. const { onChangeSplit } = this.props;
  341. if (onChangeSplit) {
  342. onChangeSplit(false);
  343. }
  344. };
  345. onClickGraphButton = () => {
  346. this.setState(
  347. state => {
  348. const showingGraph = !state.showingGraph;
  349. let nextQueryTransactions = state.queryTransactions;
  350. if (!showingGraph) {
  351. // Discard transactions related to Graph query
  352. nextQueryTransactions = state.queryTransactions.filter(qt => qt.resultType !== 'Graph');
  353. }
  354. return { queryTransactions: nextQueryTransactions, showingGraph };
  355. },
  356. () => {
  357. if (this.state.showingGraph) {
  358. this.onSubmit();
  359. }
  360. }
  361. );
  362. };
  363. onClickLogsButton = () => {
  364. this.setState(
  365. state => {
  366. const showingLogs = !state.showingLogs;
  367. let nextQueryTransactions = state.queryTransactions;
  368. if (!showingLogs) {
  369. // Discard transactions related to Logs query
  370. nextQueryTransactions = state.queryTransactions.filter(qt => qt.resultType !== 'Logs');
  371. }
  372. return { queryTransactions: nextQueryTransactions, showingLogs };
  373. },
  374. () => {
  375. if (this.state.showingLogs) {
  376. this.onSubmit();
  377. }
  378. }
  379. );
  380. };
  381. // Use this in help pages to set page to a single query
  382. onClickExample = (query: DataQuery) => {
  383. const nextQueries = [{ ...query, ...generateQueryKeys() }];
  384. this.modifiedQueries = [...nextQueries];
  385. this.setState({ initialQueries: nextQueries }, this.onSubmit);
  386. };
  387. onClickSplit = () => {
  388. const { onChangeSplit } = this.props;
  389. if (onChangeSplit) {
  390. const state = this.cloneState();
  391. onChangeSplit(true, state);
  392. }
  393. };
  394. onClickTableButton = () => {
  395. this.setState(
  396. state => {
  397. const showingTable = !state.showingTable;
  398. if (showingTable) {
  399. return { showingTable, queryTransactions: state.queryTransactions };
  400. }
  401. // Toggle off needs discarding of table queries
  402. const nextQueryTransactions = state.queryTransactions.filter(qt => qt.resultType !== 'Table');
  403. const results = calculateResultsFromQueryTransactions(
  404. nextQueryTransactions,
  405. state.datasource,
  406. state.graphInterval
  407. );
  408. return { ...results, queryTransactions: nextQueryTransactions, showingTable };
  409. },
  410. () => {
  411. if (this.state.showingTable) {
  412. this.onSubmit();
  413. }
  414. }
  415. );
  416. };
  417. onClickLabel = (key: string, value: string) => {
  418. this.onModifyQueries({ type: 'ADD_FILTER', key, value });
  419. };
  420. onModifyQueries = (action, index?: number) => {
  421. const { datasource } = this.state;
  422. if (datasource && datasource.modifyQuery) {
  423. const preventSubmit = action.preventSubmit;
  424. this.setState(
  425. state => {
  426. const { initialQueries, queryTransactions } = state;
  427. let nextQueries: DataQuery[];
  428. let nextQueryTransactions;
  429. if (index === undefined) {
  430. // Modify all queries
  431. nextQueries = initialQueries.map((query, i) => ({
  432. ...datasource.modifyQuery(this.modifiedQueries[i], action),
  433. ...generateQueryKeys(i),
  434. }));
  435. // Discard all ongoing transactions
  436. nextQueryTransactions = [];
  437. } else {
  438. // Modify query only at index
  439. nextQueries = initialQueries.map((query, i) => {
  440. // Synchronise all queries with local query cache to ensure consistency
  441. // TODO still needed?
  442. return i === index
  443. ? {
  444. ...datasource.modifyQuery(this.modifiedQueries[i], action),
  445. ...generateQueryKeys(i),
  446. }
  447. : query;
  448. });
  449. nextQueryTransactions = queryTransactions
  450. // Consume the hint corresponding to the action
  451. .map(qt => {
  452. if (qt.hints != null && qt.rowIndex === index) {
  453. qt.hints = qt.hints.filter(hint => hint.fix.action !== action);
  454. }
  455. return qt;
  456. })
  457. // Preserve previous row query transaction to keep results visible if next query is incomplete
  458. .filter(qt => preventSubmit || qt.rowIndex !== index);
  459. }
  460. this.modifiedQueries = [...nextQueries];
  461. return {
  462. initialQueries: nextQueries,
  463. queryTransactions: nextQueryTransactions,
  464. };
  465. },
  466. // Accepting certain fixes do not result in a well-formed query which should not be submitted
  467. !preventSubmit ? () => this.onSubmit() : null
  468. );
  469. }
  470. };
  471. onRemoveQueryRow = index => {
  472. // Remove from local cache
  473. this.modifiedQueries = [...this.modifiedQueries.slice(0, index), ...this.modifiedQueries.slice(index + 1)];
  474. this.setState(
  475. state => {
  476. const { initialQueries, queryTransactions } = state;
  477. if (initialQueries.length <= 1) {
  478. return null;
  479. }
  480. // Remove row from react state
  481. const nextQueries = [...initialQueries.slice(0, index), ...initialQueries.slice(index + 1)];
  482. // Discard transactions related to row query
  483. const nextQueryTransactions = queryTransactions.filter(qt => qt.rowIndex !== index);
  484. const results = calculateResultsFromQueryTransactions(
  485. nextQueryTransactions,
  486. state.datasource,
  487. state.graphInterval
  488. );
  489. return {
  490. ...results,
  491. initialQueries: nextQueries,
  492. logsHighlighterExpressions: undefined,
  493. queryTransactions: nextQueryTransactions,
  494. };
  495. },
  496. () => this.onSubmit()
  497. );
  498. };
  499. onStartScanning = () => {
  500. this.setState({ scanning: true }, this.scanPreviousRange);
  501. };
  502. scanPreviousRange = () => {
  503. const scanRange = this.timepickerRef.current.move(-1, true);
  504. this.setState({ scanRange });
  505. };
  506. onStopScanning = () => {
  507. clearTimeout(this.scanTimer);
  508. this.setState(state => {
  509. const { queryTransactions } = state;
  510. const nextQueryTransactions = queryTransactions.filter(qt => qt.scanning && !qt.done);
  511. return { queryTransactions: nextQueryTransactions, scanning: false, scanRange: undefined };
  512. });
  513. };
  514. onSubmit = () => {
  515. const { showingLogs, showingGraph, showingTable, supportsGraph, supportsLogs, supportsTable } = this.state;
  516. // Keep table queries first since they need to return quickly
  517. if (showingTable && supportsTable) {
  518. this.runQueries(
  519. 'Table',
  520. {
  521. format: 'table',
  522. instant: true,
  523. valueWithRefId: true,
  524. },
  525. data => data[0]
  526. );
  527. }
  528. if (showingGraph && supportsGraph) {
  529. this.runQueries(
  530. 'Graph',
  531. {
  532. format: 'time_series',
  533. instant: false,
  534. },
  535. makeTimeSeriesList
  536. );
  537. }
  538. if (showingLogs && supportsLogs) {
  539. this.runQueries('Logs', { format: 'logs' });
  540. }
  541. this.saveState();
  542. };
  543. buildQueryOptions(query: DataQuery, queryOptions: { format: string; hinting?: boolean; instant?: boolean }) {
  544. const { datasource, range } = this.state;
  545. const { interval, intervalMs } = getIntervals(range, datasource, this.el.offsetWidth);
  546. const configuredQueries = [
  547. {
  548. ...query,
  549. ...queryOptions,
  550. },
  551. ];
  552. // Clone range for query request
  553. const queryRange: RawTimeRange = { ...range };
  554. // Datasource is using `panelId + query.refId` for cancellation logic.
  555. // Using `format` here because it relates to the view panel that the request is for.
  556. const panelId = queryOptions.format;
  557. return {
  558. interval,
  559. intervalMs,
  560. panelId,
  561. targets: configuredQueries, // Datasources rely on DataQueries being passed under the targets key.
  562. range: queryRange,
  563. };
  564. }
  565. startQueryTransaction(query: DataQuery, rowIndex: number, resultType: ResultType, options: any): QueryTransaction {
  566. const queryOptions = this.buildQueryOptions(query, options);
  567. const transaction: QueryTransaction = {
  568. query,
  569. resultType,
  570. rowIndex,
  571. id: generateKey(), // reusing for unique ID
  572. done: false,
  573. latency: 0,
  574. options: queryOptions,
  575. scanning: this.state.scanning,
  576. };
  577. // Using updater style because we might be modifying queryTransactions in quick succession
  578. this.setState(state => {
  579. const { queryTransactions } = state;
  580. // Discarding existing transactions of same type
  581. const remainingTransactions = queryTransactions.filter(
  582. qt => !(qt.resultType === resultType && qt.rowIndex === rowIndex)
  583. );
  584. // Append new transaction
  585. const nextQueryTransactions = [...remainingTransactions, transaction];
  586. const results = calculateResultsFromQueryTransactions(
  587. nextQueryTransactions,
  588. state.datasource,
  589. state.graphInterval
  590. );
  591. return {
  592. ...results,
  593. queryTransactions: nextQueryTransactions,
  594. showingStartPage: false,
  595. graphInterval: queryOptions.intervalMs,
  596. };
  597. });
  598. return transaction;
  599. }
  600. completeQueryTransaction(
  601. transactionId: string,
  602. result: any,
  603. latency: number,
  604. queries: DataQuery[],
  605. datasourceId: string
  606. ) {
  607. const { datasource } = this.state;
  608. if (datasource.meta.id !== datasourceId) {
  609. // Navigated away, queries did not matter
  610. return;
  611. }
  612. this.setState(state => {
  613. const { history, queryTransactions, scanning } = state;
  614. // Transaction might have been discarded
  615. const transaction = queryTransactions.find(qt => qt.id === transactionId);
  616. if (!transaction) {
  617. return null;
  618. }
  619. // Get query hints
  620. let hints: QueryHint[];
  621. if (datasource.getQueryHints as QueryHintGetter) {
  622. hints = datasource.getQueryHints(transaction.query, result);
  623. }
  624. // Mark transactions as complete
  625. const nextQueryTransactions = queryTransactions.map(qt => {
  626. if (qt.id === transactionId) {
  627. return {
  628. ...qt,
  629. hints,
  630. latency,
  631. result,
  632. done: true,
  633. };
  634. }
  635. return qt;
  636. });
  637. const results = calculateResultsFromQueryTransactions(
  638. nextQueryTransactions,
  639. state.datasource,
  640. state.graphInterval
  641. );
  642. const nextHistory = updateHistory(history, datasourceId, queries);
  643. // Keep scanning for results if this was the last scanning transaction
  644. if (_.size(result) === 0 && scanning) {
  645. const other = nextQueryTransactions.find(qt => qt.scanning && !qt.done);
  646. if (!other) {
  647. this.scanTimer = setTimeout(this.scanPreviousRange, 1000);
  648. }
  649. }
  650. return {
  651. ...results,
  652. history: nextHistory,
  653. queryTransactions: nextQueryTransactions,
  654. };
  655. });
  656. }
  657. failQueryTransaction(transactionId: string, response: any, datasourceId: string) {
  658. const { datasource } = this.state;
  659. if (datasource.meta.id !== datasourceId || response.cancelled) {
  660. // Navigated away, queries did not matter
  661. return;
  662. }
  663. console.error(response);
  664. let error: string | JSX.Element;
  665. if (response.data) {
  666. if (typeof response.data === 'string') {
  667. error = response.data;
  668. } else if (response.data.error) {
  669. error = response.data.error;
  670. if (response.data.response) {
  671. error = (
  672. <>
  673. <span>{response.data.error}</span>
  674. <details>{response.data.response}</details>
  675. </>
  676. );
  677. }
  678. } else {
  679. throw new Error('Could not handle error response');
  680. }
  681. } else if (response.message) {
  682. error = response.message;
  683. } else if (typeof response === 'string') {
  684. error = response;
  685. } else {
  686. error = 'Unknown error during query transaction. Please check JS console logs.';
  687. }
  688. this.setState(state => {
  689. // Transaction might have been discarded
  690. if (!state.queryTransactions.find(qt => qt.id === transactionId)) {
  691. return null;
  692. }
  693. // Mark transactions as complete
  694. const nextQueryTransactions = state.queryTransactions.map(qt => {
  695. if (qt.id === transactionId) {
  696. return {
  697. ...qt,
  698. error,
  699. done: true,
  700. };
  701. }
  702. return qt;
  703. });
  704. return {
  705. queryTransactions: nextQueryTransactions,
  706. };
  707. });
  708. }
  709. async runQueries(resultType: ResultType, queryOptions: any, resultGetter?: any) {
  710. const queries = [...this.modifiedQueries];
  711. if (!hasNonEmptyQuery(queries)) {
  712. this.setState({
  713. queryTransactions: [],
  714. });
  715. return;
  716. }
  717. const { datasource } = this.state;
  718. const datasourceId = datasource.meta.id;
  719. // Run all queries concurrently
  720. queries.forEach(async (query, rowIndex) => {
  721. const transaction = this.startQueryTransaction(query, rowIndex, resultType, queryOptions);
  722. try {
  723. const now = Date.now();
  724. const res = await datasource.query(transaction.options);
  725. const latency = Date.now() - now;
  726. const results = resultGetter ? resultGetter(res.data) : res.data;
  727. this.completeQueryTransaction(transaction.id, results, latency, queries, datasourceId);
  728. } catch (response) {
  729. this.failQueryTransaction(transaction.id, response, datasourceId);
  730. }
  731. });
  732. }
  733. updateLogsHighlights = _.debounce((value: DataQuery, index: number) => {
  734. this.setState(state => {
  735. const { datasource } = state;
  736. if (datasource.getHighlighterExpression) {
  737. const logsHighlighterExpressions = [state.datasource.getHighlighterExpression(value)];
  738. return { logsHighlighterExpressions };
  739. }
  740. return null;
  741. });
  742. }, 500);
  743. cloneState(): ExploreState {
  744. // Copy state, but copy queries including modifications
  745. return {
  746. ...this.state,
  747. queryTransactions: [],
  748. initialQueries: [...this.modifiedQueries],
  749. };
  750. }
  751. saveState = () => {
  752. const { stateKey, onSaveState } = this.props;
  753. onSaveState(stateKey, this.cloneState());
  754. };
  755. render() {
  756. const { position, split } = this.props;
  757. const {
  758. StartPage,
  759. datasource,
  760. datasourceError,
  761. datasourceLoading,
  762. datasourceMissing,
  763. exploreDatasources,
  764. graphResult,
  765. history,
  766. initialQueries,
  767. logsHighlighterExpressions,
  768. logsResult,
  769. queryTransactions,
  770. range,
  771. scanning,
  772. scanRange,
  773. showingGraph,
  774. showingLogs,
  775. showingStartPage,
  776. showingTable,
  777. supportsGraph,
  778. supportsLogs,
  779. supportsTable,
  780. tableResult,
  781. } = this.state;
  782. const graphHeight = showingGraph && showingTable ? '200px' : '400px';
  783. const exploreClass = split ? 'explore explore-split' : 'explore';
  784. const selectedDatasource = datasource ? exploreDatasources.find(d => d.label === datasource.name) : undefined;
  785. const graphLoading = queryTransactions.some(qt => qt.resultType === 'Graph' && !qt.done);
  786. const tableLoading = queryTransactions.some(qt => qt.resultType === 'Table' && !qt.done);
  787. const logsLoading = queryTransactions.some(qt => qt.resultType === 'Logs' && !qt.done);
  788. const loading = queryTransactions.some(qt => !qt.done);
  789. return (
  790. <div className={exploreClass} ref={this.getRef}>
  791. <div className="navbar">
  792. {position === 'left' ? (
  793. <div>
  794. <a className="navbar-page-btn">
  795. <i className="fa fa-rocket" />
  796. Explore
  797. </a>
  798. </div>
  799. ) : (
  800. <div className="navbar-buttons explore-first-button">
  801. <button className="btn navbar-button" onClick={this.onClickCloseSplit}>
  802. Close Split
  803. </button>
  804. </div>
  805. )}
  806. {!datasourceMissing ? (
  807. <div className="navbar-buttons">
  808. <Select
  809. classNamePrefix={`gf-form-select-box`}
  810. isMulti={false}
  811. isLoading={datasourceLoading}
  812. isClearable={false}
  813. className="gf-form-input gf-form-input--form-dropdown datasource-picker"
  814. onChange={this.onChangeDatasource}
  815. options={exploreDatasources}
  816. styles={ResetStyles}
  817. placeholder="Select datasource"
  818. loadingMessage={() => 'Loading datasources...'}
  819. noOptionsMessage={() => 'No datasources found'}
  820. value={selectedDatasource}
  821. components={{
  822. Option: PickerOption,
  823. IndicatorsContainer,
  824. NoOptionsMessage,
  825. }}
  826. />
  827. </div>
  828. ) : null}
  829. <div className="navbar__spacer" />
  830. {position === 'left' && !split ? (
  831. <div className="navbar-buttons">
  832. <button className="btn navbar-button" onClick={this.onClickSplit}>
  833. Split
  834. </button>
  835. </div>
  836. ) : null}
  837. <TimePicker ref={this.timepickerRef} range={range} onChangeTime={this.onChangeTime} />
  838. <div className="navbar-buttons">
  839. <button className="btn navbar-button navbar-button--no-icon" onClick={this.onClickClear}>
  840. Clear All
  841. </button>
  842. </div>
  843. <div className="navbar-buttons relative">
  844. <button className="btn navbar-button--primary" onClick={this.onSubmit}>
  845. Run Query{' '}
  846. {loading ? <i className="fa fa-spinner fa-spin run-icon" /> : <i className="fa fa-level-down run-icon" />}
  847. </button>
  848. </div>
  849. </div>
  850. {datasourceLoading ? <div className="explore-container">Loading datasource...</div> : null}
  851. {datasourceMissing ? (
  852. <div className="explore-container">Please add a datasource that supports Explore (e.g., Prometheus).</div>
  853. ) : null}
  854. {datasourceError ? (
  855. <div className="explore-container">Error connecting to datasource. [{datasourceError}]</div>
  856. ) : null}
  857. {datasource && !datasourceError ? (
  858. <div className="explore-container">
  859. <QueryRows
  860. datasource={datasource}
  861. history={history}
  862. initialQueries={initialQueries}
  863. onAddQueryRow={this.onAddQueryRow}
  864. onChangeQuery={this.onChangeQuery}
  865. onClickHintFix={this.onModifyQueries}
  866. onExecuteQuery={this.onSubmit}
  867. onRemoveQueryRow={this.onRemoveQueryRow}
  868. transactions={queryTransactions}
  869. />
  870. <main className="m-t-2">
  871. <ErrorBoundary>
  872. {showingStartPage && <StartPage onClickExample={this.onClickExample} />}
  873. {!showingStartPage && (
  874. <>
  875. {supportsGraph && (
  876. <Panel
  877. label="Graph"
  878. isOpen={showingGraph}
  879. loading={graphLoading}
  880. onToggle={this.onClickGraphButton}
  881. >
  882. <Graph
  883. data={graphResult}
  884. height={graphHeight}
  885. id={`explore-graph-${position}`}
  886. onChangeTime={this.onChangeTime}
  887. range={range}
  888. split={split}
  889. />
  890. </Panel>
  891. )}
  892. {supportsTable && (
  893. <Panel
  894. label="Table"
  895. loading={tableLoading}
  896. isOpen={showingTable}
  897. onToggle={this.onClickTableButton}
  898. >
  899. <Table data={tableResult} loading={tableLoading} onClickCell={this.onClickLabel} />
  900. </Panel>
  901. )}
  902. {supportsLogs && (
  903. <Panel label="Logs" loading={logsLoading} isOpen={showingLogs} onToggle={this.onClickLogsButton}>
  904. <Logs
  905. data={logsResult}
  906. key={logsResult.id}
  907. highlighterExpressions={logsHighlighterExpressions}
  908. loading={logsLoading}
  909. position={position}
  910. onChangeTime={this.onChangeTime}
  911. onClickLabel={this.onClickLabel}
  912. onStartScanning={this.onStartScanning}
  913. onStopScanning={this.onStopScanning}
  914. range={range}
  915. scanning={scanning}
  916. scanRange={scanRange}
  917. />
  918. </Panel>
  919. )}
  920. </>
  921. )}
  922. </ErrorBoundary>
  923. </main>
  924. </div>
  925. ) : null}
  926. </div>
  927. );
  928. }
  929. }
  930. export default hot(module)(Explore);