337 lines
15 KiB
C#
337 lines
15 KiB
C#
// <copyright file="CounterCleanUpTests.cs" company="OpenTelemetry Authors">
|
|
// Copyright The OpenTelemetry 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.
|
|
// </copyright>
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading;
|
|
using OpenTelemetry.Metrics;
|
|
using OpenTelemetry.Metrics.Export;
|
|
using OpenTelemetry.Trace;
|
|
using Xunit;
|
|
using Xunit.Abstractions;
|
|
|
|
namespace OpenTelemetry.Metrics.Test
|
|
{
|
|
public class CounterCleanUpTests
|
|
{
|
|
private readonly ITestOutputHelper output;
|
|
|
|
public CounterCleanUpTests(ITestOutputHelper output)
|
|
{
|
|
this.output = output;
|
|
}
|
|
|
|
[Fact]
|
|
public void LongCounterBoundInstrumentsStatusUpdatedCorrectlySingleThread()
|
|
{
|
|
var testProcessor = new TestMetricProcessor();
|
|
var meter = MeterFactory.Create(mb => mb.SetMetricProcessor(testProcessor)).GetMeter("library1") as MeterSdk;
|
|
var testCounter = meter.CreateInt64Counter("testCounter") as CounterMetricSdkBase<long>;
|
|
var labels1 = new List<KeyValuePair<string, string>>();
|
|
labels1.Add(new KeyValuePair<string, string>("dim1", "value1"));
|
|
var ls1 = meter.GetLabelSet(labels1);
|
|
|
|
var labels2 = new List<KeyValuePair<string, string>>();
|
|
labels2.Add(new KeyValuePair<string, string>("dim1", "value2"));
|
|
var ls2 = meter.GetLabelSet(labels2);
|
|
|
|
var labels3 = new List<KeyValuePair<string, string>>();
|
|
labels3.Add(new KeyValuePair<string, string>("dim1", "value3"));
|
|
var ls3 = meter.GetLabelSet(labels3);
|
|
|
|
var context = default(SpanContext);
|
|
|
|
// We have ls1, ls2, ls3
|
|
// ls1 and ls3 are not bound so they should removed when no usage for a Collect cycle.
|
|
// ls2 is bound by user.
|
|
testCounter.Add(context, 100, ls1);
|
|
testCounter.Add(context, 10, ls1);
|
|
|
|
// initial status for temp bound instruments are UpdatePending.
|
|
Assert.Equal(RecordStatus.UpdatePending, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
|
|
var boundCounterLabel2 = testCounter.Bind(ls2);
|
|
boundCounterLabel2.Add(context, 200);
|
|
|
|
// initial/forever status for user bound instruments are Bound.
|
|
Assert.Equal(RecordStatus.Bound, testCounter.GetAllBoundInstruments()[ls2].Status);
|
|
|
|
testCounter.Add(context, 200, ls3);
|
|
testCounter.Add(context, 10, ls3);
|
|
|
|
// initial status for temp bound instruments are UpdatePending.
|
|
Assert.Equal(RecordStatus.UpdatePending, testCounter.GetAllBoundInstruments()[ls3].Status);
|
|
|
|
// This collect should mark ls1, ls3 as NoPendingUpdate, leave ls2 untouched.
|
|
meter.Collect();
|
|
|
|
// Validate collect() has marked records correctly.
|
|
Assert.Equal(RecordStatus.NoPendingUpdate, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
Assert.Equal(RecordStatus.NoPendingUpdate, testCounter.GetAllBoundInstruments()[ls3].Status);
|
|
Assert.Equal(RecordStatus.Bound, testCounter.GetAllBoundInstruments()[ls2].Status);
|
|
|
|
// Use ls1 again, so that it'll be promoted to UpdatePending
|
|
testCounter.Add(context, 100, ls1);
|
|
|
|
// This collect should mark ls1 as NoPendingUpdate, leave ls2 untouched.
|
|
// And ls3 as CandidateForRemoval, as it was not used since last Collect
|
|
meter.Collect();
|
|
|
|
// Validate collect() has marked records correctly.
|
|
Assert.Equal(RecordStatus.NoPendingUpdate, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
Assert.Equal(RecordStatus.CandidateForRemoval, testCounter.GetAllBoundInstruments()[ls3].Status);
|
|
Assert.Equal(RecordStatus.Bound, testCounter.GetAllBoundInstruments()[ls2].Status);
|
|
|
|
// This collect should mark
|
|
// ls1 as CandidateForRemoval as it was not used since last Collect
|
|
// leave ls2 untouched.
|
|
// ls3 should be physically removed as it remained CandidateForRemoval during an entire Collect cycle.
|
|
meter.Collect();
|
|
Assert.Equal(RecordStatus.CandidateForRemoval, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
Assert.Equal(RecordStatus.Bound, testCounter.GetAllBoundInstruments()[ls2].Status);
|
|
Assert.False(testCounter.GetAllBoundInstruments().ContainsKey(ls3));
|
|
}
|
|
|
|
[Fact]
|
|
public void DoubleCounterBoundInstrumentsStatusUpdatedCorrectlySingleThread()
|
|
{
|
|
var testProcessor = new TestMetricProcessor();
|
|
var meter = MeterFactory.Create(mb => mb.SetMetricProcessor(testProcessor)).GetMeter("library1") as MeterSdk;
|
|
var testCounter = meter.CreateDoubleCounter("testCounter") as CounterMetricSdkBase<double>;
|
|
|
|
var labels1 = new List<KeyValuePair<string, string>>();
|
|
labels1.Add(new KeyValuePair<string, string>("dim1", "value1"));
|
|
var ls1 = meter.GetLabelSet(labels1);
|
|
|
|
var labels2 = new List<KeyValuePair<string, string>>();
|
|
labels2.Add(new KeyValuePair<string, string>("dim1", "value2"));
|
|
var ls2 = meter.GetLabelSet(labels2);
|
|
|
|
var labels3 = new List<KeyValuePair<string, string>>();
|
|
labels3.Add(new KeyValuePair<string, string>("dim1", "value3"));
|
|
var ls3 = meter.GetLabelSet(labels3);
|
|
|
|
var context = default(SpanContext);
|
|
|
|
// We have ls1, ls2, ls3
|
|
// ls1 and ls3 are not bound so they should removed when no usage for a Collect cycle.
|
|
// ls2 is bound by user.
|
|
testCounter.Add(context, 100.0, ls1);
|
|
testCounter.Add(context, 10.0, ls1);
|
|
|
|
// initial status for temp bound instruments are UpdatePending.
|
|
Assert.Equal(RecordStatus.UpdatePending, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
|
|
var boundCounterLabel2 = testCounter.Bind(ls2);
|
|
boundCounterLabel2.Add(context, 200.0);
|
|
|
|
// initial/forever status for user bound instruments are Bound.
|
|
Assert.Equal(RecordStatus.Bound, testCounter.GetAllBoundInstruments()[ls2].Status);
|
|
|
|
testCounter.Add(context, 200.0, ls3);
|
|
testCounter.Add(context, 10.0, ls3);
|
|
|
|
// initial status for temp bound instruments are UpdatePending.
|
|
Assert.Equal(RecordStatus.UpdatePending, testCounter.GetAllBoundInstruments()[ls3].Status);
|
|
|
|
// This collect should mark ls1, ls3 as NoPendingUpdate, leave ls2 untouched.
|
|
meter.Collect();
|
|
|
|
// Validate collect() has marked records correctly.
|
|
Assert.Equal(RecordStatus.NoPendingUpdate, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
Assert.Equal(RecordStatus.NoPendingUpdate, testCounter.GetAllBoundInstruments()[ls3].Status);
|
|
Assert.Equal(RecordStatus.Bound, testCounter.GetAllBoundInstruments()[ls2].Status);
|
|
|
|
// Use ls1 again, so that it'll be promoted to UpdatePending
|
|
testCounter.Add(context, 100.0, ls1);
|
|
|
|
// This collect should mark ls1 as NoPendingUpdate, leave ls2 untouched.
|
|
// And ls3 as CandidateForRemoval, as it was not used since last Collect
|
|
meter.Collect();
|
|
|
|
// Validate collect() has marked records correctly.
|
|
Assert.Equal(RecordStatus.NoPendingUpdate, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
Assert.Equal(RecordStatus.CandidateForRemoval, testCounter.GetAllBoundInstruments()[ls3].Status);
|
|
Assert.Equal(RecordStatus.Bound, testCounter.GetAllBoundInstruments()[ls2].Status);
|
|
|
|
// This collect should mark
|
|
// ls1 as CandidateForRemoval as it was not used since last Collect
|
|
// leave ls2 untouched.
|
|
// ls3 should be physically removed as it remained CandidateForRemoval during an entire Collect cycle.
|
|
meter.Collect();
|
|
Assert.Equal(RecordStatus.CandidateForRemoval, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
Assert.Equal(RecordStatus.Bound, testCounter.GetAllBoundInstruments()[ls2].Status);
|
|
Assert.False(testCounter.GetAllBoundInstruments().ContainsKey(ls3));
|
|
}
|
|
|
|
[Fact]
|
|
public void LongCounterBoundInstrumentsStatusUpdatedCorrectlyMultiThread()
|
|
{
|
|
var testProcessor = new TestMetricProcessor();
|
|
var meter = MeterFactory.Create(mb => mb.SetMetricProcessor(testProcessor)).GetMeter("library1") as MeterSdk;
|
|
var testCounter = meter.CreateInt64Counter("testCounter") as CounterMetricSdkBase<long>;
|
|
|
|
var labels1 = new List<KeyValuePair<string, string>>();
|
|
labels1.Add(new KeyValuePair<string, string>("dim1", "value1"));
|
|
var ls1 = meter.GetLabelSet(labels1);
|
|
|
|
var context = default(SpanContext);
|
|
|
|
// Call metric update with ls1 so that ls1 wont be brand new labelset when doing multi-thread test.
|
|
testCounter.Add(context, 100, ls1);
|
|
testCounter.Add(context, 10, ls1);
|
|
|
|
// This collect should mark ls1 NoPendingUpdate
|
|
meter.Collect();
|
|
|
|
// Validate collect() has marked records correctly.
|
|
Assert.Equal(RecordStatus.NoPendingUpdate, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
|
|
// Another collect(). This collect should mark ls1 as CandidateForRemoval.
|
|
meter.Collect();
|
|
Assert.Equal(RecordStatus.CandidateForRemoval, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
|
|
// Call Collect() and update with ls1 parallelly to validate no update is lost, as ls1 is marked
|
|
// candidate for removal after above step.
|
|
var mre = new ManualResetEvent(false);
|
|
var argsForMeterCollect = new ArgsToThread();
|
|
argsForMeterCollect.MreToBlockStartOfThread = mre;
|
|
argsForMeterCollect.Callback = () => meter.Collect();
|
|
|
|
var argsForCounterAdd = new ArgsToThread();
|
|
argsForCounterAdd.MreToBlockStartOfThread = mre;
|
|
argsForCounterAdd.Callback = () => testCounter.Add(context, 100, ls1);
|
|
|
|
var collectThread = new Thread(ThreadMethod);
|
|
var updateThread = new Thread(ThreadMethod);
|
|
collectThread.Start(argsForMeterCollect);
|
|
updateThread.Start(argsForCounterAdd);
|
|
|
|
// Attempt to start both threads.
|
|
// TODO:
|
|
// Instead of this, evaluate if a different testing approach is needed.
|
|
// One or more thread doing Updates in parallel.
|
|
// One thread doing occasional Collect.
|
|
// At the end, validate that no metric update is lost.
|
|
mre.Set();
|
|
|
|
collectThread.Join();
|
|
updateThread.Join();
|
|
|
|
// Validate that the exported record doesn't miss any update.
|
|
// The Add(100) value must have already been exported, or must be exported in the next Collect().
|
|
|
|
meter.Collect();
|
|
|
|
long sum = 0;
|
|
foreach (var exportedData in testProcessor.Metrics)
|
|
{
|
|
exportedData.Data.ForEach(data => sum += (data as Int64SumData).Sum);
|
|
}
|
|
|
|
// 210 = 110 from initial update, 100 from the multi-thread test case.
|
|
Assert.Equal(210, sum);
|
|
}
|
|
|
|
[Fact]
|
|
public void DoubleCounterBoundInstrumentsStatusUpdatedCorrectlyMultiThread()
|
|
{
|
|
var testProcessor = new TestMetricProcessor();
|
|
var meter = MeterFactory.Create(mb => mb.SetMetricProcessor(testProcessor)).GetMeter("library1") as MeterSdk;
|
|
var testCounter = meter.CreateDoubleCounter("testCounter") as CounterMetricSdkBase<double>;
|
|
|
|
var labels1 = new List<KeyValuePair<string, string>>();
|
|
labels1.Add(new KeyValuePair<string, string>("dim1", "value1"));
|
|
var ls1 = meter.GetLabelSet(labels1);
|
|
|
|
var context = default(SpanContext);
|
|
|
|
// Call metric update with ls1 so that ls1 wont be brand new labelset when doing multi-thread test.
|
|
testCounter.Add(context, 100.0, ls1);
|
|
testCounter.Add(context, 10.0, ls1);
|
|
|
|
// This collect should mark ls1 NoPendingUpdate
|
|
meter.Collect();
|
|
|
|
// Validate collect() has marked records correctly.
|
|
Assert.Equal(RecordStatus.NoPendingUpdate, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
|
|
// Another collect(). This collect should mark ls1 as CandidateForRemoval.
|
|
meter.Collect();
|
|
Assert.Equal(RecordStatus.CandidateForRemoval, testCounter.GetAllBoundInstruments()[ls1].Status);
|
|
|
|
// Call Collect() and update with ls1 parallelly to validate no update is lost, as ls1 is marked
|
|
// candidate for removal after above step.
|
|
var mre = new ManualResetEvent(false);
|
|
var argsForMeterCollect = new ArgsToThread();
|
|
argsForMeterCollect.MreToBlockStartOfThread = mre;
|
|
argsForMeterCollect.Callback = () => meter.Collect();
|
|
|
|
var argsForCounterAdd = new ArgsToThread();
|
|
argsForCounterAdd.MreToBlockStartOfThread = mre;
|
|
argsForCounterAdd.Callback = () => testCounter.Add(context, 100.0, ls1);
|
|
|
|
var collectThread = new Thread(ThreadMethod);
|
|
var updateThread = new Thread(ThreadMethod);
|
|
collectThread.Start(argsForMeterCollect);
|
|
updateThread.Start(argsForCounterAdd);
|
|
|
|
// Attempt to start both threads.
|
|
// TODO:
|
|
// Instead of this, evaluate if a different testing approach is needed.
|
|
// One or more thread doing Updates in parallel.
|
|
// One thread doing occasional Collect.
|
|
// At the end, validate that no metric update is lost.
|
|
mre.Set();
|
|
|
|
collectThread.Join();
|
|
updateThread.Join();
|
|
|
|
// Validate that the exported record doesn't miss any update.
|
|
// The Add(100) value must have already been exported, or must be exported in the next Collect().
|
|
|
|
meter.Collect();
|
|
|
|
double sum = 0;
|
|
|
|
foreach (var exportedData in testProcessor.Metrics)
|
|
{
|
|
exportedData.Data.ForEach(data => sum += (data as DoubleSumData).Sum);
|
|
}
|
|
|
|
// 210 = 110 from initial update, 100 from the multi-thread test case.
|
|
Assert.Equal(210.0, sum);
|
|
}
|
|
|
|
private static void ThreadMethod(object obj)
|
|
{
|
|
var args = obj as ArgsToThread;
|
|
var mre = args.MreToBlockStartOfThread;
|
|
var callBack = args.Callback;
|
|
|
|
// Wait until signalled to call Collect.
|
|
mre.WaitOne();
|
|
callBack();
|
|
}
|
|
|
|
private class ArgsToThread
|
|
{
|
|
public ManualResetEvent MreToBlockStartOfThread;
|
|
public Action Callback;
|
|
}
|
|
}
|
|
}
|