PubSub Subscriptions Should Retain Acknowledged Messages For Record Keeping
More Info:
Ensure that PubSub Subscriptions retain acknowledged messagesRisk Level
LowAddress
Operational Excellence, ReliabilityCompliance Standards
CBPTriage and Remediation
Remediation
Using Console
Using Console
To remediate the misconfiguration “PubSub Subscriptions Should Retain Acknowledged Messages For Record Keeping” for GCP using GCP console, follow these steps:
- Open the Google Cloud Console and navigate to the Pub/Sub page.
- Select the subscription that you want to configure.
- Click on the “Edit” button at the top of the page.
- In the “Message retention duration” section, select “Custom”.
- Enter the number of days that you want to retain acknowledged messages.
- Click on the “Save” button to apply the changes.
Using CLI
Using CLI
To remediate the misconfiguration “PubSub Subscriptions Should Retain Acknowledged Messages For Record Keeping” in GCP using GCP CLI, follow the below steps:Note: Replace
- Open the Cloud Shell in the GCP console.
- Run the following command to list all the subscriptions in the project:
- Identify the subscription that needs to be remediated.
- Run the following command to update the subscription to retain acknowledged messages for 7 days:
<subscription-name> with the name of the subscription that needs to be remediated.
5. Verify the subscription has been updated by running the following command:- Check the “ackDeadlineSeconds” field in the output of the above command. It should be set to 604800 (7 days).
Using Python
Using Python
To remediate the misconfiguration “PubSub Subscriptions Should Retain Acknowledged Messages For Record Keeping” for GCP using Python, you can follow the below steps:By following these steps, you can remediate the misconfiguration “PubSub Subscriptions Should Retain Acknowledged Messages For Record Keeping” for GCP using Python.
- First, you need to enable the retention policy for the subscription. You can do this by setting the
expiration_policyproperty of the subscription object to a value greater than zero. This will ensure that the messages that have been acknowledged are retained for a certain period of time.
- Next, you need to modify your code to handle the retained messages. You can do this by setting the
return_immediatelyparameter of thepullmethod toFalse. This will ensure that the method waits for the server to return any retained messages before returning.
- Finally, you need to acknowledge the retained messages after processing them. You can do this by calling the
acknowledgemethod of theSubscriberClientobject and passing in the message IDs of the retained messages.