Skip to content

Commit 865d1d1

Browse files
Troubleshooting OAuth 2: document initial_frame_max
1 parent 12e880d commit 865d1d1

File tree

3 files changed

+62
-6
lines changed

3 files changed

+62
-6
lines changed

docs/troubleshooting-oauth2.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,34 @@ For example, in the case of AMQP 0-9-1 it would look like this:
5959
2025-03-15 05:55:24.745906+00:00 [error] <0.2771.0> none}}
6060
```
6161

62-
The solution is to reduce the token content size, for example, by dropping certain scopes
63-
that are not used by RabbitMQ or optimizing (simplifying) them.
62+
There are two solutions available:
63+
64+
1. Increase the `initial_frame_max` value in `rabbitmq.conf`, or `rabbit.initial_frame_max` in `advanced.config`
65+
2. Reduce the token content size, for example, by dropping certain scopes that are not used by RabbitMQ or optimizing (simplifying) them
66+
67+
#### Increase the Initial Frame Size Limit
68+
69+
The following `rabbitmq.conf` example increases the initial frame size limit to 8192 bytes (from the default of 4096 bytes):
70+
71+
```ini
72+
initial_frame_max = 8192
73+
```
74+
75+
the same example using `advanced.config`:
76+
77+
```erl
78+
[
79+
{rabbit, [
80+
{initial_frame_max, 8192}
81+
]}
82+
].
83+
```
84+
85+
#### Reduce the JWT Token Payload Size
86+
87+
JWT token size can often be reduced by dropping certain scopes that are not used by RabbitMQ.
88+
Alternatively, a new JWT token can be generated with a more narrow set of scopes
89+
and thus a smaller size.
6490

6591

6692
## Troubleshooting OAuth 2 in the management UI {#management-ui}

versioned_docs/version-3.13/troubleshooting-oauth2.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,12 @@ For example, in the case of AMQP 0-9-1 it would look like this:
5959
2025-03-15 05:55:24.745906+00:00 [error] <0.2771.0> none}}
6060
```
6161

62-
The solution is to reduce the token content size, for example, by dropping certain scopes
63-
that are not used by RabbitMQ or optimizing (simplifying) them.
62+
The only solution available in the 3.13.x series is to reduce size of JWT token,
63+
or [upgrade](./upgrade) to a newer version.
64+
65+
JWT token size can often be reduced by dropping certain scopes that are not used by RabbitMQ.
66+
Alternatively, a new JWT token can be generated with a more narrow set of scopes
67+
and thus a smaller size.
6468

6569

6670
## Troubleshooting OAuth 2 in the management UI {#management-ui}

versioned_docs/version-4.0/troubleshooting-oauth2.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,34 @@ For example, in the case of AMQP 0-9-1 it would look like this:
5959
2025-03-15 05:55:24.745906+00:00 [error] <0.2771.0> none}}
6060
```
6161

62-
The solution is to reduce the token content size, for example, by dropping certain scopes
63-
that are not used by RabbitMQ or optimizing (simplifying) them.
62+
There are two solutions available:
63+
64+
1. Increase the `initial_frame_max` value in `rabbitmq.conf`, or `rabbit.initial_frame_max` in `advanced.config`
65+
2. Reduce the token content size, for example, by dropping certain scopes that are not used by RabbitMQ or optimizing (simplifying) them
66+
67+
#### Increase the Initial Frame Size Limit
68+
69+
The following `rabbitmq.conf` example increases the initial frame size limit to 8192 bytes (from the default of 4096 bytes):
70+
71+
```ini
72+
initial_frame_max = 8192
73+
```
74+
75+
the same example using `advanced.config`:
76+
77+
```erl
78+
[
79+
{rabbit, [
80+
{initial_frame_max, 8192}
81+
]}
82+
].
83+
```
84+
85+
#### Reduce the JWT Token Payload Size
86+
87+
JWT token size can often be reduced by dropping certain scopes that are not used by RabbitMQ.
88+
Alternatively, a new JWT token can be generated with a more narrow set of scopes
89+
and thus a smaller size.
6490

6591

6692
## Troubleshooting OAuth 2 in the management UI {#management-ui}

0 commit comments

Comments
 (0)