Skip to content
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

Actor reminders related tracing improvements #360

Merged
merged 4 commits into from
Mar 1, 2024
Merged

Actor reminders related tracing improvements #360

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93d7290
Actor reminders related tracing imporvements
yashagarwal23 Dec 26, 2023
7982b70
retrigger checks
yashagarwal23 Feb 27, 2024
a26d892
Address comments
yashagarwal23 Feb 29, 2024
84805ee
Catch exception when failed to acquire actor lock
yashagarwal23 Mar 1, 2024
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
16 changes: 14 additions & 2 deletions src/Microsoft.ServiceFabric.Actors/Runtime/ActorManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,13 @@ public async Task FireReminderAsync(ActorReminder reminder)

try
{
ActorTrace.Source.WriteInfoWithId(
yashagarwal23 marked this conversation as resolved.
Show resolved Hide resolved
TraceType,
this.traceId,
yashagarwal23 marked this conversation as resolved.
Show resolved Hide resolved
"Firing reminder ({0}) for actor ({1})",
reminder.Name,
reminder.OwnerActorId.GetStorageKey());

using (var actorScope = this.GetActor(reminder.OwnerActorId, true, false))
{
var actorBase = actorScope.Actor;
Expand Down Expand Up @@ -1233,12 +1240,17 @@ private async Task CleanupRemindersAsync()

private async Task LoadRemindersAsync(CancellationToken cancellationToken)
{
ActorTrace.Source.WriteInfoWithId(
TraceType,
this.traceId,
$"Loading reminders.");

var reminders = await this.StateProvider.LoadRemindersAsync(cancellationToken);

ActorTrace.Source.WriteInfoWithId(
TraceType,
this.traceId,
$"Loading {reminders.Count} reminders.");
$"Found {reminders.Count} reminders.");

if (reminders.Count > 0 && !this.actorService.ActorTypeInformation.IsRemindable)
{
Expand Down Expand Up @@ -1306,7 +1318,7 @@ private async Task RegisterOrUpdateReminderAsync(
TraceType,
this.traceId,
"Registering reminder for actor: ({0}), reminderName: ({1}), remainingDueTime: ({2}), saveState {3}",
actorReminder.OwnerActorId,
actorReminder.OwnerActorId.GetStorageKey(),
actorReminder.Name,
remainingDueTime,
saveState);
Expand Down
8 changes: 8 additions & 0 deletions src/Microsoft.ServiceFabric.Actors/Runtime/ActorReminder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,14 @@ internal void ArmTimer(TimeSpan newDueTime)
{
try
{
this.actorManager.TraceSource.WriteInfoWithId(
TraceType,
this.actorManager.GetActorTraceId(this.OwnerActorId),
"Arming timer for reminder ({0}), actor: ({1}), newDueTime: ({2})",
this.Name,
this.OwnerActorId.GetStorageKey(),
yashagarwal23 marked this conversation as resolved.
Show resolved Hide resolved
newDueTime);

snap.Change(newDueTime, Timeout.InfiniteTimeSpan);
}
catch (Exception e)
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.ServiceFabric.Actors/Runtime/ActorReminderData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public long EstimateDataLength()

public override string ToString()
{
return $"ActorId: {this.ActorId} Name: {this.Name} DueTime: {this.DueTime} Period: {this.Period} State: {this.State} LogicalCreationTime: {this.LogicalCreationTime}";
return $"ActorId: ({this.ActorId.GetStorageKey()}), Name: ({this.Name}), DueTime: ({this.DueTime}), Period: ({this.Period}), State: ({this.State}), LogicalCreationTime: ({this.LogicalCreationTime})";
}
}
}
19 changes: 19 additions & 0 deletions src/Microsoft.ServiceFabric.Actors/Runtime/ActorReminderState.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
namespace Microsoft.ServiceFabric.Actors.Runtime
{
using System;
using System.Diagnostics;
using System.Runtime.Serialization;
using System.Threading;

Expand All @@ -15,6 +16,8 @@ namespace Microsoft.ServiceFabric.Actors.Runtime
[DataContract(Name = "ActorReminderState")]
public class ActorReminderState : IActorReminderState
{
private const string TraceType = "ActorReminderState";

[DataMember(Name = "Reminder", Order = 0, IsRequired = true)]
private readonly ActorReminderData reminder;

Expand All @@ -34,10 +37,26 @@ internal ActorReminderState(ActorReminderData reminder, TimeSpan currentLogicalT
if (reminderCompletedData != null)
{
this.nextDueTime = ComputeRemainingTime(currentLogicalTime, reminderCompletedData.LogicalTime, reminder.Period);
ActorTrace.Source.WriteInfo(
yashagarwal23 marked this conversation as resolved.
Show resolved Hide resolved
TraceType,
"Next Due Time for Reminder: ({0}), Actor: ({1}), Reminder Completed Time: ({2}), Period: ({3}) is ({4})",
reminder.Name,
reminder.ActorId.GetStorageKey(),
reminderCompletedData.LogicalTime,
reminder.Period,
this.nextDueTime);
}
else
{
this.nextDueTime = ComputeRemainingTime(currentLogicalTime, reminder.LogicalCreationTime, reminder.DueTime);
ActorTrace.Source.WriteInfo(
TraceType,
yashagarwal23 marked this conversation as resolved.
Show resolved Hide resolved
"Next Due Time for Reminder: ({0}), Actor: ({1}), Reminder Creation Time: ({2}), Due Time: ({3}) is ({4})",
reminder.Name,
reminder.ActorId.GetStorageKey(),
reminder.LogicalCreationTime,
reminder.DueTime,
this.nextDueTime);
}
}

Expand Down
18 changes: 14 additions & 4 deletions src/Microsoft.ServiceFabric.Actors/Runtime/KvsActorStateProviderBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -564,8 +564,14 @@ async Task IActorStateProvider.SaveReminderAsync(ActorId actorId, IActorReminder
await this.EnsureLogicalTimeManagerInitializedAsync(cancellationToken);

var reminderKey = CreateReminderStorageKey(actorId, reminder.Name);
var data = new ActorReminderData(actorId, reminder, this.logicalTimeManager.CurrentLogicalTime);
var buffer = this.SerializeReminder(data);
var reminderData = new ActorReminderData(actorId, reminder, this.logicalTimeManager.CurrentLogicalTime);
var buffer = this.SerializeReminder(reminderData);

ActorTrace.Source.WriteInfoWithId(
TraceType,
this.traceId,
"Saving Reminder - {0}",
reminderData);

var reminderCompletedKey = ActorStateProviderHelper.CreateReminderCompletedStorageKey(actorId, reminder.Name);

Expand Down Expand Up @@ -1140,8 +1146,6 @@ private async Task EnsureLogicalTimeManagerInitializedAsync(CancellationToken ca
await Task.Delay(retryCount * StateProviderInitRetryDelayMilliseconds, cancellationToken);
}

ActorTrace.Source.WriteInfoWithId(TraceType, this.traceId, "Logical Time Manager is initialized");

if (this.replicaRole != ReplicaRole.Primary)
{
throw new FabricNotPrimaryException(FabricErrorCode.NotPrimary);
Expand Down Expand Up @@ -1532,6 +1536,12 @@ private Task<Dictionary<string, ReminderCompletedData>> GetReminderCompletedData

private async Task<IActorReminderCollection> EnumerateReminderAsync(CancellationToken cancellationToken)
{
ActorTrace.Source.WriteInfoWithId(
TraceType,
this.traceId,
"Enumerating all reminders. Current Logical Time - {0}",
this.logicalTimeManager.CurrentLogicalTime);

var reminderCollection = new ActorReminderCollection();

using (var tx = this.storeReplica.CreateTransaction())
Expand Down
6 changes: 6 additions & 0 deletions src/Microsoft.ServiceFabric.Actors/Runtime/NullActorStateProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,12 @@ Task IActorStateProvider.SaveReminderAsync(ActorId actorId, IActorReminder state
var key = CreateReminderStorageKey(actorId, state.Name);
var reminderData = new ActorReminderData(actorId, state, TimeSpan.Zero);

ActorTrace.Source.WriteInfoWithId(
TraceType,
this.traceId,
"Saving Reminder - {0}",
reminderData);

this.stateDictionary.AddOrUpdate(key, reminderData, (s, o) => reminderData);

return Task.FromResult(true);
Expand Down
12 changes: 12 additions & 0 deletions src/Microsoft.ServiceFabric.Actors/Runtime/ReliableCollectionsActorStateProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,12 @@ async Task IActorStateProvider.SaveReminderAsync(ActorId actorId, IActorReminder
var reminderData = new ActorReminderData(actorId, reminder, this.logicalTimeManager.CurrentLogicalTime);
var data = ActorReminderDataSerializer.Serialize(reminderData);

ActorTrace.Source.WriteInfoWithId(
TraceType,
this.traceId,
"Saving Reminder - {0}",
reminderData);

await this.stateProviderHelper.ExecuteWithRetriesAsync(
async () =>
{
Expand Down Expand Up @@ -1131,6 +1137,12 @@ private async Task EnumerateRemindersAsync(

private async Task<IActorReminderCollection> EnumerateRemindersAsync(CancellationToken cancellationToken)
{
ActorTrace.Source.WriteInfoWithId(
TraceType,
this.traceId,
"Enumerating all reminders. Current Logical Time - {0}",
this.logicalTimeManager.CurrentLogicalTime);

var reminderCollection = new ActorReminderCollection();
var reminderCompletedDataDict = await this.GetReminderCompletedDataMapAsync(null, cancellationToken);

Expand Down
18 changes: 15 additions & 3 deletions src/Microsoft.ServiceFabric.Actors/Runtime/VolatileActorStateProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,12 +570,20 @@ async Task IActorStateProvider.SaveReminderAsync(ActorId actorId, IActorReminder
{
await this.EnsureLogicalTimeManagerInitializedAsync(cancellationToken);

var reminderData = new ActorStateData(new ActorReminderData(actorId, reminder, this.logicalTimeManager.CurrentLogicalTime));

ActorTrace.Source.WriteInfoWithId(
TraceType,
this.traceId,
"Saving Reminder - {0}",
reminderData);

var actorStateDataWrapperList = new List<ActorStateDataWrapper>
{
ActorStateDataWrapper.CreateForUpdate(
ActorStateType.Reminder,
CreateReminderStorageKey(actorId, reminder.Name),
new ActorStateData(new ActorReminderData(actorId, reminder, this.logicalTimeManager.CurrentLogicalTime))),
reminderData),

ActorStateDataWrapper.CreateForDelete(
ActorStateType.Actor,
Expand Down Expand Up @@ -664,6 +672,12 @@ async Task<IActorReminderCollection> IActorStateProvider.LoadRemindersAsync(Canc
{
await this.EnsureLogicalTimeManagerInitializedAsync(cancellationToken);

ActorTrace.Source.WriteInfoWithId(
TraceType,
this.traceId,
"Enumerating all reminders. Current Logical Time - {0}",
this.logicalTimeManager.CurrentLogicalTime);

var reminderCollection = new ActorReminderCollection();
var stateDictionary = this.stateTable.GetActorStateDictionary(ActorStateType.Reminder);

Expand Down Expand Up @@ -1288,8 +1302,6 @@ private async Task EnsureLogicalTimeManagerInitializedAsync(CancellationToken ca
await Task.Delay(retryCount * StateProviderInitRetryDelayMilliseconds, cancellationToken);
}

ActorTrace.Source.WriteInfoWithId(TraceType, this.traceId, "Logical Time Manager is initialized");

if (this.replicaRole != ReplicaRole.Primary)
{
throw new FabricNotPrimaryException(FabricErrorCode.NotPrimary);
Expand Down