Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
CounterSample Structure
Collapse the table of content
Expand the table of content

CounterSample Structure

Defines a structure that holds the raw data for a performance counter.

Namespace:  System.Diagnostics
Assembly:  System (in System.dll)

public struct CounterSample

The CounterSample type exposes the following members.

Public methodCounterSample(Int64, Int64, Int64, Int64, Int64, Int64, PerformanceCounterType)Initializes a new instance of the CounterSample structure and sets the CounterTimeStamp property to 0 (zero).
Public methodCounterSample(Int64, Int64, Int64, Int64, Int64, Int64, PerformanceCounterType, Int64)Initializes a new instance of the CounterSample structure and sets the CounterTimeStamp property to the value that is passed in.

Public propertyBaseValueGets an optional, base raw value for the counter.
Public propertyCounterFrequencyGets the raw counter frequency.
Public propertyCounterTimeStampGets the counter's time stamp.
Public propertyCounterTypeGets the performance counter type.
Public propertyRawValueGets the raw value of the counter.
Public propertySystemFrequencyGets the raw system frequency.
Public propertyTimeStampGets the raw time stamp.
Public propertyTimeStamp100nSecGets the raw, high-fidelity time stamp.

Public methodStatic memberCalculate(CounterSample)Calculates the performance data of the counter, using a single sample point. This method is generally used for uncalculated performance counter types.
Public methodStatic memberCalculate(CounterSample, CounterSample)Calculates the performance data of the counter, using two sample points. This method is generally used for calculated performance counter types, such as averages.
Public methodEquals(CounterSample)Indicates whether the specified CounterSample structure is equal to the current CounterSample structure.
Public methodEquals(Object)Indicates whether the specified structure is a CounterSample structure and is identical to the current CounterSample structure. (Overrides ValueType.Equals(Object).)
Public methodGetHashCodeGets a hash code for the current counter sample. (Overrides ValueType.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)

Public operatorStatic memberEqualityReturns a value that indicates whether two CounterSample structures are equal.
Public operatorStatic memberInequalityReturns a value that indicates whether two CounterSample structures are not equal.

Public fieldStatic memberEmptyDefines an empty, uninitialized performance counter sample of type NumberOfItems32.

The following example demonstrates the use of the CounterSample class to display data for a performance counter.

using System;
using System.Collections;
using System.Collections.Specialized;
using System.Diagnostics;

public class App {

	private static PerformanceCounter avgCounter64Sample;
	private static PerformanceCounter avgCounter64SampleBase;

	public static void Main()
		ArrayList samplesList = new ArrayList();

        // If the category does not exist, create the category and exit. 
        // Performance counters should not be created and immediately used. 
        // There is a latency time to enable the counters, they should be created 
        // prior to executing the application that uses the counters. 
        // Execute this sample a second time to use the category. 
        if (SetupCategory())


	private static bool SetupCategory()
		if ( !PerformanceCounterCategory.Exists("AverageCounter64SampleCategory") ) 

			CounterCreationDataCollection counterDataCollection = new CounterCreationDataCollection();
			// Add the counter.
			CounterCreationData averageCount64 = new CounterCreationData();
			averageCount64.CounterType = PerformanceCounterType.AverageCount64;
			averageCount64.CounterName = "AverageCounter64Sample";
	        // Add the base counter.
			CounterCreationData averageCount64Base = new CounterCreationData();
			averageCount64Base.CounterType = PerformanceCounterType.AverageBase;
			averageCount64Base.CounterName = "AverageCounter64SampleBase";

			// Create the category.
                "Demonstrates usage of the AverageCounter64 performance counter type.",
                PerformanceCounterCategoryType.SingleInstance, counterDataCollection);
			Console.WriteLine("Category exists - AverageCounter64SampleCategory");
	private static void CreateCounters()
		// Create the counters.

		avgCounter64Sample = new PerformanceCounter("AverageCounter64SampleCategory", 

		avgCounter64SampleBase = new PerformanceCounter("AverageCounter64SampleCategory", 
	private static void CollectSamples(ArrayList samplesList)
		Random r = new Random( DateTime.Now.Millisecond );

		// Loop for the samples. 
		for (int j = 0; j < 100; j++) 
			int value = r.Next(1, 10);
			Console.Write(j + " = " + value);



			if ((j % 10) == 9) 
				samplesList.Add( avgCounter64Sample.NextSample() );

	private static void CalculateResults(ArrayList samplesList)
		for(int i = 0; i < (samplesList.Count - 1); i++)
			// Output the sample.
			OutputSample( (CounterSample)samplesList[i] );
			OutputSample( (CounterSample)samplesList[i+1] );

			// Use .NET to calculate the counter value.
			Console.WriteLine(".NET computed counter value = " +
				(CounterSample)samplesList[i+1]) );

			// Calculate the counter value manually.
			Console.WriteLine("My computed counter value = " + 
				(CounterSample)samplesList[i+1]) );

	//	Description - This counter type shows how many items are processed, on average, 
	//		during an operation. Counters of this type display a ratio of the items  
	//		processed (such as bytes sent) to the number of operations completed. The   
	//		ratio is calculated by comparing the number of items processed during the  
	//		last interval to the number of operations completed during the last interval.  
	// Generic type - Average 
	//  	Formula - (N1 - N0) / (D1 - D0), where the numerator (N) represents the number  
	//		of items processed during the last sample interval and the denominator (D)  
	//		represents the number of operations completed during the last two sample  
	//		intervals.  
	//	Average (Nx - N0) / (Dx - D0)   
	//	Example PhysicalDisk\ Avg. Disk Bytes/Transfer  
	private static Single MyComputeCounterValue(CounterSample s0, CounterSample s1)
		Single numerator = (Single)s1.RawValue - (Single)s0.RawValue;
		Single denomenator = (Single)s1.BaseValue - (Single)s0.BaseValue;
		Single counterValue = numerator / denomenator;
	// Output information about the counter sample. 
	private static void OutputSample(CounterSample s)
		Console.WriteLine("Sample values - \r\n");
		Console.WriteLine("   BaseValue        = " + s.BaseValue);
		Console.WriteLine("   CounterFrequency = " + s.CounterFrequency);
		Console.WriteLine("   CounterTimeStamp = " + s.CounterTimeStamp);
		Console.WriteLine("   CounterType      = " + s.CounterType);
		Console.WriteLine("   RawValue         = " + s.RawValue);
		Console.WriteLine("   SystemFrequency  = " + s.SystemFrequency);
		Console.WriteLine("   TimeStamp        = " + s.TimeStamp);
		Console.WriteLine("   TimeStamp100nSec = " + s.TimeStamp100nSec);

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft