Merge pull request #128 from m-lab/sandbox-soltesz

Add new monitoring for requested tests and submitted meta values

legacy/legacy.go

@@ -164,16 +164,28 @@ func handleControlChannel(conn protocol.Connection, s ndt.Server) {
 	runC2s := (tests & cTestC2S) != 0
 	runS2c := (tests & cTestS2C) != 0
 	runMeta := (tests & cTestMETA) != 0
-	// TODO: count cTestSFW & cTestMID requests.
+	runSFW := (tests & cTestSFW) != 0
+	runMID := (tests & cTestMID) != 0
 
+	legacymetrics.ClientRequestedTestSuites.WithLabelValues(fmt.Sprintf("%d", 0xff&tests)).Inc()
+
+	if runMID {
+		legacymetrics.ClientRequestedTests.WithLabelValues("mid").Inc()
+	}
 	if runC2s {
 		testsToRun = append(testsToRun, strconv.Itoa(cTestC2S))
+		legacymetrics.ClientRequestedTests.WithLabelValues("c2s").Inc()
 	}
 	if runS2c {
 		testsToRun = append(testsToRun, strconv.Itoa(cTestS2C))
+		legacymetrics.ClientRequestedTests.WithLabelValues("s2c").Inc()
+	}
+	if runSFW {
+		legacymetrics.ClientRequestedTests.WithLabelValues("sfw").Inc()
 	}
 	if runMeta {
 		testsToRun = append(testsToRun, strconv.Itoa(cTestMETA))
+		legacymetrics.ClientRequestedTests.WithLabelValues("meta").Inc()
 	}
 
 	m := conn.Messager()

legacy/meta/meta.go

@@ -6,11 +6,11 @@ import (
 	"strings"
 	"time"
 
+	"github.com/m-lab/ndt-server/legacy/metrics"
 	"github.com/m-lab/ndt-server/legacy/protocol"
 )
 
 // maxClientMessages is the maximum allowed messages we will accept from a client.
-// TODO: add histogram (1-20) counting number of messages per client.
 var maxClientMessages = 20
 
 // ArchivalData contains all meta data reported by the client.
@@ -43,7 +43,6 @@ func ManageTest(ctx context.Context, m protocol.Messager) (ArchivalData, error)
 		}
 		count++
 
-		log.Println("Meta message: ", string(message))
 		s := strings.SplitN(string(message), ":", 2)
 		if len(s) != 2 {
 			continue
@@ -66,6 +65,8 @@ func ManageTest(ctx context.Context, m protocol.Messager) (ArchivalData, error)
 		log.Println("Error reading JSON message:", err)
 		return nil, err
 	}
+	// Count the number meta values sent by the client (when there are no errors).
+	metrics.SubmittedMetaValues.Observe(float64(count))
 	m.SendMessage(protocol.TestFinalize, []byte{})
 	return results, nil
 }

legacy/metrics/metrics.go

@@ -41,4 +41,27 @@ var (
 			Help: "The number of times we sniffed-then-proxied a websocket connection on the legacy channel.",
 		},
 	)
+	ClientRequestedTestSuites = promauto.NewCounterVec(
+		prometheus.CounterOpts{
+			Name: "ndt_legacy_client_requested_suites_total",
+			Help: "The number of client request test suites (the combination of all test types as an integer 0-255).",
+		},
+		[]string{"suite"},
+	)
+	ClientRequestedTests = promauto.NewCounterVec(
+		prometheus.CounterOpts{
+			Name: "ndt_legacy_client_requested_tests_total",
+			Help: "The number of client requests for each legacy test type.",
+		},
+		[]string{"type"},
+	)
+	SubmittedMetaValues = promauto.NewHistogram(
+		prometheus.HistogramOpts{
+			Name: "ndt_legacy_submitted_meta_values",
+			Help: "The number of meta values submitted by clients.",
+			Buckets: []float64{
+				0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
+				11, 12, 13, 14, 15, 16, 17, 18, 19, 20},
+		},
+	)
 )

ndt-server_test.go

@@ -152,8 +152,10 @@ func Test_MainIntegrationTest(t *testing.T) {
 	tests := []testcase{
 		// Legacy TLV-only clients.
 		{
+			// NOTE: we must disable the middle-box test in the legacy TLV client because it unconditionally expects
+			// that test to run irrespective of what the server supports.
 			name: "web100clt (legacy TLV)",
-			cmd:  "timeout 45s /bin/web100clt-without-json-support --name localhost --port " + legacyAddr + " --disablemid --disablesfw",
+			cmd:  "timeout 45s /bin/web100clt-without-json-support --name localhost --port " + legacyAddr + " --disablemid",
 		},
 		{
 			name: "libndt-client - legacy NDT with JSON, download test",
@@ -193,7 +195,7 @@ func Test_MainIntegrationTest(t *testing.T) {
 		// Test legacy raw JSON clients
 		{
 			name: "web100clt (with JSON), no MID or SFW",
-			cmd:  "timeout 45s /bin/web100clt-with-json-support --name localhost --port " + legacyAddr + " --disablemid --disablesfw",
+			cmd:  "timeout 45s /bin/web100clt-with-json-support --name localhost --port " + legacyAddr,
 		},
 		// Test legacy WS clients connected to the HTTP port
 		{