From 4a2ba2a3ab37df8d3c074701e8e32fa35d38e524 Mon Sep 17 00:00:00 2001
From: Gary Wang <34413055+whua3@users.noreply.github.com>
Date: Mon, 22 Mar 2021 22:35:48 +0800
Subject: [PATCH] Add min time interval in opentsdb plugin (#31534)

* #31533 Add min time interval in Opentsdb plugin

* add docs to explain min time interval in opentsdb plugin

* Update docs/sources/datasources/opentsdb.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/datasources/opentsdb.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* optimize docs

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
---
 docs/sources/datasources/opentsdb.md          | 16 +++++++++++
 .../opentsdb/components/OpenTsdbDetails.tsx   | 28 +++++++++++++++++--
 .../plugins/datasource/opentsdb/datasource.ts |  2 ++
 .../app/plugins/datasource/opentsdb/types.ts  |  1 +
 4 files changed, 45 insertions(+), 2 deletions(-)

diff --git a/docs/sources/datasources/opentsdb.md b/docs/sources/datasources/opentsdb.md
index 9b2122e8036..9a6deb63fe4 100644
--- a/docs/sources/datasources/opentsdb.md
+++ b/docs/sources/datasources/opentsdb.md
@@ -23,6 +23,22 @@ To access OpenTSDB settings, hover your mouse over the **Configuration** (gear)
 | `Version`    | Version = opentsdb version, either <=2.1 or 2.2                                                                                       |
 | `Resolution` | Metrics from opentsdb may have datapoints with either second or millisecond resolution.                                               |
 | `Lookup Limit`| Default is 1000.                                                                                                                     |
+| `Min time interval`| A lower limit for the auto group by time interval. Recommended to be set to write frequency, for example `1m` if your data is written every minute. This option can also be overridden/configured in a dashboard panel under data source options. It's important to note that this value _must_ be formatted as a number followed by a [valid time identifier](#Supported min time identifiers), e.g. `1m` (1 minute) or `30s` (30 seconds). |
+
+### Supported min time identifiers
+
+The following time identifiers are supported:
+
+| Identifier | Description |
+| ---------- | ----------- |
+| `y`        | Years (365 days)|
+| `n`        | Months (30 days)|
+| `w`        | Weeks (7 days)|
+| `d`        | Days (24 hours)|
+| `h`        | Hours        |
+| `m`        | Minutes      |
+| `s`        | Seconds      |
+| `ms`       | Milliseconds |
 
 ## Query editor
 
diff --git a/public/app/plugins/datasource/opentsdb/components/OpenTsdbDetails.tsx b/public/app/plugins/datasource/opentsdb/components/OpenTsdbDetails.tsx
index 0457fe63db7..c689b96975a 100644
--- a/public/app/plugins/datasource/opentsdb/components/OpenTsdbDetails.tsx
+++ b/public/app/plugins/datasource/opentsdb/components/OpenTsdbDetails.tsx
@@ -1,6 +1,6 @@
 import React, { SyntheticEvent } from 'react';
-import { InlineFormLabel, LegacyForms } from '@grafana/ui';
-const { Select, Input } = LegacyForms;
+import { EventsWithValidation, regexValidation, InlineFormLabel, LegacyForms } from '@grafana/ui';
+const { Select, Input, FormField } = LegacyForms;
 import { DataSourceSettings, SelectableValue } from '@grafana/data';
 import { OpenTsdbOptions } from '../types';
 
@@ -53,6 +53,30 @@ export const OpenTsdbDetails = (props: Props) => {
           onChange={onInputChangeHandler('lookupLimit', value, onChange)}
         />
       </div>
+      <div className="gf-form-inline">
+        <div className="gf-form">
+          <FormField
+            labelWidth={7}
+            label="Min time interval"
+            inputEl={
+              <Input
+                className={'width-6'}
+                value={value.jsonData.interval || ''}
+                onChange={onInputChangeHandler('interval', value, onChange)}
+                placeholder="1m"
+                validationEvents={{
+                  [EventsWithValidation.onBlur]: [
+                    regexValidation(
+                      /^\d+(ms|[Mwdhmsy])$/,
+                      'Value is not valid, you can use number with time unit specifier: y, M, w, d, h, m, s'
+                    ),
+                  ],
+                }}
+              />
+            }
+          />
+        </div>
+      </div>
     </>
   );
 };
diff --git a/public/app/plugins/datasource/opentsdb/datasource.ts b/public/app/plugins/datasource/opentsdb/datasource.ts
index 59847c96de2..98a1b388d49 100644
--- a/public/app/plugins/datasource/opentsdb/datasource.ts
+++ b/public/app/plugins/datasource/opentsdb/datasource.ts
@@ -24,6 +24,7 @@ export default class OpenTsDatasource extends DataSourceApi<OpenTsdbQuery, OpenT
   tsdbVersion: any;
   tsdbResolution: any;
   lookupLimit: any;
+  interval: any;
   tagKeys: any;
 
   aggregatorsPromise: any;
@@ -40,6 +41,7 @@ export default class OpenTsDatasource extends DataSourceApi<OpenTsdbQuery, OpenT
     this.tsdbVersion = instanceSettings.jsonData.tsdbVersion || 1;
     this.tsdbResolution = instanceSettings.jsonData.tsdbResolution || 1;
     this.lookupLimit = instanceSettings.jsonData.lookupLimit || 1000;
+    this.interval = instanceSettings.jsonData.interval || '30s';
     this.tagKeys = {};
 
     this.aggregatorsPromise = null;
diff --git a/public/app/plugins/datasource/opentsdb/types.ts b/public/app/plugins/datasource/opentsdb/types.ts
index 4a5cf58eb47..bc693fcd703 100644
--- a/public/app/plugins/datasource/opentsdb/types.ts
+++ b/public/app/plugins/datasource/opentsdb/types.ts
@@ -8,4 +8,5 @@ export interface OpenTsdbOptions extends DataSourceJsonData {
   tsdbVersion: number;
   tsdbResolution: number;
   lookupLimit: number;
+  interval: string;
 }