Table of Contents

Class EnableTelemetryAttribute

Namespace
DotCompute.Abstractions.Attributes
Assembly
DotCompute.Abstractions.dll

Instructs the source generator to inject telemetry collection code into a Ring Kernel.

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public sealed class EnableTelemetryAttribute : Attribute
Inheritance
EnableTelemetryAttribute
Inherited Members

Remarks

When applied to a Ring Kernel class, the source generator will automatically inject performance telemetry collection including:

  • Execution start/end timestamps
  • Message processing counts
  • Memory allocation tracking
  • Latency measurements
  • Throughput calculations

The injected telemetry code has minimal overhead (typically <1% performance impact) and provides detailed insights into kernel performance characteristics.

Example Usage: 

[RingKernel(Backend = "CUDA", ExecutionMode = RingKernelExecutionMode.Persistent)]
[EnableTelemetry]
public class MyActorKernel : IRingKernel
{
    public void Execute()
    {
        // Kernel logic - telemetry automatically injected by source generator
    }
}

Properties

CollectDetailedMetrics

Gets or sets a value indicating whether to collect detailed per-message metrics.

public bool CollectDetailedMetrics { get; set; }

Property Value

bool

Remarks

When true, collects individual message sizes and processing times. When false, only aggregated metrics are collected. Default is false for minimal overhead.

CustomProviderType

Gets or sets the telemetry provider type name (optional).

public string? CustomProviderType { get; set; }

Property Value

string

Remarks

Allows specifying a custom telemetry provider implementation. If null, uses the default IKernelTelemetryProvider from dependency injection. Must be a fully qualified type name implementing IKernelTelemetryProvider.

SamplingRate

Gets or sets the sampling rate for telemetry collection (0.0 to 1.0).

public double SamplingRate { get; set; }

Property Value

double

Remarks

Sampling rate determines what fraction of executions are measured.

  • 1.0 = measure every execution (highest accuracy, highest overhead)
  • 0.1 = measure 10% of executions (lower overhead, statistically valid)
  • 0.01 = measure 1% of executions (minimal overhead, approximate metrics) Default is 1.0 (100% sampling).

TrackMemory

Gets or sets a value indicating whether to track memory allocations.

public bool TrackMemory { get; set; }

Property Value

bool

Remarks

When true, monitors memory allocated/deallocated by the kernel. When false, memory metrics are not collected. Default is true.

Edit this page