Skip to content

Commit aa93549

Browse files
RoRoJjcirinosclwynerda-codes
authored
feat(messaging): add troubleshooting (#5039)
* feat(messaging): add troubleshooting * Apply suggestions from code review Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com> Co-authored-by: Néda <87707325+nerda-codes@users.noreply.github.com> * Update pages/queues/troubleshooting/approximate-messages-unexpected.mdx --------- Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com> Co-authored-by: Néda <87707325+nerda-codes@users.noreply.github.com>
1 parent f612a1a commit aa93549

File tree

13 files changed

+384
-2
lines changed

13 files changed

+384
-2
lines changed

‎menu/navigation.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2626,6 +2626,10 @@
26262626
],
26272627
"label": "Additional Content",
26282628
"slug": "reference-content"
2629+
},
2630+
{
2631+
"label": "Troubleshooting",
2632+
"slug": "troubleshooting"
26292633
}
26302634
],
26312635
"label": "NATS",
@@ -3347,6 +3351,10 @@
33473351
],
33483352
"label": "Additional Content",
33493353
"slug": "reference-content"
3354+
},
3355+
{
3356+
"label": "Troubleshooting",
3357+
"slug": "troubleshooting"
33503358
}
33513359
],
33523360
"label": "Topics and Events",
@@ -3431,6 +3439,10 @@
34313439
],
34323440
"label": "Additional Content",
34333441
"slug": "reference-content"
3442+
},
3443+
{
3444+
"label": "Troubleshooting",
3445+
"slug": "troubleshooting"
34343446
}
34353447
],
34363448
"label": "Queues",

‎pages/nats/faq.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,8 @@ The **N**eural **A**utonomic **T**ransport **S**ystem, or [NATS](https://nats.io
2828

2929
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).
3030

31-
For full pricing details, see our [dedicated pricing page](https://www.scaleway.com/en/pricing/).
31+
For full pricing details, see our [dedicated pricing page](https://www.scaleway.com/en/pricing/).
32+
33+
## Can I access the NATS monitoring endpoint in order to deploy autoscaling tools?
34+
35+
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.

‎pages/nats/how-to/monitor-nats-cockpit.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,8 @@ To view your metrics with Cockpit, you will use a Grafana dashboard which is acc
4343

4444
You are directed to the NATS dashboard, where you can view all your metrics.
4545

46+
<Message type="tip">
47+
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/)
48+
</Message>
49+
4650

‎pages/nats/troubleshooting/cant-delete-namespace.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
meta:
3+
title: I can't delete my Project due to a Messaging namespace
4+
description: Troubleshoot issues deleting your Messaging namespace and resolve the problem quickly.
5+
content:
6+
h1: I can't delete my Project due to a Messaging namespace
7+
paragraph: Troubleshoot issues deleting your Messaging namespace and resolve the problem quickly.
8+
tags: nats phantom messaging namespace
9+
dates:
10+
validation: 2025-05-28
11+
posted: 2025-05-28
12+
categories:
13+
- data
14+
---
15+
16+
## I can't delete my Project due to a Messaging namespace
17+
18+
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.
19+
20+
### Cause
21+
22+
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.
23+
24+
### Solution
25+
26+
Try the following steps:
27+
28+
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.**
29+
30+
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.

‎pages/nats/troubleshooting/index.mdx‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
meta:
3+
title: NATS - Troubleshooting
4+
description: Find troubleshooting resources for resolving issues with Scaleway NATS.
5+
content:
6+
h1: NATS - Troubleshooting
7+
paragraph: Find troubleshooting resources for resolving issues with Scaleway NATS.
8+
dates:
9+
posted: 2025-05-28
10+
validation: 2025-05-28
11+
categories:
12+
- network
13+
---
14+
15+
<ProductHeader
16+
productName="NATS troubleshooting"
17+
productLogo="nats"
18+
description="Learn how to fix the most common issues with Scaleway NATS."
19+
/>
20+
21+
## Featured Pages
22+
23+
<Grid>
24+
<DefaultCard
25+
title="NATS FAQ"
26+
description="Answers to common questions"
27+
url="/nats/faq/"
28+
label="See more"
29+
/>
30+
<DefaultCard
31+
title="NATS Overview"
32+
description="Understand NATS basics"
33+
url="/nats/reference-content/nats-overview/"
34+
label="See more"
35+
/>
36+
<DefaultCard
37+
title="Using the NATS CLI"
38+
description="Basic commands and tips"
39+
url="/nats/api-cli/nats-cli/"
40+
label="See more"
41+
/>
42+
43+
</Grid>
44+
45+
## NATS troubleshooting pages
46+
47+
- [I can't delete my Project due to a Messaging namespace](/nats/troubleshooting/cant-delete-namespace/)
48+
- [NATS queue reports a higher than expected message volume to Cockpit](/nats/troubleshooting/nats-message-counting/)
49+

‎pages/nats/troubleshooting/nats-message-counting.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
meta:
3+
title: NATS queue is reporting more messages than expected to Scaleway Cockpit
4+
description: Understand apparent NATS queue discrepancies in Scaleway Cockpit with our troubleshooting guide.
5+
content:
6+
h1: NATS queue is reporting more messages than expected to Scaleway Cockpit
7+
paragraph: Understand apparent NATS queue discrepancies in Scaleway Cockpit with our troubleshooting guide.
8+
tags: nats cockpit messages queues
9+
dates:
10+
validation: 2025-05-28
11+
posted: 2025-05-28
12+
categories:
13+
- data
14+
---
15+
16+
## My NATS queue is reporting an unexpectedly large number of messages to Cockpit
17+
18+
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.
19+
20+
### Cause
21+
22+
This is due to the way that the number of messages is displayed on Grafana. The count is accurate, but perhaps not intuitive.
23+
24+
### Solution
25+
26+
You can better understand the volume of messages by considering the following points:
27+
28+
- 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.
29+
- 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.
30+
- 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.

‎pages/queues/troubleshooting/approximate-messages-unexpected.mdx‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
meta:
3+
title: Unexpected value for Approximate Number Of Messages Not Visible
4+
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
5+
content:
6+
h1: Unexpected value for Approximate Number Of Messages Not Visible
7+
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
8+
tags: queues parameter visibility
9+
dates:
10+
validation: 2025-05-28
11+
posted: 2025-05-28
12+
categories:
13+
- integration-services
14+
---
15+
16+
## Unexpected value for Approximate Number Of Messages Not Visible
17+
18+
You may find that the `ChangeMessageVisibility` feature combined with the `ApproximateNumberOfMessagesNotVisible` attribute in Scaleway Queues does not behave as you expect.
19+
20+
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.
21+
22+
## Cause
23+
24+
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.
25+
26+
## Solution
27+
28+
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.

‎pages/queues/troubleshooting/cant-delete-namespace.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
meta:
3+
title: I can't delete my Project due to a Messaging namespace
4+
description: Troubleshoot issues deleting your Messaging namespace and resolve the problem quickly.
5+
content:
6+
h1: I can't delete my Project due to a Messaging namespace
7+
paragraph: Troubleshoot issues deleting your Messaging namespace and resolve the problem quickly.
8+
tags: nats phantom messaging namespace
9+
dates:
10+
validation: 2025-05-28
11+
posted: 2025-05-28
12+
categories:
13+
- data
14+
---
15+
16+
## I can't delete my Project due to a Messaging namespace
17+
18+
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.
19+
20+
### Cause
21+
22+
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.
23+
24+
### Solution
25+
26+
Try the following steps:
27+
28+
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.**
29+
30+
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.

‎pages/queues/troubleshooting/index.mdx‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
meta:
3+
title: Queues - Troubleshooting
4+
description: Find troubleshooting resources for resolving issues with Scaleway Queues.
5+
content:
6+
h1: Queues - Troubleshooting
7+
paragraph: Find troubleshooting resources for resolving issues with Scaleway Queues.
8+
dates:
9+
posted: 2025-05-28
10+
validation: 2025-05-28
11+
categories:
12+
- network
13+
---
14+
15+
<ProductHeader
16+
productName="Queues troubleshooting"
17+
productLogo="sqs"
18+
description="Learn how to fix the most common issues with Scaleway Queues."
19+
/>
20+
21+
## Featured Pages
22+
23+
<Grid>
24+
<DefaultCard
25+
title="Queues FAQ"
26+
description="Answers to common questions"
27+
url="/queues/faq/"
28+
label="See more"
29+
/>
30+
<DefaultCard
31+
title="Queues Overview"
32+
description="Understand Queues basics"
33+
url="/queues/reference-content/queues-overview/"
34+
label="See more"
35+
/>
36+
<DefaultCard
37+
title="Supported actions in Queues"
38+
description="Discover supported actions"
39+
url="/queues/reference-content/queues-support/"
40+
label="See more"
41+
/>
42+
</Grid>
43+
<Grid>
44+
<DefaultCard
45+
title="Connect to AWS CLI"
46+
description="Connect Queues to the AWS-CLI"
47+
url="/queues/api-cli/connect-aws-cli/"
48+
label="See more"
49+
/>
50+
<DefaultCard
51+
title="Use with AWS CLI"
52+
description="Use Queues with the AWS-CLI"
53+
url="/queues/api-cli/queues-aws-cli//"
54+
label="See more"
55+
/>
56+
<DefaultCard
57+
title="Use Python, Go & Node"
58+
description="Use SDKs with Queues"
59+
url="/queues/api-cli/python-node-queues/"
60+
label="See more"
61+
/>
62+
</Grid>
63+
64+
## Queues troubleshooting pages
65+
66+
- [I can't delete my Project due to a Messaging namespace](/queues/troubleshooting/cant-delete-namespace/)
67+
- [Unexpected value for Approximate Number Of Messages Not Visible](/queues/troubleshooting/approximate-messages-unexpected/)
68+

‎pages/topics-and-events/how-to/create-manage-subscriptions.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,8 @@ An HTTP or HTTPS subscription will have a `Pending` status until you **confirm**
8585

8686
2. Click the <Icon name="more" /> icon next to the subscription you wish to confirm, then select **Confirm subscription** from the menu. A pop-up displays with the following message:
8787

88-
```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
88+
```
89+
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
8990
```
9091

9192
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.

0 commit comments

Comments
 (0)