Skip to main content

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.

info

A maximum of 13 subscriptions per project can be created. (See Pub/Sub quota)

  1. Go to KakaoCloud console > Analytics > Pub/Sub.
  2. In the Subscription menu, click the [Create subscription] button.
  3. Enter the subscription details and click the [Create] button.
Basic settings
ItemDescription
NameSubscription name
Select topicTopic to bind the subscription
TypeDetailed settings by type
Pull: User requests message delivery
Push: Pub/Sub pushes messages
Object Storage: Delivers messages to a storage bucket
Message retentionRetention period for messages
- Range: 10 minutes to 7 days
- Must be equal to or less than topic retention period
Detailed settings by type

Pull

ItemDescription
Retry countIf not acknowledged within the wait time, specifies how many times to retry
- Set count: 1–100
- Unlimited: Infinite retries
Ack wait timeTime to wait for message acknowledgment
- Range: 10–600 seconds

Push

ItemDescription
Endpoint URLURL that receives messages
- Protocol: HTTP/HTTPS
- Security group setup required
Retry countSame as above
Ack wait timeSame as above

Object Storage

ItemDescription
BucketSelect a bucket from Object Storage (must be pre-created)
File formatFormat 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 intervalFrequency 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 countNumber of channels for exporting messages
- Range: 1–16
- Default: 1
⚠️ Actual file count may differ
info

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

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

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

    FieldDescription
    FilterFilter or search subscriptions
    - Filters are combined with AND
    - Keywords use OR
    NameName assigned by the user
    StatusSubscription status
    TypePull / Push / Object Storage
    Topic nameName of the topic
    Retention periodRetention period for the subscription
    Ack wait timeTime to wait for acknowledgment
    CreatorUser who created the subscription
    [More]Modify / Delete / Rewind timestamp

View subscription details

  1. Go to KakaoCloud console > Analytics > Pub/Sub menu.

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

  3. Check the information on the subscription detail page.

    Basic information

    ItemDescription
    Summary- Type
    - Status
    - Export status
    - Retention period
    NameSubscription name
    IDUnique ID
    RetentionMessage retention period
    Unacknowledged countNumber of messages not acknowledged
    * Retry-exceeded messages are excluded
    CreatorWho created it
    Created atTimestamp
    [Buttons]Modify / Delete / Rewind timestamp / Start export / Stop export

    Type-specific details

    See Detailed settings by type

Modify subscription

info

Retention period can currently only be extended. Reducing retention will be supported in the future.

  1. Go to KakaoCloud console > Analytics > Pub/Sub menu.

  2. In the Subscription menu, click the [More] icon and select Modify.

  3. In the Modify subscription screen, modify the subscription settings and click the [Save] button.

    Common

    ItemDescription
    Retention10 minutes to 7 days
    Must be ≤ topic retention period

    Pull-specific

    ItemDescription
    Ack wait time10–600 seconds
    Retry countSame as in creation

    Push-specific

    ItemDescription
    Endpoint URLHTTP/HTTPS endpoint
    Ack wait time10–600 seconds
    Retry countAs above

    Object Storage-specific

    ItemDescription
    BucketBucket to deliver messages
    File formatOnly Text is supported
    File prefix (optional)Same rules as in creation
    File suffix (optional)Same rules as in creation
    Max batching intervalMin: 1, Max: 10, Default: 5 (in minutes)
    ⚠️ May not apply immediately if there are pending messages
    Export channel count1–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.

info

Cannot rewind to a point before the topic was created.

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

Delete subscription

info

Deleted subscriptions cannot be recovered.

  1. Go to KakaoCloud console > Analytics > Pub/Sub menu.
  2. In the Subscription menu, click the [More] icon for the subscription you want to delete, then select Delete.
  3. 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.

info

Some delay may occur in aggregating unacknowledged messages. Retry-exceeded messages are excluded.

  1. Go to KakaoCloud console > Pub/Sub menu.

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

  3. Select the Monitoring tab.

    CategoryDescription
    Data rangeTime range displayed in the monitoring graph
    - Options: 1 hour (default) / 3 hours / 12 hours / 1 day / 7 days
    View modeSets the monitoring graph view layout
    - Options: 1-column, 2-column, 3-column
    Auto refresh intervalSets the auto-refresh interval
    - Options: Do not auto-refresh (default) / 10 seconds / 30 seconds / 1 minute / 5 minutes
    Manual refreshClick to manually refresh monitoring results

    Metrics by type

    Pull

    MetricUnitDescription
    Acked messages per secondcount/sMessages acknowledged per second
    Unacked messagescountCount of unprocessed messages
    Rewind requests in 5 mincountNumber of rewind requests
    Ack requests per secondcount/sAck requests per second
    Streaming Pull responsescount/sStreaming Pull responses per second
    Stored databytesTotal stored data in the subscription

    Push

    MetricUnitDescription
    Acked messages per secondcount/sMessages acknowledged per second
    Unacked messagescountCount of unprocessed messages
    Rewind requests in 5 mincountNumber of rewind requests
    Ack requests per secondcount/sAck requests per second
    Push requests per secondcount/sPush requests per second
    Stored databytesTotal stored data in the subscription

    Object Storage

    MetricUnitDescription
    Processed messages per secondcount/sMessages exported per second
    Unacked messagescountCount of unprocessed messages
    Rewind requests in 5 mincountNumber of rewind requests
    Export requests per minutecount/mAPI export calls to Object Storage
    Stored databytesTotal stored data in the subscription