Auto Interval and metricdatapoints error handling cdscrs 35197 (#263)

* auto works

* datapoints error handling

* capturing interval undefined

* some cleaning

* wait till region is populated

* cleanup

* interval as template var

* cleanup

* template variable for interval

* fix template var

* fine tune interval defaults

* interpolateProps verbessern

* some more controls

* golang verbesserungen

* minor golang warn fixed

* ready

Author: Mattia Moretti

docs/images/Interval-Template-Var.png

@@ -191,6 +191,15 @@ The final list of variables should look like this (**Plugin v5** and above):
 
 ![Metrics dashboard variables screenshot](images/template-multi.png)
 
+### Template variable for interval
+
+For intervals, you can use a custom or constant variable. To create a custom, select the variable type as custom. 
+Label(appears as the display name of the variable selected).
+
+Custom variables provide the convenience of using custom intervals for your dashboard. Please note the accepted format for intervals are within squared brackets and must include the time unit (for example [5m] to specify 5 minutes or [2h] for two hours). Following is an example of interval template variable definition:
+![Template variable for interval](images/Interval-Template-Var.png)
+
+
 ### Windows and Resolution
 
 For windows and resolution, you can use a custom or constant variable. To create a custom, select the variable type as custom. 

docs/using.md

@@ -36,7 +36,7 @@ func (o *OCIDatasource) TestConnectivity(ctx context.Context) error {
 		return fmt.Errorf("TestConnectivity failed: cannot read o.tenancyAccess")
 	}
 
-	for key, _ := range o.tenancyAccess {
+	for key := range o.tenancyAccess {
 		testResult = false
 
 		if tmode == "multitenancy" && tenv == "OCI Instance" {
@@ -118,7 +118,7 @@ func (o *OCIDatasource) GetTenancies(ctx context.Context) []models.OCIResource {
 	backend.Logger.Error("client", "GetTenancies", "fetching the tenancies")
 
 	tenancyList := []models.OCIResource{}
-	for key, _ := range o.tenancyAccess {
+	for key := range o.tenancyAccess {
 		// frame.AppendRow(*(common.String(key)))
 
 		tenancyList = append(tenancyList, models.OCIResource{
@@ -421,7 +421,7 @@ func (o *OCIDatasource) GetNamespaceWithMetricNames(
 // Links:
 // https://docs.oracle.com/en-us/iaas/Content/Identity/Reference/monitoringpolicyreference.htm
 // https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/MetricData/SummarizeMetricsData
-func (o *OCIDatasource) GetMetricDataPoints(ctx context.Context, requestParams models.MetricsDataRequest, tenancyOCID string) ([]time.Time, []models.OCIMetricDataPoints) {
+func (o *OCIDatasource) GetMetricDataPoints(ctx context.Context, requestParams models.MetricsDataRequest, tenancyOCID string) ([]time.Time, []models.OCIMetricDataPoints, error) {
 	backend.Logger.Error("client", "GetMetricDataPoints", "fetching the metrics datapoints under compartment '"+requestParams.CompartmentOCID+"' for query '"+requestParams.QueryText+"'")
 
 	times := []time.Time{}
@@ -441,7 +441,7 @@ func (o *OCIDatasource) GetMetricDataPoints(ctx context.Context, requestParams m
 
 	if len(takey) == 0 {
 		backend.Logger.Warn("client", "GetMetricDataPoints", "invalid takey")
-		return nil, nil
+		return nil, nil, errors.New("Datasource not configured (invalid takey)")
 	}
 
 	metricsDataRequest := monitoring.SummarizeMetricsDataRequest{
@@ -481,17 +481,18 @@ func (o *OCIDatasource) GetMetricDataPoints(ctx context.Context, requestParams m
 
 	// fetching the metrics data for specified region in parallel
 	var wg sync.WaitGroup
+	errCh := make(chan error)
 	for _, subscribedRegion := range subscribedRegions {
 		if subscribedRegion != constants.ALL_REGION {
 			wg.Add(1)
-			go func(mc monitoring.MonitoringClient, sRegion string) {
+			go func(mc monitoring.MonitoringClient, sRegion string, errCh chan error) {
 				defer wg.Done()
 
 				mc.SetRegion(sRegion)
 				resp, err := mc.SummarizeMetricsData(ctx, metricsDataRequest)
 				if err != nil {
 					backend.Logger.Error("client", "GetMetricDataPoints", err)
-					return
+					errCh <- err
 				}
 
 				if len(resp.Items) > 0 {
@@ -516,7 +517,14 @@ func (o *OCIDatasource) GetMetricDataPoints(ctx context.Context, requestParams m
 						resourceLabels: rl,
 					})
 				}
-			}(o.tenancyAccess[takey].monitoringClient, subscribedRegion)
+				errCh <- nil
+			}(o.tenancyAccess[takey].monitoringClient, subscribedRegion, errCh)
+			// Receive on the error channel
+			err := <-errCh
+			if err != nil {
+				backend.Logger.Error("client", "GetMetricDataPoints", err)
+				return nil, nil, err
+			}
 		}
 	}
 	wg.Wait()
@@ -686,7 +694,7 @@ func (o *OCIDatasource) GetMetricDataPoints(ctx context.Context, requestParams m
 		dataPoints = append(dataPoints, dp)
 	}
 
-	return times, dataPoints
+	return times, dataPoints, nil
 }
 
 // fetchFromCache will fetch value from cache and if it not present it will fetch via api and store to cache and return
@@ -731,15 +739,15 @@ func (o *OCIDatasource) GetTags(
 		}
 	}
 
-	compartments := []models.OCIResource{}
-	if len(compartmentOCID) == 0 {
-		compartments = append(compartments, o.GetCompartments(ctx, tenancyOCID)...)
-	} else {
-		compartments = append(compartments, models.OCIResource{
-			Name: compartmentName,
-			OCID: compartmentOCID,
-		})
-	}
+	// compartments := []models.OCIResource{}
+	// if len(compartmentOCID) == 0 {
+	// 	compartments = append(compartments, o.GetCompartments(ctx, tenancyOCID)...)
+	// } else {
+	// 	compartments = append(compartments, models.OCIResource{
+	// 		Name: compartmentName,
+	// 		OCID: compartmentOCID,
+	// 	})
+	// }
 
 	// var ccc core.ComputeClient
 	// //var vcc core.VirtualNetworkClient

pkg/plugin/metrics_functions.go

@@ -9,10 +9,8 @@ import (
 	"fmt"
 	"net/http"
 	"reflect"
-	"regexp"
 	"strconv"
 	"strings"
-	"time"
 
 	"github.com/pkg/errors"
 
@@ -37,22 +35,17 @@ const NoTenancy = "NoTenancy"
 var EmptyString string = ""
 var EmptyKeyPass *string = &EmptyString
 
-var (
-	cacheRefreshTime = time.Minute // how often to refresh our compartmentID cache
-	re               = regexp.MustCompile(`(?m)\w+Name`)
-)
-
 type TenancyAccess struct {
 	monitoringClient monitoring.MonitoringClient
 	identityClient   identity.IdentityClient
 	config           common.ConfigurationProvider
 }
 
 type OCIDatasource struct {
-	tenancyAccess    map[string]*TenancyAccess
-	logger           log.Logger
-	nameToOCID       map[string]string
-	timeCacheUpdated time.Time
+	tenancyAccess map[string]*TenancyAccess
+	logger        log.Logger
+	nameToOCID    map[string]string
+	// timeCacheUpdated time.Time
 	backend.CallResourceHandler
 	// clients  *client.OCIClients
 	settings *models.OCIDatasourceSettings
@@ -301,7 +294,7 @@ func (o *OCIDatasource) getConfigProvider(environment string, tenancymode string
 		if err != nil {
 			return errors.New("Error Loading config settings")
 		}
-		for key, _ := range q.tenancyocid {
+		for key := range q.tenancyocid {
 			var configProvider common.ConfigurationProvider
 			if tenancymode != "multitenancy" {
 				if key != "DEFAULT" {

pkg/plugin/plugin.go

@@ -5,6 +5,7 @@ package plugin
 
 import (
 	"context"
+	"time"
 
 	"github.com/grafana/grafana-plugin-sdk-go/backend"
 	"github.com/grafana/grafana-plugin-sdk-go/data"
@@ -57,8 +58,19 @@ func (ocidx *OCIDatasource) query(ctx context.Context, pCtx backend.PluginContex
 
 	// create data frame response
 	frame := data.NewFrame("response").SetMeta(&data.FrameMeta{ExecutedQueryString: qm.QueryText})
-
-	times, metricDataValues := ocidx.GetMetricDataPoints(ctx, metricsDataRequest, qm.TenancyOCID)
+	var err error
+	var metricDataValues []models.OCIMetricDataPoints
+	var times []time.Time
+
+	if (qm.Region != "" && qm.Region != "select region") &&
+		(qm.CompartmentOCID != "" && qm.CompartmentOCID != "select compartment") &&
+		(qm.Namespace != "" && qm.Namespace != "select namespace") {
+		times, metricDataValues, err = ocidx.GetMetricDataPoints(ctx, metricsDataRequest, qm.TenancyOCID)
+	}
+	if err != nil {
+		response.Error = err
+		return response
+	}
 
 	// plotting the x axis with time as unit
 	frame.Fields = append(frame.Fields, data.NewField("time", nil, times))
@@ -88,10 +100,8 @@ func (ocidx *OCIDatasource) query(ctx context.Context, pCtx backend.PluginContex
 
 				// Create a new slice for each key in the map
 				var values []string
+				values = append(values, dimension.Values...)
 
-				for _, vall := range dimension.Values {
-					values = append(values, vall)
-				}
 				// Assign the values slice to the map key
 				OriginalDimensionMap[key] = values
 			}

pkg/plugin/query.go

@@ -86,7 +86,7 @@ func listMetricsMetadataFromAllRegion(
 			go func(mc monitoring.MonitoringClient, sRegion string) {
 				defer wg.Done()
 
-				newCacheKey := strings.ReplaceAll(cacheKey, constants.ALL_REGION, subscribedRegion)
+				newCacheKey := strings.ReplaceAll(cacheKey, constants.ALL_REGION, sRegion)
 				metadata := listMetricsMetadataPerRegion(ctx, ci, newCacheKey, fetchFor, mc, req)
 
 				if len(metadata) > 0 {
@@ -627,7 +627,7 @@ func (o *OCIDatasource) generateCustomMetricLabel(legendFormat string, metricNam
 	}
 
 	for _, placeholderStr := range rePlaceholderLabel.FindAllString(metricLabel, -1) {
-		if rePlaceholderLabel.Match([]byte(placeholderStr)) == true {
+		if rePlaceholderLabel.Match([]byte(placeholderStr)) {
 			matches := rePlaceholderLabel.FindStringSubmatch(placeholderStr)
 			labelIndex := rePlaceholderLabel.SubexpIndex("label")
 

pkg/plugin/utils.go

@@ -267,6 +267,7 @@ export const QueryEditor: React.FC<Props> = (props) => {
 
   const getIntervalOptions = async () => {
     let options: Array<SelectableValue<string>> = [];
+    options = addTemplateVariablesToOptions(options);
     IntervalOptions.forEach((item: any) => {
       const sv: SelectableValue<any> = {
         label: item.label,

src/QueryEditor.tsx

@@ -51,6 +51,20 @@ export class OCIDataSource extends DataSourceWithBackend<OCIQuery, OCIDataSource
     return true;
   }
 
+  SetAutoInterval(timestamp1: number, timestamp2: number): string {
+    const differenceInMs = timestamp2 - timestamp1;
+    const differenceInHours = differenceInMs / (1000 * 60 * 60);
+  
+    // use limits and defaults specified here: https://docs.oracle.com/en-us/iaas/Content/Monitoring/Reference/mql.htm#Interval
+    if (differenceInHours <= 6) {
+      return "[1m]"; // Equal or Less than 6 hours, set to 1 minute interval
+    } else if (differenceInHours < 36) {
+      return "[5m]"; // Between 6 and 36 hours, set to 5 minute interval
+    } else {
+      return "[1h]"; // More than 36 hours, set to 1 hour interval
+    }
+  }
+
   compartmentFormatter = (value: string): string => {
     // if (typeof value === 'string') {
     //   return value;
@@ -71,6 +85,14 @@ export class OCIDataSource extends DataSourceWithBackend<OCIQuery, OCIDataSource
   applyTemplateVariables(query: OCIQuery, scopedVars: ScopedVars) {
     const templateSrv = getTemplateSrv();
 
+    const TimeStart = parseInt(getTemplateSrv().replace("${__from}"), 10)
+    const TimeEnd  = parseInt(getTemplateSrv().replace("${__to}"), 10)
+    if (this.isVariable(query.interval)) {
+      query.interval = templateSrv.replace(query.interval, scopedVars);
+    }
+    if (query.interval === QueryPlaceholder.Interval || query.interval === "auto" || query.interval === undefined){
+      query.interval = this.SetAutoInterval(TimeStart, TimeEnd);
+    }
     query.region = templateSrv.replace(query.region, scopedVars);
     query.tenancy = templateSrv.replace(query.tenancy, scopedVars);
     query.compartment = templateSrv.replace(query.compartment, scopedVars, this.compartmentFormatter);
@@ -110,20 +132,15 @@ export class OCIDataSource extends DataSourceWithBackend<OCIQuery, OCIDataSource
 
   interpolateProps<T extends Record<string, any>>(object: T, scopedVars: ScopedVars = {}): T {
     const templateSrv = getTemplateSrv();
-    return Object.entries(object).reduce((acc, [key, value]) => {
-      if (key === "compartment"){
-        return {
-          ...acc,
-          [key]: value && isString(value) ? templateSrv.replace(value, scopedVars, this.compartmentFormatter) : value,
-        };        
+    return Object.entries(object).reduce((acc: any, [key, value]) => {
+      if (value && isString(value)) {
+        const formatter = key === "compartment" ? this.compartmentFormatter : undefined;
+        acc[key] = templateSrv.replace(value, scopedVars, formatter);
       } else {
-        return {
-          ...acc,
-          [key]: value && isString(value) ? templateSrv.replace(value, scopedVars) : value,
-        };
+        acc[key] = value;
       }
-
-    }, {} as T);
+      return acc as T;
+    }, {});
   }
 
   // // **************************** Template variable helpers ****************************
@@ -133,7 +150,6 @@ export class OCIDataSource extends DataSourceWithBackend<OCIQuery, OCIDataSource
   //  * Example:
   //  * template variable with the query "regions()" will be matched with the regionsQueryRegex and list of available regions will be returned.
   //  */
-  // metricFindQuery?(query: any, options?: any): Promise<MetricFindValue[]> {
 
   async metricFindQuery?(query: any, options?: any): Promise<MetricFindValue[]> {
     const templateSrv = getTemplateSrv();

src/datasource.ts

@@ -3,7 +3,7 @@
 ** Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 */
 
-import { OCIQuery, QueryPlaceholder, AggregationOptions, IntervalOptions } from './types';
+import { OCIQuery, QueryPlaceholder, AggregationOptions } from './types';
 import { ScopedVars } from '@grafana/data';
 import { TemplateSrv } from '@grafana/runtime';
 
@@ -64,50 +64,45 @@ export default class QueryModel {
 
     return true;
   }
-  
 
-  buildQuery(queryText: string) { 
 
+  buildQuery(queryText: string) { 
+    //check if a raw query is being used
     if (this.target.queryTextRaw !== '' && this.target.rawQuery === false) {
       queryText = String(this.target.queryTextRaw);
     }  else {
-      // for default interval
-      if (this.target.interval === QueryPlaceholder.Interval) {
-        this.target.interval = IntervalOptions[0].value;
-      }
+      // if builder mode is used then:
+
+      // add interval
       queryText += this.target.interval;
 
-      // for dimensions
+      // add dimensions
       let dimensionParams = '{';
       let noOfDimensions = this.target.dimensionValues?.length ?? 0;
       if (noOfDimensions !== 0) {
         this.target.dimensionValues?.forEach((dv) => {
           dimensionParams += dv;
           noOfDimensions--;
-
           if (noOfDimensions !== 0) {
             dimensionParams += ',';
           }
         });
         dimensionParams += '}';
-
         queryText += dimensionParams;
       }
 
-      // for groupBy option
+      // add groupBy option
       if (this.target.groupBy !== QueryPlaceholder.GroupBy) {
         queryText += '.groupBy(' + this.target.groupBy + ')';
       }
 
-      // for default statistics
+      // add default statistics
       if (this.target.statistic === QueryPlaceholder.Aggregation) {
         this.target.statistic = AggregationOptions[0].value;
       }
-
       queryText += '.' + this.target.statistic;
       } 
 
-
     return queryText;
   }
 }

src/query_model.ts

@@ -59,6 +59,7 @@ export const IntervalOptions = [
   { label: '5 minutes', value: '[5m]', description: 'Maximum time range supported: 30 days' },
   { label: '1 hour', value: '[1h]', description: 'Maximum time range supported: 90 days' },
   { label: '1 day', value: '[1d]', description: 'Maximum time range supported: 90 days' },
+  { label: 'Auto', value: 'auto', description: 'Automatic selection of interval accordingly to OCI default' },
 ];
 
 export const AggregationOptions = [