Create and manage subscription
Create subscription
Messages published to a topic can be received via subscriptions. Pub/Sub supports three types of subscriptions: Pull
, Push
, and Object Storage
.
Follow these steps to create a subscription.
A maximum of 13 subscriptions per project can be created. (See Pub/Sub quota)
- Go to KakaoCloud console > Analytics > Pub/Sub.
- In the Subscription menu, click the [Create subscription] button.
- Enter the subscription details and click the [Create] button.
Basic settings
Item | Description |
---|---|
Name | Subscription name |
Select topic | Topic to bind the subscription |
Type | Detailed settings by type Pull: User requests message delivery Push: Pub/Sub pushes messages Object Storage: Delivers messages to a storage bucket |
Message retention | Retention period for messages - Range: 10 minutes to 7 days - Must be equal to or less than topic retention period |
Detailed settings by type
Pull
Item | Description |
---|---|
Retry count | If not acknowledged within the wait time, specifies how many times to retry - Set count: 1–100 - Unlimited: Infinite retries |
Ack wait time | Time to wait for message acknowledgment - Range: 10–600 seconds |
Push
Item | Description |
---|---|
Endpoint URL | URL that receives messages - Protocol: HTTP/HTTPS - Security group setup required |
Retry count | Same as above |
Ack wait time | Same as above |
Object Storage
Item | Description |
---|---|
Bucket | Select a bucket from Object Storage (must be pre-created) |
File format | Format for stored files - Only Text supported |
File prefix (optional) | Adds prefix to all files - Certain characters prohibited: \ : * ? " < > | - Cannot start with / , nor contain // - Combined prefix and suffix must not exceed 200 bytes |
File suffix (optional) | Adds suffix to all files - Same character restrictions as prefix |
Max batching interval | Frequency for storing files - Min: 1 min- Max: 10 min- Default: 5 min⚠️ At least one file will be created per interval. May occur earlier. |
Export channel count | Number of channels for exporting messages - Range: 1–16 - Default: 1 ⚠️ Actual file count may differ |
When creating an Object Storage subscription, an export channel is automatically activated.
Use the [Start export] / [Stop export] buttons on the subscription detail page to manage the export status.
Manage subscription
View subscription list
-
Go to KakaoCloud console > Analytics > Pub/Sub.
-
In the Subscription menu, view the list of existing subscriptions.
Field Description Filter Filter or search subscriptions
- Filters are combined with AND
- Keywords use ORName Name assigned by the user Status Subscription status Type Pull / Push / Object Storage Topic name Name of the topic Retention period Retention period for the subscription Ack wait time Time to wait for acknowledgment Creator User who created the subscription [More] Modify / Delete / Rewind timestamp
View subscription details
-
Go to KakaoCloud console > Analytics > Pub/Sub menu.
-
In the Subscription menu, select the subscription to view details.
-
Check the information on the subscription detail page.
Basic information
Item Description Summary - Type
- Status
- Export status
- Retention periodName Subscription name ID Unique ID Retention Message retention period Unacknowledged count Number of messages not acknowledged
* Retry-exceeded messages are excludedCreator Who created it Created at Timestamp [Buttons] Modify / Delete / Rewind timestamp / Start export / Stop export Type-specific details
Modify subscription
Retention period can currently only be extended. Reducing retention will be supported in the future.
-
Go to KakaoCloud console > Analytics > Pub/Sub menu.
-
In the Subscription menu, click the [More] icon and select Modify.
-
In the Modify subscription screen, modify the subscription settings and click the [Save] button.
Common
Item Description Retention 10 minutes to 7 days
Must be ≤ topic retention periodPull-specific
Item Description Ack wait time 10–600 seconds Retry count Same as in creation Push-specific
Item Description Endpoint URL HTTP/HTTPS endpoint Ack wait time 10–600 seconds Retry count As above Object Storage-specific
Item Description Bucket Bucket to deliver messages File format Only Text is supported File prefix (optional) Same rules as in creation File suffix (optional) Same rules as in creation Max batching interval Min: 1
, Max:10
, Default:5
(in minutes)
⚠️ May not apply immediately if there are pending messagesExport channel count 1–16 channels, default 1
Rewind timestamp
Rewind a subscription to re-receive messages from a specific time.
Messages beyond the topic’s retention period cannot be recovered.
Cannot rewind to a point before the topic was created.
- Go to KakaoCloud console > Analytics > Pub/Sub menu.
- In the Subscription menu, click the [More] icon and select Rewind timestamp.
- In the Rewind subscription timestamp popup, set the desired point to rewind to, then click the [Rewind] button.
Delete subscription
Deleted subscriptions cannot be recovered.
- Go to KakaoCloud console > Analytics > Pub/Sub menu.
- In the Subscription menu, click the [More] icon for the subscription you want to delete, then select Delete.
- In the Delete subscription popup, enter the name of the subscription to delete, then click the [Delete] button.
Monitor subscription
You can view monitoring metrics for each subscription in the Monitoring tab.
Some delay may occur in aggregating unacknowledged messages. Retry-exceeded messages are excluded.
-
Go to KakaoCloud console > Pub/Sub menu.
-
In the Subscription menu, select the subscription to monitor.
-
Select the Monitoring tab.
Category Description Data range Time range displayed in the monitoring graph
- Options: 1 hour (default) / 3 hours / 12 hours / 1 day / 7 daysView mode Sets the monitoring graph view layout
- Options: 1-column, 2-column, 3-columnAuto refresh interval Sets the auto-refresh interval
- Options: Do not auto-refresh (default) / 10 seconds / 30 seconds / 1 minute / 5 minutesManual refresh Click to manually refresh monitoring results Metrics by type
Pull
Metric Unit Description Acked messages per second count/s Messages acknowledged per second Unacked messages count Count of unprocessed messages Rewind requests in 5 min count Number of rewind requests Ack requests per second count/s Ack requests per second Streaming Pull responses count/s Streaming Pull responses per second Stored data bytes Total stored data in the subscription Push
Metric Unit Description Acked messages per second count/s Messages acknowledged per second Unacked messages count Count of unprocessed messages Rewind requests in 5 min count Number of rewind requests Ack requests per second count/s Ack requests per second Push requests per second count/s Push requests per second Stored data bytes Total stored data in the subscription Object Storage
Metric Unit Description Processed messages per second count/s Messages exported per second Unacked messages count Count of unprocessed messages Rewind requests in 5 min count Number of rewind requests Export requests per minute count/m API export calls to Object Storage Stored data bytes Total stored data in the subscription