You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/platform/account/app/configuration/api-keys.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ To manage an API key: set [capabilities](/docs/auth/capabilities), define resour
27
27
28
28
### Capabilities <aid="capabilities"/>
29
29
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.
31
31
32
32
### Set resource restrictions <aid="resource-restrictions"/>
Copy file name to clipboardExpand all lines: src/pages/docs/platform/account/app/configuration/integrations.mdx
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,17 +7,17 @@ redirect_from:
7
7
- /docs/account/app/integrations
8
8
---
9
9
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).
Copy file name to clipboardExpand all lines: src/pages/docs/platform/account/app/configuration/rules.mdx
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ redirect_from:
7
7
- /docs/account/app/rules
8
8
---
9
9
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.
Copy file name to clipboardExpand all lines: src/pages/docs/platform/account/app/configuration/settings.mdx
+5-11Lines changed: 5 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,16 +7,16 @@ redirect_from:
7
7
- /docs/account/app/settings
8
8
---
9
9
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).
The application settings section contains the fundamental configuration options that define your application's identity and basic operational parameters.
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.
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 <aid="available-adapters"/>
48
+
Protocol adapters allow clients using standard messaging protocols to connect to your Ably application without requiring Ably-specific client libraries:
Copy file name to clipboardExpand all lines: src/pages/docs/platform/account/app/monitoring/logs.mdx
+14-75Lines changed: 14 additions & 75 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,101 +7,40 @@ redirect_from:
7
7
- /docs/account/app/logs
8
8
---
9
9
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.
| 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 |
26
25
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.
28
27
29
28
## API requests <aid="api-requests"/>
30
29
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 <aid="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.
48
31
49
32
## Channels <aid="channels"/>
50
33
51
-
The channels section provides detailed logs of channel events and activities, enabling you to monitor channel lifecycle, message flow, and channel-specific operations.
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.
63
35
64
36
## Connections <aid="connections"/>
65
37
66
-
The connections section provides detailed logs of client connection events, helping you troubleshoot connection issues and monitor client behavior patterns.
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.
81
39
82
40
## Integration errors <aid="integration-errors"/>
83
41
84
-
The integration errors section provides detailed logs of integration failures, webhook issues, and external service connectivity problems.
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.
95
43
96
44
## Push notifications <aid="push-notifications"/>
97
45
98
-
The push notifications section provides detailed logs of push notification events, delivery status, and related errors for troubleshooting notification delivery issues.
Copy file name to clipboardExpand all lines: src/pages/docs/platform/account/app/monitoring/reports.mdx
+11-49Lines changed: 11 additions & 49 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,60 +7,22 @@ redirect_from:
7
7
- /docs/account/app/reports
8
8
---
9
9
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).
11
11
12
-
### Available report sections <aid="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
+
<Asidedata-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.
The billable consumption section provides detailed usage metrics and cost analysis through the Global usage report.
25
-
26
-
#### Global usage report <aid="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 <aid="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 <aid="billable-messages"/>
18
+
The Global usage report provides a consolidated view of your application's realtime activity, including:
41
19
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.
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 <aid="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 <aid="message-type-traffic"/>
53
-
54
-
This section breaks down message activity by content type including messages, presence events, objects, and annotations.
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.
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.
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