import React from 'react'; import { hot } from 'react-hot-loader'; import Select from 'react-select'; import _ from 'lodash'; import { ExploreState, ExploreUrlState, HistoryItem, Query, QueryTransaction, ResultType } from 'app/types/explore'; import { RawTimeRange } from 'app/types/series'; import kbn from 'app/core/utils/kbn'; import colors from 'app/core/utils/colors'; import store from 'app/core/store'; import TimeSeries from 'app/core/time_series2'; import { parse as parseDate } from 'app/core/utils/datemath'; import { DEFAULT_RANGE } from 'app/core/utils/explore'; import ResetStyles from 'app/core/components/Picker/ResetStyles'; import PickerOption from 'app/core/components/Picker/PickerOption'; import IndicatorsContainer from 'app/core/components/Picker/IndicatorsContainer'; import NoOptionsMessage from 'app/core/components/Picker/NoOptionsMessage'; import TableModel, { mergeTablesIntoModel } from 'app/core/table_model'; import QueryRows from './QueryRows'; import Graph from './Graph'; import Logs from './Logs'; import Table from './Table'; import ErrorBoundary from './ErrorBoundary'; import TimePicker from './TimePicker'; import { ensureQueries, generateQueryKey, hasQuery } from './utils/query'; import { DataSource } from 'app/types/datasources'; const MAX_HISTORY_ITEMS = 100; function makeTimeSeriesList(dataList, options) { return dataList.map((seriesData, index) => { const datapoints = seriesData.datapoints || []; const alias = seriesData.target; const colorIndex = index % colors.length; const color = colors[colorIndex]; const series = new TimeSeries({ datapoints, alias, color, unit: seriesData.unit, }); return series; }); } /** * Update the query history. Side-effect: store history in local storage */ function updateHistory(history: HistoryItem[], datasourceId: string, queries: string[]): HistoryItem[] { const ts = Date.now(); queries.forEach(query => { history = [{ query, ts }, ...history]; }); if (history.length > MAX_HISTORY_ITEMS) { history = history.slice(0, MAX_HISTORY_ITEMS); } // Combine all queries of a datasource type into one history const historyKey = `grafana.explore.history.${datasourceId}`; store.setObject(historyKey, history); return history; } interface ExploreProps { datasourceSrv: any; onChangeSplit: (split: boolean, state?: ExploreState) => void; onSaveState: (key: string, state: ExploreState) => void; position: string; split: boolean; splitState?: ExploreState; stateKey: string; urlState: ExploreUrlState; } export class Explore extends React.PureComponent { el: any; /** * Current query expressions of the rows including their modifications, used for running queries. * Not kept in component state to prevent edit-render roundtrips. */ queryExpressions: string[]; constructor(props) { super(props); const splitState: ExploreState = props.splitState; let initialQueries: Query[]; if (splitState) { // Split state overrides everything this.state = splitState; initialQueries = splitState.queries; } else { const { datasource, queries, range } = props.urlState as ExploreUrlState; initialQueries = ensureQueries(queries); const initialRange = range || { ...DEFAULT_RANGE }; this.state = { datasource: null, datasourceError: null, datasourceLoading: null, datasourceMissing: false, datasourceName: datasource, exploreDatasources: [], graphRange: initialRange, history: [], queries: initialQueries, queryTransactions: [], range: initialRange, showingGraph: true, showingLogs: true, showingTable: true, supportsGraph: null, supportsLogs: null, supportsTable: null, }; } this.queryExpressions = initialQueries.map(q => q.query); } async componentDidMount() { const { datasourceSrv } = this.props; const { datasourceName } = this.state; if (!datasourceSrv) { throw new Error('No datasource service passed as props.'); } const datasources = datasourceSrv.getExploreSources(); const exploreDatasources = datasources.map(ds => ({ value: ds.name, label: ds.name, })); if (datasources.length > 0) { this.setState({ datasourceLoading: true, exploreDatasources }); // Priority: datasource in url, default datasource, first explore datasource let datasource; if (datasourceName) { datasource = await datasourceSrv.get(datasourceName); } else { datasource = await datasourceSrv.get(); } if (!datasource.meta.explore) { datasource = await datasourceSrv.get(datasources[0].name); } await this.setDatasource(datasource); } else { this.setState({ datasourceMissing: true }); } } async setDatasource(datasource: DataSource) { const supportsGraph = datasource.meta.metrics; const supportsLogs = datasource.meta.logs; const supportsTable = datasource.meta.metrics; const datasourceId = datasource.meta.id; let datasourceError = null; try { const testResult = await datasource.testDatasource(); datasourceError = testResult.status === 'success' ? null : testResult.message; } catch (error) { datasourceError = (error && error.statusText) || 'Network error'; } const historyKey = `grafana.explore.history.${datasourceId}`; const history = store.getObject(historyKey, []); if (datasource.init) { datasource.init(); } // Keep queries but reset edit state const nextQueries = this.state.queries.map((q, i) => ({ ...q, key: generateQueryKey(i), query: this.queryExpressions[i], })); // Custom components const StartPage = datasource.pluginExports.ExploreStartPage; this.setState( { StartPage, datasource, datasourceError, history, supportsGraph, supportsLogs, supportsTable, datasourceLoading: false, datasourceName: datasource.name, queries: nextQueries, }, () => { if (datasourceError === null) { this.onSubmit(); } } ); } getRef = el => { this.el = el; }; onAddQueryRow = index => { // Local cache this.queryExpressions[index + 1] = ''; this.setState(state => { const { queries, queryTransactions } = state; // Add row by generating new react key const nextQueries = [ ...queries.slice(0, index + 1), { query: '', key: generateQueryKey() }, ...queries.slice(index + 1), ]; // Ongoing transactions need to update their row indices const nextQueryTransactions = queryTransactions.map(qt => { if (qt.rowIndex > index) { return { ...qt, rowIndex: qt.rowIndex + 1, }; } return qt; }); return { queries: nextQueries, queryTransactions: nextQueryTransactions }; }); }; onChangeDatasource = async option => { this.setState({ datasource: null, datasourceError: null, datasourceLoading: true, queryTransactions: [], }); const datasourceName = option.value; const datasource = await this.props.datasourceSrv.get(datasourceName); this.setDatasource(datasource); }; onChangeQuery = (value: string, index: number, override?: boolean) => { // Keep current value in local cache this.queryExpressions[index] = value; if (override) { this.setState(state => { // Replace query row const { queries, queryTransactions } = state; const nextQuery: Query = { key: generateQueryKey(index), query: value, }; const nextQueries = [...queries]; nextQueries[index] = nextQuery; // Discard ongoing transaction related to row query const nextQueryTransactions = queryTransactions.filter(qt => qt.rowIndex !== index); return { queries: nextQueries, queryTransactions: nextQueryTransactions, }; }, this.onSubmit); } }; onChangeTime = (nextRange: RawTimeRange) => { const range: RawTimeRange = { ...nextRange, }; this.setState({ range }, () => this.onSubmit()); }; onClickClear = () => { this.queryExpressions = ['']; this.setState( { queries: ensureQueries(), queryTransactions: [], }, this.saveState ); }; onClickCloseSplit = () => { const { onChangeSplit } = this.props; if (onChangeSplit) { onChangeSplit(false); } }; onClickGraphButton = () => { this.setState( state => { const showingGraph = !state.showingGraph; let nextQueryTransactions = state.queryTransactions; if (!showingGraph) { // Discard transactions related to Graph query nextQueryTransactions = state.queryTransactions.filter(qt => qt.resultType !== 'Graph'); } return { queryTransactions: nextQueryTransactions, showingGraph }; }, () => { if (this.state.showingGraph) { this.onSubmit(); } } ); }; onClickLogsButton = () => { this.setState( state => { const showingLogs = !state.showingLogs; let nextQueryTransactions = state.queryTransactions; if (!showingLogs) { // Discard transactions related to Logs query nextQueryTransactions = state.queryTransactions.filter(qt => qt.resultType !== 'Logs'); } return { queryTransactions: nextQueryTransactions, showingLogs }; }, () => { if (this.state.showingLogs) { this.onSubmit(); } } ); }; // Use this in help pages to set page to a single query onClickQuery = query => { const nextQueries = [{ query, key: generateQueryKey() }]; this.queryExpressions = nextQueries.map(q => q.query); this.setState({ queries: nextQueries }, this.onSubmit); }; onClickSplit = () => { const { onChangeSplit } = this.props; if (onChangeSplit) { const state = this.cloneState(); onChangeSplit(true, state); } }; onClickTableButton = () => { this.setState( state => { const showingTable = !state.showingTable; let nextQueryTransactions = state.queryTransactions; if (!showingTable) { // Discard transactions related to Table query nextQueryTransactions = state.queryTransactions.filter(qt => qt.resultType !== 'Table'); } return { queryTransactions: nextQueryTransactions, showingTable }; }, () => { if (this.state.showingTable) { this.onSubmit(); } } ); }; onClickTableCell = (columnKey: string, rowValue: string) => { this.onModifyQueries({ type: 'ADD_FILTER', key: columnKey, value: rowValue }); }; onModifyQueries = (action, index?: number) => { const { datasource } = this.state; if (datasource && datasource.modifyQuery) { const preventSubmit = action.preventSubmit; this.setState( state => { const { queries, queryTransactions } = state; let nextQueries; let nextQueryTransactions; if (index === undefined) { // Modify all queries nextQueries = queries.map((q, i) => ({ key: generateQueryKey(i), query: datasource.modifyQuery(this.queryExpressions[i], action), })); // Discard all ongoing transactions nextQueryTransactions = []; } else { // Modify query only at index nextQueries = queries.map((q, i) => { // Synchronise all queries with local query cache to ensure consistency q.query = this.queryExpressions[i]; return i === index ? { key: generateQueryKey(index), query: datasource.modifyQuery(q.query, action), } : q; }); nextQueryTransactions = queryTransactions // Consume the hint corresponding to the action .map(qt => { if (qt.hints != null && qt.rowIndex === index) { qt.hints = qt.hints.filter(hint => hint.fix.action !== action); } return qt; }) // Preserve previous row query transaction to keep results visible if next query is incomplete .filter(qt => preventSubmit || qt.rowIndex !== index); } this.queryExpressions = nextQueries.map(q => q.query); return { queries: nextQueries, queryTransactions: nextQueryTransactions, }; }, // Accepting certain fixes do not result in a well-formed query which should not be submitted !preventSubmit ? () => this.onSubmit() : null ); } }; onRemoveQueryRow = index => { // Remove from local cache this.queryExpressions = [...this.queryExpressions.slice(0, index), ...this.queryExpressions.slice(index + 1)]; this.setState( state => { const { queries, queryTransactions } = state; if (queries.length <= 1) { return null; } // Remove row from react state const nextQueries = [...queries.slice(0, index), ...queries.slice(index + 1)]; // Discard transactions related to row query const nextQueryTransactions = queryTransactions.filter(qt => qt.rowIndex !== index); return { queries: nextQueries, queryTransactions: nextQueryTransactions, }; }, () => this.onSubmit() ); }; onSubmit = () => { const { showingLogs, showingGraph, showingTable, supportsGraph, supportsLogs, supportsTable } = this.state; if (showingTable && supportsTable) { this.runTableQuery(); } if (showingGraph && supportsGraph) { this.runGraphQueries(); } if (showingLogs && supportsLogs) { this.runLogsQuery(); } this.saveState(); }; buildQueryOptions( query: string, rowIndex: number, targetOptions: { format: string; hinting?: boolean; instant?: boolean } ) { const { datasource, range } = this.state; const resolution = this.el.offsetWidth; const absoluteRange: RawTimeRange = { from: parseDate(range.from, false), to: parseDate(range.to, true), }; const { interval } = kbn.calculateInterval(absoluteRange, resolution, datasource.interval); const targets = [ { ...targetOptions, // Target identifier is needed for table transformations refId: rowIndex + 1, expr: query, }, ]; // Clone range for query request const queryRange: RawTimeRange = { ...range }; return { interval, targets, range: queryRange, }; } startQueryTransaction(query: string, rowIndex: number, resultType: ResultType, options: any): QueryTransaction { const queryOptions = this.buildQueryOptions(query, rowIndex, options); const transaction: QueryTransaction = { query, resultType, rowIndex, id: generateQueryKey(), done: false, latency: 0, options: queryOptions, }; // Using updater style because we might be modifying queryTransactions in quick succession this.setState(state => { const { queryTransactions } = state; // Discarding existing transactions of same type const remainingTransactions = queryTransactions.filter( qt => !(qt.resultType === resultType && qt.rowIndex === rowIndex) ); // Append new transaction const nextQueryTransactions = [...remainingTransactions, transaction]; return { queryTransactions: nextQueryTransactions, }; }); return transaction; } completeQueryTransaction( transactionId: string, result: any, latency: number, queries: string[], datasourceId: string ) { const { datasource } = this.state; if (datasource.meta.id !== datasourceId) { // Navigated away, queries did not matter return; } this.setState(state => { const { history, queryTransactions } = state; // Transaction might have been discarded const transaction = queryTransactions.find(qt => qt.id === transactionId); if (!transaction) { return null; } // Get query hints let hints; if (datasource.getQueryHints) { hints = datasource.getQueryHints(transaction.query, result); } // Mark transactions as complete const nextQueryTransactions = queryTransactions.map(qt => { if (qt.id === transactionId) { return { ...qt, hints, latency, result, done: true, }; } return qt; }); const nextHistory = updateHistory(history, datasourceId, queries); return { history: nextHistory, queryTransactions: nextQueryTransactions, }; }); } discardTransactions(rowIndex: number) { this.setState(state => { const remainingTransactions = state.queryTransactions.filter(qt => qt.rowIndex !== rowIndex); return { queryTransactions: remainingTransactions }; }); } failQueryTransaction(transactionId: string, response: any, datasourceId: string) { const { datasource } = this.state; if (datasource.meta.id !== datasourceId) { // Navigated away, queries did not matter return; } console.error(response); let error: string | JSX.Element = response; if (response.data) { error = response.data.error; if (response.data.response) { error = ( <> {response.data.error}
{response.data.response}
); } } this.setState(state => { // Transaction might have been discarded if (!state.queryTransactions.find(qt => qt.id === transactionId)) { return null; } // Mark transactions as complete const nextQueryTransactions = state.queryTransactions.map(qt => { if (qt.id === transactionId) { return { ...qt, error, done: true, }; } return qt; }); return { queryTransactions: nextQueryTransactions, }; }); } async runGraphQueries() { const queries = [...this.queryExpressions]; if (!hasQuery(queries)) { return; } const { datasource } = this.state; const datasourceId = datasource.meta.id; // Run all queries concurrently queries.forEach(async (query, rowIndex) => { if (query) { const transaction = this.startQueryTransaction(query, rowIndex, 'Graph', { format: 'time_series', instant: false, }); try { const now = Date.now(); const res = await datasource.query(transaction.options); const latency = Date.now() - now; const results = makeTimeSeriesList(res.data, transaction.options); this.completeQueryTransaction(transaction.id, results, latency, queries, datasourceId); this.setState({ graphRange: transaction.options.range }); } catch (response) { this.failQueryTransaction(transaction.id, response, datasourceId); } } else { this.discardTransactions(rowIndex); } }); } async runTableQuery() { const queries = [...this.queryExpressions]; if (!hasQuery(queries)) { return; } const { datasource } = this.state; const datasourceId = datasource.meta.id; // Run all queries concurrently queries.forEach(async (query, rowIndex) => { if (query) { const transaction = this.startQueryTransaction(query, rowIndex, 'Table', { format: 'table', instant: true, valueWithRefId: true, }); try { const now = Date.now(); const res = await datasource.query(transaction.options); const latency = Date.now() - now; const results = res.data[0]; this.completeQueryTransaction(transaction.id, results, latency, queries, datasourceId); } catch (response) { this.failQueryTransaction(transaction.id, response, datasourceId); } } else { this.discardTransactions(rowIndex); } }); } async runLogsQuery() { const queries = [...this.queryExpressions]; if (!hasQuery(queries)) { return; } const { datasource } = this.state; const datasourceId = datasource.meta.id; // Run all queries concurrently queries.forEach(async (query, rowIndex) => { if (query) { const transaction = this.startQueryTransaction(query, rowIndex, 'Logs', { format: 'logs' }); try { const now = Date.now(); const res = await datasource.query(transaction.options); const latency = Date.now() - now; const results = res.data; this.completeQueryTransaction(transaction.id, results, latency, queries, datasourceId); } catch (response) { this.failQueryTransaction(transaction.id, response, datasourceId); } } else { this.discardTransactions(rowIndex); } }); } cloneState(): ExploreState { // Copy state, but copy queries including modifications return { ...this.state, queryTransactions: [], queries: ensureQueries(this.queryExpressions.map(query => ({ query }))), }; } saveState = () => { const { stateKey, onSaveState } = this.props; onSaveState(stateKey, this.cloneState()); }; render() { const { position, split } = this.props; const { StartPage, datasource, datasourceError, datasourceLoading, datasourceMissing, exploreDatasources, graphRange, history, queries, queryTransactions, range, showingGraph, showingLogs, showingTable, supportsGraph, supportsLogs, supportsTable, } = this.state; const showingBoth = showingGraph && showingTable; const graphHeight = showingBoth ? '200px' : '400px'; const graphButtonActive = showingBoth || showingGraph ? 'active' : ''; const logsButtonActive = showingLogs ? 'active' : ''; const tableButtonActive = showingBoth || showingTable ? 'active' : ''; const exploreClass = split ? 'explore explore-split' : 'explore'; const selectedDatasource = datasource ? exploreDatasources.find(d => d.label === datasource.name) : undefined; const graphLoading = queryTransactions.some(qt => qt.resultType === 'Graph' && !qt.done); const tableLoading = queryTransactions.some(qt => qt.resultType === 'Table' && !qt.done); const logsLoading = queryTransactions.some(qt => qt.resultType === 'Logs' && !qt.done); // TODO don't recreate those on each re-render const graphResult = _.flatten( queryTransactions.filter(qt => qt.resultType === 'Graph' && qt.done && qt.result).map(qt => qt.result) ); const tableResult = mergeTablesIntoModel( new TableModel(), ...queryTransactions.filter(qt => qt.resultType === 'Table' && qt.done && qt.result).map(qt => qt.result) ); const logsResult = datasource && datasource.mergeStreams ? datasource.mergeStreams( _.flatten( queryTransactions.filter(qt => qt.resultType === 'Logs' && qt.done && qt.result).map(qt => qt.result) ) ) : undefined; const loading = queryTransactions.some(qt => !qt.done); const showStartPages = StartPage && queryTransactions.length === 0; const viewModeCount = [supportsGraph, supportsLogs, supportsTable].filter(m => m).length; return (
{position === 'left' ? (
Explore
) : (
)} {!datasourceMissing ? (