public void QuickPulseTelemetryModuleHandlesUnexpectedExceptions()
{
if (QuickPulseTelemetryModuleTests.Ignored)
{
return;
}
// ARRANGE
var interval = TimeSpan.FromMilliseconds(1);
var timings = new QuickPulseTimings(interval, interval, interval, interval, interval, interval);
var collectionTimeSlotManager = new QuickPulseCollectionTimeSlotManagerMock(timings);
var serviceClient = new QuickPulseServiceClientMock
{
AlwaysThrow = true,
ReturnValueFromPing = false,
ReturnValueFromSubmitSample = null
};
var performanceCollector = new PerformanceCollectorMock();
var topCpuCollector = new QuickPulseTopCpuCollectorMock();
var module = new QuickPulseTelemetryModule(collectionTimeSlotManager, null, serviceClient, performanceCollector, topCpuCollector, timings);
module.Initialize(new TelemetryConfiguration()
{
InstrumentationKey = "some ikey"
});
// ACT
Thread.Sleep(TimeSpan.FromSeconds(1));
// ASSERT
// it shouldn't throw and must keep pinging
int pingCount = serviceClient.PingCount;
Assert.IsTrue(pingCount > 5, string.Format(CultureInfo.InvariantCulture, "PingCount is not high enough, the value is {0}", pingCount));
}
/// <summary>
/// Initializes the telemetry client with the given configuration.
/// </summary>
/// <param name="telemetryConfig">The telemetry configuration.</param>
/// <returns>The telemetry client.</returns>
private TelemetryClient InitializeTelemetry(TelemetryConfiguration telemetryConfig)
{
QuickPulseTelemetryProcessor processor = null;
telemetryConfig.TelemetryInitializers.Add(new OperationCorrelationTelemetryInitializer());
telemetryConfig.TelemetryProcessorChainBuilder
.Use((next) =>
{
processor = new QuickPulseTelemetryProcessor(next);
return(processor);
})
.Build();
var quickPulse = new QuickPulseTelemetryModule()
{
AuthenticationApiKey = telemetryConfig.InstrumentationKey,
};
quickPulse.Initialize(telemetryConfig);
quickPulse.RegisterTelemetryProcessor(processor);
return(new TelemetryClient(telemetryConfig));
}
private static void AddTelemetryChannelAndProcessorsForFullFramework(IServiceProvider serviceProvider, TelemetryConfiguration configuration, ApplicationInsightsServiceOptions serviceOptions)
{
#if NET451
// Adding Server Telemetry Channel if services doesn't have an existing channel
configuration.TelemetryChannel = serviceProvider.GetService <ITelemetryChannel>() ?? new ServerTelemetryChannel();
if (configuration.TelemetryChannel is ServerTelemetryChannel)
{
// Enabling Quick Pulse Metric Stream
if (serviceOptions.EnableQuickPulseMetricStream)
{
var quickPulseModule = new QuickPulseTelemetryModule();
quickPulseModule.Initialize(configuration);
QuickPulseTelemetryProcessor processor = null;
configuration.TelemetryProcessorChainBuilder.Use((next) => {
processor = new QuickPulseTelemetryProcessor(next);
quickPulseModule.RegisterTelemetryProcessor(processor);
return(processor);
});
}
// Enabling Adaptive Sampling and initializing server telemetry channel with configuration
if (configuration.TelemetryChannel.GetType() == typeof(ServerTelemetryChannel))
{
if (serviceOptions.EnableAdaptiveSampling)
{
configuration.TelemetryProcessorChainBuilder.UseAdaptiveSampling();
}
(configuration.TelemetryChannel as ServerTelemetryChannel).Initialize(configuration);
}
configuration.TelemetryProcessorChainBuilder.Build();
}
#endif
}
public void QuickPulseTelemetryModuleDoesNotLeakThreads()
{
// ARRANGE
var interval = TimeSpan.FromMilliseconds(1);
var timings = new QuickPulseTimings(interval, interval, interval, interval, interval, interval);
var collectionTimeSlotManager = new QuickPulseCollectionTimeSlotManagerMock(timings);
// this will flip-flop between collection and no collection, creating and ending a collection thread each time
var serviceClient = new QuickPulseServiceClientMock {
ReturnValueFromPing = true, ReturnValueFromSubmitSample = false
};
var performanceCollector = new PerformanceCollectorMock();
var module = new QuickPulseTelemetryModule(
collectionTimeSlotManager,
null,
serviceClient,
performanceCollector,
timings);
module.Initialize(new TelemetryConfiguration()
{
InstrumentationKey = "some ikey"
});
int initialThreadCount = Process.GetCurrentProcess().Threads.Count;
// ACT
Thread.Sleep(TimeSpan.FromMilliseconds(300));
// ASSERT
// we don't expect to find many more threads, even though other components might be spinning new ones up and down
var threadDelta = Process.GetCurrentProcess().Threads.Count - initialThreadCount;
Assert.IsTrue(Math.Abs(threadDelta) < 5, threadDelta.ToString(CultureInfo.InvariantCulture));
}
private static QuickPulseTelemetryModule InitializeQuickPulseModule()
{
var quickPulseModule = new QuickPulseTelemetryModule();
var quickPulseEndpointPort = ConfigurationManager.AppSettings["QuickPulseEndpointPort"];
quickPulseModule.QuickPulseServiceEndpoint = string.Format("http://localhost:{0}/QuickPulseService.svc/", quickPulseEndpointPort);
QuickPulseTelemetryProcessor processor = null;
TelemetryConfiguration.Active.TelemetryProcessorChainBuilder.Use(
(next) =>
{
processor = new QuickPulseTelemetryProcessor(next);
quickPulseModule.RegisterTelemetryProcessor(processor);
return(processor);
});
TelemetryConfiguration.Active.TelemetryProcessorChainBuilder.Build();
quickPulseModule.Initialize(TelemetryConfiguration.Active);
return(quickPulseModule);
}
public void QuickPulseTelemetryModuleSupportsMultipleTelemetryProcessorsForMultipleConfigurations()
{
if (QuickPulseTelemetryModuleTests.Ignored)
{
return;
}
// ARRANGE
var pollingInterval = TimeSpan.FromMilliseconds(1);
var collectionInterval = TimeSpan.FromMilliseconds(1);
var timings = new QuickPulseTimings(pollingInterval, collectionInterval);
var collectionTimeSlotManager = new QuickPulseCollectionTimeSlotManagerMock(timings);
CollectionConfigurationError[] errors;
var accumulatorManager =
new QuickPulseDataAccumulatorManager(
new CollectionConfiguration(
new CollectionConfigurationInfo()
{
ETag = string.Empty, Metrics = new CalculatedMetricInfo[0]
},
out errors,
new ClockMock()));
var serviceClient = new QuickPulseServiceClientMock {
ReturnValueFromPing = true, ReturnValueFromSubmitSample = true
};
var performanceCollector = new PerformanceCollectorMock();
var topCpuCollector = new QuickPulseTopCpuCollectorMock();
var module = new QuickPulseTelemetryModule(
collectionTimeSlotManager,
accumulatorManager,
serviceClient,
performanceCollector,
topCpuCollector,
timings);
const int TelemetryProcessorCount = 4;
var ikey = "some ikey";
var config = new TelemetryConfiguration {
InstrumentationKey = ikey
};
// spawn a bunch of configurations, each one having an individual instance of QuickPulseTelemetryProcessor
var telemetryProcessors = new List <QuickPulseTelemetryProcessor>();
for (int i = 0; i < TelemetryProcessorCount; i++)
{
var configuration = new TelemetryConfiguration();
var builder = configuration.TelemetryProcessorChainBuilder;
builder = builder.Use(current => new QuickPulseTelemetryProcessor(new SimpleTelemetryProcessorSpy()));
builder.Build();
telemetryProcessors.Add(configuration.TelemetryProcessors.OfType <QuickPulseTelemetryProcessor>().Single());
}
// ACT
foreach (var telemetryProcessor in telemetryProcessors)
{
module.RegisterTelemetryProcessor(telemetryProcessor);
}
module.Initialize(config);
Thread.Sleep(TimeSpan.FromMilliseconds(100));
// send data to each instance of QuickPulseTelemetryProcessor
var request = new RequestTelemetry()
{
ResponseCode = "200", Success = true, Context = { InstrumentationKey = ikey }
};
telemetryProcessors[0].Process(request);
request = new RequestTelemetry()
{
ResponseCode = "500", Success = false, Context = { InstrumentationKey = ikey }
};
telemetryProcessors[1].Process(request);
var dependency = new DependencyTelemetry()
{
Success = true, Context = { InstrumentationKey = ikey }
};
telemetryProcessors[2].Process(dependency);
dependency = new DependencyTelemetry()
{
Success = false, Context = { InstrumentationKey = ikey }
};
telemetryProcessors[3].Process(dependency);
Thread.Sleep(TimeSpan.FromMilliseconds(100));
// ASSERT
// verify that every telemetry processor has contributed to the accumulator
int samplesWithSomeRequests = serviceClient.SnappedSamples.Count(s => s.AIRequestsPerSecond > 0);
int samplesWithSomeDependencies = serviceClient.SnappedSamples.Count(s => s.AIDependencyCallsPerSecond > 0);
Assert.AreEqual(TelemetryProcessorCount, QuickPulseTestHelper.GetTelemetryProcessors(module).Count);
Assert.IsTrue(samplesWithSomeRequests > 0 && samplesWithSomeRequests <= 2);
Assert.AreEqual(1, serviceClient.SnappedSamples.Count(s => s.AIRequestsFailedPerSecond > 0));
Assert.IsTrue(samplesWithSomeDependencies > 0 && samplesWithSomeDependencies < 2);
Assert.AreEqual(1, serviceClient.SnappedSamples.Count(s => s.AIDependencyCallsFailedPerSecond > 0));
}
public void QuickPulseTelemetryModuleCollectsData()
{
if (QuickPulseTelemetryModuleTests.Ignored)
{
return;
}
// ARRANGE
var pause = TimeSpan.FromSeconds(1);
var interval = TimeSpan.FromMilliseconds(1);
var timings = new QuickPulseTimings(interval, interval);
var collectionTimeSlotManager = new QuickPulseCollectionTimeSlotManagerMock(timings);
var filter1 = new[]
{
new FilterConjunctionGroupInfo()
{
Filters = new[] { new FilterInfo()
{
FieldName = "Name", Predicate = Predicate.Equal, Comparand = "Request1"
} }
}
};
var metrics = new[]
{
new CalculatedMetricInfo()
{
Id = "Metric0",
TelemetryType = TelemetryType.Request,
Projection = "Id",
Aggregation = AggregationType.Avg,
FilterGroups = filter1
}
};
var serviceClient = new QuickPulseServiceClientMock {
ReturnValueFromPing = true, ReturnValueFromSubmitSample = true
};
serviceClient.CollectionConfigurationInfo = new CollectionConfigurationInfo()
{
ETag = "1", Metrics = metrics
};
var performanceCollector = new PerformanceCollectorMock();
var topCpuCollector = new QuickPulseTopCpuCollectorMock()
{
TopProcesses = new List <Tuple <string, int> >()
{
Tuple.Create("Process1", 25)
}
};
var module = new QuickPulseTelemetryModule(collectionTimeSlotManager, null, serviceClient, performanceCollector, topCpuCollector, timings);
var telemetryProcessor = new QuickPulseTelemetryProcessor(new SimpleTelemetryProcessorSpy());
telemetryProcessor.Initialize(new TelemetryConfiguration());
module.RegisterTelemetryProcessor(telemetryProcessor);
// ACT
var telemetryConfiguration = new TelemetryConfiguration()
{
InstrumentationKey = "some ikey"
};
module.Initialize(telemetryConfiguration);
Thread.Sleep(pause);
telemetryProcessor.Process(new RequestTelemetry()
{
Id = "1", Name = "Request1", Context = { InstrumentationKey = "some ikey" }
});
telemetryProcessor.Process(new DependencyTelemetry()
{
Context = { InstrumentationKey = "some ikey" }
});
Thread.Sleep(pause);
Assert.AreEqual(1, serviceClient.PingCount);
// ASSERT
serviceClient.ReturnValueFromPing = false;
serviceClient.ReturnValueFromSubmitSample = false;
Thread.Sleep(pause);
Assert.IsTrue(serviceClient.SnappedSamples.Count > 0);
Assert.IsTrue(serviceClient.SnappedSamples.Any(s => s.AIRequestsPerSecond > 0));
Assert.IsTrue(serviceClient.SnappedSamples.Any(s => s.AIDependencyCallsPerSecond > 0));
Assert.IsTrue(
serviceClient.SnappedSamples.Any(s => Math.Abs(s.PerfCountersLookup[@"\Processor(_Total)\% Processor Time"]) > double.Epsilon));
Assert.IsTrue(
serviceClient.SnappedSamples.TrueForAll(s => s.TopCpuData.Single().Item1 == "Process1" && s.TopCpuData.Single().Item2 == 25));
Assert.IsTrue(
serviceClient.SnappedSamples.Any(
s =>
s.CollectionConfigurationAccumulator.MetricAccumulators.Any(
a => a.Value.MetricId == "Metric0" && a.Value.CalculateAggregation(out long count) == 1.0d && count == 1)));
}
public Library(string configuration)
{
this.config = new Configuration(configuration);
Diagnostics.LogInfo(
FormattableString.Invariant($"Loaded configuration. {Environment.NewLine}{configuration}"));
this.telemetryGenerator = new TelemetryGenerator(this.config.Watchlist_Namespaces, this.config.Watchlist_IgnoredNamespaces);
try
{
var activeConfiguration = TelemetryConfiguration.Active;
activeConfiguration.InstrumentationKey = this.config.InstrumentationKey;
var channel = new ServerTelemetryChannel();
string telemetryChannelEndpoint = this.config.Endpoints_TelemetryChannelEndpoint;
if (!string.IsNullOrWhiteSpace(telemetryChannelEndpoint))
{
channel.EndpointAddress = telemetryChannelEndpoint;
}
channel.Initialize(activeConfiguration);
activeConfiguration.TelemetryChannel = channel;
var builder = activeConfiguration.DefaultTelemetrySink.TelemetryProcessorChainBuilder;
QuickPulseTelemetryProcessor processor = null;
builder.Use((next) =>
{
processor = new QuickPulseTelemetryProcessor(next);
return(processor);
});
if (this.config.AdaptiveSampling_Enabled == true)
{
builder.UseAdaptiveSampling(this.config.AdaptiveSampling_MaxOtherItemsPerSecond ?? 5, excludedTypes: "Event");
builder.UseAdaptiveSampling(this.config.AdaptiveSampling_MaxEventsPerSecond ?? 5, includedTypes: "Event");
}
builder.Build();
var quickPulseModule = new QuickPulseTelemetryModule()
{
AuthenticationApiKey = this.config.LiveMetricsStreamAuthenticationApiKey
};
string quickPulseServiceEndpoint = this.config.Endpoints_QuickPulseServiceEndpoint;
if (!string.IsNullOrWhiteSpace(quickPulseServiceEndpoint))
{
quickPulseModule.QuickPulseServiceEndpoint = quickPulseServiceEndpoint;
}
quickPulseModule.Initialize(activeConfiguration);
quickPulseModule.RegisterTelemetryProcessor(processor);
this.telemetryClient = this.telemetryClient ?? new TelemetryClient(activeConfiguration);
}
catch (Exception e)
{
Diagnostics.LogError(
FormattableString.Invariant($"Could not initialize AI SDK. {e.ToString()}"));
throw new InvalidOperationException(
FormattableString.Invariant($"Could not initialize AI SDK. {e.ToString()}"), e);
}
try
{
if (this.config.Port.HasValue)
{
this.istioMixerInput = new GrpcInput(this.config.Host, this.config.Port.Value, this.OnDataReceived);
Diagnostics.LogInfo(
FormattableString.Invariant($"We will listen for Istio's Mixer data on {this.config.Host}:{this.config.Port}"));
}
else
{
Diagnostics.LogInfo(
FormattableString.Invariant($"We will not listen for Istio's Mixer data, configuration is insufficient."));
}
}
catch (Exception e)
{
Diagnostics.LogError(
FormattableString.Invariant($"Could not create the gRPC Istio Mixer channel. {e.ToString()}"));
throw new InvalidOperationException(
FormattableString.Invariant($"Could not create the gRPC Istio Mixer channel. {e.ToString()}"), e);
}
}
private static void SetupTelemetryConfiguration(
TelemetryConfiguration configuration,
string instrumentationKey,
SamplingPercentageEstimatorSettings samplingSettings,
SnapshotCollectorConfiguration snapshotCollectorConfiguration,
ITelemetryChannel channel,
IEnumerable <ITelemetryInitializer> telemetryInitializers,
IEnumerable <ITelemetryModule> telemetryModules,
IApplicationIdProvider applicationIdProvider,
LoggerFilterOptions filterOptions)
{
if (instrumentationKey != null)
{
configuration.InstrumentationKey = instrumentationKey;
// Because of https://github.com/Microsoft/ApplicationInsights-dotnet-server/issues/943
// we have to touch (and create) Active configuration before initializing telemetry modules
TelemetryConfiguration.Active.InstrumentationKey = instrumentationKey;
}
configuration.TelemetryChannel = channel;
foreach (ITelemetryInitializer initializer in telemetryInitializers)
{
configuration.TelemetryInitializers.Add(initializer);
}
(channel as ServerTelemetryChannel)?.Initialize(configuration);
QuickPulseTelemetryModule quickPulseModule = null;
foreach (ITelemetryModule module in telemetryModules)
{
if (module is QuickPulseTelemetryModule telemetryModule)
{
quickPulseModule = telemetryModule;
}
module.Initialize(configuration);
}
QuickPulseTelemetryProcessor quickPulseProcessor = null;
configuration.TelemetryProcessorChainBuilder
.Use((next) =>
{
quickPulseProcessor = new QuickPulseTelemetryProcessor(next);
return(quickPulseProcessor);
})
.Use((next) => new FilteringTelemetryProcessor(filterOptions, next));
if (samplingSettings != null)
{
configuration.TelemetryProcessorChainBuilder.Use((next) =>
new AdaptiveSamplingTelemetryProcessor(samplingSettings, null, next));
}
if (snapshotCollectorConfiguration != null)
{
configuration.TelemetryProcessorChainBuilder.UseSnapshotCollector(snapshotCollectorConfiguration);
}
configuration.TelemetryProcessorChainBuilder.Build();
quickPulseModule?.RegisterTelemetryProcessor(quickPulseProcessor);
foreach (ITelemetryProcessor processor in configuration.TelemetryProcessors)
{
if (processor is ITelemetryModule module)
{
module.Initialize(configuration);
}
}
configuration.ApplicationIdProvider = applicationIdProvider;
}
public void QuickPulseTelemetryModuleCollectsData()
{
// ARRANGE
var pause = TimeSpan.FromMilliseconds(100);
var interval = TimeSpan.FromMilliseconds(1);
var timings = new QuickPulseTimings(interval, interval);
var collectionTimeSlotManager = new QuickPulseCollectionTimeSlotManagerMock(timings);
var serviceClient = new QuickPulseServiceClientMock {
ReturnValueFromPing = true, ReturnValueFromSubmitSample = true
};
var performanceCollector = new PerformanceCollectorMock();
var topCpuCollector = new QuickPulseTopCpuCollectorMock()
{
TopProcesses = new List <Tuple <string, int> >()
{
Tuple.Create("Process1", 25)
}
};
var module = new QuickPulseTelemetryModule(collectionTimeSlotManager, null, serviceClient, performanceCollector, topCpuCollector, timings);
var telemetryProcessor = new QuickPulseTelemetryProcessor(new SimpleTelemetryProcessorSpy());
telemetryProcessor.Initialize(new TelemetryConfiguration());
module.RegisterTelemetryProcessor(telemetryProcessor);
// ACT
module.Initialize(new TelemetryConfiguration()
{
InstrumentationKey = "some ikey"
});
Thread.Sleep(pause);
telemetryProcessor.Process(new RequestTelemetry()
{
Context = { InstrumentationKey = "some ikey" }
});
telemetryProcessor.Process(new DependencyTelemetry()
{
Context = { InstrumentationKey = "some ikey" }
});
Thread.Sleep(pause);
Assert.AreEqual(1, serviceClient.PingCount);
// ASSERT
serviceClient.ReturnValueFromPing = false;
serviceClient.ReturnValueFromSubmitSample = false;
Thread.Sleep(pause);
Assert.IsTrue(serviceClient.SnappedSamples.Count > 0);
Assert.IsTrue(serviceClient.SnappedSamples.Any(s => s.AIRequestsPerSecond > 0));
Assert.IsTrue(serviceClient.SnappedSamples.Any(s => s.AIDependencyCallsPerSecond > 0));
Assert.IsTrue(
serviceClient.SnappedSamples.Any(s => Math.Abs(s.PerfCountersLookup[@"\Processor(_Total)\% Processor Time"]) > double.Epsilon));
Assert.IsTrue(
serviceClient.SnappedSamples.TrueForAll(s => s.TopCpuData.Single().Item1 == "Process1" && s.TopCpuData.Single().Item2 == 25));
}
public void QuickPulseTelemetryModuleUpdatesPerformanceCollectorWhenUpdatingCollectionConfiguration()
{
if (QuickPulseTelemetryModuleTests.Ignored)
{
return;
}
// ARRANGE
var pollingInterval = TimeSpan.FromMilliseconds(200);
var collectionInterval = TimeSpan.FromMilliseconds(80);
var timings = new QuickPulseTimings(pollingInterval, collectionInterval);
var collectionTimeSlotManager = new QuickPulseCollectionTimeSlotManagerMock(timings);
var serviceClient = new QuickPulseServiceClientMock {
ReturnValueFromPing = true, ReturnValueFromSubmitSample = true
};
var performanceCollector = new PerformanceCollectorMock();
var topCpuCollector = new QuickPulseTopCpuCollectorMock();
var module = new QuickPulseTelemetryModule(collectionTimeSlotManager, null, serviceClient, performanceCollector, topCpuCollector, timings);
// ACT & ASSERT
serviceClient.CollectionConfigurationInfo = new CollectionConfigurationInfo()
{
ETag = "ETag1",
Metrics =
new[]
{
new CalculatedMetricInfo()
{
Id = "PerformanceCounter1",
TelemetryType = TelemetryType.PerformanceCounter,
Projection = @"\Memory\Cache Bytes"
},
new CalculatedMetricInfo()
{
Id = "PerformanceCounter2",
TelemetryType = TelemetryType.PerformanceCounter,
Projection = @"\Memory\Cache Bytes Peak"
},
new CalculatedMetricInfo()
{
Id = "PerformanceCounter3",
TelemetryType = TelemetryType.PerformanceCounter,
Projection = @"\Processor(_Total)\% Processor Time"
}
}
};
module.Initialize(new TelemetryConfiguration()
{
InstrumentationKey = "some ikey"
});
Thread.Sleep(pollingInterval);
Thread.Sleep((int)(2.5 * collectionInterval.TotalMilliseconds));
Assert.AreEqual("ETag1", serviceClient.SnappedSamples.Last().CollectionConfigurationAccumulator.CollectionConfiguration.ETag);
// 2 default + 3 configured
Assert.AreEqual(5, performanceCollector.PerformanceCounters.Count());
Assert.AreEqual(@"\Memory\Cache Bytes", performanceCollector.PerformanceCounters.Skip(0).First().OriginalString);
Assert.AreEqual(@"PerformanceCounter1", performanceCollector.PerformanceCounters.Skip(0).First().ReportAs);
Assert.AreEqual(@"\Memory\Cache Bytes Peak", performanceCollector.PerformanceCounters.Skip(1).First().OriginalString);
Assert.AreEqual(@"PerformanceCounter2", performanceCollector.PerformanceCounters.Skip(1).First().ReportAs);
Assert.AreEqual(@"\Processor(_Total)\% Processor Time", performanceCollector.PerformanceCounters.Skip(2).First().OriginalString);
Assert.AreEqual(@"PerformanceCounter3", performanceCollector.PerformanceCounters.Skip(2).First().ReportAs);
Assert.AreEqual(@"\Memory\Committed Bytes", performanceCollector.PerformanceCounters.Skip(3).First().OriginalString);
Assert.AreEqual(@"\Memory\Committed Bytes", performanceCollector.PerformanceCounters.Skip(3).First().ReportAs);
Assert.AreEqual(@"\Processor(_Total)\% Processor Time", performanceCollector.PerformanceCounters.Skip(4).First().OriginalString);
Assert.AreEqual(@"\Processor(_Total)\% Processor Time", performanceCollector.PerformanceCounters.Skip(4).First().ReportAs);
serviceClient.CollectionConfigurationInfo = new CollectionConfigurationInfo()
{
ETag = "ETag2",
Metrics =
new[]
{
new CalculatedMetricInfo()
{
Id = "PerformanceCounter1",
TelemetryType = TelemetryType.PerformanceCounter,
Projection = @"\MEMORY\Cache Bytes"
},
new CalculatedMetricInfo()
{
Id = "PerformanceCounter5",
TelemetryType = TelemetryType.PerformanceCounter,
Projection = @"\Memory\Commit Limit"
}
}
};
Thread.Sleep((int)(10 * collectionInterval.TotalMilliseconds));
Assert.AreEqual("ETag2", serviceClient.SnappedSamples.Last().CollectionConfigurationAccumulator.CollectionConfiguration.ETag);
// 2 default + 1 configured remaining + 1 configured new
Assert.AreEqual(4, performanceCollector.PerformanceCounters.Count());
Assert.AreEqual(@"\Memory\Cache Bytes", performanceCollector.PerformanceCounters.Skip(0).First().OriginalString);
Assert.AreEqual(@"PerformanceCounter1", performanceCollector.PerformanceCounters.Skip(0).First().ReportAs);
Assert.AreEqual(@"\Memory\Committed Bytes", performanceCollector.PerformanceCounters.Skip(1).First().OriginalString);
Assert.AreEqual(@"\Memory\Committed Bytes", performanceCollector.PerformanceCounters.Skip(1).First().ReportAs);
Assert.AreEqual(@"\Processor(_Total)\% Processor Time", performanceCollector.PerformanceCounters.Skip(2).First().OriginalString);
Assert.AreEqual(@"\Processor(_Total)\% Processor Time", performanceCollector.PerformanceCounters.Skip(2).First().ReportAs);
Assert.AreEqual(@"\Memory\Commit Limit", performanceCollector.PerformanceCounters.Skip(3).First().OriginalString);
Assert.AreEqual(@"PerformanceCounter5", performanceCollector.PerformanceCounters.Skip(3).First().ReportAs);
}
public Library(string configuration)
{
this.config = new Configuration(configuration);
this.ocToAiInstrumentationKey = config.OpenCensusToApplicationInsights_InstrumentationKey;
this.liveMetricsStreamInstrumentationKey = config.ApplicationInsights_LiveMetricsStreamInstrumentationKey;
this.liveMetricsStreamAuthenticationApiKey = config.ApplicationInsights_LiveMetricsStreamAuthenticationApiKey;
this.opencensusPeers = new OpenCensusClientCache <string, Node>();
this.DefaultOpencensusConfig = new TraceConfig
{
ConstantSampler = new ConstantSampler
{
Decision = true
}
};
Diagnostics.LogInfo(
FormattableString.Invariant($"Loaded configuration. {Environment.NewLine}{configuration}"));
try
{
var activeConfiguration = TelemetryConfiguration.Active;
activeConfiguration.InstrumentationKey = this.liveMetricsStreamInstrumentationKey;
var channel = new ServerTelemetryChannel();
channel.Initialize(activeConfiguration);
activeConfiguration.TelemetryChannel = channel;
var builder = activeConfiguration.DefaultTelemetrySink.TelemetryProcessorChainBuilder;
QuickPulseTelemetryProcessor processor = null;
builder.Use((next) =>
{
processor = new QuickPulseTelemetryProcessor(next);
return(processor);
});
if (config.ApplicationInsights_AdaptiveSampling_Enabled == true)
{
builder.UseAdaptiveSampling(config.ApplicationInsights_AdaptiveSampling_MaxOtherItemsPerSecond ?? 5, excludedTypes: "Event");
builder.UseAdaptiveSampling(config.ApplicationInsights_AdaptiveSampling_MaxEventsPerSecond ?? 5, includedTypes: "Event");
}
builder.Build();
var quickPulseModule = new QuickPulseTelemetryModule()
{
AuthenticationApiKey = this.liveMetricsStreamAuthenticationApiKey
};
quickPulseModule.Initialize(activeConfiguration);
quickPulseModule.RegisterTelemetryProcessor(processor);
this.telemetryClient = new TelemetryClient(activeConfiguration);
}
catch (Exception e)
{
Diagnostics.LogError(
FormattableString.Invariant($"Could not initialize AI SDK. {e.ToString()}"));
throw new InvalidOperationException(
FormattableString.Invariant($"Could not initialize AI SDK. {e.ToString()}"), e);
}
try
{
if (this.config.ApplicationInsightsInput_Enabled == true && this.config.ApplicationInsightsInput_Port.HasValue)
{
this.gRpcAiInput = new GrpcAiInput(this.config.ApplicationInsightsInput_Host, this.config.ApplicationInsightsInput_Port.Value);
Diagnostics.LogInfo(
FormattableString.Invariant($"We will listen for AI data on {this.config.ApplicationInsightsInput_Host}:{this.config.ApplicationInsightsInput_Port}"));
}
else
{
Diagnostics.LogInfo(
FormattableString.Invariant($"We will not listen for AI data"));
}
}
catch (Exception e)
{
Diagnostics.LogError(
FormattableString.Invariant($"Could not create the gRPC AI channel. {e.ToString()}"));
throw new InvalidOperationException(
FormattableString.Invariant($"Could not create the gRPC AI channel. {e.ToString()}"), e);
}
try
{
if (this.config.OpenCensusInput_Enabled == true && this.config.OpenCensusInput_Port.HasValue)
{
this.gRpcOpenCensusInput = new GrpcOpenCensusInput(this.config.OpenCensusInput_Host, this.config.OpenCensusInput_Port.Value);
Diagnostics.LogInfo(
FormattableString.Invariant($"We will listen for OpenCensus data on {this.config.OpenCensusInput_Host}:{this.config.OpenCensusInput_Port}"));
}
else
{
Diagnostics.LogInfo(
FormattableString.Invariant($"We will not listen for OpenCensus data"));
}
}
catch (Exception e)
{
Diagnostics.LogError(
FormattableString.Invariant($"Could not create the gRPC OpenCensus channel. {e.ToString()}"));
throw new InvalidOperationException(
FormattableString.Invariant($"Could not create the gRPC OpenCensus channel. {e.ToString()}"), e);
}
}
private static void SetupTelemetryConfiguration(
TelemetryConfiguration configuration,
ApplicationInsightsLoggerOptions options,
ITelemetryChannel channel,
IEnumerable <ITelemetryInitializer> telemetryInitializers,
IEnumerable <ITelemetryModule> telemetryModules,
IApplicationIdProvider applicationIdProvider,
LoggerFilterOptions filterOptions)
{
if (options.InstrumentationKey != null)
{
configuration.InstrumentationKey = options.InstrumentationKey;
}
if (options.HttpAutoCollectionOptions.EnableW3CDistributedTracing)
{
// W3C distributed tracing is enabled by the feature flag inside ApplicationInsights SDK
// W3COperationCorrelationTelemetryInitializer will go away once W3C is implemented
// in the DiagnosticSource (.NET)
configuration.TelemetryInitializers.Add(new W3COperationCorrelationTelemetryInitializer());
}
configuration.TelemetryChannel = channel;
foreach (ITelemetryInitializer initializer in telemetryInitializers)
{
configuration.TelemetryInitializers.Add(initializer);
}
(channel as ServerTelemetryChannel)?.Initialize(configuration);
QuickPulseTelemetryModule quickPulseModule = null;
foreach (ITelemetryModule module in telemetryModules)
{
if (module is QuickPulseTelemetryModule telemetryModule)
{
quickPulseModule = telemetryModule;
if (options.QuickPulseAuthenticationApiKey != null)
{
quickPulseModule.AuthenticationApiKey = options.QuickPulseAuthenticationApiKey;
}
}
module.Initialize(configuration);
}
QuickPulseTelemetryProcessor quickPulseProcessor = null;
configuration.TelemetryProcessorChainBuilder
.Use((next) => new OperationFilteringTelemetryProcessor(next))
.Use((next) =>
{
quickPulseProcessor = new QuickPulseTelemetryProcessor(next);
return(quickPulseProcessor);
})
.Use((next) => new FilteringTelemetryProcessor(filterOptions, next));
if (options.SamplingSettings != null)
{
configuration.TelemetryProcessorChainBuilder.Use((next) =>
new AdaptiveSamplingTelemetryProcessor(options.SamplingSettings, null, next));
}
if (options.SnapshotConfiguration != null)
{
configuration.TelemetryProcessorChainBuilder.UseSnapshotCollector(options.SnapshotConfiguration);
}
configuration.TelemetryProcessorChainBuilder.Build();
quickPulseModule?.RegisterTelemetryProcessor(quickPulseProcessor);
foreach (ITelemetryProcessor processor in configuration.TelemetryProcessors)
{
if (processor is ITelemetryModule module)
{
module.Initialize(configuration);
}
}
configuration.ApplicationIdProvider = applicationIdProvider;
}
public Library(string configuration)
{
this.config = new Configuration(configuration);
this.ocToAiInstrumentationKey = config.OpenCensusToApplicationInsights_InstrumentationKey;
this.liveMetricsStreamInstrumentationKey = config.ApplicationInsights_LiveMetricsStreamInstrumentationKey;
Diagnostics.LogInfo(
FormattableString.Invariant($"Loaded configuration. {Environment.NewLine}{configuration}"));
try
{
var activeConfiguration = TelemetryConfiguration.Active;
activeConfiguration.InstrumentationKey = this.liveMetricsStreamInstrumentationKey;
QuickPulseTelemetryProcessor processor = null;
activeConfiguration.TelemetryProcessorChainBuilder
.Use((next) =>
{
processor = new QuickPulseTelemetryProcessor(next);
return(processor);
})
.Build();
var QuickPulse = new QuickPulseTelemetryModule();
QuickPulse.Initialize(activeConfiguration);
QuickPulse.RegisterTelemetryProcessor(processor);
this.telemetryClient = new TelemetryClient();
}
catch (Exception e)
{
Diagnostics.LogError(
FormattableString.Invariant($"Could not initialize AI SDK. {e.ToString()}"));
throw new InvalidOperationException(
FormattableString.Invariant($"Could not initialize AI SDK. {e.ToString()}"), e);
}
try
{
if (this.config.ApplicationInsightsInput_Enabled)
{
this.gRpcAiInput = new GrpcAiInput(this.config.ApplicationInsightsInput_Host, this.config.ApplicationInsightsInput_Port);
Diagnostics.LogInfo(
FormattableString.Invariant($"We will listen for AI data on {this.config.ApplicationInsightsInput_Host}:{this.config.ApplicationInsightsInput_Port}"));
}
else
{
Diagnostics.LogInfo(
FormattableString.Invariant($"We will not listen for AI data"));
}
}
catch (Exception e)
{
Diagnostics.LogError(
FormattableString.Invariant($"Could not create the gRPC AI channel. {e.ToString()}"));
throw new InvalidOperationException(
FormattableString.Invariant($"Could not create the gRPC AI channel. {e.ToString()}"), e);
}
try
{
if (this.config.OpenCensusInput_Enabled)
{
this.gRpcOpenCensusInput = new GrpcOpenCensusInput(this.config.OpenCensusInput_Host, this.config.OpenCensusInput_Port);
Diagnostics.LogInfo(
FormattableString.Invariant($"We will listen for OpenCensus data on {this.config.OpenCensusInput_Host}:{this.config.OpenCensusInput_Port}"));
}
else
{
Diagnostics.LogInfo(
FormattableString.Invariant($"We will not listen for OpenCensus data"));
}
}
catch (Exception e)
{
Diagnostics.LogError(
FormattableString.Invariant($"Could not create the gRPC OpenCensus channel. {e.ToString()}"));
throw new InvalidOperationException(
FormattableString.Invariant($"Could not create the gRPC OpenCensus channel. {e.ToString()}"), e);
}
}
public static async Task RunAsync(CancellationToken token)
{
// set Instrumentation Key
var configuration = new TelemetryConfiguration();
configuration.InstrumentationKey = "fb8a0b03-235a-4b52-b491-307e9fd6b209";
// automatically track dependency calls
var dependencies = new DependencyTrackingTelemetryModule();
dependencies.Initialize(configuration);
// automatically correlate all telemetry data with request
configuration.TelemetryInitializers.Add(new OperationCorrelationTelemetryInitializer());
QuickPulseTelemetryProcessor processor = null;
// enable Live Metrics
configuration.TelemetryProcessorChainBuilder
// adding LiveMetrics telemetry processor
.Use((next) =>
{
processor = new QuickPulseTelemetryProcessor(next);
return(processor);
})
.Build();
var quickPulse = new QuickPulseTelemetryModule();
quickPulse.Initialize(configuration);
quickPulse.RegisterTelemetryProcessor(processor);
var client = new TelemetryClient(configuration);
var iteration = 0;
var http = new HttpClient();
var rnd = new Random();
while (!token.IsCancellationRequested)
{
iteration++;
using (var operation = client.StartOperation <RequestTelemetry>("Process item"))
{
client.TrackEvent("test", new Dictionary <string, string>()
{
{ "iteration", iteration.ToString() }
});
client.TrackTrace($"Iteration {iteration} happened", SeverityLevel.Information);
var status = rnd.Next() < rnd.Next();
try
{
if (status)
{
throw new Exception($"Failure during processing of iteration #{iteration}");
}
await http.GetStringAsync("http://bing.com");
}
catch (Exception exc)
{
client.TrackException(exc);
}
finally
{
client.StopOperation <RequestTelemetry>(operation);
operation.Telemetry.Success = status;
Console.WriteLine($"Iteration {iteration}. Elapsed time: {operation.Telemetry.Duration}. Success: {operation.Telemetry.Success}");
}
}
}
}
public void QuickPulseTelemetryModuleDisposeWithoutInitialize()
{
var qp = new QuickPulseTelemetryModule();
qp.Dispose();
}
public void QuickPulseTelemetryModuleManagesTimersCorrectly()
{
if (QuickPulseTelemetryModuleTests.Ignored)
{
return;
}
// ARRANGE
var pollingInterval = TimeSpan.FromSeconds(1);
var collectionInterval = TimeSpan.FromMilliseconds(400);
var timings = new QuickPulseTimings(pollingInterval, collectionInterval);
var collectionTimeSlotManager = new QuickPulseCollectionTimeSlotManagerMock(timings);
var serviceClient = new QuickPulseServiceClientMock {
ReturnValueFromPing = false, ReturnValueFromSubmitSample = true
};
var performanceCollector = new PerformanceCollectorMock();
var topCpuCollector = new QuickPulseTopCpuCollectorMock();
var module = new QuickPulseTelemetryModule(collectionTimeSlotManager, null, serviceClient, performanceCollector, topCpuCollector, timings);
// ACT & ASSERT
module.Initialize(new TelemetryConfiguration()
{
InstrumentationKey = "some ikey"
});
// initially, the module is in the polling state
Thread.Sleep((int)(2.5 * pollingInterval.TotalMilliseconds));
serviceClient.CountersEnabled = false;
// 2.5 polling intervals have elapsed, we must have pinged the service 3 times (the first time immediately upon initialization), but no samples yet
Assert.AreEqual(3, serviceClient.PingCount, "Ping count 1");
Assert.AreEqual(0, serviceClient.SnappedSamples.Count, "Sample count 1");
// now the service wants the data
serviceClient.Reset();
serviceClient.ReturnValueFromPing = true;
serviceClient.ReturnValueFromSubmitSample = true;
serviceClient.CountersEnabled = true;
Thread.Sleep((int)(5 * collectionInterval.TotalMilliseconds));
serviceClient.CountersEnabled = false;
// a number of collection intervals have elapsed, we must have pinged the service once, and then started sending samples
Assert.AreEqual(1, serviceClient.PingCount, "Ping count 2");
Assert.IsTrue(serviceClient.SnappedSamples.Count > 0, "Sample count 2");
lock (serviceClient.ResponseLock)
{
// the service doesn't want the data anymore
serviceClient.ReturnValueFromPing = false;
serviceClient.ReturnValueFromSubmitSample = false;
serviceClient.Reset();
serviceClient.CountersEnabled = true;
}
Thread.Sleep((int)(2.9 * pollingInterval.TotalMilliseconds));
serviceClient.CountersEnabled = false;
// 2 polling intervals have elapsed, we must have submitted one batch of samples, stopped collecting and pinged the service twice afterwards
Assert.AreEqual(1, serviceClient.SnappedSamples.Count / serviceClient.LastSampleBatchSize, "Sample count 3");
Assert.AreEqual(2, serviceClient.PingCount, "Ping count 3");
}
public static LinkedList <IQuickPulseTelemetryProcessor> GetTelemetryProcessors(QuickPulseTelemetryModule module)
{
return(GetPrivateField(module, "telemetryProcessors") as LinkedList <IQuickPulseTelemetryProcessor>);
}
public void QuickPulseTelemetryModuleReportsErrorsFromPerformanceCollectorWhenUpdatingCollectionConfiguration()
{
if (QuickPulseTelemetryModuleTests.Ignored)
{
return;
}
// ARRANGE
var pollingInterval = TimeSpan.FromMilliseconds(200);
var collectionInterval = TimeSpan.FromMilliseconds(80);
var timings = new QuickPulseTimings(pollingInterval, collectionInterval);
var collectionTimeSlotManager = new QuickPulseCollectionTimeSlotManagerMock(timings);
var serviceClient = new QuickPulseServiceClientMock {
ReturnValueFromPing = true, ReturnValueFromSubmitSample = true
};
var performanceCollector = new PerformanceCollectorMock();
var topCpuCollector = new QuickPulseTopCpuCollectorMock();
var module = new QuickPulseTelemetryModule(collectionTimeSlotManager, null, serviceClient, performanceCollector, topCpuCollector, timings);
// ACT & ASSERT
serviceClient.CollectionConfigurationInfo = new CollectionConfigurationInfo()
{
ETag = "ETag1",
Metrics =
new[]
{
new CalculatedMetricInfo()
{
Id = "PerformanceCounter1",
TelemetryType = TelemetryType.PerformanceCounter,
Projection = @"\SomeCategory(SomeInstance)\SomeCounter"
},
new CalculatedMetricInfo()
{
Id = "PerformanceCounter2",
TelemetryType = TelemetryType.PerformanceCounter,
Projection = @"\Memory\Cache Bytes Peak"
},
new CalculatedMetricInfo()
{
Id = "PerformanceCounter3",
TelemetryType = TelemetryType.PerformanceCounter,
Projection = @"NonParseable"
},
new CalculatedMetricInfo()
{
Id = "PerformanceCounter4",
TelemetryType = TelemetryType.PerformanceCounter,
Projection = @"\SomeObject\SomeCounter"
},
new CalculatedMetricInfo()
{
Id = "PerformanceCounter4",
TelemetryType = TelemetryType.PerformanceCounter,
Projection = @"\SomeObject1\SomeCounter1"
}
}
};
module.Initialize(new TelemetryConfiguration()
{
InstrumentationKey = "some ikey"
});
Thread.Sleep(pollingInterval);
Thread.Sleep((int)(2.5 * collectionInterval.TotalMilliseconds));
Assert.AreEqual("ETag1", serviceClient.SnappedSamples.Last().CollectionConfigurationAccumulator.CollectionConfiguration.ETag);
Assert.AreEqual(5, performanceCollector.PerformanceCounters.Count());
Assert.AreEqual(@"\SomeCategory(SomeInstance)\SomeCounter", performanceCollector.PerformanceCounters.Skip(0).First().OriginalString);
Assert.AreEqual(@"PerformanceCounter1", performanceCollector.PerformanceCounters.Skip(0).First().ReportAs);
Assert.AreEqual(@"\Memory\Cache Bytes Peak", performanceCollector.PerformanceCounters.Skip(1).First().OriginalString);
Assert.AreEqual(@"PerformanceCounter2", performanceCollector.PerformanceCounters.Skip(1).First().ReportAs);
Assert.AreEqual(@"\SomeObject\SomeCounter", performanceCollector.PerformanceCounters.Skip(2).First().OriginalString);
Assert.AreEqual(@"PerformanceCounter4", performanceCollector.PerformanceCounters.Skip(2).First().ReportAs);
Assert.AreEqual(@"\Memory\Committed Bytes", performanceCollector.PerformanceCounters.Skip(3).First().OriginalString);
Assert.AreEqual(@"\Memory\Committed Bytes", performanceCollector.PerformanceCounters.Skip(3).First().ReportAs);
Assert.AreEqual(@"\Processor(_Total)\% Processor Time", performanceCollector.PerformanceCounters.Skip(4).First().OriginalString);
Assert.AreEqual(@"\Processor(_Total)\% Processor Time", performanceCollector.PerformanceCounters.Skip(4).First().ReportAs);
CollectionConfigurationError[] errors = serviceClient.CollectionConfigurationErrors;
Assert.AreEqual(2, errors.Length);
Assert.AreEqual(CollectionConfigurationErrorType.PerformanceCounterDuplicateIds, errors[0].ErrorType);
Assert.AreEqual(@"Duplicate performance counter id 'PerformanceCounter4'", errors[0].Message);
Assert.AreEqual(string.Empty, errors[0].FullException);
Assert.AreEqual(2, errors[0].Data.Count);
Assert.AreEqual("PerformanceCounter4", errors[0].Data["MetricId"]);
Assert.AreEqual("ETag1", errors[0].Data["ETag"]);
Assert.AreEqual(CollectionConfigurationErrorType.PerformanceCounterParsing, errors[1].ErrorType);
string expected = string.Format(CultureInfo.InvariantCulture, "Error parsing performance counter: '(PerformanceCounter3, NonParseable)'. Invalid performance counter name format: NonParseable. Expected formats are \\category(instance)\\counter or \\category\\counter{0}Parameter name: performanceCounter", Environment.NewLine);
Assert.AreEqual(expected, errors[1].Message);
Assert.AreEqual(string.Empty, errors[1].FullException);
Assert.AreEqual(1, errors[1].Data.Count);
Assert.AreEqual("PerformanceCounter3", errors[1].Data["MetricId"]);
}
private static void SetupTelemetryConfiguration(
TelemetryConfiguration configuration,
ApplicationInsightsLoggerOptions options,
ITelemetryChannel channel,
IEnumerable <ITelemetryInitializer> telemetryInitializers,
IEnumerable <ITelemetryModule> telemetryModules,
IApplicationIdProvider applicationIdProvider,
LoggerFilterOptions filterOptions)
{
if (options.InstrumentationKey != null)
{
configuration.InstrumentationKey = options.InstrumentationKey;
}
configuration.TelemetryChannel = channel;
foreach (ITelemetryInitializer initializer in telemetryInitializers)
{
configuration.TelemetryInitializers.Add(initializer);
}
(channel as ServerTelemetryChannel)?.Initialize(configuration);
QuickPulseTelemetryModule quickPulseModule = null;
foreach (ITelemetryModule module in telemetryModules)
{
if (module is QuickPulseTelemetryModule telemetryModule)
{
quickPulseModule = telemetryModule;
if (options.QuickPulseAuthenticationApiKey != null)
{
quickPulseModule.AuthenticationApiKey = options.QuickPulseAuthenticationApiKey;
}
}
module.Initialize(configuration);
}
QuickPulseTelemetryProcessor quickPulseProcessor = null;
configuration.TelemetryProcessorChainBuilder
.Use((next) => new OperationFilteringTelemetryProcessor(next))
.Use((next) =>
{
quickPulseProcessor = new QuickPulseTelemetryProcessor(next);
return(quickPulseProcessor);
})
.Use((next) => new FilteringTelemetryProcessor(filterOptions, next));
if (options.SamplingSettings != null)
{
configuration.TelemetryProcessorChainBuilder.Use((next) =>
new AdaptiveSamplingTelemetryProcessor(options.SamplingSettings, null, next));
}
if (options.SnapshotConfiguration != null)
{
configuration.TelemetryProcessorChainBuilder.UseSnapshotCollector(options.SnapshotConfiguration);
}
configuration.TelemetryProcessorChainBuilder.Build();
quickPulseModule?.RegisterTelemetryProcessor(quickPulseProcessor);
foreach (ITelemetryProcessor processor in configuration.TelemetryProcessors)
{
if (processor is ITelemetryModule module)
{
module.Initialize(configuration);
}
}
configuration.ApplicationIdProvider = applicationIdProvider;
}
