feat!: [Core Contracts] Remove old common Metrics DTO and route constant

BREAKING CHANGE: /metrics endpoint no longer available for any service Closes: #787 Signed-off-by: Valina Li <[email protected]>
edgexfoundry · Feb 2, 2023 · 3eccfbd · 3eccfbd
1 parent a1a1c93
commit 3eccfbd
Show file tree

Hide file tree

Showing 16 changed files with 6 additions and 225 deletions.
diff --git a/clients/http/common.go b/clients/http/common.go
@@ -35,15 +35,6 @@ func (cc *commonClient) Configuration(ctx context.Context) (dtoCommon.ConfigResp
 	return cr, nil
 }
 
-func (cc *commonClient) Metrics(ctx context.Context) (dtoCommon.MetricsResponse, errors.EdgeX) {
-	mr := dtoCommon.MetricsResponse{}
-	err := utils.GetRequest(ctx, &mr, cc.baseUrl, common.ApiMetricsRoute, nil)
-	if err != nil {
-		return mr, errors.NewCommonEdgeXWrapper(err)
-	}
-	return mr, nil
-}
-
 func (cc *commonClient) Ping(ctx context.Context) (dtoCommon.PingResponse, errors.EdgeX) {
 	pr := dtoCommon.PingResponse{}
 	err := utils.GetRequest(ctx, &pr, cc.baseUrl, common.ApiPingRoute, nil)

diff --git a/clients/http/common_test.go b/clients/http/common_test.go
@@ -8,11 +8,12 @@ package http
 import (
 	"context"
 	"encoding/json"
-	"github.com/stretchr/testify/require"
 	"net/http"
 	"net/http/httptest"
 	"testing"
 
+	"github.com/stretchr/testify/require"
+
 	"github.com/edgexfoundry/go-mod-core-contracts/v3/common"
 	dtoCommon "github.com/edgexfoundry/go-mod-core-contracts/v3/dtos/common"
 )
@@ -32,17 +33,6 @@ func TestGetConfig(t *testing.T) {
 	require.Equal(t, expected, response)
 }
 
-func TestGetMetrics(t *testing.T) {
-	expected := dtoCommon.MetricsResponse{}
-	ts := newTestServer(http.MethodGet, common.ApiMetricsRoute, dtoCommon.MetricsResponse{})
-	defer ts.Close()
-
-	gc := NewCommonClient(ts.URL)
-	response, err := gc.Metrics(context.Background())
-	require.NoError(t, err)
-	require.Equal(t, expected, response)
-}
-
 func TestPing(t *testing.T) {
 	expected := dtoCommon.PingResponse{}
 	ts := newTestServer(http.MethodGet, common.ApiPingRoute, dtoCommon.PingResponse{})

diff --git a/clients/http/general.go b/clients/http/general.go
@@ -33,12 +33,3 @@ func (g *generalClient) FetchConfiguration(ctx context.Context) (res dtoCommon.C
 
 	return res, nil
 }
-
-func (g *generalClient) FetchMetrics(ctx context.Context) (res dtoCommon.MetricsResponse, err errors.EdgeX) {
-	err = utils.GetRequest(ctx, &res, g.baseUrl, common.ApiMetricsRoute, nil)
-	if err != nil {
-		return res, errors.NewCommonEdgeXWrapper(err)
-	}
-
-	return res, nil
-}
diff --git a/clients/http/general_test.go b/clients/http/general_test.go
@@ -25,13 +25,3 @@ func Test_generalClient_FetchConfiguration(t *testing.T) {
 	require.NoError(t, err)
 	require.IsType(t, dtoCommon.ConfigResponse{}, res)
 }
-
-func Test_generalClient_FetchMetrics(t *testing.T) {
-	ts := newTestServer(http.MethodGet, common.ApiMetricsRoute, dtoCommon.MetricsResponse{})
-	defer ts.Close()
-
-	client := NewGeneralClient(ts.URL)
-	res, err := client.FetchMetrics(context.Background())
-	require.NoError(t, err)
-	require.IsType(t, dtoCommon.MetricsResponse{}, res)
-}
diff --git a/clients/http/system.go b/clients/http/system.go
@@ -39,17 +39,6 @@ func (smc *SystemManagementClient) GetHealth(ctx context.Context, services []str
 	return
 }
 
-func (smc *SystemManagementClient) GetMetrics(ctx context.Context, services []string) (res []dtoCommon.BaseWithMetricsResponse, err errors.EdgeX) {
-	requestParams := url.Values{}
-	requestParams.Set(common.Services, strings.Join(services, common.CommaSeparator))
-	err = utils.GetRequest(ctx, &res, smc.baseUrl, common.ApiMultiMetricsRoute, requestParams)
-	if err != nil {
-		return res, errors.NewCommonEdgeXWrapper(err)
-	}
-
-	return
-}
-
 func (smc *SystemManagementClient) GetConfig(ctx context.Context, services []string) (res []dtoCommon.BaseWithConfigResponse, err errors.EdgeX) {
 	requestParams := url.Values{}
 	requestParams.Set(common.Services, strings.Join(services, common.CommaSeparator))

diff --git a/clients/http/system_test.go b/clients/http/system_test.go
@@ -27,16 +27,6 @@ func TestSystemManagementClient_GetHealth(t *testing.T) {
 	require.IsType(t, []dtoCommon.BaseWithServiceNameResponse{}, res)
 }
 
-func TestSystemManagementClient_GetMetrics(t *testing.T) {
-	ts := newTestServer(http.MethodGet, common.ApiMultiMetricsRoute, []dtoCommon.BaseWithMetricsResponse{})
-	defer ts.Close()
-
-	client := NewSystemManagementClient(ts.URL)
-	res, err := client.GetMetrics(context.Background(), []string{"core-data"})
-	require.NoError(t, err)
-	require.IsType(t, []dtoCommon.BaseWithMetricsResponse{}, res)
-}
-
 func TestSystemManagementClient_GetConfig(t *testing.T) {
 	ts := newTestServer(http.MethodGet, common.ApiMultiConfigRoute, []dtoCommon.BaseWithConfigResponse{})
 	defer ts.Close()

diff --git a/clients/interfaces/common.go b/clients/interfaces/common.go
@@ -15,8 +15,6 @@ import (
 type CommonClient interface {
 	// Configuration obtains configuration information from the target service.
 	Configuration(ctx context.Context) (common.ConfigResponse, errors.EdgeX)
-	// Metrics obtains metrics information from the target service.
-	Metrics(ctx context.Context) (common.MetricsResponse, errors.EdgeX)
 	// Ping tests whether the service is working
 	Ping(ctx context.Context) (common.PingResponse, errors.EdgeX)
 	// Version obtains version information from the target service.

diff --git a/clients/interfaces/general.go b/clients/interfaces/general.go
@@ -15,6 +15,4 @@ import (
 type GeneralClient interface {
 	// FetchConfiguration obtains configuration information from the target service.
 	FetchConfiguration(ctx context.Context) (common.ConfigResponse, errors.EdgeX)
-	// FetchMetrics obtains metrics information from the target service.
-	FetchMetrics(ctx context.Context) (common.MetricsResponse, errors.EdgeX)
 }
diff --git a/clients/interfaces/mocks/CommonClient.go b/clients/interfaces/mocks/CommonClient.go
diff --git a/clients/interfaces/mocks/GeneralClient.go b/clients/interfaces/mocks/GeneralClient.go
diff --git a/clients/interfaces/mocks/SystemManagementClient.go b/clients/interfaces/mocks/SystemManagementClient.go
diff --git a/clients/interfaces/system.go b/clients/interfaces/system.go
@@ -17,8 +17,6 @@ import (
 type SystemManagementClient interface {
 	// GetHealth obtain health information of services via registry by their name
 	GetHealth(ctx context.Context, services []string) ([]common.BaseWithServiceNameResponse, errors.EdgeX)
-	// GetMetrics obtain metrics information from services by their name
-	GetMetrics(ctx context.Context, services []string) ([]common.BaseWithMetricsResponse, errors.EdgeX)
 	// GetConfig obtain configuration from services by their name
 	GetConfig(ctx context.Context, services []string) ([]common.BaseWithConfigResponse, errors.EdgeX)
 	// DoOperation issue a start, stop, restart action to the targeted services

diff --git a/common/constants.go b/common/constants.go
@@ -101,7 +101,6 @@ const (
 	ApiTransmissionByNotificationIdRoute   = ApiTransmissionRoute + "/" + Notification + "/" + Id + "/{" + Id + "}"
 
 	ApiConfigRoute         = ApiBase + "/config"
-	ApiMetricsRoute        = ApiBase + "/metrics"
 	ApiPingRoute           = ApiBase + "/ping"
 	ApiVersionRoute        = ApiBase + "/version"
 	ApiSecretRoute         = ApiBase + "/secret"
@@ -125,11 +124,10 @@ const (
 	ApiIntervalActionByNameRoute   = ApiIntervalActionRoute + "/" + Name + "/{" + Name + "}"
 	ApiIntervalActionByTargetRoute = ApiIntervalActionRoute + "/" + Target + "/{" + Target + "}"
 
-	ApiSystemRoute       = ApiBase + "/system"
-	ApiOperationRoute    = ApiSystemRoute + "/operation"
-	ApiHealthRoute       = ApiSystemRoute + "/health"
-	ApiMultiMetricsRoute = ApiSystemRoute + "/metrics"
-	ApiMultiConfigRoute  = ApiSystemRoute + "/config"
+	ApiSystemRoute      = ApiBase + "/system"
+	ApiOperationRoute   = ApiSystemRoute + "/operation"
+	ApiHealthRoute      = ApiSystemRoute + "/health"
+	ApiMultiConfigRoute = ApiSystemRoute + "/config"
 )
 
 // Constants related to defined url path names and parameters in the v2 service APIs

diff --git a/dtos/common/base.go b/dtos/common/base.go
@@ -92,15 +92,6 @@ type BaseWithServiceNameResponse struct {
 	ServiceName  string `json:"serviceName"`
 }
 
-// BaseWithMetricsResponse defines the base content for response DTOs (data transfer objects).
-// This object and its properties correspond to the BaseWithMetricsResponse object in the APIv2 specification:
-// https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/system-agent/2.1.0#/BaseWithMetricsResponse
-type BaseWithMetricsResponse struct {
-	BaseResponse `json:",inline"`
-	ServiceName  string      `json:"serviceName"`
-	Metrics      interface{} `json:"metrics"`
-}
-
 // BaseWithConfigResponse defines the base content for response DTOs (data transfer objects).
 // This object and its properties correspond to the BaseWithConfigResponse object in the APIv2 specification:
 // https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/system-agent/2.1.0#/BaseWithConfigResponse

diff --git a/dtos/common/metrics.go b/dtos/common/metrics.go
diff --git a/dtos/common/metrics_test.go b/dtos/common/metrics_test.go