diff --git a/metrics/config_test.go b/metrics/config_test.go index 0a4029c3be..42caed562c 100644 --- a/metrics/config_test.go +++ b/metrics/config_test.go @@ -22,12 +22,16 @@ import ( . "knative.dev/pkg/logging/testing" ) +// TODO UTs should move to eventing and serving, as appropriate. +// See https://github.com/knative/pkg/issues/608 + const ( - servingDomain = "knative.dev/serving" - badDomain = "test.domain" - testComponent = "testComponent" - testProj = "test-project" - anotherProj = "another-project" + servingDomain = "knative.dev/serving" + eventingDomain = "knative.dev/eventing" + badDomain = "test.domain" + testComponent = "testComponent" + testProj = "test-project" + anotherProj = "another-project" ) var ( diff --git a/metrics/exporter_test.go b/metrics/exporter_test.go index 1781424d14..75f0947ffc 100644 --- a/metrics/exporter_test.go +++ b/metrics/exporter_test.go @@ -25,12 +25,24 @@ import ( "knative.dev/pkg/metrics/metricskey" ) +// TODO UTs should move to eventing and serving, as appropriate. +// See https://github.com/knative/pkg/issues/608 + const ( testNS = "test" testService = "test-service" testRoute = "test-route" testConfiguration = "test-configuration" testRevision = "test-revision" + + testBroker = "test-broker" + testEventType = "test-eventtype" + testEventSource = "test-eventsource" + testTrigger = "test-trigger" + testFilterType = "test-filtertype" + testFilterSource = "test-filtersource" + testImporter = "test-importer" + testImporterResourceGroup = "test-importer-rg" ) var ( @@ -41,12 +53,26 @@ var ( TagKeys: []tag.Key{}, } - nsKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelNamespaceName), Value: testNS} + nsKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelNamespaceName), Value: testNS} + serviceKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelServiceName), Value: testService} routeKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelRouteName), Value: testRoute} revisionKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelRevisionName), Value: testRevision} - testTags = []tag.Tag{nsKey, serviceKey, routeKey, revisionKey} + brokerKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelBrokerName), Value: testBroker} + triggerKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelTriggerName), Value: testTrigger} + filterTypeKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelFilterType), Value: testFilterType} + filterSourceKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelFilterSource), Value: testFilterSource} + importerKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelImporterName), Value: testImporter} + importerResourceGroupKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelImporterResourceGroup), Value: testImporterResourceGroup} + eventTypeKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelEventType), Value: testEventType} + eventSourceKey = tag.Tag{Key: mustNewTagKey(metricskey.LabelEventSource), Value: testEventSource} + + revisionTestTags = []tag.Tag{nsKey, serviceKey, routeKey, revisionKey} + + brokerTestTags = []tag.Tag{nsKey, brokerKey, eventTypeKey, eventSourceKey} + triggerTestTags = []tag.Tag{nsKey, triggerKey, brokerKey, filterTypeKey, filterSourceKey} + importerTestTags = []tag.Tag{nsKey, importerKey, importerResourceGroupKey, eventTypeKey, eventSourceKey} ) func mustNewTagKey(s string) tag.Key { diff --git a/metrics/gcp_metadata.go b/metrics/gcp_metadata.go index 5f33e3ea49..9cf9882e24 100644 --- a/metrics/gcp_metadata.go +++ b/metrics/gcp_metadata.go @@ -1,9 +1,12 @@ /* Copyright 2019 The Knative Authors + Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -18,6 +21,12 @@ import ( "knative.dev/pkg/metrics/metricskey" ) +type gcpMetadata struct { + project string + location string + cluster string +} + func retrieveGCPMetadata() *gcpMetadata { gm := gcpMetadata{ project: metricskey.ValueUnknown, diff --git a/metrics/metricskey/constants.go b/metrics/metricskey/constants.go index f941f222ae..01e5adff7e 100644 --- a/metrics/metricskey/constants.go +++ b/metrics/metricskey/constants.go @@ -1,9 +1,12 @@ /* Copyright 2018 The Knative Authors + Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -13,12 +16,7 @@ limitations under the License. package metricskey -import "k8s.io/apimachinery/pkg/util/sets" - const ( - // ResourceTypeKnativeRevision is the Stackdriver resource type for Knative revision - ResourceTypeKnativeRevision = "knative_revision" - // LabelProject is the label for project (e.g. GCP GAIA ID, AWS project name) LabelProject = "project_id" @@ -31,49 +29,7 @@ const ( // LabelNamespaceName is the label for immutable name of the namespace that the service is deployed LabelNamespaceName = "namespace_name" - // LabelServiceName is the label for the deployed service name - LabelServiceName = "service_name" - - // LabelRouteName is the label for immutable name of the route that receives the request - LabelRouteName = "route_name" - - // LabelConfigurationName is the label for the configuration which created the monitored revision - LabelConfigurationName = "configuration_name" - - // LabelRevisionName is the label for the monitored revision - LabelRevisionName = "revision_name" - // ValueUnknown is the default value if the field is unknown, e.g. project will be unknown if Knative // is not running on GKE. ValueUnknown = "unknown" ) - -var ( - // KnativeRevisionLabels stores the set of resource labels for resource type knative_revision. - // LabelRouteName is added as extra label since it is optional, not in this map. - KnativeRevisionLabels = sets.NewString( - LabelProject, - LabelLocation, - LabelClusterName, - LabelNamespaceName, - LabelServiceName, - LabelConfigurationName, - LabelRevisionName, - ) - - // KnativeRevisionMetrics stores a set of metric types which are supported - // by resource type knative_revision. - KnativeRevisionMetrics = sets.NewString( - "knative.dev/serving/activator/request_count", - "knative.dev/serving/activator/request_latencies", - "knative.dev/serving/autoscaler/desired_pods", - "knative.dev/serving/autoscaler/requested_pods", - "knative.dev/serving/autoscaler/actual_pods", - "knative.dev/serving/autoscaler/stable_request_concurrency", - "knative.dev/serving/autoscaler/panic_request_concurrency", - "knative.dev/serving/autoscaler/target_concurrency_per_pod", - "knative.dev/serving/autoscaler/panic_mode", - "knative.dev/serving/revision/request_count", - "knative.dev/serving/revision/request_latencies", - ) -) diff --git a/metrics/metricskey/constants_eventing.go b/metrics/metricskey/constants_eventing.go new file mode 100644 index 0000000000..249c582f48 --- /dev/null +++ b/metrics/metricskey/constants_eventing.go @@ -0,0 +1,107 @@ +/* +Copyright 2019 The Knative Authors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package metricskey + +import "k8s.io/apimachinery/pkg/util/sets" + +// TODO should be moved to eventing. See https://github.com/knative/pkg/issues/608 + +const ( + // ResourceTypeKnativeTrigger is the Stackdriver resource type for Knative Triggers. + ResourceTypeKnativeTrigger = "knative_trigger" + + // ResourceTypeKnativeBroker is the Stackdriver resource type for Knative Brokers. + ResourceTypeKnativeBroker = "knative_broker" + + // ResourceTypeKnativeImporter is the Stackdriver resource type for Knative Importers. + ResourceTypeKnativeImporter = "knative_importer" + + // LabelTriggerName is the label for the name of the Trigger. + LabelTriggerName = "trigger_name" + + // LabelBrokerName is the label for the name of the Broker. + LabelBrokerName = "broker_name" + + // LabelEventType is the label for the name of the event type. + LabelEventType = "event_type" + + // LabelEventSource is the label for the name of the event source. + LabelEventSource = "event_source" + + // LabelFilterType is the label for the Trigger filter attribute "type". + LabelFilterType = "filter_type" + + // LabelFilterSource is the label for the Trigger filter attribute "source". + LabelFilterSource = "filter_source" + + // LabelImporterName is the label for the name of the Importer. + LabelImporterName = "importer_name" + + // LabelImporterResourceGroup is the name of the Importer CRD. + LabelImporterResourceGroup = "importer_resource_group" +) + +var ( + // KnativeTriggerLabels stores the set of resource labels for resource type knative_trigger. + KnativeTriggerLabels = sets.NewString( + LabelProject, + LabelLocation, + LabelClusterName, + LabelNamespaceName, + LabelTriggerName, + LabelBrokerName, + ) + + // KnativeTriggerMetrics stores a set of metric types which are supported + // by resource type knative_trigger. + KnativeTriggerMetrics = sets.NewString( + "knative.dev/eventing/trigger/event_count", + "knative.dev/eventing/trigger/event_processing_latencies", + "knative.dev/eventing/trigger/event_dispatch_latencies", + ) + + // KnativeBrokerLabels stores the set of resource labels for resource type knative_broker. + KnativeBrokerLabels = sets.NewString( + LabelProject, + LabelLocation, + LabelClusterName, + LabelNamespaceName, + LabelBrokerName, + ) + + // KnativeBrokerMetrics stores a set of metric types which are supported + // by resource type knative_trigger. + KnativeBrokerMetrics = sets.NewString( + "knative.dev/eventing/broker/event_count", + ) + + // KnativeImporterLabels stores the set of resource labels for resource type knative_importer. + KnativeImporterLabels = sets.NewString( + LabelProject, + LabelLocation, + LabelClusterName, + LabelNamespaceName, + LabelImporterName, + LabelImporterResourceGroup, + ) + + // KnativeImporterMetrics stores a set of metric types which are supported + // by resource type knative_importer. + KnativeImporterMetrics = sets.NewString( + "knative.dev/eventing/importer/event_count", + ) +) diff --git a/metrics/metricskey/constants_serving.go b/metrics/metricskey/constants_serving.go new file mode 100644 index 0000000000..2b50dda770 --- /dev/null +++ b/metrics/metricskey/constants_serving.go @@ -0,0 +1,68 @@ +/* +Copyright 2019 The Knative Authors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package metricskey + +import "k8s.io/apimachinery/pkg/util/sets" + +// TODO should be moved to serving. See https://github.com/knative/pkg/issues/608 + +const ( + // ResourceTypeKnativeRevision is the Stackdriver resource type for Knative revision + ResourceTypeKnativeRevision = "knative_revision" + + // LabelServiceName is the label for the deployed service name + LabelServiceName = "service_name" + + // LabelRouteName is the label for immutable name of the route that receives the request + LabelRouteName = "route_name" + + // LabelConfigurationName is the label for the configuration which created the monitored revision + LabelConfigurationName = "configuration_name" + + // LabelRevisionName is the label for the monitored revision + LabelRevisionName = "revision_name" +) + +var ( + // KnativeRevisionLabels stores the set of resource labels for resource type knative_revision. + // LabelRouteName is added as extra label since it is optional, not in this map. + KnativeRevisionLabels = sets.NewString( + LabelProject, + LabelLocation, + LabelClusterName, + LabelNamespaceName, + LabelServiceName, + LabelConfigurationName, + LabelRevisionName, + ) + + // KnativeRevisionMetrics stores a set of metric types which are supported + // by resource type knative_revision. + KnativeRevisionMetrics = sets.NewString( + "knative.dev/serving/activator/request_count", + "knative.dev/serving/activator/request_latencies", + "knative.dev/serving/autoscaler/desired_pods", + "knative.dev/serving/autoscaler/requested_pods", + "knative.dev/serving/autoscaler/actual_pods", + "knative.dev/serving/autoscaler/stable_request_concurrency", + "knative.dev/serving/autoscaler/panic_request_concurrency", + "knative.dev/serving/autoscaler/target_concurrency_per_pod", + "knative.dev/serving/autoscaler/panic_mode", + "knative.dev/serving/revision/request_count", + "knative.dev/serving/revision/request_latencies", + ) +) diff --git a/metrics/monitored_resources.go b/metrics/monitored_resources.go index d8ab5d875d..d8034efc92 100644 --- a/metrics/monitored_resources.go +++ b/metrics/monitored_resources.go @@ -1,9 +1,12 @@ /* Copyright 2018 The Knative Authors + Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -14,40 +17,27 @@ limitations under the License. package metrics import ( + "go.opencensus.io/tag" "knative.dev/pkg/metrics/metricskey" ) -type gcpMetadata struct { - project string - location string - cluster string -} +type Global struct{} -type KnativeRevision struct { - Project string - Location string - ClusterName string - NamespaceName string - ServiceName string - ConfigurationName string - RevisionName string +func (g *Global) MonitoredResource() (resType string, labels map[string]string) { + return "global", nil } -func (kr *KnativeRevision) MonitoredResource() (resType string, labels map[string]string) { - labels = map[string]string{ - metricskey.LabelProject: kr.Project, - metricskey.LabelLocation: kr.Location, - metricskey.LabelClusterName: kr.ClusterName, - metricskey.LabelNamespaceName: kr.NamespaceName, - metricskey.LabelServiceName: kr.ServiceName, - metricskey.LabelConfigurationName: kr.ConfigurationName, - metricskey.LabelRevisionName: kr.RevisionName, +func getTagsMap(tags []tag.Tag) map[string]string { + tagsMap := map[string]string{} + for _, t := range tags { + tagsMap[t.Key.Name()] = t.Value } - return "knative_revision", labels + return tagsMap } -type Global struct{} - -func (g *Global) MonitoredResource() (resType string, labels map[string]string) { - return "global", nil +func valueOrUnknown(key string, tagsMap map[string]string) string { + if value, ok := tagsMap[key]; ok { + return value + } + return metricskey.ValueUnknown } diff --git a/metrics/monitored_resources_eventing.go b/metrics/monitored_resources_eventing.go new file mode 100644 index 0000000000..30208ca959 --- /dev/null +++ b/metrics/monitored_resources_eventing.go @@ -0,0 +1,163 @@ +/* +Copyright 2019 The Knative Authors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package metrics + +// TODO should be moved to eventing. See https://github.com/knative/pkg/issues/608 + +import ( + "contrib.go.opencensus.io/exporter/stackdriver/monitoredresource" + "go.opencensus.io/stats/view" + "go.opencensus.io/tag" + "knative.dev/pkg/metrics/metricskey" +) + +type KnativeTrigger struct { + Project string + Location string + ClusterName string + NamespaceName string + TriggerName string + BrokerName string + TypeFilterAttribute string + SourceFilterAttribute string +} + +type KnativeBroker struct { + Project string + Location string + ClusterName string + NamespaceName string + BrokerName string +} + +type KnativeImporter struct { + Project string + Location string + ClusterName string + NamespaceName string + ImporterName string + ImporterResourceGroup string +} + +func (kt *KnativeTrigger) MonitoredResource() (resType string, labels map[string]string) { + labels = map[string]string{ + metricskey.LabelProject: kt.Project, + metricskey.LabelLocation: kt.Location, + metricskey.LabelClusterName: kt.ClusterName, + metricskey.LabelNamespaceName: kt.NamespaceName, + metricskey.LabelTriggerName: kt.TriggerName, + metricskey.LabelBrokerName: kt.BrokerName, + } + return metricskey.ResourceTypeKnativeTrigger, labels +} + +func (kb *KnativeBroker) MonitoredResource() (resType string, labels map[string]string) { + labels = map[string]string{ + metricskey.LabelProject: kb.Project, + metricskey.LabelLocation: kb.Location, + metricskey.LabelClusterName: kb.ClusterName, + metricskey.LabelNamespaceName: kb.NamespaceName, + metricskey.LabelBrokerName: kb.BrokerName, + } + return metricskey.ResourceTypeKnativeBroker, labels +} + +func (ki *KnativeImporter) MonitoredResource() (resType string, labels map[string]string) { + labels = map[string]string{ + metricskey.LabelProject: ki.Project, + metricskey.LabelLocation: ki.Location, + metricskey.LabelClusterName: ki.ClusterName, + metricskey.LabelNamespaceName: ki.NamespaceName, + metricskey.LabelImporterName: ki.ImporterName, + metricskey.LabelImporterResourceGroup: ki.ImporterResourceGroup, + } + return metricskey.ResourceTypeKnativeImporter, labels +} + +func GetKnativeBrokerMonitoredResource( + v *view.View, tags []tag.Tag, gm *gcpMetadata) ([]tag.Tag, monitoredresource.Interface) { + tagsMap := getTagsMap(tags) + kb := &KnativeBroker{ + // The first three resource labels are from metadata. + Project: gm.project, + Location: gm.location, + ClusterName: gm.cluster, + // The rest resource labels are from metrics labels. + NamespaceName: valueOrUnknown(metricskey.LabelNamespaceName, tagsMap), + BrokerName: valueOrUnknown(metricskey.LabelBrokerName, tagsMap), + } + + var newTags []tag.Tag + for _, t := range tags { + // Keep the metrics labels that are not resource labels + if !metricskey.KnativeBrokerLabels.Has(t.Key.Name()) { + newTags = append(newTags, t) + } + } + + return newTags, kb +} + +func GetKnativeTriggerMonitoredResource( + v *view.View, tags []tag.Tag, gm *gcpMetadata) ([]tag.Tag, monitoredresource.Interface) { + tagsMap := getTagsMap(tags) + kt := &KnativeTrigger{ + // The first three resource labels are from metadata. + Project: gm.project, + Location: gm.location, + ClusterName: gm.cluster, + // The rest resource labels are from metrics labels. + NamespaceName: valueOrUnknown(metricskey.LabelNamespaceName, tagsMap), + TriggerName: valueOrUnknown(metricskey.LabelTriggerName, tagsMap), + BrokerName: valueOrUnknown(metricskey.LabelBrokerName, tagsMap), + } + + var newTags []tag.Tag + for _, t := range tags { + // Keep the metrics labels that are not resource labels + if !metricskey.KnativeTriggerLabels.Has(t.Key.Name()) { + newTags = append(newTags, t) + } + } + + return newTags, kt +} + +func GetKnativeImporterMonitoredResource( + v *view.View, tags []tag.Tag, gm *gcpMetadata) ([]tag.Tag, monitoredresource.Interface) { + tagsMap := getTagsMap(tags) + ki := &KnativeImporter{ + // The first three resource labels are from metadata. + Project: gm.project, + Location: gm.location, + ClusterName: gm.cluster, + // The rest resource labels are from metrics labels. + NamespaceName: valueOrUnknown(metricskey.LabelNamespaceName, tagsMap), + ImporterName: valueOrUnknown(metricskey.LabelImporterName, tagsMap), + ImporterResourceGroup: valueOrUnknown(metricskey.LabelImporterResourceGroup, tagsMap), + } + + var newTags []tag.Tag + for _, t := range tags { + // Keep the metrics labels that are not resource labels + if !metricskey.KnativeImporterLabels.Has(t.Key.Name()) { + newTags = append(newTags, t) + } + } + + return newTags, ki +} diff --git a/metrics/monitored_resources_serving.go b/metrics/monitored_resources_serving.go new file mode 100644 index 0000000000..b2a1d33f5c --- /dev/null +++ b/metrics/monitored_resources_serving.go @@ -0,0 +1,75 @@ +/* +Copyright 2019 The Knative Authors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package metrics + +import ( + "contrib.go.opencensus.io/exporter/stackdriver/monitoredresource" + "go.opencensus.io/stats/view" + "go.opencensus.io/tag" + "knative.dev/pkg/metrics/metricskey" +) + +// TODO should be moved to serving. See https://github.com/knative/pkg/issues/608 + +type KnativeRevision struct { + Project string + Location string + ClusterName string + NamespaceName string + ServiceName string + ConfigurationName string + RevisionName string +} + +func (kr *KnativeRevision) MonitoredResource() (resType string, labels map[string]string) { + labels = map[string]string{ + metricskey.LabelProject: kr.Project, + metricskey.LabelLocation: kr.Location, + metricskey.LabelClusterName: kr.ClusterName, + metricskey.LabelNamespaceName: kr.NamespaceName, + metricskey.LabelServiceName: kr.ServiceName, + metricskey.LabelConfigurationName: kr.ConfigurationName, + metricskey.LabelRevisionName: kr.RevisionName, + } + return metricskey.ResourceTypeKnativeRevision, labels +} + +func GetKnativeRevisionMonitoredResource( + v *view.View, tags []tag.Tag, gm *gcpMetadata) ([]tag.Tag, monitoredresource.Interface) { + tagsMap := getTagsMap(tags) + kr := &KnativeRevision{ + // The first three resource labels are from metadata. + Project: gm.project, + Location: gm.location, + ClusterName: gm.cluster, + // The rest resource labels are from metrics labels. + NamespaceName: valueOrUnknown(metricskey.LabelNamespaceName, tagsMap), + ServiceName: valueOrUnknown(metricskey.LabelServiceName, tagsMap), + ConfigurationName: valueOrUnknown(metricskey.LabelConfigurationName, tagsMap), + RevisionName: valueOrUnknown(metricskey.LabelRevisionName, tagsMap), + } + + var newTags []tag.Tag + for _, t := range tags { + // Keep the metrics labels that are not resource labels + if !metricskey.KnativeRevisionLabels.Has(t.Key.Name()) { + newTags = append(newTags, t) + } + } + + return newTags, kr +} diff --git a/metrics/record.go b/metrics/record.go index 1b045ea0ab..87e67fc356 100644 --- a/metrics/record.go +++ b/metrics/record.go @@ -24,6 +24,9 @@ import ( "knative.dev/pkg/metrics/metricskey" ) +// TODO should be properly refactored and pieces should move to eventing and serving, as appropriate. +// See https://github.com/knative/pkg/issues/608 + // Record decides whether to record one measurement via OpenCensus based on the // following conditions: // 1) No package level metrics config. In this case it just proxies to OpenCensus @@ -32,7 +35,8 @@ import ( // using this function to get expected behavior. // 2) The backend is not Stackdriver. // 3) The backend is Stackdriver and it is allowed to use custom metrics. -// 4) The backend is Stackdriver and the metric is "knative_revison" built-in metric. +// 4) The backend is Stackdriver and the metric is one of the built-in metrics: "knative_revision", "knative_broker", +// "knative_trigger", "knative_importer". func Record(ctx context.Context, ms stats.Measurement) { mc := getCurMetricsConfig() @@ -50,7 +54,12 @@ func Record(ctx context.Context, ms stats.Measurement) { // Condition 4) metricType := path.Join(mc.stackdriverMetricTypePrefix, ms.Measure().Name()) - if metricskey.KnativeRevisionMetrics.Has(metricType) { + isServingBuiltIn := metricskey.KnativeRevisionMetrics.Has(metricType) + isEventingBuiltIn := metricskey.KnativeTriggerMetrics.Has(metricType) || + metricskey.KnativeBrokerMetrics.Has(metricType) || + metricskey.KnativeImporterMetrics.Has(metricType) + + if isServingBuiltIn || isEventingBuiltIn { stats.Record(ctx, ms) } } diff --git a/metrics/record_test.go b/metrics/record_test.go index 5f1b84f734..5adab472d5 100644 --- a/metrics/record_test.go +++ b/metrics/record_test.go @@ -26,21 +26,15 @@ import ( "go.opencensus.io/stats/view" ) -func TestRecord(t *testing.T) { - ctx := context.TODO() - measure := stats.Int64("request_count", "Number of reconcile operations", stats.UnitNone) - v := &view.View{ - Measure: measure, - Aggregation: view.LastValue(), - } - view.Register(v) - defer view.Unregister(v) +type cases struct { + name string + metricsConfig *metricsConfig + measurement stats.Measurement +} - shouldReportCases := []struct { - name string - metricsConfig *metricsConfig - measurement stats.Measurement - }{ +func TestRecordServing(t *testing.T) { + measure := stats.Int64("request_count", "Number of reconcile operations", stats.UnitNone) + shouldReportCases := []cases{ // Increase the measurement value for each test case so that checking // the last value ensures the measurement has been recorded. { @@ -67,6 +61,49 @@ func TestRecord(t *testing.T) { measurement: measure.M(4), }, } + testRecord(t, measure, shouldReportCases) +} + +func TestRecordEventing(t *testing.T) { + measure := stats.Int64("event_count", "Number of event received", stats.UnitNone) + shouldReportCases := []cases{ + // Increase the measurement value for each test case so that checking + // the last value ensures the measurement has been recorded. + { + name: "none stackdriver backend", + metricsConfig: &metricsConfig{}, + measurement: measure.M(1), + }, { + name: "stackdriver backend with supported metric", + metricsConfig: &metricsConfig{ + isStackdriverBackend: true, + stackdriverMetricTypePrefix: "knative.dev/eventing/broker", + }, + measurement: measure.M(5), + }, { + name: "stackdriver backend with unsupported metric and allow custom metric", + metricsConfig: &metricsConfig{ + isStackdriverBackend: true, + stackdriverMetricTypePrefix: "knative.dev/unsupported", + allowStackdriverCustomMetrics: true, + }, + measurement: measure.M(3), + }, { + name: "empty metricsConfig", + measurement: measure.M(4), + }, + } + testRecord(t, measure, shouldReportCases) +} + +func testRecord(t *testing.T, measure *stats.Int64Measure, shouldReportCases []cases) { + ctx := context.TODO() + v := &view.View{ + Measure: measure, + Aggregation: view.LastValue(), + } + view.Register(v) + defer view.Unregister(v) for _, test := range shouldReportCases { setCurMetricsConfig(test.metricsConfig) diff --git a/metrics/stackdriver_exporter.go b/metrics/stackdriver_exporter.go index 6d2a8cab8e..80f830216a 100644 --- a/metrics/stackdriver_exporter.go +++ b/metrics/stackdriver_exporter.go @@ -1,9 +1,12 @@ /* Copyright 2019 The Knative Authors + Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -55,6 +58,8 @@ func newOpencensusSDExporter(o stackdriver.Options) (view.Exporter, error) { return stackdriver.NewExporter(o) } +// TODO should be properly refactored to be able to inject the getMonitoredResourceFunc function. +// See https://github.com/knative/pkg/issues/608 func newStackdriverExporter(config *metricsConfig, logger *zap.SugaredLogger) (view.Exporter, error) { gm := gcpMetadataFunc() mtf := getMetricTypeFunc(config.stackdriverMetricTypePrefix, config.stackdriverCustomMetricTypePrefix) @@ -77,54 +82,19 @@ func getMonitoredResourceFunc(metricTypePrefix string, gm *gcpMetadata) func(v * return func(view *view.View, tags []tag.Tag) ([]tag.Tag, monitoredresource.Interface) { metricType := path.Join(metricTypePrefix, view.Measure.Name()) if metricskey.KnativeRevisionMetrics.Has(metricType) { - return getKnativeRevisionMonitoredResource(view, tags, gm) + return GetKnativeRevisionMonitoredResource(view, tags, gm) + } else if metricskey.KnativeBrokerMetrics.Has(metricType) { + return GetKnativeBrokerMonitoredResource(view, tags, gm) + } else if metricskey.KnativeTriggerMetrics.Has(metricType) { + return GetKnativeTriggerMonitoredResource(view, tags, gm) + } else if metricskey.KnativeImporterMetrics.Has(metricType) { + return GetKnativeImporterMonitoredResource(view, tags, gm) } - // Unsupported metric by knative_revision, use "global" resource type. + // Unsupported metric by knative_revision, knative_broker, knative_trigger, and knative_importer, use "global" resource type. return getGlobalMonitoredResource(view, tags) } } -func getKnativeRevisionMonitoredResource( - v *view.View, tags []tag.Tag, gm *gcpMetadata) ([]tag.Tag, monitoredresource.Interface) { - tagsMap := getTagsMap(tags) - kr := &KnativeRevision{ - // The first three resource labels are from metadata. - Project: gm.project, - Location: gm.location, - ClusterName: gm.cluster, - // The rest resource labels are from metrics labels. - NamespaceName: valueOrUnknown(metricskey.LabelNamespaceName, tagsMap), - ServiceName: valueOrUnknown(metricskey.LabelServiceName, tagsMap), - ConfigurationName: valueOrUnknown(metricskey.LabelConfigurationName, tagsMap), - RevisionName: valueOrUnknown(metricskey.LabelRevisionName, tagsMap), - } - - var newTags []tag.Tag - for _, t := range tags { - // Keep the metrics labels that are not resource labels - if !metricskey.KnativeRevisionLabels.Has(t.Key.Name()) { - newTags = append(newTags, t) - } - } - - return newTags, kr -} - -func getTagsMap(tags []tag.Tag) map[string]string { - tagsMap := map[string]string{} - for _, t := range tags { - tagsMap[t.Key.Name()] = t.Value - } - return tagsMap -} - -func valueOrUnknown(key string, tagsMap map[string]string) string { - if value, ok := tagsMap[key]; ok { - return value - } - return metricskey.ValueUnknown -} - func getGlobalMonitoredResource(v *view.View, tags []tag.Tag) ([]tag.Tag, monitoredresource.Interface) { return tags, &Global{} } @@ -132,7 +102,11 @@ func getGlobalMonitoredResource(v *view.View, tags []tag.Tag) ([]tag.Tag, monito func getMetricTypeFunc(metricTypePrefix, customMetricTypePrefix string) func(view *view.View) string { return func(view *view.View) string { metricType := path.Join(metricTypePrefix, view.Measure.Name()) - if metricskey.KnativeRevisionMetrics.Has(metricType) { + inServing := metricskey.KnativeRevisionMetrics.Has(metricType) + inEventing := metricskey.KnativeBrokerMetrics.Has(metricType) || + metricskey.KnativeTriggerMetrics.Has(metricType) || + metricskey.KnativeImporterMetrics.Has(metricType) + if inServing || inEventing { return metricType } // Unsupported metric by knative_revision, use custom domain. diff --git a/metrics/stackdriver_exporter_test.go b/metrics/stackdriver_exporter_test.go index 9d08fdd19f..11093ded71 100644 --- a/metrics/stackdriver_exporter_test.go +++ b/metrics/stackdriver_exporter_test.go @@ -1,15 +1,19 @@ /* -Copyright 2019 The Knative Authors. +Copyright 2019 The Knative Authors + Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ + package metrics import ( @@ -24,6 +28,9 @@ import ( "knative.dev/pkg/metrics/metricskey" ) +// TODO UTs should move to eventing and serving, as appropriate. +// See https://github.com/knative/pkg/issues/608 + var ( testGcpMetadata = gcpMetadata{ project: "test-project", @@ -31,7 +38,7 @@ var ( cluster: "test-cluster", } - supportedMetricsTestCases = []struct { + supportedServingMetricsTestCases = []struct { name string domain string component string @@ -48,6 +55,52 @@ var ( metricName: "desired_pods", }} + supportedEventingBrokerMetricsTestCases = []struct { + name string + domain string + component string + metricName string + }{{ + name: "broker metric", + domain: eventingDomain, + component: "broker", + metricName: "event_count", + }} + + supportedEventingTriggerMetricsTestCases = []struct { + name string + domain string + component string + metricName string + }{{ + name: "trigger metric", + domain: eventingDomain, + component: "trigger", + metricName: "event_count", + }, { + name: "trigger metric", + domain: eventingDomain, + component: "trigger", + metricName: "event_processing_latencies", + }, { + name: "trigger metric", + domain: eventingDomain, + component: "trigger", + metricName: "event_dispatch_latencies", + }} + + supportedEventingImporterMetricsTestCases = []struct { + name string + domain string + component string + metricName string + }{{ + name: "importer metric", + domain: eventingDomain, + component: "importer", + metricName: "event_count", + }} + unsupportedMetricsTestCases = []struct { name string domain string @@ -68,6 +121,16 @@ var ( domain: servingDomain, component: "activator", metricName: "unsupported", + }, { + name: "unsupported component", + domain: eventingDomain, + component: "unsupported", + metricName: "event_count", + }, { + name: "unsupported metric", + domain: eventingDomain, + component: "broker", + metricName: "unsupported", }} ) @@ -85,7 +148,7 @@ func newFakeExporter(o stackdriver.Options) (view.Exporter, error) { } func TestGetMonitoredResourceFunc_UseKnativeRevision(t *testing.T) { - for _, testCase := range supportedMetricsTestCases { + for _, testCase := range supportedServingMetricsTestCases { testView = &view.View{ Description: "Test View", Measure: stats.Int64(testCase.metricName, "Test Measure", stats.UnitNone), @@ -94,7 +157,7 @@ func TestGetMonitoredResourceFunc_UseKnativeRevision(t *testing.T) { } mrf := getMonitoredResourceFunc(path.Join(testCase.domain, testCase.component), &testGcpMetadata) - newTags, monitoredResource := mrf(testView, testTags) + newTags, monitoredResource := mrf(testView, revisionTestTags) gotResType, labels := monitoredResource.MonitoredResource() wantedResType := "knative_revision" if gotResType != wantedResType { @@ -115,6 +178,115 @@ func TestGetMonitoredResourceFunc_UseKnativeRevision(t *testing.T) { } } +func TestGetMonitoredResourceFunc_UseKnativeBroker(t *testing.T) { + for _, testCase := range supportedEventingBrokerMetricsTestCases { + testView = &view.View{ + Description: "Test View", + Measure: stats.Int64(testCase.metricName, "Test Measure", stats.UnitDimensionless), + Aggregation: view.LastValue(), + TagKeys: []tag.Key{}, + } + mrf := getMonitoredResourceFunc(path.Join(testCase.domain, testCase.component), &testGcpMetadata) + + newTags, monitoredResource := mrf(testView, brokerTestTags) + gotResType, labels := monitoredResource.MonitoredResource() + wantedResType := "knative_broker" + if gotResType != wantedResType { + t.Fatalf("MonitoredResource=%v, want %v", gotResType, wantedResType) + } + got := getResourceLabelValue(metricskey.LabelEventType, newTags) + if got != testEventType { + t.Errorf("expected new tag: %v, got: %v", eventTypeKey, newTags) + } + got = getResourceLabelValue(metricskey.LabelEventSource, newTags) + if got != testEventSource { + t.Errorf("expected new tag: %v, got: %v", eventSourceKey, newTags) + } + got, ok := labels[metricskey.LabelNamespaceName] + if !ok || got != testNS { + t.Errorf("expected label %v with value %v, got: %v", metricskey.LabelNamespaceName, testNS, got) + } + got, ok = labels[metricskey.LabelBrokerName] + if !ok || got != testBroker { + t.Errorf("expected label %v with value %v, got: %v", metricskey.LabelBrokerName, testBroker, got) + } + } +} + +func TestGetMonitoredResourceFunc_UseKnativeTrigger(t *testing.T) { + for _, testCase := range supportedEventingTriggerMetricsTestCases { + testView = &view.View{ + Description: "Test View", + Measure: stats.Int64(testCase.metricName, "Test Measure", stats.UnitDimensionless), + Aggregation: view.LastValue(), + TagKeys: []tag.Key{}, + } + mrf := getMonitoredResourceFunc(path.Join(testCase.domain, testCase.component), &testGcpMetadata) + + newTags, monitoredResource := mrf(testView, triggerTestTags) + gotResType, labels := monitoredResource.MonitoredResource() + wantedResType := "knative_trigger" + if gotResType != wantedResType { + t.Fatalf("MonitoredResource=%v, want %v", gotResType, wantedResType) + } + got := getResourceLabelValue(metricskey.LabelFilterType, newTags) + if got != testFilterType { + t.Errorf("expected new tag: %v, got: %v", filterTypeKey, newTags) + } + got = getResourceLabelValue(metricskey.LabelFilterSource, newTags) + if got != testFilterSource { + t.Errorf("expected new tag: %v, got: %v", filterSourceKey, newTags) + } + got, ok := labels[metricskey.LabelNamespaceName] + if !ok || got != testNS { + t.Errorf("expected label %v with value %v, got: %v", metricskey.LabelNamespaceName, testNS, got) + } + got, ok = labels[metricskey.LabelBrokerName] + if !ok || got != testBroker { + t.Errorf("expected label %v with value %v, got: %v", metricskey.LabelBrokerName, testBroker, got) + } + } +} + +func TestGetMonitoredResourceFunc_UseKnativeImporter(t *testing.T) { + for _, testCase := range supportedEventingImporterMetricsTestCases { + testView = &view.View{ + Description: "Test View", + Measure: stats.Int64(testCase.metricName, "Test Measure", stats.UnitDimensionless), + Aggregation: view.LastValue(), + TagKeys: []tag.Key{}, + } + mrf := getMonitoredResourceFunc(path.Join(testCase.domain, testCase.component), &testGcpMetadata) + + newTags, monitoredResource := mrf(testView, importerTestTags) + gotResType, labels := monitoredResource.MonitoredResource() + wantedResType := "knative_importer" + if gotResType != wantedResType { + t.Fatalf("MonitoredResource=%v, want %v", gotResType, wantedResType) + } + got := getResourceLabelValue(metricskey.LabelEventType, newTags) + if got != testEventType { + t.Errorf("expected new tag: %v, got: %v", eventTypeKey, newTags) + } + got = getResourceLabelValue(metricskey.LabelEventSource, newTags) + if got != testEventSource { + t.Errorf("expected new tag: %v, got: %v", eventSourceKey, newTags) + } + got, ok := labels[metricskey.LabelNamespaceName] + if !ok || got != testNS { + t.Errorf("expected label %v with value %v, got: %v", metricskey.LabelNamespaceName, testNS, got) + } + got, ok = labels[metricskey.LabelImporterName] + if !ok || got != testImporter { + t.Errorf("expected label %v with value %v, got: %v", metricskey.LabelImporterName, testImporter, got) + } + got, ok = labels[metricskey.LabelImporterResourceGroup] + if !ok || got != testImporterResourceGroup { + t.Errorf("expected label %v with value %v, got: %v", metricskey.LabelImporterResourceGroup, testImporterResourceGroup, got) + } + } +} + func TestGetMonitoredResourceFunc_UseGlobal(t *testing.T) { for _, testCase := range unsupportedMetricsTestCases { testView = &view.View{ @@ -125,7 +297,7 @@ func TestGetMonitoredResourceFunc_UseGlobal(t *testing.T) { } mrf := getMonitoredResourceFunc(path.Join(testCase.domain, testCase.component), &testGcpMetadata) - newTags, monitoredResource := mrf(testView, testTags) + newTags, monitoredResource := mrf(testView, revisionTestTags) gotResType, labels := monitoredResource.MonitoredResource() wantedResType := "global" if gotResType != wantedResType { @@ -142,7 +314,7 @@ func TestGetMonitoredResourceFunc_UseGlobal(t *testing.T) { } func TestGetgetMetricTypeFunc_UseKnativeDomain(t *testing.T) { - for _, testCase := range supportedMetricsTestCases { + for _, testCase := range supportedServingMetricsTestCases { testView = &view.View{ Description: "Test View", Measure: stats.Int64(testCase.metricName, "Test Measure", stats.UnitNone),