chore: add Health Status to Waku API #92

weboko · 2025-10-22T22:42:43Z

This PR add spec for health status for Waku API and depicts what is used now in js-waku

This is re-use from the original attempt to define Messaging API
https://github.com/waku-org/specs/blob/17464d356a40cfa130c0df25b50769a4f38b7c45/standards/application/messaging-api.md#health-indicator

Resolves - logos-messaging/js-waku#2712

Copilot

Pull Request Overview

This PR adds a health status specification to the Waku API, defining three health states (Unhealthy, MinimallyHealthy, Healthy) and an event source mechanism for health status changes, based on the implementation currently used in js-waku.

Key Changes:

Addition of HealthStatus enum type with three health levels
Introduction of event source mechanism for health status change notifications
Extended documentation describing each health state

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

standards/application/waku-api.md

Co-authored-by: Copilot <[email protected]>

fryorcraken

You do have to specify how the event source is accessible (e.g. events property on WakuNode).

standards/application/waku-api.md

chaitanyaprem · 2025-10-23T02:54:15Z

standards/application/waku-api.md

+
+```yml
+types:
+  HealthStatus:


One of the things i have initially considered and while thinking again recently on this topic is to consider HealthStatus not just at node level but also at a more fine-grained level.
In case of relay health status makes more sense at shard level because a node can be healthily connected to 1 shard and not on the other.
When it comes to edge/light clients this becomes even more complicated as there are even finer grain concept of content-topics, i.e a node can have peers or subscriptions to certain content-topics and loose subscriptions to others.

If so, does it make more sense to consider health to be notified to a user based on content-topics? Ref discussion thread:
https://discord.com/channels/1110799176264056863/1414975481438011392/1428769536139857989

We can always aggregate the health of all shards or content-topics and depict it as node health, but i do think we will require granular health events to be reported to app devs. Consider status for example, if a user is part of 2 communities (which is nothing but 2 different content-topics) but has at some point only subscriptions to 1 content-topic then we can't indicate node is unhealthy rather reception on 1 community is unhealthy whereas on the other it is fine.

WDYT @fryorcraken @weboko @Ivansete-status
cc @igor-sirotin

really good idea, @chaitanyaprem

I think this comes to the realm of Waku App API as now we are communicating about application concerns of fragmented network and it's application of content topics in an app

but we definitely can implement it in Waku API

I agree that health per content topic may make sense.

But at this point in time, I would KISS it, and then review whether an application developer would want to expose this information to their user. Aka, not do per content topic just yet.

review whether an application developer would want to expose this information to their user

iirc status app already has this requirement unless there is some priority change. hence was suggesting this.
But i would leave it upto based on priorities.

iirc status app already has this requirement unless there is some priority change. hence was suggesting this.
But i would leave it upto based on priorities.

Please provide more context. What do they do with this information? How does the per content-topic information impacts application behaviour?

I remember they wanted to show connectivity health at community level , but not sure if priority has changed now. Maybe @igor-sirotin or someone from status team can give more clarity on this

I remember they wanted to show connectivity health at community level , but not sure if priority has changed now. Maybe @igor-sirotin or someone from status team can give more clarity on this

Good to know, If that's something they have/want to keep then yes, we should do it from the get go.
cc @osmaczko @jrainville to confirm if this feature still exists

cc @plopezlpz @jazzz FYI, there is a request to show connectivity at conversation level (can be done later in chat sdk)

UI

I remember they wanted to show connectivity health at community level

I only know about this feature from this ticket, but I don't know about our desire to implement this on Status UI level.

It makes sense on paper, but in reality this might unnecessarily complicate UI. And I don't think this is of any priority at the moment.

cc @jrainville

Backend

In backend we manually trigger discovery (or peer exchange) when we don't have enough peers.

In full client, we run discovery periodically if we "have enough connected peers"
messaging/waku/gowaku.go#L1773-L1776

In light client, we run peer exchange every 5 seconds
messaging/waku/gowaku.go#L605-L612

Instead, we want to:

trigger discovery for specific pubsub topic, when it's unhealthy

trigger peer exchange for specific content topic, when it's unhealhy

cc @weboko @chaitanyaprem @fryorcraken

Co-authored-by: fryorcraken <[email protected]>

Copilot

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

standards/application/waku-api.md

fryorcraken · 2025-10-24T00:06:36Z

standards/application/waku-api.md

+`Unhealthy` indicates that the node has lost connectivity for message reception,
+sending, or both, and as a result, it cannot reliably process or transmit messages.
+
+`MinimallyHealthy` indicates that the node meets the minimum operational requirements: connect to at least one peer with a protocol to send messages ([LIGHT-PUSH]() or [RELAY]()) and one peer with a protocol to receive messages ([FILTER ] or [RELAY])


Need to use the proper names IMO (WAKU2-RELAY) and add the links please.

I am using names as they were defined in originally in #65

do you want to change it across the file?

🤷 Not sure how much it matters. @jimstir ?

The links are missing tho

@weboko It is good practice to use the actual title of the spec at the time of writing, e.g. 11/WAKU2-RELAY. In the waku/specs repo this is not required or enforced, but will be in the rfc-index.

standards/application/waku-api.md

one comment was not tackled

fryorcraken · 2025-10-24T00:08:39Z

Almost approved, still need to fix

You do have to specify how the event source is accessible (e.g. events property on WakuNode).

chaitanyaprem

Once comments are addressed, LGTM

chaitanyaprem · 2025-10-24T01:36:10Z

standards/application/waku-api.md

+
+```yml
+types:
+  HealthStatus:


review whether an application developer would want to expose this information to their user

iirc status app already has this requirement unless there is some priority change. hence was suggesting this.
But i would leave it upto based on priorities.

standards/application/waku-api.md

weboko · 2025-10-28T00:37:32Z

You do have to specify how the event source is accessible (e.g. events property on WakuNode).

@fryorcraken I'll merge this PR after #87 in which I define events property

fryorcraken · 2025-10-28T01:03:49Z

standards/application/waku-api.md

+    fields:
+      eventType:
+        type: string
+        default: "health"


the default values does not make sense here

Ivansete-status

Thanks for it! 🙌
Adding my 2cs that I hope you find useful
Also, cc @fcecin as she will implement it on nwaku side 🥳

Ivansete-status · 2025-11-19T15:11:27Z

standards/application/waku-api.md

+  HealthStatus:
+    type: enum
+    values: [Unhealthy, MinimallyHealthy, Healthy]
+    description: "Used to identify health of the operating node"


Suggested change

HealthStatus:

type: enum

values: [Unhealthy, MinimallyHealthy, Healthy]

description: "Used to identify health of the operating node"

HealthState:

type: enum

values: [Unhealthy, Healthy]

description: "Used to identify health of the operating node"

HealthStateDetail:

type: object

fields:

state:

type: HealthState

reason:

type: string

description: "Brings clear detail about why the node is in the given state."

I think is very important/compulsory to allow precise detail about why a node is unhealthy, f.e. For now, it is enough returning this detail in a string so that the API consumer can better understand why the node is not getting healthy. That will also help us bring a better assistance (in case someone asks.)

The reason field will also give us freedom to properly inform about the topic health, as @chaitanyaprem suggested. Even, we can return a JSON in the future with better detail, which can help us to extend the API if needed.

Ivansete-status · 2025-11-19T15:12:24Z

standards/application/waku-api.md

+`MinimallyHealthy` indicates that the node meets the minimum operational requirements:
+it is connected to at least one peer with a protocol to send messages ([LIGHTPUSH](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/19/lightpush.md) or [RELAY](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/11/relay.md)), 
+one peer with a protocol to receive messages ([FILTER](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/12/filter.md) or [RELAY](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/11/relay.md)),
+and one peer with [STORE](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) service capabilities,
+although performance or reliability may still be impacted.


I would not use the MinimallyHealthy state. Instead, only Unhealthy and Healthy.
Much simpler and the API consumer doesn't need to bother about lightpush, etc.

Suggested change

`MinimallyHealthy` indicates that the node meets the minimum operational requirements:

it is connected to at least one peer with a protocol to send messages ([LIGHTPUSH](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/19/lightpush.md) or [RELAY](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/11/relay.md)),

one peer with a protocol to receive messages ([FILTER](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/12/filter.md) or [RELAY](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/11/relay.md)),

and one peer with [STORE](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/13/store.md) service capabilities,

although performance or reliability may still be impacted.

chore: add health status

36c3879

weboko requested review from chaitanyaprem, Copilot and fryorcraken October 22, 2025 22:42

Copilot AI reviewed Oct 22, 2025

View reviewed changes

standards/application/waku-api.md Outdated Show resolved Hide resolved

standards/application/waku-api.md Outdated Show resolved Hide resolved

weboko and others added 2 commits October 23, 2025 00:44

use capital

ed2ffc1

Co-authored-by: Copilot <[email protected]>

remove ambiguity

88783f0

fryorcraken reviewed Oct 23, 2025

View reviewed changes

standards/application/waku-api.md Outdated Show resolved Hide resolved

fryorcraken self-assigned this Oct 23, 2025

chaitanyaprem reviewed Oct 23, 2025

View reviewed changes

up text

b957762

Co-authored-by: fryorcraken <[email protected]>

weboko requested review from chaitanyaprem, Copilot and fryorcraken October 23, 2025 23:53

Copilot AI reviewed Oct 23, 2025

View reviewed changes

standards/application/waku-api.md Outdated Show resolved Hide resolved

standards/application/waku-api.md Outdated Show resolved Hide resolved

standards/application/waku-api.md Outdated Show resolved Hide resolved

fryorcraken previously approved these changes Oct 24, 2025

View reviewed changes

chaitanyaprem approved these changes Oct 24, 2025

View reviewed changes

address comments

78d0b9d

fryorcraken reviewed Oct 28, 2025

View reviewed changes

fryorcraken mentioned this pull request Nov 12, 2025

feat: provide content topic health for filter/lightpush logos-messaging/logos-messaging-nim#3629

Closed

Ivansete-status mentioned this pull request Nov 17, 2025

feat: Implement Health API logos-messaging/logos-messaging-nim#3646

Open

Ivansete-status reviewed Nov 19, 2025

View reviewed changes

chore: add Health Status to Waku API #92

Are you sure you want to change the base?

chore: add Health Status to Waku API #92

Conversation

weboko commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

fryorcraken left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fryorcraken Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

UI

Backend

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fryorcraken Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fryorcraken commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chaitanyaprem left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

weboko commented Oct 28, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ivansete-status left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

weboko commented Oct 22, 2025 •

edited

Loading

fryorcraken Oct 24, 2025 •

edited

Loading

fryorcraken Oct 28, 2025 •

edited

Loading

fryorcraken commented Oct 24, 2025 •

edited

Loading