Create and manage subscription

Create subscription

Messages posted to a topic can be received through subscriptions. Subscriptions offer three types of message delivery methods: Pull, Push, and Object Storage. Here's how to create a subscription in the Pub/Sub service.

info

You can create up to 13 subscriptions per project. For details, refer to the Pub/Sub quotas.

1. Go to the KakaoCloud Console > Analytics > Pub/Sub menu.
2. In the Subscription menu, click the [Create subscription] button.
3. Enter the necessary details and click [Create].

Default settings

Item	Description
Name	Set the subscription name
Select topic	Select the topic for which to create the subscription
Type	[Details by type] Pull: The user requests message delivery Push: Pub/Sub pushes messages Object Storage: Sends messages to a bucket
Subscription message retention	Set the subscription message retention period - Must be less than or equal to the topic's retention period

Detailed settings by type

Pull type

Item	Description
Retry attempts	Number of retries if no response within the wait time - Set attempts: 1-100 - Unlimited: Retry indefinitely
Response wait time	Time to wait for message confirmation - Range: 10-600 seconds (10 minutes)

Push type

Item	Description
Endpoint URL	Enter the endpoint URL to receive topic messages  - Protocol: HTTP/HTTPS  - Configure security group inbound rules for endpoint resources
Retry attempts	Number of retries if no response within the wait time - Set attempts: 1-100 - Unlimited: Retry indefinitely
Response wait time	Time to wait for message confirmation - Range: 10-600 seconds (10 minutes)

Object Storage type

Item	Description
Bucket	Select the bucket in Object Storage where the message will be sent ⚠️ A bucket must be created in Object Storage beforehand.
File Format	Format of the output file stored in the bucket - Text: Stored in Text file format (*Currently, only Text format is supported).
File Prefix (Optional)	When set, a prefix is included in all output files - Certain special characters (\ : * ? ” < > |) and a leading slash ('/') are not allowed in the prefix - Consecutive slashes ('//') are not allowed ⚠️ The combined length of the prefix and suffix must not exceed 200 bytes.
File Suffix (Optional)	When set, a suffix is included in all output files - Certain special characters (\ : * ? ” < > |) are not allowed - Consecutive slashes ('//') are not allowed.
Maximum File Batch Duration	Stores files in the bucket at the specified time interval - Min: 1 min - Max: 10 min - Default: 5 min ⚠️ Notes: - At least one file is created within each interval. - Files may also be created before the interval ends.
Number of Export Channels	Sets the number of channels for exporting messages to Object Storage - Adjust the number of channels based on the message volume (unit: count) - Min: 1 channel - Max: 16 channels - Default: 1 channel ⚠️ The number of channels set may differ from the number of files output to the bucket.

info

When creating a subscription of the Object Storage type, export channels are automatically enabled to send messages to the bucket.
To stop or restart message delivery to the bucket, use the [Start export] and [Stop export] options on the subscription details page.

Manage subscription

Here's how to manage subscriptions in the Pub/Sub service.

View subscription list

You can view the list of existing subscriptions and their basic information.

1. Go to the KakaoCloud Console > Analytics > Pub/Sub menu.

2. In the Subscription menu, view the list of subscriptions.

   Category	Description
   Filter	Search for specific subscriptions using filters or keywords - Selected filters work with AND conditions, while general keyword searches use OR conditions
   Name	Name assigned to the subscription
   Status	Status of the subscription
   Type	Subscription type - Pull: User requests message delivery - Push: Pub/Sub pushes messages - Object Storage: Exports messages to an Object Storage bucket
   Topic name	Name of the topic the subscription belongs to
   Message retention period	Subscription's message retention period
   Response wait time	Time to wait for message confirmation
   Creator	User who created the subscription
   [More] icon	- [Edit]: Modify subscription settings - [Delete]: Delete the subscription - [Rewind timestamp]: Rewind the subscription timestamp

View subscription details

Check detailed information about a subscription.

1. Go to the KakaoCloud Console > Analytics > Pub/Sub menu.
2. In the Subscription menu, select the subscription you want to view.
3. Check the details on the subscription page.

Basic information

Item	Description
Summary information	- Type: Subscription type - Status: Subscription status - Export status: Enabled/disabled status of the export channel to Object Storage - Subscription message retention period: Retention period of messages in the subscription
Subscription name	Name of the subscription
Subscription ID	Unique ID of the subscription
Subscription retention period	Retention period of messages in the subscription
Unprocessed messages	Number of unprocessed messages *It may take some time to aggregate unprocessed messages, and messages that exceed the retry limit are excluded from aggregation.
Creator	User who created the subscription
Creation time	Time when the subscription was created
[Button options]	- [Edit]: Modify subscription settings - [Delete]: Delete the subscription - [Rewind timestamp]: Rewind the subscription timestamp - [Start export]: Enable export channels to Object Storage - [Stop export]: Disable export channels to Object Storage

Detailed information by type

Items vary depending on the subscription type. For details, please refer to Detailed settings by type.

Modify subscription

You can update the detailed settings of a subscription.

info

The retention period of a subscription can only be extended at this time. Reduction features are planned for future updates.

1. Go to the KakaoCloud Console > Analytics > Pub/Sub menu.
2. In the Subscription menu, click the [More] icon > Modify.
3. In the Modify subscription page, update the settings and click [Save].

Basic settings

Item	Description
Subscription message retention period	Set the retention period for subscription messages - Range: 10 minutes - 7 days Must be less than or equal to the topic's retention period

Pull type settings

Item	Description
Response wait time	Time to wait for message confirmation - Range: 10-600 seconds (10 minutes)
Retry attempts	Number of retries if no response within the wait time - Set attempts: 1-100 - Unlimited: Retry indefinitely

Push type settings

Item	Description
Endpoint URL	URL entered during Push subscription creation  - Protocol: HTTP/HTTPS
Response wait time	Time to wait for message confirmation - Range: 10-600 seconds (10 minutes)
Retry attempts	Number of retries if no response within the wait time - Set attempts: 1-100 - Unlimited: Retry indefinitely

Object Storage type settings

Item	Description
Bucket	Select the bucket in Object Storage where the message will be sent.
File Format	Format of the output file stored in the bucket - Currently, only Text is supported.
File Prefix (Optional)	When set, a prefix is included in all output files. - Certain special characters (\ : * ? ” < > |) and a leading slash ('/') are not allowed in the prefix. - Consecutive slashes ('//') are not allowed. ⚠️ The combined length of the prefix and suffix must not exceed 200 bytes.
File Suffix (Optional)	When set, a suffix is included in all output files. - Certain special characters (\ : * ? ” < > |) are not allowed. - Consecutive slashes ('//') are not allowed.
Maximum File Batch Duration	Stores files in the bucket at the specified time interval. - Min: 1 min - Max: 10 min - Default: 5 min   ⚠️ If there are unprocessed messages, the changes may not apply immediately. It is recommended to modify the settings after all unprocessed messages are handled.
Number of Export Channels	Sets the number of channels for exporting messages to Object Storage. - Adjust the number of channels based on the message volume (unit: count). - Min: 1 - Max: 16 - Default: 1

Rewind timestamp

Rewind a subscription to a specific timestamp to receive all messages from that point onward. Messages that have expired from the topic's retention period cannot be retrieved even after rewinding.

info

You cannot rewind to a time earlier than the creation time of the topic the subscription belongs to.

1. Go to the KakaoCloud Console > Analytics > Pub/Sub menu.
2. In the Subscription menu, click the [More] icon > Rewind timestamp for the desired subscription.
3. In the popup, set the desired timestamp and click the [Rewind timestamp] button.

Delete subscription

Delete unused subscriptions.

info

Deleted subscriptions cannot be recovered.

1. Go to the KakaoCloud Console > Analytics > Pub/Sub menu.
2. In the Subscription menu, click the [More] icon > Delete for the subscription you want to remove.
3. In the popup, enter the subscription name to confirm deletion, and click [Delete].

Monitor subscription

Use the Monitoring tab to view monitoring results for a selected subscription.

info

It may take some time to aggregate unprocessed messages during subscription monitoring, and messages that exceed the retry limit are excluded from aggregation.

1. Go to the KakaoCloud Console and select the Pub/Sub menu.

2. In the Subscription menu, select the subscription to monitor.

3. Click the Monitoring tab.

   Data provided for Pull subscriptions

   Metric name	Unit	Description
   Acknowledged messages per second compared to Pull	count/s	Number of confirmed messages per Pull per second
   Unprocessed messages	count	Number of unprocessed messages
   Rewind timestamp requests for 5 mins	count	Number of rewind requests made in 5 minutes
   Acknowledgement requests per second	count/s	Number of confirmation requests per second
   Streaming Pull requests per second	count/s	Number of Streaming Pull responses per second
   Stored data	bytes	Total size of data stored in the subscription

   Data provided for Push subscriptions

   Metric name	Unit	Description
   Acknowledged messages per second compared to Push	count/s	Number of confirmed messages per Push per second
   Unprocessed messages	count	Number of unprocessed messages
   Rewind timestamp requests for 5 mins	count	Number of rewind requests made in 5 minutes
   Push requests per second	count/s	Number of Push requests per second
   Stored data	bytes	Total size of data stored in the subscription

   Data provided for Object Storage subscriptions

   Metric name	Unit	Description
   Processed messages per second	count/s	Number of messages processed for Object Storage export per second
   Unprocessed messages	count	Number of unprocessed messages
   Rewind timestamp requests for 5 mins	count	Number of rewind requests made in 5 minutes
   Requests for Object Storage export per minute	count/m	Number of API requests for Object Storage export per minute
   Stored data	bytes	Total size of data stored in the subscription