diff --git a/menu/navigation.json b/menu/navigation.json index 703fa3228a..7d48e8856e 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -2626,6 +2626,10 @@ ], "label": "Additional Content", "slug": "reference-content" + }, + { + "label": "Troubleshooting", + "slug": "troubleshooting" } ], "label": "NATS", @@ -3347,6 +3351,10 @@ ], "label": "Additional Content", "slug": "reference-content" + }, + { + "label": "Troubleshooting", + "slug": "troubleshooting" } ], "label": "Topics and Events", @@ -3431,6 +3439,10 @@ ], "label": "Additional Content", "slug": "reference-content" + }, + { + "label": "Troubleshooting", + "slug": "troubleshooting" } ], "label": "Queues", diff --git a/pages/nats/faq.mdx b/pages/nats/faq.mdx index 254cedb8a5..e21d7fe747 100644 --- a/pages/nats/faq.mdx +++ b/pages/nats/faq.mdx @@ -28,4 +28,8 @@ The **N**eural **A**utonomic **T**ransport **S**ystem, or [NATS](https://nats.io Billing is based on [message volume](/nats/concepts/#message-volume) (the total sum of each message's size going through NATS) and [message persistence](/nats/concepts/#message-persistence) (the total amount of data stored * duration). -For full pricing details, see our [dedicated pricing page](https://www.scaleway.com/en/pricing/). \ No newline at end of file +For full pricing details, see our [dedicated pricing page](https://www.scaleway.com/en/pricing/). + +## Can I access the NATS monitoring endpoint in order to deploy autoscaling tools? + +The monitoring endpoint is not available on Scaleway NATS. Although you can access your account monitoring information through [Scaleway Cockpit](/cockpit/), this may not be usable by third-party autoscaling tools. As a workaround, you may consider coding a solution whereby your worker monitors consumption information via the metadata on each received message and provides this information to your scaling logic. \ No newline at end of file diff --git a/pages/nats/how-to/monitor-nats-cockpit.mdx b/pages/nats/how-to/monitor-nats-cockpit.mdx index d3836fb723..f36990c96e 100644 --- a/pages/nats/how-to/monitor-nats-cockpit.mdx +++ b/pages/nats/how-to/monitor-nats-cockpit.mdx @@ -43,4 +43,8 @@ To view your metrics with Cockpit, you will use a Grafana dashboard which is acc You are directed to the NATS dashboard, where you can view all your metrics. + +If you are having trouble understanding the reporting of your NATS message count in Cockpit, see our dedicated [troubleshooting guide](/nats/troubleshooting/nats-message-counting/) + + diff --git a/pages/nats/troubleshooting/cant-delete-namespace.mdx b/pages/nats/troubleshooting/cant-delete-namespace.mdx new file mode 100644 index 0000000000..6c8cb272c4 --- /dev/null +++ b/pages/nats/troubleshooting/cant-delete-namespace.mdx @@ -0,0 +1,30 @@ +--- +meta: + title: I can't delete my Project due to a Messaging namespace + description: Troubleshoot issues deleting your Messaging namespace and resolve the problem quickly. +content: + h1: I can't delete my Project due to a Messaging namespace + paragraph: Troubleshoot issues deleting your Messaging namespace and resolve the problem quickly. +tags: nats phantom messaging namespace +dates: + validation: 2025-05-28 + posted: 2025-05-28 +categories: + - data +--- + +## I can't delete my Project due to a Messaging namespace + +You may be trying to delete a Scaleway [Project](/organizations-and-projects/concepts/#project), and encounter an error message telling you that the Project cannot be deleted due to an existing Messaging namespace. + +### Cause + +The Project is still detecting a legacy namespace resource, dating from the time before NATS, Queues and Topics and Events were split into three separate products and the namespace resource was retired. + +### Solution + +Try the following steps: + +1. In the Scaleway console, check that you have no remaining resources in either of the [NATS](https://console.scaleway.com/nats/), [Queues](https://console.scaleway.com/queues/), or [Topics and Events](https://console.scaleway.com/topics-events/) sections. **Make sure to check for resources in all regions by using the regional drop-down menu.** + +2. If you have deleted all resources for these three products and the problem persists, [open a support ticket](https://console.scaleway.com/support/tickets/create) to request manual deletion of the phantom namespace. \ No newline at end of file diff --git a/pages/nats/troubleshooting/index.mdx b/pages/nats/troubleshooting/index.mdx new file mode 100644 index 0000000000..b8ecb05a2a --- /dev/null +++ b/pages/nats/troubleshooting/index.mdx @@ -0,0 +1,49 @@ +--- +meta: + title: NATS - Troubleshooting + description: Find troubleshooting resources for resolving issues with Scaleway NATS. +content: + h1: NATS - Troubleshooting + paragraph: Find troubleshooting resources for resolving issues with Scaleway NATS. +dates: + posted: 2025-05-28 + validation: 2025-05-28 +categories: + - network +--- + + + +## Featured Pages + + + + + + + + +## NATS troubleshooting pages + +- [I can't delete my Project due to a Messaging namespace](/nats/troubleshooting/cant-delete-namespace/) +- [NATS queue reports a higher than expected message volume to Cockpit](/nats/troubleshooting/nats-message-counting/) + diff --git a/pages/nats/troubleshooting/nats-message-counting.mdx b/pages/nats/troubleshooting/nats-message-counting.mdx new file mode 100644 index 0000000000..726075530e --- /dev/null +++ b/pages/nats/troubleshooting/nats-message-counting.mdx @@ -0,0 +1,30 @@ +--- +meta: + title: NATS queue is reporting more messages than expected to Scaleway Cockpit + description: Understand apparent NATS queue discrepancies in Scaleway Cockpit with our troubleshooting guide. +content: + h1: NATS queue is reporting more messages than expected to Scaleway Cockpit + paragraph: Understand apparent NATS queue discrepancies in Scaleway Cockpit with our troubleshooting guide. +tags: nats cockpit messages queues +dates: + validation: 2025-05-28 + posted: 2025-05-28 +categories: + - data +--- + +## My NATS queue is reporting an unexpectedly large number of messages to Cockpit + +You may be viewing your NATS queue's metrics in [Scaleway Cockpit](/nats/how-to/monitor-nats-cockpit/), and observe an unexpectedly large volume of messages, which appears higher than your expected usage. + +### Cause + +This is due to the way that the number of messages is displayed on Grafana. The count is accurate, but perhaps not intuitive. + +### Solution + +You can better understand the volume of messages by considering the following points: + +- The message count reported by Grafana includes not only published messages, but also requests and replies between clients and the NATS server, such as publish requests, pull requests, and replies. +- For example, when a client sends a `nats stream ls` request, this counts as 1 message IN (the request) and 1 message OUT (the reply), even if no actual messages are being published or consumed. +- Additionally, the message count can increase due to consumer pull actions, even if there are no new messages published. This is because each pull request is counted as a message, regardless of whether any messages are actually returned. \ No newline at end of file diff --git a/pages/queues/troubleshooting/approximate-messages-unexpected.mdx b/pages/queues/troubleshooting/approximate-messages-unexpected.mdx new file mode 100644 index 0000000000..e8ce71d6a3 --- /dev/null +++ b/pages/queues/troubleshooting/approximate-messages-unexpected.mdx @@ -0,0 +1,28 @@ +--- +meta: + title: Unexpected value for Approximate Number Of Messages Not Visible + description: Understand why you may observe unexpected behavior from the Approximate Number Of Messages Not Visible attribute when used with the Change Message Visibility feature +content: + h1: Unexpected value for Approximate Number Of Messages Not Visible + paragraph: Understand why you may observe unexpected behavior from the Approximate Number Of Messages Not Visible attribute when used with the Change Message Visibility feature +tags: queues parameter visibility +dates: + validation: 2025-05-28 + posted: 2025-05-28 +categories: + - integration-services +--- + +## Unexpected value for Approximate Number Of Messages Not Visible + +You may find that the `ChangeMessageVisibility` feature combined with the `ApproximateNumberOfMessagesNotVisible` attribute in Scaleway Queues does not behave as you expect. + +When using `ChangeMessageVisibility` to set a `VisibilityTimeout` of `0`, you force the queue to requeue the message in question, making it immediately available for other consumers to process. You imagine this should have a direct effect on the `ApproximateNumberOfMessagesNotVisible` attribute, but the value for that attribute does not change. + +## Cause + +The cause of the problem is that the underlying message broker used by Scaleway Queues does not provide the necessary information to set an absolutely correct value for the `ApproximateNumberOfMessagesNotVisible` attribute. As a result, this attribute does not accurately reflect the number of messages that are not visible. + +## Solution + +We can confirm that the `ChangeMessageVisibility` feature works properly, and the name of the `ApproximateNumberOfMessagesNotVisible` attribute may be misleading. That said, the attribute name contains the qualifier "Approximate" for a reason, and as such its value may not always reflect the actual number of messages that are not visible. \ No newline at end of file diff --git a/pages/queues/troubleshooting/cant-delete-namespace.mdx b/pages/queues/troubleshooting/cant-delete-namespace.mdx new file mode 100644 index 0000000000..6c8cb272c4 --- /dev/null +++ b/pages/queues/troubleshooting/cant-delete-namespace.mdx @@ -0,0 +1,30 @@ +--- +meta: + title: I can't delete my Project due to a Messaging namespace + description: Troubleshoot issues deleting your Messaging namespace and resolve the problem quickly. +content: + h1: I can't delete my Project due to a Messaging namespace + paragraph: Troubleshoot issues deleting your Messaging namespace and resolve the problem quickly. +tags: nats phantom messaging namespace +dates: + validation: 2025-05-28 + posted: 2025-05-28 +categories: + - data +--- + +## I can't delete my Project due to a Messaging namespace + +You may be trying to delete a Scaleway [Project](/organizations-and-projects/concepts/#project), and encounter an error message telling you that the Project cannot be deleted due to an existing Messaging namespace. + +### Cause + +The Project is still detecting a legacy namespace resource, dating from the time before NATS, Queues and Topics and Events were split into three separate products and the namespace resource was retired. + +### Solution + +Try the following steps: + +1. In the Scaleway console, check that you have no remaining resources in either of the [NATS](https://console.scaleway.com/nats/), [Queues](https://console.scaleway.com/queues/), or [Topics and Events](https://console.scaleway.com/topics-events/) sections. **Make sure to check for resources in all regions by using the regional drop-down menu.** + +2. If you have deleted all resources for these three products and the problem persists, [open a support ticket](https://console.scaleway.com/support/tickets/create) to request manual deletion of the phantom namespace. \ No newline at end of file diff --git a/pages/queues/troubleshooting/index.mdx b/pages/queues/troubleshooting/index.mdx new file mode 100644 index 0000000000..74658bc9f3 --- /dev/null +++ b/pages/queues/troubleshooting/index.mdx @@ -0,0 +1,68 @@ +--- +meta: + title: Queues - Troubleshooting + description: Find troubleshooting resources for resolving issues with Scaleway Queues. +content: + h1: Queues - Troubleshooting + paragraph: Find troubleshooting resources for resolving issues with Scaleway Queues. +dates: + posted: 2025-05-28 + validation: 2025-05-28 +categories: + - network +--- + + + +## Featured Pages + + + + + + + + + + + + +## Queues troubleshooting pages + +- [I can't delete my Project due to a Messaging namespace](/queues/troubleshooting/cant-delete-namespace/) +- [Unexpected value for Approximate Number Of Messages Not Visible](/queues/troubleshooting/approximate-messages-unexpected/) + diff --git a/pages/topics-and-events/how-to/create-manage-subscriptions.mdx b/pages/topics-and-events/how-to/create-manage-subscriptions.mdx index 391b6e0f5a..f64809fba5 100644 --- a/pages/topics-and-events/how-to/create-manage-subscriptions.mdx +++ b/pages/topics-and-events/how-to/create-manage-subscriptions.mdx @@ -85,7 +85,8 @@ An HTTP or HTTPS subscription will have a `Pending` status until you **confirm** 2. Click the icon next to the subscription you wish to confirm, then select **Confirm subscription** from the menu. A pop-up displays with the following message: - ```A subscription confirmation message has been sent to the subscription endpoint. Retrieve the SubscribeURL value from the message and enter it in the box below. This is a necessary step to start receiving messages from the topic + ``` + A subscription confirmation message has been sent to the subscription endpoint. Retrieve the SubscribeURL value from the message and enter it in the box below. This is a necessary step to start receiving messages from the topic ``` 3. Retrieve the confirmation message that Scaleway Topics and Events sent to your endpoint (delivered as an `HTTP POST` request), and extract the `SubscribeURL` from the message payload. diff --git a/pages/topics-and-events/troubleshooting/cant-confirm-subscription.mdx b/pages/topics-and-events/troubleshooting/cant-confirm-subscription.mdx new file mode 100644 index 0000000000..a84f7e7b95 --- /dev/null +++ b/pages/topics-and-events/troubleshooting/cant-confirm-subscription.mdx @@ -0,0 +1,28 @@ +--- +meta: + title: I'm having trouble confirming a subscription to a topic + description: Troubleshoot various issues with confirming a subscription to a topics with Scaleway Topics and Events +content: + h1: I'm having trouble confirming a subscription to a topic + paragraph: Troubleshoot various issues with confirming a subscription to a topics with Scaleway Topics and Events +tags: topics-and-events confirm subscription subsribeurl +dates: + validation: 2025-05-28 + posted: 2025-05-28 +categories: + - integration-services +--- + +## I'm having trouble confirming a subscription to a topic + +When you create an HTTP or HTTPS subscription to a topic, this subscription will have a `Pending` status until you **confirm** it. This is essential to start receiving messages. + +## Problem: You don't know how to confirm the subscription + +Ensure you have followed the steps outlined on our [dedicated how-to page](/topics-and-events/how-to/create-manage-subscriptions/#how-to-confirm-an-http-or-https-subscription) for confirming a subscription. You must retrieve the message Scaleway sent to your endpoint, and provide us with the `SubscribeURL` to confirm the subscription. + +## Problem: No message received from Scaleway to confirm the subscription + +You may find that you are not receiving the expected message from Scaleway (delivered as an HTTP POST request) sent to confirm the subscription. + +The Scaleway POST request may not include an `ORIGIN` header. Ensure that your framework can receive a message without an origin header without triggering a 403 error, and retry. \ No newline at end of file diff --git a/pages/topics-and-events/troubleshooting/cant-delete-namespace.mdx b/pages/topics-and-events/troubleshooting/cant-delete-namespace.mdx new file mode 100644 index 0000000000..6a1e1994c1 --- /dev/null +++ b/pages/topics-and-events/troubleshooting/cant-delete-namespace.mdx @@ -0,0 +1,30 @@ +--- +meta: + title: I can't delete my Project due to a Messaging namespace + description: Troubleshoot issues deleting your Messaging namespace and resolve the problem quickly. +content: + h1: I can't delete my Project due to a Messaging namespace + paragraph: Troubleshoot issues deleting your Messaging namespace and resolve the problem quickly. +tags: phantom messaging namespace +dates: + validation: 2025-05-28 + posted: 2025-05-28 +categories: + - data +--- + +## I can't delete my Project due to a Messaging namespace + +You may be trying to delete a Scaleway [Project](/organizations-and-projects/concepts/#project), and encounter an error message telling you that the Project cannot be deleted due to an existing Messaging namespace. + +### Cause + +The Project is still detecting a legacy namespace resource, dating from the time before NATS, Queues and Topics and Events were split into three separate products and the namespace resource was retired. + +### Solution + +Try the following steps: + +1. In the Scaleway console, check that you have no remaining resources in either of the [NATS](https://console.scaleway.com/nats/), [Queues](https://console.scaleway.com/queues/), or [Topics and Events](https://console.scaleway.com/topics-events/) sections. **Make sure to check for resources in all regions by using the regional drop-down menu.** + +2. If you have deleted all resources for these three products and the problem persists, [open a support ticket](https://console.scaleway.com/support/tickets/create) to request manual deletion of the phantom namespace. \ No newline at end of file diff --git a/pages/topics-and-events/troubleshooting/index.mdx b/pages/topics-and-events/troubleshooting/index.mdx new file mode 100644 index 0000000000..a89aae3464 --- /dev/null +++ b/pages/topics-and-events/troubleshooting/index.mdx @@ -0,0 +1,68 @@ +--- +meta: + title: Topics and Events - Troubleshooting + description: Find troubleshooting resources for resolving issues with Scaleway Topics and Events. +content: + h1: Topics and Events - Troubleshooting + paragraph: Find troubleshooting resources for resolving issues with Scaleway Topics and Events. +dates: + posted: 2025-05-28 + validation: 2025-05-28 +categories: + - network +--- + + + +## Featured Pages + + + + + + + + + + + + +## Topics and Events troubleshooting pages + +- [I can't delete my Project due to a Messaging namespace](/topics-and-events/troubleshooting/cant-delete-namespace/) +- [I'm having trouble confirming a subscription](/topics-and-events/troubleshooting/cant-confirm-subscription/) +