docs: Actor App-Initiated gRPC Event Streams (SubscribeActorEventsAlpha1)#5182
Open
nelson-parente wants to merge 3 commits into
Open
docs: Actor App-Initiated gRPC Event Streams (SubscribeActorEventsAlpha1)#5182nelson-parente wants to merge 3 commits into
nelson-parente wants to merge 3 commits into
Conversation
Add documentation for SubscribeActorEventsAlpha1, the new bidirectional gRPC stream that lets actor-hosting apps receive all callbacks (invoke, reminder, timer, deactivate) over an app-initiated connection to daprd, without exposing an inbound server port. Closes dapr/dapr#927. Introduced in Dapr v1.18 via dapr/dapr#9812. Files added/changed: - actors-app-initiated-streams.md: concept page explaining the protocol, the motivation, how it differs from traditional callbacks, and NetworkPolicy / firewall guidance for operators. - howto-actors-app-initiated-streams.md: how-to guide with step-by-step instructions and raw gRPC code examples in Go. - actors_api.md: new SubscribeActorEventsAlpha1 gRPC section with full proto reference tables for all request/response message types. - alpha-beta-apis.md: add row for the new alpha API. Signed-off-by: Nelson Parente <nelson_parente@live.com.pt>
Signed-off-by: Nelson Parente <nelson_parente@live.com.pt>
marcduiker
requested changes
Jun 3, 2026
| ## Protocol summary | ||
|
|
||
| ``` | ||
| App daprd (Dapr sidecar) |
Contributor
There was a problem hiding this comment.
Can you convert this to a mermaid style diagram? Don't worry about formatting, I'll prepare something for this later.
| --- | ||
|
|
||
| {{% alert title="Alpha" color="warning" %}} | ||
| `SubscribeActorEventsAlpha1` is in alpha. The API shape may change in a future release. |
Contributor
There was a problem hiding this comment.
Which SDKs support this atm? Can you add this info here?
| | **SDK support** | All SDKs | SDKs adding support (see below) | | ||
| | **Stability** | Stable | Alpha (v1.18+) | | ||
|
|
||
| The app-initiated approach is useful when NetworkPolicies restrict inbound traffic to application pods, when actors run in restricted-networking environments, or when you want a single connection-management surface instead of per-callback HTTP/gRPC routes. |
Contributor
There was a problem hiding this comment.
Move this sentence above the table, so the question in the h2 is answered immediately.
|
|
||
| ## SDK support | ||
|
|
||
| SDK helpers for `SubscribeActorEventsAlpha1` are not yet available; use the generated gRPC client directly. See the [how-to guide]({{% ref "howto-actors-app-initiated-streams" %}}) for a raw gRPC example in Go. SDK support is being tracked in the v1.18 SDK releases. |
Contributor
There was a problem hiding this comment.
Ah ok, this explains the SDKs question. I suggest to remove this: "SDK support is being tracked in the v1.18 SDK releases." This is not typically mentioned in docs.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Documents
SubscribeActorEventsAlpha1, the flagship new alpha API in Dapr v1.18 that lets actor-hosting apps receive all callbacks over a single bidirectional gRPC stream initiated from the app to the sidecar, with no inbound server port required.v1.18branchFiles changed
daprdocs/content/en/developing-applications/building-blocks/actors/actors-app-initiated-streams.mddaprdocs/content/en/developing-applications/building-blocks/actors/howto-actors-app-initiated-streams.mdrequest_failed, and implement reconnection with exponential back-off. Includes full raw gRPC Go code examples.daprdocs/content/en/reference/api/actors_api.mdSubscribeActorEventsAlpha1 (gRPC)section with the gRPC service definition and complete field-level reference tables for all request/response proto messages.daprdocs/content/en/operations/support/alpha-beta-apis.mdActor App-Initiated Streamsrow to the Alpha APIs table.Test plan
{{< ref >}}links)weight: 55andweight: 56don't collide with existing actor pages (current highest non-how-to weight in the folder isactors-timers-reminders.md— check_index.mdordering)dapr/dapr#9812once final proto is tagged in v1.18Open questions / TODOs for reviewer
{{< tabpane >}}in the how-to.master. Replace with a tagged v1.18 permalink once the release tag is cut.weight: 55andweight: 56are slotted betweenhowto-actors.md(no explicit weight) and the existing pages. Verify the rendered nav order looks right.howto-actors-partitioning.mdweight: The v1.18 branch may have different weight values if other actor pages were added. Double-check.actors-overview.mdcross-link: Consider adding a bullet under the "Features" section ofactors-overview.mdpointing to the new concept page for discoverability. Not blocking.Targets v1.18. Draft pending review.