IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Elasticsearch: Removed reference to obsolete esVersion value (#65415)

Browse Source 
* elastic: removed reference to obsolete esVersion value

* removed unused code

* cleaned up tests
This commit is contained in:
Gábor Farkas
2023-03-28 16:04:56 +02:00
committed by GitHub
parent de1637afe5
commit 0cff917f2a
22 changed files with 81 additions and 410 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
pkg/tsdb/elasticsearch/client/client.go
View File

@@ -12,7 +12,6 @@ import (
"strings"
"time"
"github.com/Masterminds/semver"
"github.com/grafana/grafana-plugin-sdk-go/backend"
"github.com/grafana/grafana/pkg/infra/log"
@@ -23,7 +22,6 @@ type DatasourceInfo struct {
HTTPClient *http.Client
URL string
Database string
ESVersion *semver.Version
ConfiguredFields ConfiguredFields
Interval string
TimeInterval string
@@ -60,7 +58,7 @@ var NewClient = func(ctx context.Context, ds *DatasourceInfo, timeRange backend.
}
logger := log.New(loggerName).FromContext(ctx)
logger.Debug("Creating new client", "version", ds.ESVersion, "configuredFields", fmt.Sprintf("%#v", ds.ConfiguredFields), "indices", strings.Join(indices, ", "))
logger.Debug("Creating new client", "configuredFields", fmt.Sprintf("%#v", ds.ConfiguredFields), "indices", strings.Join(indices, ", "))
return &baseClientImpl{
logger: logger,

5
pkg/tsdb/elasticsearch/client/client_test.go
View File

@@ -9,7 +9,6 @@ import (
"testing"
"time"
"github.com/Masterminds/semver"
"github.com/grafana/grafana-plugin-sdk-go/backend"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
@@ -43,9 +42,6 @@ func TestClient_ExecuteMultisearch(t *testing.T) {
rw.WriteHeader(200)
}))
version, err := semver.NewVersion("8.0.0")
require.NoError(t, err)
configuredFields := ConfiguredFields{
TimeField: "testtime",
LogMessageField: "line",
@@ -56,7 +52,6 @@ func TestClient_ExecuteMultisearch(t *testing.T) {
URL: ts.URL,
HTTPClient: ts.Client(),
Database: "[metrics-]YYYY.MM.DD",
ESVersion: version,
ConfiguredFields: configuredFields,
Interval: "Daily",
MaxConcurrentShardRequests: 6,

42
pkg/tsdb/elasticsearch/elasticsearch.go
View File

@@ -7,7 +7,6 @@ import (
"fmt"
"strconv"
"github.com/Masterminds/semver"
"github.com/grafana/grafana-plugin-sdk-go/backend"
"github.com/grafana/grafana-plugin-sdk-go/backend/datasource"
"github.com/grafana/grafana-plugin-sdk-go/backend/instancemgmt"
@@ -44,12 +43,6 @@ func (s *Service) QueryData(ctx context.Context, req *backend.QueryDataRequest)
// separate function to allow testing the whole transformation and query flow
func queryData(ctx context.Context, queries []backend.DataQuery, dsInfo *es.DatasourceInfo) (*backend.QueryDataResponse, error) {
// Support for version after their end-of-life (currently <7.10.0) was removed
lastSupportedVersion, _ := semver.NewVersion("7.10.0")
if dsInfo.ESVersion.LessThan(lastSupportedVersion) {
return &backend.QueryDataResponse{}, fmt.Errorf("support for elasticsearch versions after their end-of-life (currently versions < 7.10) was removed")
}
if len(queries) == 0 {
return &backend.QueryDataResponse{}, fmt.Errorf("query contains no queries")
}
@@ -84,10 +77,7 @@ func newInstanceSettings(httpClientProvider httpclient.Provider) datasource.Inst
return nil, err
}
version, err := coerceVersion(jsonData["esVersion"])
if err != nil {
return nil, fmt.Errorf("elasticsearch version is required, err=%v", err)
}
// we used to have a field named `esVersion`, please do not use this name in the future.
timeField, ok := jsonData["timeField"].(string)
if !ok {
@@ -154,7 +144,6 @@ func newInstanceSettings(httpClientProvider httpclient.Provider) datasource.Inst
HTTPClient: httpCli,
Database: settings.Database,
MaxConcurrentShardRequests: int64(maxConcurrentShardRequests),
ESVersion: version,
ConfiguredFields: configuredFields,
Interval: interval,
TimeInterval: timeInterval,
@@ -175,32 +164,3 @@ func (s *Service) getDSInfo(pluginCtx backend.PluginContext) (*es.DatasourceInfo
return &instance, nil
}
func coerceVersion(v interface{}) (*semver.Version, error) {
versionString, ok := v.(string)
if ok {
return semver.NewVersion(versionString)
}
versionNumber, ok := v.(float64)
if !ok {
return nil, fmt.Errorf("elasticsearch version %v, cannot be cast to int", v)
}
// Legacy version numbers (before Grafana 8)
// valid values were 2,5,56,60,70
switch int64(versionNumber) {
case 2:
return semver.NewVersion("2.0.0")
case 5:
return semver.NewVersion("5.0.0")
case 56:
return semver.NewVersion("5.6.0")
case 60:
return semver.NewVersion("6.0.0")
case 70:
return semver.NewVersion("7.0.0")
default:
return nil, fmt.Errorf("elasticsearch version=%d is not supported", int64(versionNumber))
}
}

118
pkg/tsdb/elasticsearch/elasticsearch_test.go
View File

@@ -11,50 +11,15 @@ import (
)
type datasourceInfo struct {
ESVersion interface{} `json:"esVersion"`
TimeField interface{} `json:"timeField"`
MaxConcurrentShardRequests int64 `json:"maxConcurrentShardRequests"`
Interval string `json:"interval"`
TimeInterval string `json:"timeInterval"`
}
func TestCoerceVersion(t *testing.T) {
t.Run("version is string", func(t *testing.T) {
ver := "7.0.0"
smvr, err := coerceVersion(ver)
require.NoError(t, err)
require.NotNil(t, smvr)
require.Equal(t, "7.0.0", smvr.String())
})
t.Run("version is int", func(t *testing.T) {
testCases := []struct {
intVersion float64
stringVersion string
}{
{intVersion: 2, stringVersion: "2.0.0"},
{intVersion: 5, stringVersion: "5.0.0"},
{intVersion: 56, stringVersion: "5.6.0"},
{intVersion: 60, stringVersion: "6.0.0"},
{intVersion: 70, stringVersion: "7.0.0"},
}
for _, tc := range testCases {
smvr, err := coerceVersion(tc.intVersion)
require.NoError(t, err)
require.Equal(t, tc.stringVersion, smvr.String())
}
smvr, err := coerceVersion(12345)
require.Error(t, err)
require.Nil(t, smvr)
})
}
func TestNewInstanceSettings(t *testing.T) {
t.Run("fields exist", func(t *testing.T) {
dsInfo := datasourceInfo{
ESVersion: "7.0.0",
TimeField: "@timestamp",
MaxConcurrentShardRequests: 5,
}
@@ -69,91 +34,9 @@ func TestNewInstanceSettings(t *testing.T) {
require.NoError(t, err)
})
t.Run("esVersion", func(t *testing.T) {
t.Run("correct version", func(t *testing.T) {
dsInfo := datasourceInfo{
ESVersion: 5,
TimeField: "@timestamp",
MaxConcurrentShardRequests: 5,
Interval: "Daily",
TimeInterval: "TimeInterval",
}
settingsJSON, err := json.Marshal(dsInfo)
require.NoError(t, err)
dsSettings := backend.DataSourceInstanceSettings{
JSONData: json.RawMessage(settingsJSON),
}
_, err = newInstanceSettings(httpclient.NewProvider())(dsSettings)
require.NoError(t, err)
})
t.Run("faulty version int", func(t *testing.T) {
dsInfo := datasourceInfo{
ESVersion: 1234,
TimeField: "@timestamp",
MaxConcurrentShardRequests: 5,
Interval: "Daily",
TimeInterval: "TimeInterval",
}
settingsJSON, err := json.Marshal(dsInfo)
require.NoError(t, err)
dsSettings := backend.DataSourceInstanceSettings{
JSONData: json.RawMessage(settingsJSON),
}
_, err = newInstanceSettings(httpclient.NewProvider())(dsSettings)
require.EqualError(t, err, "elasticsearch version is required, err=elasticsearch version=1234 is not supported")
})
t.Run("faulty version string", func(t *testing.T) {
dsInfo := datasourceInfo{
ESVersion: "NOT_VALID",
TimeField: "@timestamp",
MaxConcurrentShardRequests: 5,
Interval: "Daily",
TimeInterval: "TimeInterval",
}
settingsJSON, err := json.Marshal(dsInfo)
require.NoError(t, err)
dsSettings := backend.DataSourceInstanceSettings{
JSONData: json.RawMessage(settingsJSON),
}
_, err = newInstanceSettings(httpclient.NewProvider())(dsSettings)
require.EqualError(t, err, "elasticsearch version is required, err=Invalid Semantic Version")
})
t.Run("no version", func(t *testing.T) {
dsInfo := datasourceInfo{
TimeField: "@timestamp",
MaxConcurrentShardRequests: 5,
Interval: "Daily",
TimeInterval: "TimeInterval",
}
settingsJSON, err := json.Marshal(dsInfo)
require.NoError(t, err)
dsSettings := backend.DataSourceInstanceSettings{
JSONData: json.RawMessage(settingsJSON),
}
_, err = newInstanceSettings(httpclient.NewProvider())(dsSettings)
require.EqualError(t, err, "elasticsearch version is required, err=elasticsearch version <nil>, cannot be cast to int")
})
})
t.Run("timeField", func(t *testing.T) {
t.Run("is nil", func(t *testing.T) {
dsInfo := datasourceInfo{
ESVersion: 2,
MaxConcurrentShardRequests: 5,
Interval: "Daily",
TimeInterval: "TimeInterval",
@@ -172,7 +55,6 @@ func TestNewInstanceSettings(t *testing.T) {
t.Run("is empty", func(t *testing.T) {
dsInfo := datasourceInfo{
ESVersion: 2,
MaxConcurrentShardRequests: 5,
Interval: "Daily",
TimeField: "",

2
pkg/tsdb/elasticsearch/querydata_test.go
View File

@@ -9,7 +9,6 @@ import (
"net/http"
"time"
"github.com/Masterminds/semver"
"github.com/grafana/grafana-plugin-sdk-go/backend"
es "github.com/grafana/grafana/pkg/tsdb/elasticsearch/client"
@@ -49,7 +48,6 @@ func newFlowTestDsInfo(body []byte, statusCode int, requestCallback func(req *ht
}
return &es.DatasourceInfo{
ESVersion: semver.MustParse("8.5.0"),
Interval: "Daily",
Database: "[testdb-]YYYY.MM.DD",
ConfiguredFields: configuredFields,