Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aamalev/hsmq
Horizontal Scalable Message Queue Broker
https://github.com/aamalev/hsmq
mq rust
Last synced: about 2 months ago
JSON representation
Horizontal Scalable Message Queue Broker
- Host: GitHub
- URL: https://github.com/aamalev/hsmq
- Owner: aamalev
- License: apache-2.0
- Created: 2024-04-20T15:03:31.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-11-10T23:48:53.000Z (about 2 months ago)
- Last Synced: 2024-11-11T00:27:34.443Z (about 2 months ago)
- Topics: mq, rust
- Language: Rust
- Homepage:
- Size: 345 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hsmq
Horizontal Scalable Message Queue Broker
[](https://www.rust-lang.org/)
[](https://github.com/aamalev/hsmq/actions)
[](https://doc.rust-lang.org/stable/clippy/)
[](https://github.com/aamalev/hsmq/actions)
## Features
- [x] Interface
- [x] gRPC
- [ ] WebSocket
- [x] Configurable service
- [x] Graceful shutdown
- [x] Prometheus metrics
- [x] Consul
- [x] Sentry
- [x] Vault
- [x] Declare queue params
- [x] Console client hsmq-cli
- [x] Publish
- [x] Publish QoS0
- [x] Subscribe to a queue
- [x] Queue
- [x] Bind on static topics
- [x] In memory buffer
- [x] Graceful serve consumers on shutdown
- [x] Metrics
- [x] Limit
- [x] Ack
- [ ] TTL for messages
- [ ] Dynamic queue with ttl
- [x] Auth
- [x] Tokens
- [x] JWT
- [ ] Cluster
- [ ] Static routes
- [ ] DNS routes
- [ ] Broadcast routes
- [ ] Hot replication queue on shutdown
## Message life cycle
Message contains:
- data
- headers
- topic
After publication, messages are filtered by topic.
If the topic satisfies the condition, the message is saved in the queue.
## Queues
### InMemory
```toml
[[queues]]
type = "InMemory"
name = "b"
limit = 99 # oldest messages will be drop with metric label "drop-limit"
ack_timeout = 1 # in seconds, or use { m = 3 } to specify 3 minutes
topics = [
"b.a", # all messages with topic "b.a" will be kept to queue "b"
]
```
## Auth
### JWT
Your secrets must be kept to config:
```toml
[auth.jwt]
secrets = [
"inline secret",
{ env = "JWT_SECRET" }, # secret from environment variable
{ name = "old_secret_2", env = "OLD_JWT_2" }, # name for metrics
{ name = "old_secret_1", env = "OLD_JWT_1", disable = true },
]
```
You must specify a header in each request:
authorization: Bearer {jwt-token}
Required claims with token:
* exp - deadline unix timestamp
* sub - username
### Tokens
Your tokens must be kept to config for each user:
```toml
[users.my_username]
tokens = [
"inline personal token",
{ env = "TOKEN" }, # token from environment variable
{ env = "TOKEN_1", disable = true },
]
```
You must specify a header in each request:
authorization: Bearer {token}
### Vault
For enable vault add to config block [vault]
```toml
[vault]
```
```toml
[vault] # enable vault
uri = "http://localhost:8200" # optional
auth.jwt.env = "VAULT_JWT_TOKEN" # optional
token = { env = "VAULT_TOKEN", file = "/etc/vault-token.json", json_field = "jwt" } # optional
ca_cert = "/etc/ca.pem" # optional
[auth.jwt]
secrets = [
{ vault_path = "project/hsmq/jwt_1", json_field = "token", vault_mount = "secret" }, # field from json from kv2
{ vault_path = "project/hsmq/jwt_2", vault_kv_version = 1, json_field = "token" }, # token from kv1
]
```