Create and manage subscription

Create subscription

Messages published to a topic can be received via subscriptions. Subscriptions support three message delivery types: Pull, Push, and Object Storage. The following describes how to create a subscription in the Pub/Sub service.

info

Each project can create up to 10 subscriptions. (View Pub/Sub quota)

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

2. In the Subscription menu, click the [Create subscription] button.

3. In the Create subscription form, enter the required information and click the [Create] button.

   Basic settings

   Item	Description
   Name	Set subscription name
   Select topic	Select topic to associate with the subscription
   Type	See detailed settings by type Pull: User requests message delivery Push: Pub/Sub sends messages to user-defined endpoint Object Storage: Messages are sent to a storage bucket
   Subscription message retention period	Set retention period for messages - Range: 10 minutes to 7 days - Must be equal to or less than the topic’s retention period

Detailed settings by type

Pull type

Item	Description
Max delivery attempts	Number of times to retry delivery if no response within wait time - Specify attempts: 1–100 - Unlimited retries: retry indefinitely
Acknowledgment wait time	Time to wait for message acknowledgment - Range: 10–600 seconds (10 minutes)

Push type

Item	Description
Endpoint URL	Enter the URL to receive published messages  - Protocol: HTTP/HTTPS  - Security group inbound rules must be configured
Message delivery format	Configure JSON wrapping and metadata handling - Default delivery: JSON format containing message data and metadata - Unwrapped payload: Only the decoded message data is sent in the body; metadata inclusion can be configured additionally    ㄴ Include metadata: Can be configured when the unwrapped payload option is selected
Max delivery attempts	Number of times to retry delivery if no response within wait time - Specify attempts: 1–100 - Unlimited retries: retry indefinitely
Acknowledgment wait time	Time to wait for message acknowledgment - Range: 10–600 seconds (10 minutes)

Object Storage type

Item	Description
Bucket	Select Object Storage bucket to receive messages ⚠️ Bucket must be pre-created in Object Storage
File format	Output file format stored in bucket - Text: Currently only Text format is supported
File prefix (optional)	Adds a prefix to all output files - Certain characters (\ : * ? ” < > |) and leading / are not allowed - Consecutive slashes (//) are not allowed ⚠️ Total length of prefix and suffix must not exceed 200 bytes
File suffix (optional)	Adds a suffix to all output files - Certain characters (\ : * ? ” < > |) are not allowed - Consecutive slashes (//) are not allowed
Max batch duration	Time interval for saving files to bucket - Min: 1 min - Max: 10 min - Default: 5 min ⚠️ At least one file is generated per interval. Files may be generated before interval ends.
Export channel count	Number of channels to export messages to Object Storage - Adjust based on message volume - Min: 1 - Max: 16 - Default: 1 ⚠️ Number of channels does not equal number of output files

info

When creating an Object Storage subscription, an export channel is automatically activated.
Use the [Start export] / [Stop export] options in the subscription detail page to resume or stop export to the bucket.

Manage subscription

Describes how to manage subscriptions in the Pub/Sub service.

View subscription list

Check the list of existing subscriptions and their basic information.

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

2. In the Subscription menu, check the subscription list.

   Item	Description
   Filter	Filter or search subscriptions by keyword - Selected filters = AND condition - Keyword = OR condition
   Name	Name of the subscription set by user
   Status	Subscription status
   Type	Type of subscription - Pull: User requests message delivery - Push: Pub/Sub sends messages to endpoint - Object Storage: Messages sent to bucket
   Topic name	Name of topic associated with the subscription
   Message retention	Subscription message retention period
   Acknowledgment wait time	Time to wait for message acknowledgment
   Export status	Export channel status (Object Storage only)
   Creator	User who created the subscription
   [Button info]	[Edit]: Modify subscription settings [Delete]: Delete subscription [Rewind]: Rewind subscription [Export settings]: Configure Object Storage export [Create subscription]: Create new subscription
   [More options]	[Edit], [Delete], [Rewind], [Start export], [Stop export]

View subscription details

Check detailed information for a subscription.

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

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

3. Review information on the subscription detail page.

   Basic information

   Item	Description
   Summary	- Type: Subscription type - Status: Subscription status - Export status: Whether export channel is active - Retention: Message retention period
   Subscription name	Name of the subscription
   Subscription ID	Unique ID of the subscription
   Message retention	Message retention period
   Unprocessed messages	Count of unprocessed messages *Aggregation may take time; messages that exceed the max delivery attempts are excluded.
   Creator	User who created the subscription
   Created at	Timestamp when the subscription was created
   [Button info]	[Edit], [Delete], [Rewind], [Start export], [Stop export]

   Type-specific settings

   Settings vary by subscription type. See Detailed settings by type.

Modify subscription

Modify detailed subscription settings.

info

Currently, subscription retention period can only be extended. Reducing the period will be supported in a future update.

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

2. In the Subscription menu, click [More options] > Edit.

3. In the Edit subscription form, update settings and click [Save].

   Common

   Item	Description
   Message retention	Period to retain subscription messages - Range: 10 minutes to 7 days * Must not exceed topic’s retention period

   Pull-type settings

   Item	Description
   Acknowledgment wait time	Time to wait for message acknowledgment - Range: 10–600 seconds
   Max delivery attempts	Number of retry attempts if no acknowledgment - Specify: 1–100 - Unlimited: Retry indefinitely

   Push-type settings

   Item	Description
   Endpoint URL	Endpoint URL set when creating Push subscription  - Protocol: HTTP/HTTPS
   Message delivery format	Configure JSON wrapping and metadata handling - Default delivery: JSON format containing message data and metadata - Unwrapped payload: Only the decoded message data is sent in the body; metadata inclusion can be configured additionally    ㄴ Include metadata: Can be configured when the unwrapped payload option is selected
   Acknowledgment wait time	Time to wait for message acknowledgment - Range: 10–600 seconds
   Max delivery attempts	Number of retry attempts if no acknowledgment - Specify: 1–100 - Unlimited: Retry indefinitely

   Object Storage-type settings

   Item	Description
   Bucket	Select Object Storage bucket for message delivery
   File format	Output file format - Currently only Text is supported
   File prefix (optional)	Adds prefix to output files - Invalid: \ : * ? ” < > |, leading /, // ⚠️ Total of prefix + suffix must not exceed 200 bytes
   File suffix (optional)	Adds suffix to output files - Invalid: \ : * ? ” < > |, //
   Max batch duration	Interval to store files to bucket - Min: 1 min - Max: 10 min - Default: 5 min   ⚠️ May not apply immediately if unprocessed messages exist. Recommend modifying after queue is clear.
   Export channel count	Number of export channels - Min: 1, Max: 16, Default: 1

Rewind timestamp

Rewinds the subscription to a specific point in time, allowing replay of all messages from that time onward.
Messages that expired due to topic retention settings cannot be recovered.

info

Rewind time cannot be set to a time before the associated topic was created.

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

Delete subscription

Delete a subscription that is no longer needed.

info

Deleted subscriptions cannot be recovered.

1. Go to KakaoCloud Console > Analytics > Pub/Sub.
2. In the Subscription menu, click [More options] > Delete on the target subscription.
3. In the Delete subscription popup, enter the subscription name and click [Delete].

Monitor subscription

Monitor the selected subscription’s metrics.

info

During subscription monitoring, aggregation of unprocessed messages may take time. Messages that exceed the maximum number of processing attempts are excluded.

1. Go to KakaoCloud Console > Pub/Sub.

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

3. Click the Monitoring tab.

   Item	Description
   Data range	Time range displayed in monitoring graph - Options: 1 hour (default) / 3 hours / 12 hours / 1 day / 7 days
   View mode	Layout options for graph view - 1-column, 2-column, 3-column
   Auto-refresh interval	Set auto-refresh rate - Options: No auto-refresh (default) / 10s / 30s / 1min / 5min
   Manual refresh	Click to manually refresh monitoring data

   PULL subscription metrics

   Metric name	Unit	Description
   Acked messages per second (pull)	count/s	Number of acknowledged messages per second
   Unprocessed messages	count	Number of messages not yet acknowledged
   Rewind requests (5 min)	count	Number of rewind requests within 5 minutes
   Ack requests per second	count/s	Acknowledgment request rate
   Streaming pull responses per second	count/s	Streaming pull response rate
   Retained data	bytes	Total size of retained data in subscription

   PUSH subscription metrics

   Metric name	Unit	Description
   Acked messages per second (push)	count/s	Number of acknowledged messages per second
   Unprocessed messages	count	Number of messages not yet acknowledged
   Rewind requests (5 min)	count	Number of rewind requests within 5 minutes
   Ack requests per second	count/s	Acknowledgment request rate
   Push requests per second	count/s	Push request rate
   Retained data	bytes	Total size of retained data in subscription

   Object Storage subscription metrics

   Metric name	Unit	Description
   Processed messages per second	count/s	Number of export-processed messages per second
   Unprocessed messages	count	Number of messages not yet exported
   Rewind requests (5 min)	count	Number of rewind requests within 5 minutes
   Export requests per minute	count/m	Number of export API requests per minute
   Retained data	bytes	Total size of retained data in subscription