Skip to content

Adds metric tags to storage instrumentation #9595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ReubenBond merged 3 commits into from
Jul 11, 2025
Merged

Adds metric tags to storage instrumentation #9595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e2746a
Add metric tags to storage instrumentation methods
cdemi Jul 8, 2025
6730c6d
Reduced memory overhead
cdemi Jul 9, 2025
36dd782
Renamed ProviderName to ProviderTypeName
cdemi Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 68 additions & 12 deletions src/Orleans.Core/Diagnostics/Metrics/StorageInstruments.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using System.Diagnostics.Metrics;

namespace Orleans.Runtime;
Expand All @@ -12,28 +13,83 @@ internal static class StorageInstruments
private static readonly Counter<int> StorageWriteErrorsCounter = Instruments.Meter.CreateCounter<int>(InstrumentNames.STORAGE_WRITE_ERRORS);
private static readonly Counter<int> StorageClearErrorsCounter = Instruments.Meter.CreateCounter<int>(InstrumentNames.STORAGE_CLEAR_ERRORS);

internal static void OnStorageRead(TimeSpan latency)
internal static void OnStorageRead(TimeSpan latency, string providerTypeName, string stateName, string stateTypeName)
{
StorageReadHistogram.Record(latency.TotalMilliseconds);
if (StorageReadHistogram.Enabled)
{
StorageReadHistogram.Record(
latency.TotalMilliseconds,
[
new KeyValuePair<string, object>("provider_name", providerTypeName),
new KeyValuePair<string, object>("state_name", stateName),
new KeyValuePair<string, object>("state_type", stateTypeName)
]);
}
}
internal static void OnStorageWrite(TimeSpan latency)

internal static void OnStorageWrite(TimeSpan latency, string providerTypeName, string stateName, string stateTypeName)
{
StorageWriteHistogram.Record(latency.TotalMilliseconds);
if (StorageWriteHistogram.Enabled)
{
StorageWriteHistogram.Record(
latency.TotalMilliseconds,
[
new KeyValuePair<string, object>("provider_name", providerTypeName),
new KeyValuePair<string, object>("state_name", stateName),
new KeyValuePair<string, object>("state_type", stateTypeName)
]);
}
}
internal static void OnStorageReadError()

internal static void OnStorageReadError(string providerTypeName, string stateName, string stateTypeName)
{
StorageReadErrorsCounter.Add(1);
if (StorageReadErrorsCounter.Enabled)
{
StorageReadErrorsCounter.Add(1,
[
new KeyValuePair<string, object>("provider_name", providerTypeName),
new KeyValuePair<string, object>("state_name", stateName),
new KeyValuePair<string, object>("state_type", stateTypeName)
]);
}
}
internal static void OnStorageWriteError()

internal static void OnStorageWriteError(string providerTypeName, string stateName, string stateTypeName)
{
StorageWriteErrorsCounter.Add(1);
if (StorageWriteErrorsCounter.Enabled)
{
StorageWriteErrorsCounter.Add(1,
[
new KeyValuePair<string, object>("provider_name", providerTypeName),
new KeyValuePair<string, object>("state_name", stateName),
new KeyValuePair<string, object>("state_type", stateTypeName)
]);
}
}
internal static void OnStorageDelete(TimeSpan latency)

internal static void OnStorageDelete(TimeSpan latency, string providerTypeName, string stateName, string stateTypeName)
{
StorageClearHistogram.Record(latency.TotalMilliseconds);
if (StorageClearHistogram.Enabled)
{
StorageClearHistogram.Record(latency.TotalMilliseconds,
[
new KeyValuePair<string, object>("provider_name", providerTypeName),
new KeyValuePair<string, object>("state_name", stateName),
new KeyValuePair<string, object>("state_type", stateTypeName)
]);
}
}
internal static void OnStorageDeleteError()

internal static void OnStorageDeleteError(string providerTypeName, string stateName, string stateTypeName)
{
StorageClearErrorsCounter.Add(1);
if (StorageClearErrorsCounter.Enabled)
{
StorageClearErrorsCounter.Add(1,
[
new KeyValuePair<string, object>("provider_name", providerTypeName),
new KeyValuePair<string, object>("state_name", stateName),
new KeyValuePair<string, object>("state_type", stateTypeName)
]);
}
}
}
19 changes: 10 additions & 9 deletions src/Orleans.Runtime/Storage/StateStorageBridge.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,11 @@ public async Task ReadStateAsync()
var sw = ValueStopwatch.StartNew();
await _shared.Store.ReadStateAsync(_shared.Name, _grainContext.GrainId, GrainState);
IsStateInitialized = true;
StorageInstruments.OnStorageRead(sw.Elapsed);
StorageInstruments.OnStorageRead(sw.Elapsed, _shared.ProviderTypeName, _shared.Name, _shared.StateTypeName);
}
catch (Exception exc)
{
StorageInstruments.OnStorageReadError();
StorageInstruments.OnStorageReadError(_shared.ProviderTypeName, _shared.Name, _shared.StateTypeName);
OnError(exc, ErrorCode.StorageProvider_ReadFailed, nameof(ReadStateAsync));
}
}
Expand All @@ -104,11 +104,11 @@ public async Task WriteStateAsync()

var sw = ValueStopwatch.StartNew();
await _shared.Store.WriteStateAsync(_shared.Name, _grainContext.GrainId, GrainState);
StorageInstruments.OnStorageWrite(sw.Elapsed);
StorageInstruments.OnStorageWrite(sw.Elapsed, _shared.ProviderTypeName, _shared.Name, _shared.StateTypeName);
}
catch (Exception exc)
{
StorageInstruments.OnStorageWriteError();
StorageInstruments.OnStorageWriteError(_shared.ProviderTypeName, _shared.Name, _shared.StateTypeName);
OnError(exc, ErrorCode.StorageProvider_WriteFailed, nameof(WriteStateAsync));
}
}
Expand All @@ -127,11 +127,11 @@ public async Task ClearStateAsync()
sw.Stop();

// Update counters
StorageInstruments.OnStorageDelete(sw.Elapsed);
StorageInstruments.OnStorageDelete(sw.Elapsed, _shared.ProviderTypeName, _shared.Name, _shared.StateTypeName);
}
catch (Exception exc)
{
StorageInstruments.OnStorageDeleteError();
StorageInstruments.OnStorageDeleteError(_shared.ProviderTypeName, _shared.Name, _shared.StateTypeName);
OnError(exc, ErrorCode.StorageProvider_DeleteFailed, nameof(ClearStateAsync));
}
}
Expand Down Expand Up @@ -175,14 +175,13 @@ private void OnError(Exception exception, ErrorCode id, string operation)
var errorString = errorCode is { Length: > 0 } ? $" Error: {errorCode}" : null;

var grainId = _grainContext.GrainId;
var providerName = _shared.Store.GetType().Name;
// TODO: pending on https://github.com/dotnet/runtime/issues/110570
_shared.Logger.LogError((int)id, exception, "Error from storage provider {ProviderName}.{StateName} during {Operation} for grain {GrainId}{ErrorCode}", providerName, _shared.Name, operation, grainId, errorString);
_shared.Logger.LogError((int)id, exception, "Error from storage provider {ProviderName}.{StateName} during {Operation} for grain {GrainId}{ErrorCode}", _shared.ProviderTypeName, _shared.Name, operation, grainId, errorString);

// If error is not specialization of OrleansException, wrap it
if (exception is not OrleansException)
{
var errMsg = $"Error from storage provider {providerName}.{_shared.Name} during {operation} for grain {grainId}{errorString}{Environment.NewLine} {LogFormatter.PrintException(exception)}";
var errMsg = $"Error from storage provider {_shared.ProviderTypeName}.{_shared.Name} during {operation} for grain {grainId}{errorString}{Environment.NewLine} {LogFormatter.PrintException(exception)}";
throw new OrleansException(errMsg, exception);
}

Expand Down Expand Up @@ -224,6 +223,8 @@ internal sealed class StateStorageBridgeShared<TState>(string name, IGrainStorag
private string? _migrationContextKey;

public readonly string Name = name;
public readonly string ProviderTypeName = store.GetType().Name;
public readonly string StateTypeName = typeof(TState).Name;
public readonly IGrainStorage Store = store;
public readonly ILogger Logger = logger;
public readonly IActivator<TState> Activator = activator;
Expand Down