cleanup provider name usage (trickstercache#502)

LimitlessEarth · Oct 13, 2020 · 1c541ba · 1c541ba
1 parent 0ec349b
commit 1c541ba
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 13 deletions.
diff --git a/pkg/backends/clickhouse/model/model.go b/pkg/backends/clickhouse/model/model.go
@@ -33,7 +33,7 @@ var marshalers = map[byte]dataset.Marshaler{
 	5: marshalTimeseriesTSVWithNamesAndTypes,
 }
 
-// NewModeler returns a collection of modeling functions for influxdb interoperability
+// NewModeler returns a collection of modeling functions for clickhouse interoperability
 func NewModeler() *timeseries.Modeler {
 	return &timeseries.Modeler{
 		WireUnmarshalerReader: UnmarshalTimeseriesReader,

diff --git a/pkg/backends/irondb/model/model.go b/pkg/backends/irondb/model/model.go
@@ -162,7 +162,7 @@ func (dp *DataPoint) UnmarshalJSON(b []byte) error {
 // DataPoints values represent sortable slices of data point values.
 type DataPoints []DataPoint
 
-// Len returns the length of an array of Prometheus model.Times
+// Len returns the number of elements in the subject slice
 func (dps DataPoints) Len() int {
 	return len(dps)
 }
@@ -172,8 +172,7 @@ func (dps DataPoints) Less(i, j int) bool {
 	return dps[i].Time.Before(dps[j].Time)
 }
 
-// Swap modifies a slice of data tuples by swapping the values in indexes
-// i and j.
+// Swap modifies the subject slice by swapping the values in indexes i and j
 func (dps DataPoints) Swap(i, j int) {
 	dps[i], dps[j] = dps[j], dps[i]
 }
@@ -346,7 +345,7 @@ func (se *SeriesEnvelope) Sort() {
 	sort.Sort(se.Data)
 }
 
-// NewModeler returns a collection of modeling functions for influxdb interoperability
+// NewModeler returns a collection of modeling functions for irondb interoperability
 func NewModeler() *timeseries.Modeler {
 	return &timeseries.Modeler{
 		WireUnmarshalerReader: UnmarshalTimeseriesReader,

diff --git a/pkg/backends/types/types.go → pkg/backends/providers/providers.go b/pkg/backends/types/types.go → pkg/backends/providers/providers.go
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package types
+package providers
 
 import "strconv"
 

diff --git a/pkg/backends/types/types_test.go → pkg/backends/providers/providers_test.go b/pkg/backends/types/types_test.go → pkg/backends/providers/providers_test.go
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package types
+package providers
 
 import (
 	"strconv"

diff --git a/pkg/cache/index/index.go b/pkg/cache/index/index.go
@@ -392,7 +392,7 @@ func (idx *Index) reap(logger interface{}) {
 	}
 }
 
-// Len returns the length of an array of Prometheus model.Times
+// Len returns the number of elements in the subject slice
 func (o objectsAtime) Len() int {
 	return len(o)
 }
@@ -402,7 +402,7 @@ func (o objectsAtime) Less(i, j int) bool {
 	return o[i].LastAccess.Before(o[j].LastAccess)
 }
 
-// Swap modifies an array by of Prometheus model.Times swapping the values in indexes i and j
+// Swap modifies the subject slice by swapping the values in indexes i and j
 func (o objectsAtime) Swap(i, j int) {
 	o[i], o[j] = o[j], o[i]
 }
diff --git a/pkg/config/flags.go b/pkg/config/flags.go
@@ -68,7 +68,7 @@ func parseFlags(applicationName string, arguments []string) (*Flags, error) {
 	flagSet.StringVar(&flags.Origin, cfOrigin, "",
 		"URL to the Origin. Enter it like you would in grafana, e.g., http://prometheus:9090")
 	flagSet.StringVar(&flags.Provider, cfProvider, "",
-		"Type of origin (prometheus, influxdb)")
+		"Name of the backend provider (prometheus, influxdb, clickhouse, rpc, etc.)")
 	flagSet.IntVar(&flags.ProxyListenPort, cfProxyPort, 0,
 		"Port that the primary Proxy server will listen on")
 	flagSet.IntVar(&flags.MetricsListenPort, cfMetricsPort, 0,

diff --git a/pkg/proxy/engines/key.go b/pkg/proxy/engines/key.go
@@ -34,7 +34,7 @@ import (
 	"github.com/tricksterproxy/trickster/pkg/util/md5"
 )
 
-// DeriveCacheKey calculates a query-specific keyname based on the prometheus query in the user request
+// DeriveCacheKey calculates a query-specific keyname based on the user request
 func (pr *proxyRequest) DeriveCacheKey(templateURL *url.URL, extra string) string {
 
 	rsc := request.GetResources(pr.Request)

diff --git a/pkg/routing/routing.go b/pkg/routing/routing.go
@@ -34,9 +34,9 @@ import (
 	oo "github.com/tricksterproxy/trickster/pkg/backends/options"
 	"github.com/tricksterproxy/trickster/pkg/backends/prometheus"
 	modelprom "github.com/tricksterproxy/trickster/pkg/backends/prometheus/model"
+	"github.com/tricksterproxy/trickster/pkg/backends/providers"
 	"github.com/tricksterproxy/trickster/pkg/backends/reverseproxycache"
 	"github.com/tricksterproxy/trickster/pkg/backends/rule"
-	"github.com/tricksterproxy/trickster/pkg/backends/types"
 	"github.com/tricksterproxy/trickster/pkg/cache"
 	"github.com/tricksterproxy/trickster/pkg/config"
 	tl "github.com/tricksterproxy/trickster/pkg/logging"
@@ -80,7 +80,7 @@ func RegisterProxyRoutes(conf *config.Config, router *mux.Router,
 
 	// This iteration will ensure default backends are handled properly
 	for k, o := range conf.Backends {
-		if !types.IsValidProvider(o.Provider) {
+		if !providers.IsValidProvider(o.Provider) {
 			return nil,
 				fmt.Errorf(`unknown backend provider in backend options. backendName: %s, backendProvider: %s`,
 					k, o.Provider)