Skip to content

Add new documentation to enable Pulsar PubSub message compression #4990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jslatten wants to merge 2 commits into
base: v1.16
Choose a base branch
from
+35 −0
Open

Add new documentation to enable Pulsar PubSub message compression #4990

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be20829
Add new documentation to enable Pulsar PubSub message compression
jslatten Dec 23, 2025
bd160df
Update daprdocs/content/en/reference/components-reference/supported-p…
jslatten Dec 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions ...docs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,41 @@ curl -X POST http://localhost:3500/v1.0/publish/myPulsar/myTopic?metadata.delive
}'
```

### Enabling message compression

Message compression can reduce message size at the cost of slightly more CPU usage during publishing. Compression is applied at the producer level.

| Compression Type | Description |
|------------------|-------------|
| `none` | No compression (default) |
| `lz4` | LZ4 compression - fast compression/decompression |
| `zlib` | ZLib compression - balanced compression ratio |
| `zstd` | ZSTD compression - high compression ratio |

| Compression Level | Description |
|-------------------|-------------|
| `default` | Default compression level for the selected type |
| `faster` | Prioritizes speed over compression ratio |
| `better` | Prioritizes compression ratio over speed |
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: messagebus
spec:
type: pubsub.pulsar
version: v1
metadata:
- name: host
value: "localhost:6650"
- name: compressionType
value: lz4
- name: compressionLevel
value: faster
```
Comment on lines +235 to +239
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new metadata fields compressionType and compressionLevel should be documented in the "Spec metadata fields" table (around line 74-98) for consistency with how other metadata fields are documented in this file. The table should include entries for both fields with their Required status (N), Details (description, valid values, and defaults), and Examples.

Copilot uses AI. Check for mistakes.
Copy link
Author

@jslatten jslatten Dec 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot open a new pull request to apply changes based on this feedback


> **Note:** The metadata keys `compressionType` and `compressionLevel` are case-sensitive and must be specified exactly as shown. Compression is applied when publishing messages; consumers automatically decompress regardless of settings.

### E2E Encryption

Dapr supports setting public and private key pairs to enable Pulsar's [end-to-end encryption feature](https://pulsar.apache.org/docs/3.0.x/security-encryption/).
Expand Down