[DX-883] Addresses message billing docs gap #3234
+399
−23
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
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 |
|---|---|---|
|
|
@@ -57,6 +57,10 @@ export default { | |
| }, | ||
| ], | ||
| }, | ||
| { | ||
| name: 'Spaces pricing', | ||
| link: '/docs/spaces/pricing', | ||
| }, | ||
| ], | ||
| api: [ | ||
| { | ||
|
|
||
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,69 @@ | ||||||
| --- | ||||||
| title: "Chat pricing" | ||||||
| meta_description: "Understand how Chat SDK features contribute to your message count, including messages, typing indicators, reactions, and cost optimization strategies." | ||||||
| meta_keywords: "chat pricing, message counting, typing indicators, reactions, cost optimization" | ||||||
| intro: "How Chat SDK features contribute to your message count and strategies to optimize costs." | ||||||
| redirect_from: | ||||||
| - /docs/chat/message-billing | ||||||
| --- | ||||||
|
|
||||||
| The [Chat SDK](/docs/chat) is built on top of [Pub/Sub](/docs/pub-sub). All Chat operations generate Pub/Sub messages that follow the same counting rules. | ||||||
|
|
||||||
| <Aside data-type="further-reading"> | ||||||
|
Contributor
There was a problem hiding this comment. I'd suggest putting this after the table on message counting and dropping the second sentence about package comparisons. |
||||||
| For how all Ably products count messages, see [message counting](/docs/platform/pricing/message-counting). For package comparison and volume discounts, see the [pricing](https://ably.com/pricing) page. | ||||||
| </Aside> | ||||||
|
|
||||||
| ## Chat operations <a id="operations"/> | ||||||
|
|
||||||
| The following table shows how Chat operations contribute to your message count: | ||||||
|
|
||||||
| | Operation | Messages counted | | ||||||
|
Contributor
There was a problem hiding this comment. I'd suggest something like this format, to make the tables more readable and have fewer repeated links: | Operation | Messages counted |
| --- | --- |
| [Pub/Sub](/docs/pub-sub) ||
| Publish | 1 inbound message |
| Message delivery | 1 outbound message per subscriber |
| [Presence](/docs/presence-occupancy/presence) ||
| Presence enter | 1 inbound message |
| Presence leave | 1 inbound message |
| Presence update | 1 inbound message |
| Presence event delivery | 1 outbound message per presence subscriber |
| [Message persistence](/docs/storage-history/storage) ||
| Persistence storage | 1 additional message per stored message |
| History retrieval | 1 message per retrieved message | |
||||||
| | --- | --- | | ||||||
| | [Send message](/docs/chat/rooms/messages) | 1 inbound message | | ||||||
| | Message delivery | 1 outbound message per subscriber | | ||||||
| | [Update message](/docs/chat/rooms/messages#update) | 1 inbound message | | ||||||
| | Message update delivery | 1 outbound message per subscriber | | ||||||
| | [Delete message](/docs/chat/rooms/messages#delete) | 1 inbound message | | ||||||
| | Message deletion delivery | 1 outbound message per subscriber | | ||||||
| | [History](/docs/chat/rooms/history) retrieval | 1 message per retrieved message | | ||||||
| | [Typing indicator](/docs/chat/rooms/typing) keystroke | 1 inbound message; repeats every heartbeat interval (default 10s) | | ||||||
| | Typing indicator delivery | 1 outbound message per subscriber per heartbeat | | ||||||
| | [Typing indicator](/docs/chat/rooms/typing) stop | 1 inbound message | | ||||||
| | Typing stop delivery | 1 outbound message per subscriber | | ||||||
| | [Room reaction](/docs/chat/rooms/reactions) | 1 inbound message | | ||||||
| | Room reaction delivery | 1 outbound message per subscriber | | ||||||
| | [Message reaction](/docs/chat/rooms/message-reactions) send | 1 inbound message | | ||||||
| | [Message reaction](/docs/chat/rooms/message-reactions) delete | 1 inbound message | | ||||||
| | Message reaction summary delivery | 1 outbound message per subscriber; multiple reactions may be rolled up into a single summary | | ||||||
| | [Presence enter](/docs/chat/rooms/presence) | 1 inbound message | | ||||||
| | [Presence leave](/docs/chat/rooms/presence) | 1 inbound message | | ||||||
| | [Presence update](/docs/chat/rooms/presence) | 1 inbound message | | ||||||
| | Presence event delivery | 1 outbound message per presence subscriber | | ||||||
| | [Occupancy](/docs/chat/rooms/occupancy) event | 1 outbound message per subscriber (generated on membership changes, debounced up to 15s) | | ||||||
| | [Moderation](/docs/chat/moderation) action | 1 inbound message; triggers a message update or delete which follows standard delivery | | ||||||
|
|
||||||
| ## Rooms, channels, and connections <a id="rooms-connections"/> | ||||||
|
|
||||||
| Each Chat room maps to underlying Pub/Sub channels. Each room feature (messages, typing, reactions, presence, occupancy) uses its own channel, contributing to your [channel count](/docs/platform/pricing#channels). Ably bills each connected client for [connection minutes](/docs/platform/pricing#connections) in the same way as Pub/Sub. | ||||||
|
Comment on lines
+45
to
+47
Contributor
There was a problem hiding this comment. I think we should separate these out considering we charge for them independently. I also think it's worth having the explanations here rather than pushing people back to Pub/Sub to understand them. |
||||||
|
|
||||||
| ## Cost optimization <a id="optimization"/> | ||||||
|
Contributor
There was a problem hiding this comment. Is it worth adding some quick info on detaching from rooms and closing connections? |
||||||
|
|
||||||
| ### Reduce typing indicator frequency | ||||||
|
|
||||||
| Increase the `heartbeatThrottleMs` [room option](/docs/chat/rooms#typing) to reduce typing indicator event frequency. The default is 10 seconds. Increase this value in rooms that tolerate delayed typing feedback. | ||||||
|
|
||||||
| ### Disable typing indicators | ||||||
|
Contributor
There was a problem hiding this comment. I'm not sure this needs to be stated, since they'd only be enabled if someone set them up. |
||||||
|
|
||||||
| Disable typing indicators entirely in rooms where they are not needed. This eliminates a significant source of messages, especially in rooms with many participants. | ||||||
|
|
||||||
| ### Use server-side batching | ||||||
|
|
||||||
| [Server-side batching](/docs/guides/pub-sub/data-streaming#solution-server-side-batching) groups messages into single deliveries. Use this for high-throughput rooms where slight delay is acceptable. | ||||||
|
Contributor
There was a problem hiding this comment. This is odd to link to a Pub/Sub guide rather than the SSB page. |
||||||
|
|
||||||
| ### Use occupancy instead of presence | ||||||
|
|
||||||
| Use [occupancy](/docs/chat/rooms/occupancy) instead of [presence](/docs/chat/rooms/presence) when you only need member counts, not individual identities. This avoids the n-squared presence event fan-out. For example, 200 members joining and leaving generates approximately **80,400 messages**. See [large-scale presence sets](/docs/presence-occupancy/presence#large-presence) for details. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ### Enable server-side presence batching | ||||||
|
Contributor
There was a problem hiding this comment. Not sure this needs a separate callout since we have SSB above. |
||||||
|
|
||||||
| Enable [server-side batching](/docs/presence-occupancy/presence#large-presence) to group presence events. Subscribe to presence updates only on rooms where you need member-level detail. | ||||||
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
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.
You don't need this as that page never existed.