query_ctrl.ts 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. import _ from 'lodash';
  2. import { QueryCtrl } from 'app/plugins/sdk';
  3. import appEvents from 'app/core/app_events';
  4. import { FilterSegments, DefaultRemoveFilterValue } from './filter_segments';
  5. import './query_aggregation_ctrl';
  6. export interface QueryMeta {
  7. rawQuery: string;
  8. rawQueryString: string;
  9. metricLabels: { [key: string]: string[] };
  10. resourceLabels: { [key: string]: string[] };
  11. }
  12. export class StackdriverQueryCtrl extends QueryCtrl {
  13. static templateUrl = 'partials/query.editor.html';
  14. target: {
  15. project: {
  16. id: string;
  17. name: string;
  18. };
  19. metricType: string;
  20. metricService: string;
  21. refId: string;
  22. aggregation: {
  23. crossSeriesReducer: string;
  24. alignmentPeriod: string;
  25. perSeriesAligner: string;
  26. groupBys: string[];
  27. };
  28. filters: string[];
  29. aliasBy: string;
  30. metricKind: any;
  31. valueType: any;
  32. };
  33. defaultDropdownValue = 'select metric';
  34. defaultMetricResourcesValue = 'all';
  35. defaultRemoveGroupByValue = '-- remove group by --';
  36. loadLabelsPromise: Promise<any>;
  37. stackdriverConstants;
  38. defaults = {
  39. project: {
  40. id: 'default',
  41. name: 'loading project...',
  42. },
  43. metricType: this.defaultDropdownValue,
  44. metricService: this.defaultMetricResourcesValue,
  45. metric: '',
  46. aggregation: {
  47. crossSeriesReducer: 'REDUCE_MEAN',
  48. alignmentPeriod: 'auto',
  49. perSeriesAligner: 'ALIGN_MEAN',
  50. groupBys: [],
  51. },
  52. filters: [],
  53. showAggregationOptions: false,
  54. aliasBy: '',
  55. metricKind: '',
  56. valueType: '',
  57. };
  58. metricDescriptors: any[];
  59. metrics: any[];
  60. groupBySegments: any[];
  61. removeSegment: any;
  62. showHelp: boolean;
  63. showLastQuery: boolean;
  64. lastQueryMeta: QueryMeta;
  65. lastQueryError?: string;
  66. metricLabels: { [key: string]: string[] };
  67. resourceLabels: { [key: string]: string[] };
  68. filterSegments: any;
  69. /** @ngInject */
  70. constructor($scope, $injector, private uiSegmentSrv, private templateSrv) {
  71. super($scope, $injector);
  72. _.defaultsDeep(this.target, this.defaults);
  73. this.metricDescriptors = [];
  74. this.metrics = [];
  75. this.panelCtrl.events.on('data-received', this.onDataReceived.bind(this), $scope);
  76. this.panelCtrl.events.on('data-error', this.onDataError.bind(this), $scope);
  77. this.getCurrentProject()
  78. .then(this.getMetricTypes.bind(this))
  79. .then(this.getLabels.bind(this));
  80. this.initSegments();
  81. }
  82. initSegments() {
  83. this.groupBySegments = this.target.aggregation.groupBys.map(groupBy => {
  84. return this.uiSegmentSrv.getSegmentForValue(groupBy);
  85. });
  86. this.removeSegment = this.uiSegmentSrv.newSegment({ fake: true, value: '-- remove group by --' });
  87. this.ensurePlusButton(this.groupBySegments);
  88. this.filterSegments = new FilterSegments(
  89. this.uiSegmentSrv,
  90. this.target,
  91. this.getGroupBys.bind(this, null, null, DefaultRemoveFilterValue, false),
  92. this.getFilterValues.bind(this)
  93. );
  94. this.filterSegments.buildSegmentModel();
  95. }
  96. async getCurrentProject() {
  97. try {
  98. this.target.project = await this.datasource.getDefaultProject();
  99. } catch (error) {
  100. let message = 'Projects cannot be fetched: ';
  101. message += error.statusText ? error.statusText + ': ' : '';
  102. if (error && error.data && error.data.error && error.data.error.message) {
  103. if (error.data.error.code === 403) {
  104. message += `
  105. A list of projects could not be fetched from the Google Cloud Resource Manager API.
  106. You might need to enable it first:
  107. https://console.developers.google.com/apis/library/cloudresourcemanager.googleapis.com`;
  108. } else {
  109. message += error.data.error.code + '. ' + error.data.error.message;
  110. }
  111. } else {
  112. message += 'Cannot connect to Stackdriver API';
  113. }
  114. appEvents.emit('ds-request-error', message);
  115. }
  116. }
  117. async getMetricTypes() {
  118. if (this.target.project.id !== 'default') {
  119. const metricTypes = await this.datasource.getMetricTypes(this.target.project.id);
  120. this.metricDescriptors = metricTypes;
  121. if (this.target.metricType === this.defaultDropdownValue && metricTypes.length > 0) {
  122. this.$scope.$apply(() => (this.target.metricType = metricTypes[0].id));
  123. }
  124. return metricTypes.map(mt => ({ value: mt.type, text: mt.type }));
  125. } else {
  126. return [];
  127. }
  128. }
  129. getMetricServices() {
  130. const defaultValue = { value: this.defaultMetricResourcesValue, text: this.defaultMetricResourcesValue };
  131. const resources = this.metricDescriptors.map(m => {
  132. const [resource] = m.type.split('/');
  133. const [service] = resource.split('.');
  134. return {
  135. value: resource,
  136. text: service,
  137. };
  138. });
  139. return resources.length > 0 ? [defaultValue, ..._.uniqBy(resources, 'value')] : [];
  140. }
  141. getMetrics() {
  142. const metrics = this.metricDescriptors.map(m => {
  143. const [resource] = m.type.split('/');
  144. const [service] = resource.split('.');
  145. return {
  146. resource,
  147. value: m.type,
  148. service,
  149. text: m.displayName,
  150. title: m.description,
  151. };
  152. });
  153. if (this.target.metricService === this.defaultMetricResourcesValue) {
  154. return metrics.map(m => ({ ...m, text: `${m.service} - ${m.text}` }));
  155. } else {
  156. return metrics.filter(m => m.resource === this.target.metricService);
  157. }
  158. }
  159. onResourceTypeChange(resource) {
  160. this.metrics = this.getMetrics();
  161. if (!this.metrics.find(m => m.value === this.target.metricType)) {
  162. this.target.metricType = this.defaultDropdownValue;
  163. } else {
  164. this.refresh();
  165. }
  166. }
  167. async getLabels() {
  168. this.loadLabelsPromise = new Promise(async resolve => {
  169. try {
  170. const data = await this.datasource.getLabels(this.target.metricType, this.target.refId);
  171. this.metricLabels = data.results[this.target.refId].meta.metricLabels;
  172. this.resourceLabels = data.results[this.target.refId].meta.resourceLabels;
  173. this.target.valueType = data.results[this.target.refId].meta.valueType;
  174. this.target.metricKind = data.results[this.target.refId].meta.metricKind;
  175. resolve();
  176. } catch (error) {
  177. console.log(error.data.message);
  178. appEvents.emit('alert-error', ['Error', 'Error loading metric labels for ' + this.target.metricType]);
  179. resolve();
  180. }
  181. });
  182. }
  183. async onMetricTypeChange() {
  184. this.refresh();
  185. this.getLabels();
  186. }
  187. async getGroupBys(segment, index, removeText?: string, removeUsed = true) {
  188. await this.loadLabelsPromise;
  189. const metricLabels = Object.keys(this.metricLabels || {})
  190. .filter(ml => {
  191. if (!removeUsed) {
  192. return true;
  193. }
  194. return this.target.aggregation.groupBys.indexOf('metric.label.' + ml) === -1;
  195. })
  196. .map(l => {
  197. return this.uiSegmentSrv.newSegment({
  198. value: `metric.label.${l}`,
  199. expandable: false,
  200. });
  201. });
  202. const resourceLabels = Object.keys(this.resourceLabels || {})
  203. .filter(ml => {
  204. if (!removeUsed) {
  205. return true;
  206. }
  207. return this.target.aggregation.groupBys.indexOf('resource.label.' + ml) === -1;
  208. })
  209. .map(l => {
  210. return this.uiSegmentSrv.newSegment({
  211. value: `resource.label.${l}`,
  212. expandable: false,
  213. });
  214. });
  215. const noValueOrPlusButton = !segment || segment.type === 'plus-button';
  216. if (noValueOrPlusButton && metricLabels.length === 0 && resourceLabels.length === 0) {
  217. return Promise.resolve([]);
  218. }
  219. this.removeSegment.value = removeText || this.defaultRemoveGroupByValue;
  220. return Promise.resolve([...metricLabels, ...resourceLabels, this.removeSegment]);
  221. }
  222. groupByChanged(segment, index) {
  223. if (segment.value === this.removeSegment.value) {
  224. this.groupBySegments.splice(index, 1);
  225. } else {
  226. segment.type = 'value';
  227. }
  228. const reducer = (memo, seg) => {
  229. if (!seg.fake) {
  230. memo.push(seg.value);
  231. }
  232. return memo;
  233. };
  234. this.target.aggregation.groupBys = this.groupBySegments.reduce(reducer, []);
  235. this.ensurePlusButton(this.groupBySegments);
  236. this.refresh();
  237. }
  238. async getFilters(segment, index) {
  239. const hasNoFilterKeys = this.metricLabels && Object.keys(this.metricLabels).length === 0;
  240. return this.filterSegments.getFilters(segment, index, hasNoFilterKeys);
  241. }
  242. getFilterValues(index) {
  243. const filterKey = this.templateSrv.replace(this.filterSegments.filterSegments[index - 2].value);
  244. if (!filterKey || !this.metricLabels || Object.keys(this.metricLabels).length === 0) {
  245. return [];
  246. }
  247. const shortKey = filterKey.substring(filterKey.indexOf('.label.') + 7);
  248. if (filterKey.startsWith('metric.label.') && this.metricLabels.hasOwnProperty(shortKey)) {
  249. return this.metricLabels[shortKey];
  250. }
  251. if (filterKey.startsWith('resource.label.') && this.resourceLabels.hasOwnProperty(shortKey)) {
  252. return this.resourceLabels[shortKey];
  253. }
  254. return [];
  255. }
  256. filterSegmentUpdated(segment, index) {
  257. this.target.filters = this.filterSegments.filterSegmentUpdated(segment, index);
  258. this.refresh();
  259. }
  260. ensurePlusButton(segments) {
  261. const count = segments.length;
  262. const lastSegment = segments[Math.max(count - 1, 0)];
  263. if (!lastSegment || lastSegment.type !== 'plus-button') {
  264. segments.push(this.uiSegmentSrv.newPlusButton());
  265. }
  266. }
  267. onDataReceived(dataList) {
  268. this.lastQueryError = null;
  269. this.lastQueryMeta = null;
  270. const anySeriesFromQuery: any = _.find(dataList, { refId: this.target.refId });
  271. if (anySeriesFromQuery) {
  272. this.lastQueryMeta = anySeriesFromQuery.meta;
  273. this.lastQueryMeta.rawQueryString = decodeURIComponent(this.lastQueryMeta.rawQuery);
  274. }
  275. }
  276. onDataError(err) {
  277. if (err.data && err.data.results) {
  278. const queryRes = err.data.results[this.target.refId];
  279. if (queryRes && queryRes.error) {
  280. this.lastQueryMeta = queryRes.meta;
  281. this.lastQueryMeta.rawQueryString = decodeURIComponent(this.lastQueryMeta.rawQuery);
  282. let jsonBody;
  283. try {
  284. jsonBody = JSON.parse(queryRes.error);
  285. } catch {
  286. this.lastQueryError = queryRes.error;
  287. }
  288. this.lastQueryError = jsonBody.error.message;
  289. }
  290. }
  291. console.error(err);
  292. }
  293. }