common/tsmon/metric/standard_metrics_test.go

// Copyright 2016 The LUCI 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 metric

import (
	"context"
	"testing"
	"time"

	"go.chromium.org/luci/common/tsmon"

	. "github.com/smartystreets/goconvey/convey"
)

func TestStandardMetrics(t *testing.T) {
	t.Parallel()

	durMillis := 5.0
	dur := time.Duration(durMillis * float64(time.Millisecond))

	Convey("UpdatePresenceMetrics updates presenceMetric", t, func() {
		c, m := tsmon.WithDummyInMemory(context.Background())
		registerCallbacks(c)

		So(tsmon.Flush(c), ShouldBeNil)

		So(len(m.Cells), ShouldEqual, 1)
		So(len(m.Cells[0]), ShouldEqual, 1)
		So(m.Cells[0][0].Name, ShouldEqual, "presence/up")
		So(m.Cells[0][0].Value, ShouldEqual, true)
	})

	Convey("UpdateHTTPMetrics updates client metrics", t, func() {
		c := makeContext()
		name, client := "test_name", "test_client"
		So(requestBytesMetric.Get(c, name, client), ShouldBeNil)
		So(responseBytesMetric.Get(c, name, client), ShouldBeNil)
		So(requestDurationsMetric.Get(c, name, client), ShouldBeNil)
		So(responseStatusMetric.Get(c, 200, name, client), ShouldEqual, 0)

		UpdateHTTPMetrics(c, name, client, 200, dur, 123, 321)

		So(requestBytesMetric.Get(c, name, client).Sum(), ShouldEqual, 123)
		So(responseBytesMetric.Get(c, name, client).Sum(), ShouldEqual, 321)
		So(requestDurationsMetric.Get(c, name, client).Sum(), ShouldEqual, durMillis)
		So(responseStatusMetric.Get(c, 200, name, client), ShouldEqual, 1)
	})

	Convey("UpdateServerMetrics updates server metrics", t, func() {
		c := makeContext()
		code, name, isRobot := 200, "test_client", false

		So(serverDurationsMetric.Get(c, code, name, isRobot), ShouldBeNil)
		So(serverRequestBytesMetric.Get(c, code, name, isRobot), ShouldBeNil)
		So(serverResponseBytesMetric.Get(c, code, name, isRobot), ShouldBeNil)
		So(serverResponseStatusMetric.Get(c, code, name, isRobot), ShouldEqual, 0)

		Convey("for a robot user agent", func() {
			isRobot = true
			userAgent := "I am a GoogleBot."

			UpdateServerMetrics(c, name, code, dur, 123, 321, userAgent)

			So(serverDurationsMetric.Get(c, code, name, isRobot).Sum(), ShouldEqual, durMillis)
			So(serverRequestBytesMetric.Get(c, code, name, isRobot).Sum(), ShouldEqual, 123)
			So(serverResponseBytesMetric.Get(c, code, name, isRobot).Sum(), ShouldEqual, 321)
			So(serverResponseStatusMetric.Get(c, code, name, isRobot), ShouldEqual, 1)
		})

		Convey("for a non-robot user agent", func() {
			isRobot = false
			userAgent := "I am a human."

			UpdateServerMetrics(c, name, code, dur, 123, 321, userAgent)

			So(serverDurationsMetric.Get(c, code, name, isRobot).Sum(), ShouldEqual, durMillis)
			So(serverRequestBytesMetric.Get(c, code, name, isRobot).Sum(), ShouldEqual, 123)
			So(serverResponseBytesMetric.Get(c, code, name, isRobot).Sum(), ShouldEqual, 321)
			So(serverResponseStatusMetric.Get(c, code, name, isRobot), ShouldEqual, 1)
		})
	})
}