Modify metrics so that names are normalized to legal chars #771

theshadow · 2016-09-07T19:18:58Z

Add function for normalizing metric keys
Add tests for metrics functions.

metrics.go

+// This function is used to make metric names safe for all metric services. Specifically, prometheus does
+// not support * or / in metric names.
+func normalizeKeys(key []string) {
+	if key != nil {


metrics.go

+			k = strings.Replace(k, allMatcher, allReplacement, -1)
+
+			// now replace all other invalid characters with a safe one.
+			key[i] = invalidCharactersRE.ReplaceAllString(k, normalizedToken)


metrics.go

 }

 // SetMetrics initializes goa's metrics instance with the supplied metrics adapter interface.
 func SetMetrics(m Metrics) {
-	metriks = m
+	mu.Lock()


raphael

Thanks for the PR! Left a few comments to address, mainly removing the mutex and changing the regexp used by the test code.

metrics.go

+	// metriks atomic value storage
+	metriks atomic.Value
+
+	// mu mutex for metriks


metrics.go

+	invalidCharactersRE = regexp.MustCompile(`[\*/]`)
+
+	// Taken from https://github.com/prometheus/client_golang/blob/66058aac3a83021948e5fb12f1f408ff556b9037/prometheus/desc.go
+	metricsNameRE = regexp.MustCompile(`^[a-zA-Z_][a-zA-Z0-9_:]*$`)


…heus characters

* Refactor NoopSink to be NoOpSink * Create NoOpSink factory method

raphael · 2016-09-20T22:17:49Z

Thank you for all the work!

…#771) * Add normalizeKeys() function for normalizing metric key names * Properly synchronize updates to metrics object

* Added the ability to dynamically add/remove keys from the jwt security middleware after creation. (#818) * Refactor JWT key resolver (#832) To introduce new "simple" resolver. * Add an interface instead of using testing.T (#733) * removed unneeded check which would make an unsafe concurrent modification (#736) - logit() doesn't need to modify a.keyvals because it was already fixed up in New() * Modify metrics so that names are normalized to legal chars (#771) * Add normalizeKeys() function for normalizing metric key names * Properly synchronize updates to metrics object * Fix setting a default value to datetime * Add tests for a default value of datetime * address issue #738 by creating a title for the test file * Fix a finalize test * Revert "Refactor JWT key resolver (#832)" This reverts commit f6ecb66. * Revert "Added the ability to dynamically add/remove keys from the jwt security middleware after creation. (#818)" This reverts commit 4c7fc9d.

Xander Guzman added 2 commits September 7, 2016 11:18

Add normalizeKeys() function for normalizing metric key names

13707e3

Implement tests for all metric functions

a21dca5

raphael reviewed Sep 7, 2016
View reviewed changes

metrics.go

// This function is used to make metric names safe for all metric services. Specifically, prometheus does

// not support * or / in metric names.

func normalizeKeys(key []string) {

if key != nil {

This comment was marked as off-topic.

Sign in to view

Run go fmt over source

42c7a13

raphael reviewed Sep 7, 2016
View reviewed changes

metrics.go

k = strings.Replace(k, allMatcher, allReplacement, -1)

// now replace all other invalid characters with a safe one.

key[i] = invalidCharactersRE.ReplaceAllString(k, normalizedToken)

This comment was marked as off-topic.

Sign in to view

Xander Guzman added 8 commits September 7, 2016 13:32

Correct lint formatting

962f8e0

Correct test expectation result

10fb4d6

Modify test from Equal() to ConsistOf()

56b355c

PR code modifications

46fee7d

Linting correction

2632aaf

Add a metrics discarder

b312b28

Proper formatting

5aa7ac3

Add mutex locking

5157433

raphael reviewed Sep 19, 2016

View reviewed changes

metrics.go

}

// SetMetrics initializes goa's metrics instance with the supplied metrics adapter interface.

func SetMetrics(m Metrics) {

metriks = m

mu.Lock()

This comment was marked as off-topic.

Sign in to view

Xander Guzman added 5 commits September 19, 2016 10:13

Convert mockMetrics to MetricsDiscarder to test things

ae7f5c4

Add type article

223339f

Add more articles for methods.

b593774

Remind self, just run go fmt first!

24cbd8f

Change assignment to Metrics pointer

6a85edb

raphael reviewed Sep 19, 2016

View reviewed changes

Xander Guzman added 6 commits September 19, 2016 14:57

Expand invalid characters regexp to be the invert of the valid promet…

cf6d8a8

…heus characters

Revert invalid chars to match just asterisks and forward slash

6e551cf

Remove abstraction between Goa and go-metrics

9652801

Renamed the MetricsDiscarder to NoopSink

b153b2f

Correct metrics.go error

5da20cf

Formatting and correct type

28e9285

Xander Guzman added 5 commits September 20, 2016 08:46

Modify cast from metrics.Metrics to *metrics.Metrics

4a8348c

Correct metrics errors

22f4fda

* Refactor NoopSink to be NoOpSink * Create NoOpSink factory method

Correct lint errors.

44e1f2d

Correct variable/package conflict

bf21c94

Revert changes to service.go

c5e0288

raphael merged commit bc7bea7 into goadesign:master Sep 20, 2016

ikawaha mentioned this pull request Dec 13, 2016

There are unmerged features/fixes that were announced in v1.1.0. #964

Closed

51 tasks

ikawaha pushed a commit to ikawaha/goa that referenced this pull request Dec 13, 2016

Modify metrics so that names are normalized to legal chars (goadesign…

76ad6d2

…#771) * Add normalizeKeys() function for normalizing metric key names * Properly synchronize updates to metrics object

ikawaha mentioned this pull request Dec 13, 2016

Backporting unmerged features/fixes to v1 branch. #965

Merged

5 tasks

Modify metrics so that names are normalized to legal chars #771

Modify metrics so that names are normalized to legal chars #771

theshadow commented Sep 7, 2016

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

raphael left a comment

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

raphael commented Sep 20, 2016

Modify metrics so that names are normalized to legal chars #771

Modify metrics so that names are normalized to legal chars #771

Conversation

theshadow commented Sep 7, 2016

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

raphael left a comment

Choose a reason for hiding this comment

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

raphael commented Sep 20, 2016