query_ctrl.ts 8.5 KB

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