Skip to content

Commit a29e00a

Browse files
egeominotticlaude
andcommitted
docs: clarify bunqueue Cloud beta status in configuration page
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent bc1f16f commit a29e00a

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

docs/src/content/docs/guide/configuration.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,21 +132,25 @@ defineConfig({
132132

133133
### `cloud`
134134

135-
[bunqueue Cloud](https://cloud.bunqueue.io) dashboard integration.
135+
Telemetry integration with [bunqueue Cloud](https://cloud.bunqueue.io) — the hosted monitoring dashboard for bunqueue instances. When enabled, your server sends real-time telemetry (queue stats, throughput, latency, worker status) to the cloud dashboard via HTTP snapshots and WebSocket.
136+
137+
:::caution[Beta Coming Soon]
138+
bunqueue Cloud is launching in beta soon. You can already configure the `cloud` section — once the dashboard is live, your instances will automatically connect and start sending telemetry. No code changes needed.
139+
:::
136140

137141
```typescript
138142
defineConfig({
139143
cloud: {
140144
url: 'https://cloud.bunqueue.io',
141145
apiKey: process.env.BUNQUEUE_CLOUD_API_KEY,
142146
instanceName: 'production-1', // Identifies this instance in the dashboard
143-
intervalMs: 15000, // Snapshot interval (default: 15000)
144-
includeJobData: false, // Send job data to cloud (default: false)
147+
intervalMs: 15000, // Telemetry snapshot interval (default: 15000)
148+
includeJobData: false, // Include job payloads in telemetry (default: false)
145149
redactFields: ['password', 'ssn'], // Redact sensitive fields from job data
146150
eventFilter: [], // Event types to forward (empty = all)
147-
useWebSocket: true, // WebSocket channel (default: true)
148-
useHttp: true, // HTTP snapshots (default: true)
149-
remoteCommands: false, // Allow dashboard to send commands (default: false)
151+
useWebSocket: true, // Real-time WebSocket channel (default: true)
152+
useHttp: true, // HTTP telemetry snapshots (default: true)
153+
remoteCommands: false, // Allow dashboard to send commands back (default: false)
150154
bufferSize: 720, // Offline snapshot buffer (default: 720)
151155
circuitBreakerThreshold: 5, // Failures before circuit opens (default: 5)
152156
circuitBreakerResetMs: 60000, // Circuit breaker reset time (default: 60000)

0 commit comments

Comments
 (0)