Skip to content

Commit da97ce6

Browse files
committed
fixup! Update dashboard documentation with new images and improved structure
1 parent 253eede commit da97ce6

17 files changed

Lines changed: 311 additions & 945 deletions

File tree

src/pages/docs/platform/account/app/configuration/api-keys.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To manage an API key: set [capabilities](/docs/auth/capabilities), define resour
2727

2828
### Capabilities <a id="capabilities"/>
2929

30-
[Capabilities](/docs/auth/capabilities) define what permissions your API key has. You can select from core messaging capabilities (subscribe, publish, presence), content management (message updates/deletes, annotations), data access (history, stats), push notifications, and administrative features. See the [capabilities documentation](/docs/auth/capabilities) for the complete list and detailed descriptions.
30+
[Capabilities](/docs/auth/capabilities) define what permissions your API key has. You can select from core messaging capabilities (subscribe, publish, presence), content management (message updates/deletes, annotations), data access (history, stats), push notifications, and administrative features.
3131

3232
### Set resource restrictions <a id="resource-restrictions"/>
3333

src/pages/docs/platform/account/app/configuration/integrations.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ redirect_from:
77
- /docs/account/app/integrations
88
---
99

10-
The Integrations section in your Ably dashboard provides centralized management for connecting your Ably application with external services and systems. Configure and manage your integrations in the [app dashboard](https://ably.com/accounts/any/apps/any/integrations).
10+
The Integrations section allows you to connect your Ably application with external services and systems. Configure and manage your integrations in the [app dashboard](https://ably.com/accounts/any/apps/any/integrations).
1111

12-
![Integration dashboard interface](../../../../../../images/content/screenshots/dash/integration.png)
12+
![Integration management interface](../../../../../../images/content/screenshots/dash/integration.png)
1313

1414
## Available integration types <a id="available-integrations"/>
1515

16-
The Integrations dashboard allows you to configure several types of integrations:
16+
You can configure the following types of integrations:
1717

18-
- [Webhooks](/docs/platform/integrations/webhooks) - Trigger serverless functions or custom servers on Ably events
19-
- [Ably Queues](/docs/platform/integrations/queues) - Scalable realtime data consumption for message processing
20-
- [Firehose](/docs/platform/integrations/streaming) - Stream data to external systems like Kinesis or Kafka
18+
- [Inbound webhooks](/docs/platform/integrations/webhooks#inbound) - Receive events from external services into Ably
19+
- [Outbound webhooks](/docs/platform/integrations/webhooks) - Trigger serverless functions or custom servers on Ably events
20+
- [Outbound streaming](/docs/platform/integrations/streaming) - Stream data to external systems like Kinesis or Kafka
2121
- [Third-party integrations](/docs/platform/integrations) - Connect with external services like Datadog
2222

2323
<Aside data-type='note'>

src/pages/docs/platform/account/app/configuration/rules.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ redirect_from:
77
- /docs/account/app/rules
88
---
99

10-
The rules section in your Ably dashboard enables you to enforce settings and configure features for channels, rooms, or spaces within specified namespaces. Configure and manage your rules in the [app dashboard](https://ably.com/accounts/any/apps/any/rules) under the rules section. Rules provide granular control over message persistence, authentication requirements, security settings, and advanced functionality across your application.
10+
Rules allow you to configure features for channels, rooms, or spaces within specified namespaces. Configure and manage your rules in the [app dashboard](https://ably.com/accounts/any/apps/any/rules). Rules control message persistence, authentication requirements, security settings, and other functionality.
1111

1212
![Rules dashboard screenshot](../../../../../../images/content/screenshots/dash/rules.png)
1313

@@ -31,26 +31,34 @@ The Rules system provides access to multiple feature categories that can be enab
3131

3232
### Message persistence features <a id="persistence-features"/>
3333

34+
Control how messages are stored for channels in this namespace:
35+
3436
| Feature | Description |
3537
|---|---|
3638
| Persist last message | Store the most recent message published to channels. |
3739
| Persist all messages | Store all messages published to channels. |
3840

3941
### Security and access features <a id="security-features"/>
4042

43+
Enforce security requirements for channels in this namespace:
44+
4145
| Feature | Description |
4246
|---|---|
4347
| Identified | Require client identification for channel access. |
4448
| TLS only | Enforce encrypted connections for channel access. |
4549

4650
### Push notification features <a id="push-features"/>
4751

52+
Configure push notification delivery for channels in this namespace:
53+
4854
| Feature | Description |
4955
|---|---|
5056
| Push notifications | Enable push notification delivery. |
5157

5258
### Message processing features <a id="processing-features"/>
5359

60+
Configure message processing behavior for channels in this namespace:
61+
5462
| Feature | Description |
5563
|---|---|
5664
| Message interactions | Enable message references and threading. |

src/pages/docs/platform/account/app/configuration/settings.mdx

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ redirect_from:
77
- /docs/account/app/settings
88
---
99

10-
The Settings section in your Ably dashboard provides centralized configuration management for your application's core settings, security requirements, and protocol support. Configure your application settings in the [app dashboard](https://ably.com/accounts/any/apps/any/settings) under the Settings section. This interface enables you to customize your application's behavior, enforce security policies, and enable protocol adapters for different client types.
10+
The Settings section allows you to configure your application's core settings, security requirements, and protocol support. Configure your application settings in the [app dashboard](https://ably.com/accounts/any/apps/any/settings).
1111

1212
![App settings interface](../../../../../../images/content/screenshots/dash/app-settings.png)
1313

1414
## Application settings <a id="application-settings"/>
1515

16-
The application settings section contains the fundamental configuration options that define your application's identity and basic operational parameters.
17-
1816
### Basic application configuration <a id="basic-configuration"/>
1917

18+
The following settings define your application's identity:
19+
2020
| Setting | Description |
2121
|---|---|
2222
| App ID | Unique identifier for your application. |
@@ -36,7 +36,7 @@ When TLS required is enabled, this setting overrides any channel settings and en
3636

3737
### Application status <a id="application-status"/>
3838

39-
Control whether your application accepts new connections and processes requests:
39+
Control whether your application accepts connections and processes requests:
4040

4141
| Status setting | Description |
4242
|---|---|
@@ -45,13 +45,7 @@ Control whether your application accepts new connections and processes requests:
4545

4646
## Protocol Adapter Settings <a id="protocol-adapter-settings"/>
4747

48-
The Ably platform offers protocol adapter services that enable client libraries for different protocols to communicate directly with Ably, extending compatibility beyond native Ably SDKs.
49-
50-
### Protocol adapter overview <a id="protocol-adapter-overview"/>
51-
52-
Protocol adapters allow clients using standard messaging protocols to connect to your Ably application without requiring Ably-specific client libraries. This enables integration with existing systems and tools that support these protocols.
53-
54-
### Available protocol adapters <a id="available-adapters"/>
48+
Protocol adapters allow clients using standard messaging protocols to connect to your Ably application without requiring Ably-specific client libraries:
5549

5650
| Protocol | Description |
5751
|---|---|

src/pages/docs/platform/account/app/monitoring/logs.mdx

Lines changed: 14 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -7,101 +7,40 @@ redirect_from:
77
- /docs/account/app/logs
88
---
99

10-
The Logs section in your Ably dashboard provides comprehensive monitoring and debugging capabilities through detailed historical event logging across all aspects of your application. Access your application logs in the [app dashboard](https://ably.com/accounts/any/apps/any/logs) under the Logs section. These are historical logs with a short delay, not live logs. This interface enables you to track system activities, troubleshoot issues, and analyze patterns across API requests, channels, connections, integrations, and push notifications.
10+
The Logs section provides historical event logging for monitoring and debugging your application. Access your application logs in the [app dashboard](https://ably.com/accounts/any/apps/any/logs). Logs are recorded with a short delay.
1111

1212
![API requests logs interface](../../../../../../images/content/screenshots/dash/log1.png)
1313

14-
## Log sections overview <a id="sections-overview"/>
14+
## Log sections <a id="sections-overview"/>
1515

16-
The logs interface is organized into five specialized sections, each focused on different aspects of your Ably implementation:
16+
The logs interface is organized into the following sections:
1717

1818
| Log section | Description |
1919
|---|---|
20-
| API requests | Monitor REST API calls and authentication attempts |
21-
| Channels | Track channel events and activities |
22-
| Connections | Monitor client connection events |
23-
| Integration errors | Track integration failures and webhook issues |
24-
| Push notifications | Monitor push notification delivery and errors |
25-
| API integrations | Monitor third-party API integration events and errors |
20+
| API requests | REST API calls and authentication attempts |
21+
| Channels | Channel events and activities |
22+
| Connections | Client connection events |
23+
| Integration errors | Integration failures and webhook issues |
24+
| Push notifications | Push notification delivery and errors |
2625

27-
Each section provides date range filtering and specialized search capabilities tailored to the specific type of events being monitored.
26+
Each section provides date range filtering and search capabilities for the specific type of events being monitored.
2827

2928
## API requests <a id="api-requests"/>
3029

31-
The API requests section provides detailed logs of REST API calls, authentication attempts, and system operations for monitoring and troubleshooting API usage.
32-
33-
### API request filtering options <a id="api-filtering"/>
34-
35-
Filter your API request logs to find specific events:
36-
37-
| Filter | Description |
38-
|---|---|
39-
| Date range | Select start and end dates to focus on specific timeframes. |
40-
| Log level | Choose specific log levels to focus on errors or informational events. |
41-
| Event name | Enter event names to find particular API operations. |
42-
| Operation | Search for specific REST operations like GET, POST, PUT, DELETE. |
43-
| Path | Enter API paths to track specific endpoint usage. |
44-
| Channel | Enter channel names to see API requests affecting specific channels. |
45-
| Client ID | Track API requests from specific clients. |
46-
| Ably Error code | Enter error codes to investigate specific failure types. |
47-
| API Key ID | Track API usage by specific API keys. |
30+
The API requests section logs REST API calls, authentication attempts, and system operations. You can filter by date range, log level, event name, operation, path, channel, client ID, error code, and API key ID.
4831

4932
## Channels <a id="channels"/>
5033

51-
The channels section provides detailed logs of channel events and activities, enabling you to monitor channel lifecycle, message flow, and channel-specific operations.
52-
53-
### Channel log filtering options <a id="channel-filtering"/>
54-
55-
Filter your channel logs to analyze specific events:
56-
57-
1. Select dates to focus on specific channel activity periods.
58-
2. Filter by specific levels to focus on channel errors or events.
59-
3. Type event names like channel.attached, channel.detached.
60-
4. Enter channel names to monitor specific channel activities.
61-
5. Toggle to include or exclude metadata channels in results.
62-
6. Enter Ably error codes to investigate channel-specific issues.
34+
The channels section logs channel events and activities. You can filter by date range, log level, event name, channel name, and error code. You can also toggle metadata channel inclusion.
6335

6436
## Connections <a id="connections"/>
6537

66-
The connections section provides detailed logs of client connection events, helping you troubleshoot connection issues and monitor client behavior patterns.
67-
68-
### Connection log filtering options <a id="connection-filtering"/>
69-
70-
Filter your connection logs to analyze events and client behavior:
71-
72-
1. Select dates to focus on specific connection activity periods.
73-
2. Filter by specific levels to focus on connection errors or state changes.
74-
3. Type events like connection.connected, connection.disconnected.
75-
4. Monitor events for individual client connections using the connection ID filter.
76-
5. Monitor connection events for specific application clients using the client ID filter.
77-
6. Analyze connection patterns by region or investigate regional issues using the country filter.
78-
7. Search for WebSocket, HTTP, or other transport-specific events using the transport filter.
79-
8. Enter Ably error codes to investigate connection failures.
80-
9. Track connection events by API key usage.
38+
The connections section logs client connection events. You can filter by date range, log level, event name, connection ID, client ID, country, transport type, error code, and API key ID.
8139

8240
## Integration errors <a id="integration-errors"/>
8341

84-
The integration errors section provides detailed logs of integration failures, webhook issues, and external service connectivity problems.
85-
86-
### Integration error filtering options <a id="integration-filtering"/>
87-
88-
Filter your integration error logs to troubleshoot issues:
89-
90-
1. Select dates to focus on specific integration activity periods.
91-
2. Select specific integrations like webhooks, queues, or streaming services.
92-
3. Track events for individual integration configurations using the integration ID filter.
93-
4. Enter channel names to see integration events from specific channels.
94-
5. Enter error codes to investigate integration failure types.
42+
The integration errors section logs integration failures and webhook issues. You can filter by date range, integration type, integration ID, channel, and error code.
9543

9644
## Push notifications <a id="push-notifications"/>
9745

98-
The push notifications section provides detailed logs of push notification events, delivery status, and related errors for troubleshooting notification delivery issues.
99-
100-
### Push notification filtering options <a id="push-filtering"/>
101-
102-
Filter your push notification logs to analyze delivery and troubleshoot issues:
103-
104-
1. Select dates to focus on specific notification delivery periods.
105-
2. Enter channel names to track notifications from specific channels.
106-
3. Enter Ably error codes to investigate notification delivery failures.
107-
46+
The push notifications section logs push notification delivery events and errors. You can filter by date range, channel, and error code.

src/pages/docs/platform/account/app/monitoring/reports.mdx

Lines changed: 11 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -7,60 +7,22 @@ redirect_from:
77
- /docs/account/app/reports
88
---
99

10-
The Reports section in your Ably dashboard provides comprehensive analytics and insights for your application, enabling you to monitor usage patterns, analyze costs, and optimize your implementation. View your application reports in the [app dashboard](https://ably.com/accounts/any/apps/any/reports) under the Reports section. This interface offers both high-level summaries and detailed breakdowns of your application's activity.
10+
The Reports section provides analytics and usage insights for your application. View your application reports in the [app dashboard](https://ably.com/accounts/any/apps/any/reports).
1111

12-
### Available report sections <a id="available-sections"/>
13-
14-
Currently available reports:
15-
16-
| Report | Description |
17-
|---|---|
18-
| Global usage report | Comprehensive usage metrics and cost analysis for your application |
12+
<Aside data-type='note'>
13+
Reports are available at different levels: organization, account, and app. The scope of the data depends on which level you are viewing.
14+
</Aside>
1915

2016
## Global usage report <a id="global-usage"/>
2117

22-
### Billable consumption reports <a id="billable-consumption"/>
23-
24-
The billable consumption section provides detailed usage metrics and cost analysis through the Global usage report.
25-
26-
#### Global usage report <a id="global-usage-detail"/>
27-
28-
The Global usage report offers a consolidated view of your application's realtime activity and efficiency, showing:
29-
30-
- Growth trends and traffic patterns
31-
- Resource consumption breakdowns
32-
- Billable usage patterns and optimization opportunities
33-
34-
Click on the Global usage report to access detailed consumption analytics and usage breakdowns.
35-
36-
## Global usage detailed view <a id="global-usage-detailed"/>
37-
38-
When you access the Global usage report, you see comprehensive analytics across multiple categories that help you understand your application's resource consumption and identify optimization opportunities.
39-
40-
### Billable messages <a id="billable-messages"/>
18+
The Global usage report provides a consolidated view of your application's realtime activity, including:
4119

42-
The billable messages section tracks message traffic across delivery methods including inbound/outbound realtime and REST messages, persisted messages, integrations, push notifications, and optimization savings. The total messages chart displays volume trends over time.
43-
44-
### Billable connections <a id="billable-connections"/>
45-
46-
Connection analytics track your application's client connectivity patterns including connection minutes and peak concurrent connections to help you understand connection patterns and plan for scaling requirements.
47-
48-
### Billable channels <a id="billable-channels"/>
49-
50-
Channel usage metrics provide insights into your messaging infrastructure utilization including channel minutes and peak concurrent channels to help you monitor channel scaling patterns.
51-
52-
### Message type traffic <a id="message-type-traffic"/>
53-
54-
This section breaks down message activity by content type including messages, presence events, objects, and annotations.
55-
56-
### Cost optimization insights <a id="cost-optimization"/>
57-
58-
The reports include analysis of Ably's built-in optimization features that reduce your costs including delta bandwidth savings and batching/conflation savings that eliminate unnecessary messages.
20+
- Billable messages across delivery methods (realtime, REST, persisted, integrations, push notifications)
21+
- Connection analytics (connection minutes, peak concurrent connections)
22+
- Channel usage metrics (channel minutes, peak concurrent channels)
23+
- Message type traffic breakdown (messages, presence events, objects, annotations)
24+
- Cost optimization insights (delta bandwidth savings, batching/conflation savings)
5925

6026
### Usage breakdown <a id="usage-breakdown"/>
6127

62-
The detailed usage breakdown provides granular analysis with comprehensive hourly data tables showing metrics such as messages, bandwidth, connections, channels, and push notifications. This tabular data enables detailed analysis of usage patterns and helps identify opportunities for further optimization.
63-
64-
#### Export functionality <a id="export-functionality"/>
65-
66-
The usage breakdown data can be exported as a CSV file for further analysis in external tools. CSV exports are automatically named with timestamps (for example, `app_stats_details_v2_0_1_2025-12-29T19_09_45.352702118Z.csv`) to help you organize and track different export versions.
28+
The detailed usage breakdown provides hourly data tables showing metrics such as messages, bandwidth, connections, channels, and push notifications. This data can be exported as a CSV file for further analysis.

0 commit comments

Comments
 (0)