Integration Tests for Custom Events Limit Updates

.github/workflows/ci.yaml

@@ -51,8 +51,6 @@ jobs:
           - go-version: 1.13.x
             dirs: _integrations/nrecho
             pin: github.com/labstack/echo@v3.3.10
-          - go-version: 1.13.x
-            dirs: _integrations/nrgin/v1
           - go-version: 1.13.x
             dirs: _integrations/nrgorilla/v1
           - go-version: 1.13.x

v3/internal/connect_reply.go

@@ -255,6 +255,32 @@ func CreateFullTxnName(input string, reply *ConnectReply, isWeb bool) string {
 	return reply.SegmentTerms.apply(afterNameRules)
 }
 
+// RequestEventLimits sets limits for reservior testing
+type RequestEventLimits struct {
+	CustomEvents int
+}
+
+const (
+	// CustomEventHarvestsPerMinute is the number of times per minute custom events are harvested
+	CustomEventHarvestsPerMinute = 5
+)
+
+// MockConnectReplyEventLimits sets up a mock connect reply to test event limits
+func (r *ConnectReply) MockConnectReplyEventLimits(limits *RequestEventLimits) {
+	r.SetSampleEverything()
+
+	r.EventData.Limits.CustomEvents = uintPtr(uint(limits.CustomEvents) / (60 / CustomEventHarvestsPerMinute))
+
+	// The mock server will be limited to a maximum of 100,000 events per minute
+	if limits.CustomEvents > 100000 {
+		r.EventData.Limits.CustomEvents = uintPtr(uint(100000) / (60 / CustomEventHarvestsPerMinute))
+	}
+
+	if limits.CustomEvents <= 0 {
+		r.EventData.Limits.CustomEvents = uintPtr(uint(0) / (60 / CustomEventHarvestsPerMinute))
+	}
+}
+
 // SetSampleEverything is used for testing to ensure span events get saved.
 func (r *ConnectReply) SetSampleEverything() {
 	// These constants are not large enough to sample everything forever,

v3/newrelic/reservoir_limits_test.go

@@ -0,0 +1,118 @@
+// Copyright 2020 New Relic Corporation. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package newrelic
+
+import (
+	"testing"
+
+	"github.com/newrelic/go-agent/v3/internal"
+)
+
+// Check Default Value
+func TestCustomLimitsBasic(t *testing.T) {
+	limit := internal.MaxCustomEvents
+	limits := &internal.RequestEventLimits{
+		CustomEvents: limit,
+	}
+	// This function will mock a connect reply from the server
+	mockReplyFunction := func(reply *internal.ConnectReply) {
+		reply.MockConnectReplyEventLimits(limits)
+	}
+	testApp := newTestApp(
+		mockReplyFunction,
+		ConfigCustomInsightsEventsMaxSamplesStored(limit),
+	)
+
+	customEventRate := limit / (60 / internal.CustomEventHarvestsPerMinute)
+
+	// Check if custom event queue capacity == rate
+	if customEventRate != testApp.app.testHarvest.CustomEvents.capacity() {
+		t.Errorf("Custom Events Rate is not equal to harvest: expected %d, actual %d", customEventRate, testApp.app.testHarvest.CustomEvents.capacity())
+	}
+}
+func TestCustomEventLimitUserSet(t *testing.T) {
+	limit := 7000
+	limits := &internal.RequestEventLimits{
+		CustomEvents: limit,
+	}
+	mockReplyFunction := func(reply *internal.ConnectReply) {
+		reply.MockConnectReplyEventLimits(limits)
+	}
+	testApp := newTestApp(
+		mockReplyFunction,
+		ConfigCustomInsightsEventsMaxSamplesStored(limit),
+	)
+
+	customEventRate := limit / (60 / internal.CustomEventHarvestsPerMinute)
+
+	if customEventRate != testApp.app.testHarvest.CustomEvents.capacity() {
+		t.Errorf("Custom Events Rate is not equal to harvest: expected %d, actual %d", customEventRate, testApp.app.testHarvest.CustomEvents.capacity())
+	}
+}
+
+func TestCustomLimitEnthusiast(t *testing.T) {
+	limit := 100000
+	limits := &internal.RequestEventLimits{
+		CustomEvents: limit,
+	}
+	// This function will mock a connect reply from the server
+	mockReplyFunction := func(reply *internal.ConnectReply) {
+		reply.MockConnectReplyEventLimits(limits)
+	}
+	testApp := newTestApp(
+		mockReplyFunction,
+		ConfigCustomInsightsEventsMaxSamplesStored(limit),
+	)
+
+	customEventRate := limit / (60 / internal.CustomEventHarvestsPerMinute)
+
+	// Check if custom event queue capacity == rate
+	if customEventRate != testApp.app.testHarvest.CustomEvents.capacity() {
+		t.Errorf("Custom Events Rate is not equal to harvest: expected %d, actual %d", customEventRate, testApp.app.testHarvest.CustomEvents.capacity())
+	}
+}
+
+func TestCustomLimitsTypo(t *testing.T) {
+	limit := 1000000
+	limits := &internal.RequestEventLimits{
+		CustomEvents: limit,
+	}
+	// This function will mock a connect reply from the server
+	mockReplyFunction := func(reply *internal.ConnectReply) {
+		reply.MockConnectReplyEventLimits(limits)
+	}
+	testApp := newTestApp(
+		mockReplyFunction,
+		ConfigCustomInsightsEventsMaxSamplesStored(limit),
+	)
+
+	customEventRate := 100000 / (60 / internal.CustomEventHarvestsPerMinute)
+
+	// Check if custom event queue capacity == rate
+	if customEventRate != testApp.app.testHarvest.CustomEvents.capacity() {
+		t.Errorf("Custom Events Rate is not equal to harvest: expected %d, actual %d", 8333, testApp.app.testHarvest.CustomEvents.capacity())
+	}
+}
+
+func TestCustomLimitZero(t *testing.T) {
+	limit := 0
+	limits := &internal.RequestEventLimits{
+		CustomEvents: limit,
+	}
+	// This function will mock a connect reply from the server
+	mockReplyFunction := func(reply *internal.ConnectReply) {
+		reply.MockConnectReplyEventLimits(limits)
+	}
+	testApp := newTestApp(
+		mockReplyFunction,
+		ConfigCustomInsightsEventsMaxSamplesStored(limit),
+	)
+
+	customEventRate := limit / (60 / internal.CustomEventHarvestsPerMinute)
+
+	// Check if custom event queue capacity == rate
+	if customEventRate != testApp.app.testHarvest.CustomEvents.capacity() {
+		t.Errorf("Custom Events Rate is not equal to harvest: expected %d, actual %d", customEventRate, testApp.app.testHarvest.CustomEvents.capacity())
+	}
+}