From 69bcd641acb06285fe0cdd519e0dc9caefc1341a Mon Sep 17 00:00:00 2001 From: derailed Date: Wed, 11 Nov 2020 04:50:23 -0700 Subject: [PATCH] cleaning up --- internal/client/client.go | 2 +- internal/client/errors.go | 2 ++ internal/client/metrics.go | 3 ++- internal/client/types.go | 4 ++-- internal/model/semver.go | 2 +- 5 files changed, 8 insertions(+), 5 deletions(-) diff --git a/internal/client/client.go b/internal/client/client.go index fdd87bf5..2b6f4f40 100644 --- a/internal/client/client.go +++ b/internal/client/client.go @@ -45,7 +45,7 @@ type APIClient struct { connOK bool } -// NewTestClient for testing ONLY!! +// NewTestAPIClient for testing ONLY!! func NewTestAPIClient() *APIClient { return &APIClient{ config: NewConfig(nil), diff --git a/internal/client/errors.go b/internal/client/errors.go index ca1ec817..99dabe3d 100644 --- a/internal/client/errors.go +++ b/internal/client/errors.go @@ -2,8 +2,10 @@ package client import metricsapi "k8s.io/metrics/pkg/apis/metrics" +// Error represents an error. type Error string +// Error returns the error text. func (e Error) Error() string { return string(e) } diff --git a/internal/client/metrics.go b/internal/client/metrics.go index 4d7b050d..360c8c0e 100644 --- a/internal/client/metrics.go +++ b/internal/client/metrics.go @@ -172,7 +172,7 @@ func (m *MetricsServer) FetchNodesMetrics(ctx context.Context) (*mv1beta1.NodeMe return mxList, nil } -// FetchNodesMetrics return all metrics for nodes. +// FetchNodeMetrics return all metrics for nodes. func (m *MetricsServer) FetchNodeMetrics(ctx context.Context, n string) (*mv1beta1.NodeMetrics, error) { const msg = "user is not authorized to list node metrics" @@ -243,6 +243,7 @@ func (m *MetricsServer) FetchPodsMetrics(ctx context.Context, ns string) (*mv1be return mxList, err } +// FetchContainersMetrics returns a pod's containers metrics. func (m *MetricsServer) FetchContainersMetrics(ctx context.Context, fqn string) (ContainersMetrics, error) { mm, err := m.FetchPodMetrics(ctx, fqn) if err != nil { diff --git a/internal/client/types.go b/internal/client/types.go index 7838d5d7..b4daffd2 100644 --- a/internal/client/types.go +++ b/internal/client/types.go @@ -63,10 +63,10 @@ var ( // ContainersMetrics tracks containers metrics. type ContainersMetrics map[string]*mv1beta1.ContainerMetrics -// NodesMetrics tracks node metrics. +// NodesMetricsMap tracks node metrics. type NodesMetricsMap map[string]*mv1beta1.NodeMetrics -// PodsMetrics tracks pod metrics. +// PodsMetricsMap tracks pod metrics. type PodsMetricsMap map[string]*mv1beta1.PodMetrics // Authorizer checks what a user can or cannot do to a resource. diff --git a/internal/model/semver.go b/internal/model/semver.go index 211a5ea0..d2fea1e9 100644 --- a/internal/model/semver.go +++ b/internal/model/semver.go @@ -38,7 +38,7 @@ func (*SemVer) parse(version string) (major, minor, patch int) { return } -// Normalize ensures the version starts with a v. +// NormalizeVersion ensures the version starts with a v. func NormalizeVersion(version string) string { if version == "" { return version