Enabled metrics for apiserversource by sayanh · Pull Request #1761 · knative/eventing

sayanh · 2019-08-29T19:22:13Z

Proposed Changes

Enabled metrics for apiserversource

Release Note

 ApiServerSource now reports event counts

knative-prow-robot · 2019-08-29T19:22:27Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sayanh
To complete the pull request process, please assign grantr
You can assign the PR to them by writing /assign @grantr in a comment when ready.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

knative-prow-robot · 2019-08-29T19:22:28Z

Hi @sayanh. Thanks for your PR.

I'm waiting for a knative member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

nachocano · 2019-08-30T16:06:18Z

/ok-to-test

nachocano · 2019-08-30T16:06:59Z

Can you add in the release notes that the ApiServerSource now reports event counts

nachocano · 2019-08-30T16:08:27Z

 )

+const (
+	component = "ApiServerSource::ReceiveAdapter"


can we just call it apiserversource? This will end up changing to be importer later on, but not right now as we need some other changes to be merged in

sure, fixed it

nachocano · 2019-08-30T16:09:06Z

 	// _ "k8s.io/client-go/plugin/pkg/client/auth/gcp"

+	"knative.dev/eventing/pkg/reconciler/apiserversource/resources"
+


remove whitespace and run go importer formatting

nachocano · 2019-08-30T16:17:17Z

+	// Convert base64 encoded json logging.Config to logging.Config.
+	loggingConfig, err := resources.Base64ToLoggingConfig(
+		env.LoggingConfigBase64)
 	if err != nil {


Can we log an error, and try to use the default one. If it fails, then panic...
As here:
https://github.com/google/knative-gcp/blob/cabd0d258db1d23246d51fac8b181fd4c363c28e/cmd/pubsub/receive_adapter/main.go#L55

nachocano · 2019-08-30T16:18:17Z

+	metricsConfig, err := resources.Base64ToMetricsOptions(
+		env.MetricsConfigBase64)
+	if err != nil {
+		panic(err)


logger.Errorf("failed to process metrics options: %s", err.Error())

nachocano · 2019-08-30T16:18:48Z

+		panic(err)
+	}
+
+	logger, _ := logging.NewLoggerFromConfig(loggingConfig, component)


put this above the call to resources.Base64ToMetricsOptions

nachocano · 2019-08-30T16:24:15Z

+
+package apiserver
+
+// Type gets the eventtype.


update comment.

Can you add a TODO saying we should use HTTP status codes once this is merged: cloudevents/sdk-go#177

Added a TODO

nachocano · 2019-08-30T16:25:21Z

-		return err
-	}
-	return nil
+	return a.sendEvent(context.Background(), event, a.reporter)


no need to pass the reporter as it's in the adapter already

correct, fixed it

nachocano · 2019-08-30T16:25:48Z

 }

 func (a *ref) addControllerWatch(gvr schema.GroupVersionResource) {
+	reportArgs := &ReportArgs{


remove this

nachocano · 2019-08-30T16:28:23Z

+	}
+	a.reporter.ReportEventCount(reportArgs, nil)
+
+	if _, err := a.ce.Send(ctx, *event); err != nil {


_, err := a.ce.Send(ctx, *event) if err != nil { a.logger.Info("event delivery failed", zap.Error(err)) } a.reporter.ReportEventCount(reportArgs, err) return err

nachocano · 2019-08-30T16:29:03Z

+	}
+	a.reporter.ReportEventCount(reportArgs, nil)
+
+	if _, err := a.ce.Send(ctx, *event); err != nil {


same as previous comment

nachocano · 2019-08-30T16:30:03Z

+
+var (
+	// eventCountM is a counter which records the number of events received
+	// by a Trigger.


update comment: .... number of events sent by an Importer

nachocano · 2019-08-30T16:30:22Z

+	eventTypeKey    tag.Key
+	eventSourceKey  tag.Key
+	resultKey       tag.Key
+	filterResultKey tag.Key


remove filterResultKey

nachocano · 2019-08-30T16:30:53Z

+	filterResultKey tag.Key
+}
+
+// NewStatsReporter creates a reporter that collects and reports filter metrics.


NewStatsReporter creates a reporter that collects and reports apiserversource metrics.

nachocano · 2019-08-30T16:31:15Z

+		return nil, err
+	}
+	r.eventSourceKey = eventSourceTag
+	filterResultTag, err := tag.NewKey(metricskey.FilterResult)


remove filterTag

nachocano · 2019-08-30T16:31:39Z

+		&view.View{
+			Description: eventCountM.Description(),
+			Measure:     eventCountM,
+			// TODO count or sum aggregation?


remove TODO... is count

nachocano · 2019-08-30T16:39:11Z

+	return tag.New(
+		context.Background(),
+		tag.Insert(r.namespaceTagKey, args.ns),
+		tag.Insert(r.eventSourceKey, valueOrAny(args.eventSource)),


we do not need valueOrAny here. As they will not be empty... Can you remove that, and also the note?

nachocano · 2019-08-30T16:41:02Z

+	}
+
+	wantTags1 := map[string]string(wantTags)
+	wantTags1[metricskey.Result] = "success"


this should be part of the wantTags, right? No need for a wantTags1

right, fixed it

nachocano · 2019-08-30T16:42:30Z

+
+}
+
+func TestReporterEmptySourceAndType(t *testing.T) {


this one will never happen as we are setting up the event source and type in the CloudEvent, otherwise it's not a valid CloudEvent.
It should be fine to remove, or maybe change it to test for the error condition... pass an error to ReportEventCount and see that instead of success you have the error label

Added a new test for now TestReporterForErrorTag

nachocano · 2019-08-30T16:45:23Z

 	EventType = "event_type"

+	// EventSource is the label for the CloudEvents source context attribute.
+	EventSource = "event_source"


all these constants are in knative.dev/pkg/metrics/metricskey now, as LabelEventSource, etc. Can we use those instead? I'll make the changes in the other places, and remove these constants

nachocano · 2019-08-30T16:51:11Z

@@ -0,0 +1,134 @@
+/*


it would be nice to move this down to pkg as we are going to use it in many places.
@n3wscott what do you think?

How about pkg/utils?

nachocano · 2019-08-30T16:58:19Z

 }

+func (a *ref) sendEvent(ctx context.Context, event *cloudevents.Event, reporter StatsReporter) error {
+	reportArgs := &ReportArgs{


We will also need to add the importerName and the importerResourceGroup... So that we can also filter based on those attributes. E.g., give me the event_count of all apiserversource importers, and so on...

The name you might need to send it in an env variable to the receive_adapter (as we do in the broker ingress)...
The importerResourceGroup can be hardcoded to apiserversources.sources.eventing.knative.dev (put it in a constant)

See labels for tags here: https://github.com/knative/pkg/blob/ec2f20ae67fbbccfac425061f2c7c089d1932105/metrics/metricskey/constants_eventing.go#L52-54

Added those tags now. A sample metrics looks like:

apiserversource_event_count{event_source="https://1.2.3.4:443",event_type="dev.knative.apiserver.resource.update",importer_name="testevents",importer_resource_group="apiserversources.sources.eventing.knative.dev",namespace_name="default"} 3

knative-metrics-robot · 2019-09-01T20:55:28Z

The following is the coverage report on pkg/.
Say /test pull-knative-eventing-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/adapter/apiserver/metrics.go	Do not exist	100.0%
pkg/adapter/apiserver/ref.go	83.3%	90.2%	6.9
pkg/adapter/apiserver/resource.go	80.6%	90.3%	9.7
pkg/adapter/apiserver/stats_reporter.go	Do not exist	76.3%
pkg/reconciler/apiserversource/apiserversource.go	77.5%	77.9%	0.4
pkg/utils/config.go	Do not exist	72.9%

knative-prow-robot · 2019-09-01T20:56:40Z

@sayanh: The following tests failed, say /retest to rerun them all:

Test name	Commit	Details	Rerun command
pull-knative-eventing-build-tests	`7cb9e28`	link	`/test pull-knative-eventing-build-tests`
pull-knative-eventing-unit-tests	`7cb9e28`	link	`/test pull-knative-eventing-unit-tests`

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

nachocano · 2019-09-03T20:06:11Z

@sayanh can this be closed and we will use instead #1786?

sayanh · 2019-09-05T09:01:13Z

Closing this as this is a duplicate for #1786

knative-prow-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 29, 2019

googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Aug 29, 2019

knative-prow-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 29, 2019

knative-prow-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 29, 2019

knative-prow-robot requested review from matzew and n3wscott August 29, 2019 19:22

knative-prow-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 30, 2019

sayanh force-pushed the enable-metrics-for-apiserversource branch from 626dc4e to 5ce5b0e Compare August 30, 2019 15:06

sayanh marked this pull request as ready for review August 30, 2019 15:07

knative-prow-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 30, 2019

sayanh changed the title ~~Added metrics endpoint~~ Enabled metrics for apiserversource Aug 30, 2019

knative-prow-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 30, 2019

nachocano reviewed Aug 30, 2019

View reviewed changes

nachocano mentioned this pull request Aug 30, 2019

E2E Metrics for Importer/Broker/Trigger model #1693

Closed

75 tasks

knative-prow-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Sep 1, 2019

sayanh added 6 commits September 1, 2019 21:48

Added metrics endpoint

2b202a4

Added event type and event source

1d41837

Added config test

b9cbf28

Changes based on PR review

1a32cec

Updated knative.dev/pkg

b19e8ec

More refactorings based on PR review

0f3b53d

sayanh force-pushed the enable-metrics-for-apiserversource branch from 9b50089 to 0f3b53d Compare September 1, 2019 19:50

sayanh added 3 commits September 1, 2019 22:07

Fixed result

e262e44

Moved config to utils

6782e96

Fix name

7cb9e28

sayanh closed this Sep 5, 2019

		// _ "k8s.io/client-go/plugin/pkg/client/auth/gcp"

		"knative.dev/eventing/pkg/reconciler/apiserversource/resources"

Conversation

sayanh commented Aug 29, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed Changes

Uh oh!

knative-prow-robot commented Aug 29, 2019

Uh oh!

knative-prow-robot commented Aug 29, 2019

Uh oh!

nachocano commented Aug 30, 2019

Uh oh!

nachocano commented Aug 30, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

sayanh commented Aug 29, 2019 •

edited

Loading

sayanh Sep 1, 2019 •

edited

Loading