PubSub Subscriptions Should Have Set Expiration For Messages
More Info:
Ensure that PubSub Subscriptions have set expirationRisk Level
LowAddress
Operational Excellence, Cost OptimizationCompliance Standards
CBPTriage and Remediation
Remediation
Using Console
Using Console
To remediate the misconfiguration of PubSub Subscriptions not having set expiration for messages in GCP using GCP console, you can follow the below steps:
- Open the GCP console and navigate to the Pub/Sub section.
- Select the Subscription that you want to remediate.
- Click on the “Edit” button for the selected Subscription.
- In the “Edit Subscription” window, scroll down to the “Message retention duration” section.
- Set the message retention duration to the desired value. This value should be based on how frequently the Subscription is polled and how long it takes to process the messages.
- Click on the “Save” button to save the changes.
Using CLI
Using CLI
To remediate the issue of PubSub subscriptions not having set expiration for messages in GCP using GCP CLI, you can follow the below steps:
- Open the Cloud Shell in your GCP console.
-
Run the following command to list all the subscriptions in your project:
- Choose the subscription for which you want to set the expiration time for messages.
-
Run the following command to set the expiration time for messages in the chosen subscription:
Replace
<subscription-name>with the name of the chosen subscription and<duration>with the duration for which you want to set the expiration time for messages. The duration should be in the format ofn[d|h|m|s]wherenis the number of days, hours, minutes or seconds. For example, to set the expiration time for messages in a subscription namedmy-subscriptionto 7 days, run the following command: -
Verify that the expiration time for messages has been set for the chosen subscription by running the following command:
Replace
<subscription-name>with the name of the chosen subscription. The output should display the expiration time for messages in the subscription.
Using Python
Using Python
To remediate the issue of PubSub subscriptions not having set expiration for messages in GCP using Python, you can follow the below steps:
-
First, you need to identify the subscription(s) that do not have set expiration for messages. You can use the following command to list all subscriptions in a project:
This will give you a list of all subscriptions in your project.
-
Once you have identified the subscription(s) that need to be remediated, you can use the Google Cloud Pub/Sub client library for Python to set the message expiration time for each subscription. Here is a sample Python script that sets the message expiration time for a subscription:
Replace
<PROJECT_ID>and<SUBSCRIPTION_NAME>with your project ID and subscription name respectively. -
Run the Python script to set the message expiration time for the subscription(s) that need to be remediated.
This will update the subscription(s) with the message expiration time and print the updated subscription information.