Akka.Persistence HealthChecks #7842
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| // ----------------------------------------------------------------------- | ||
| // <copyright file="PersistenceHealthCheckSpec.cs" company="Akka.NET Project"> | ||
| // Copyright (C) 2009-2022 Lightbend Inc. <http://www.lightbend.com> | ||
| // Copyright (C) 2013-2025 .NET Foundation <https://github.com/akkadotnet/akka.net> | ||
| // </copyright> | ||
| // ----------------------------------------------------------------------- | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Collections.Immutable; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Akka.Configuration; | ||
| using Akka.Persistence.Journal; | ||
| using Akka.TestKit; | ||
| using Akka.TestKit.Configs; | ||
| using Xunit; | ||
| using Xunit.Abstractions; | ||
|
|
||
| namespace Akka.Persistence.Tests; | ||
|
|
||
| public class JournalHealthCheckSpec : PersistenceSpec | ||
| { | ||
| private static Config HealthCheckConfig() | ||
| { | ||
| const string extraConfig = """ | ||
|
|
||
| akka.persistence.journal.failing-open { | ||
| class = "Akka.Persistence.Tests.FailingJournal, Akka.Persistence.Tests" | ||
| circuit-breaker { | ||
| max-failures = 1 | ||
| call-timeout = 1s | ||
| reset-timeout = 10s | ||
| } | ||
| } | ||
| akka.persistence.journal.failing-half-open { | ||
| class = "Akka.Persistence.Tests.FailingJournal, Akka.Persistence.Tests" | ||
| circuit-breaker { | ||
| max-failures = 1 | ||
| call-timeout = 1s | ||
| reset-timeout = 1s | ||
| } | ||
| } | ||
| # Disable message serialization for circuit breaker tests to avoid serialization issues | ||
| akka.actor.serialize-messages = off | ||
|
|
||
| """; | ||
| return TestConfigs.TestSchedulerConfig | ||
|
Member
Author
There was a problem hiding this comment. We use the |
||
| .WithFallback(Configuration("PersistenceHealthCheckSpec", extraConfig: extraConfig)); | ||
| } | ||
|
|
||
| public JournalHealthCheckSpec(ITestOutputHelper output) : base(HealthCheckConfig(), output) | ||
| { | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData(null)] // default plugin | ||
| [InlineData("akka.persistence.journal.inmem")] | ||
| public async Task JournalHealthCheck_should_default_to_Healthy(string? pluginId) | ||
Aaronontheweb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| using var cts = new CancellationTokenSource(RemainingOrDefault); | ||
| var pluginHealth = await Extension.CheckJournalHealthAsync(pluginId, cts.Token); | ||
|
|
||
| Assert.Equal(PersistenceHealthStatus.Healthy, pluginHealth.Status); | ||
| Assert.NotNull(pluginHealth.Description); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task JournalHealthCheck_should_return_Degraded_when_CircuitBreaker_is_Open() | ||
| { | ||
| // Get the journal actor reference | ||
| var journal = Extension.JournalFor("akka.persistence.journal.failing-open"); | ||
|
|
||
| // Trigger a failure to open the circuit breaker | ||
| var writeMsg = new WriteMessages(new[] { new AtomicWrite(new Persistent("test", 1, "test-pid")) }.ToImmutableList(), | ||
| TestActor, 1); | ||
| journal.Tell(writeMsg, TestActor); | ||
|
|
||
| // Advance time to let the write fail and circuit breaker open | ||
| var testScheduler = (TestScheduler)Sys.Scheduler; | ||
| testScheduler.Advance(TimeSpan.FromSeconds(2)); | ||
|
|
||
| using var cts = new CancellationTokenSource(RemainingOrDefault); | ||
| var pluginHealth = await Extension.CheckJournalHealthAsync("akka.persistence.journal.failing-open", cts.Token); | ||
|
|
||
| Assert.Equal(PersistenceHealthStatus.Degraded, pluginHealth.Status); | ||
| Assert.Contains("Circuit breaker is open", pluginHealth.Description); | ||
|
Member
Author
There was a problem hiding this comment. Probably not necessary to be this specific, but wanted to illustrate that leveraging the |
||
| } | ||
|
|
||
| [Fact] | ||
| public async Task JournalHealthCheck_should_return_Degraded_when_CircuitBreaker_is_HalfOpen() | ||
| { | ||
| // Get the journal actor reference | ||
| var journal = Extension.JournalFor("akka.persistence.journal.failing-half-open"); | ||
|
|
||
| // Trigger a failure to open the circuit breaker | ||
| var writeMsg = new WriteMessages(new[] { new AtomicWrite(new Persistent("test", 1, "test-pid")) }.ToImmutableList(), | ||
| TestActor, 1); | ||
| journal.Tell(writeMsg, TestActor); | ||
|
|
||
| var testScheduler = (TestScheduler)Sys.Scheduler; | ||
|
|
||
| // Advance time past call-timeout to let the write fail and circuit breaker open | ||
| testScheduler.Advance(TimeSpan.FromSeconds(1)); | ||
|
|
||
| // Give the async operations time to complete | ||
| await Task.Delay(100); | ||
|
|
||
| // Advance time past reset-timeout to transition to half-open | ||
| testScheduler.Advance(TimeSpan.FromSeconds(1)); | ||
|
|
||
| // Give the transition time to complete | ||
| await Task.Delay(100); | ||
|
Member
Author
There was a problem hiding this comment. Even though we can use the |
||
|
|
||
| using var cts = new CancellationTokenSource(RemainingOrDefault); | ||
| var pluginHealth = await Extension.CheckJournalHealthAsync("akka.persistence.journal.failing-half-open", cts.Token); | ||
|
|
||
| Assert.Equal(PersistenceHealthStatus.Degraded, pluginHealth.Status); | ||
| Assert.Contains("Circuit breaker is half-open", pluginHealth.Description); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Test journal that always fails writes to trigger circuit breaker | ||
| /// </summary> | ||
| public class FailingJournal : MemoryJournal | ||
| { | ||
| protected override Task<IImmutableList<Exception>> WriteMessagesAsync(IEnumerable<AtomicWrite> messages, CancellationToken cancellationToken) | ||
| { | ||
| throw new InvalidOperationException("Simulated journal write failure"); | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are all of the new public message and enum types we added to support health checks.