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

Jump to bottom

Add an actuator health indicator to check the connection between the application and Axon Server #1964

Closed
rzcastilho opened this issue Oct 5, 2021 · 5 comments · Fixed by #2130
Closed

Add an actuator health indicator to check the connection between the application and Axon Server #1964

rzcastilho opened this issue Oct 5, 2021 · 5 comments · Fixed by #2130
Assignees
@smcvb
Labels
Priority 3: Could Low priority. Issues that are nice to have but have a straightforward workaround. Status: Resolved Use to signal that work on this issue is done. Type: Feature Use to signal an issue is completely new to the project.
Milestone
Release 4.6.0

Comments

@rzcastilho
Copy link

rzcastilho commented Oct 5, 2021 •
edited by lfgcampos

Feature Description

Implement the AbstractHealthIndicator to return the connection status between applications and Axon Server.

Current Behaviour

There is no integrated way (spring boot) to check the connection status between the application and Axon Server.

For instance, in a Kubernetes cluster, the liveness/readiness probes attached to the /actuator/health don't receive a down status because there's no health indicator for the connection between the application and Axon Server, causing problems to the consumers.

Wanted Behaviour

Return the status down at /actuator/health if the application faces some problem connecting to Axon Server.
@rzcastilho rzcastilho added the Type: Feature Use to signal an issue is completely new to the project. label Oct 5, 2021
@smcvb smcvb added Priority 3: Could Low priority. Issues that are nice to have but have a straightforward workaround. Status: Under Discussion Use to signal that the issue in question is being discussed. labels Oct 5, 2021
@smcvb
Copy link
Member

smcvb commented Oct 5, 2021

Thanks for drafting this feature request with us @rzcastilho!
We'll start an internal discussion on what the best approach to tackle this would be.
As soon as we've made a decision, we'll certainly update this ticket accordingly.

@thays-bfc
Copy link

Hello @smcvb! Any updates on this feature? Thanks

@smcvb
Copy link
Member

smcvb commented Feb 21, 2022

Fair question, @thays-bfc!
Honestly, this slipped my mind in recent months.
Thus, my apologies for that.

I can state that my schedule doesn't allow for this effort for the upcoming release.
Indeed cumbersome, but we have more people at AxonIQ that might have time for this; I just need to check whether that's the case.

Hence, I'll reignite the internal discussion on this.
If priority stays low, I'll be sure to nudge all of you with our statement on the subject.

In short: stay tuned!

@smcvb smcvb added Status: In Progress Use to signal this issue is actively worked on. and removed Status: Under Discussion Use to signal that the issue in question is being discussed. labels Mar 2, 2022
@smcvb smcvb self-assigned this Mar 2, 2022
@smcvb smcvb added this to the Release 4.6.0 milestone Mar 2, 2022
@smcvb
Copy link
Member

smcvb commented Mar 2, 2022

So, sorry for the wait, we've come to the conclusion.
Had to have a short discussion on how we feel this would make sense within Axon Framework.

As it stands, I've got something working on my local setup.
As such, you can expect a pull request soon.
Furthermore, this means it'll be part of 4.6.0. :-)

@thays-bfc
Copy link

I'll keep an eye on 4.6.0 updates. Once again, thank you!

smcvb added a commit that referenced this issue Mar 7, 2022
@smcvb
Expose the existing connection of the AxonServerConnectionManager
498f660 
Expose the connection of the AxonServerConnectionManager through the
ConnectionManager interface

#1964
smcvb added a commit that referenced this issue Mar 7, 2022
@smcvb
Introduce an AxonServer health indicator
2c44bec 
Introduce an AxonServer health indicator by implementing the
AbstractHealthIndicator. It should add the connectivity of the existing
contexts within the AxonServerConnectionManager through the Health
.Builder

#1964
smcvb added a commit that referenced this issue Mar 7, 2022
@smcvb
Introduce autoconfiguration for the AxonServerHealthIndicator
980bdf4 
Introduce an autoconfiguration class constructing an
AxonServerHealthIndicator bean if actuator is present on the classpath

#1964
smcvb added a commit that referenced this issue Mar 7, 2022
@smcvb
Add tests
a9fafdc 
Add tests for the AxonServerConnectionManager
Add tests for the AxonServerHealthIndicator
Add tests for the AxonServerActuatorAutoConfiguration

#1964
smcvb added a commit that referenced this issue Mar 9, 2022
@smcvb
Fix broken spring boot tests
f453a74 
Fix the broken spring boot tests by ignoring the new
AxonServerActuatorAutoConfiguration either by excluding it or through
the axonserver.enabled=false property

#1964
smcvb added a commit that referenced this issue Mar 9, 2022
@smcvb
Provide component status next to details
1c558ec 
Adjust the AxonServerHealthIndicator to share a status field as well.
This status field should include the additional status "WARN" for when
one of the contexts the app is connected with, is down. To support this
thoroughly, a StatusAggregate should be included.

#1964
@smcvb smcvb mentioned this issue Mar 9, 2022
Merged
smcvb added a commit that referenced this issue Mar 9, 2022
@smcvb
Fix Sonar issues
f3a927c 
- Add private constructor for the utility class HealthStatus
- Check for nullability of the connectionStatus boxed boolean

#1964
@close-label close-label bot added the Status: Resolved Use to signal that work on this issue is done. label Mar 14, 2022
smcvb added a commit that referenced this issue Mar 14, 2022
@smcvb
Merge pull request #2130 from AxonFramework/feature/1964
e635fc6 
[#1964] Include `AxonServerHealthIndicator`
@smcvb smcvb removed the Status: In Progress Use to signal this issue is actively worked on. label Mar 14, 2022
@YvonneCeelie YvonneCeelie mentioned this issue May 31, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@smcvb smcvb

Labels
Priority 3: Could Low priority. Issues that are nice to have but have a straightforward workaround. Status: Resolved Use to signal that work on this issue is done. Type: Feature Use to signal an issue is completely new to the project.
Projects
None yet
Milestone
Release 4.6.0
Development

Successfully merging a pull request may close this issue.

[#1964] Include AxonServerHealthIndicator AxonFramework/AxonFramework
3 participants
@rzcastilho @smcvb @thays-bfc