v2.7.0

This release has minor backwards incompatible changes in some Prometheus/Graphite metric names. This means that you may need to adapt your monitoring dashboards a bit. See details below.

Improvements:

• Previously metrics exposed by Centrifuge library (which Centrifugo is built on top of) belonged to centrifuge Prometheus namespace. This lead to a situation where part of Centrifugo metrics belonged to centrifugo and part to centrifuge Prometheus namespaces. Starting from v2.7.0 Centrifuge library specific metrics also belong to centrifugo namespace. So the rule to migrate is simple: if see centrifuge word in a metric name – change it to centrifugo.
• Refreshed login screen of admin web interface with moving Centrifugo logo on canvas – just check it out!
• New gauge that shows amount of running Centrifugo nodes
• Centrifugal organization just got the first baker on Opencollective ❤️. This is a nice first step in making Centrifugo development sustainable.

Fixes:

• Fix messages_sent_count counter which did not show control, join and leave messages

Coming soon 🔥:

• Official Grafana Dashboard for Prometheus storage is on its way to Centrifugo users. Track this issue for a status, the work almost finished.
• Official Centrifugo Helm Chart for Kubernetes. Track this issue for a status, the work almost finished.

Docker images

• docker pull centrifugo/centrifugo:v2.7.0
• docker pull centrifugo/centrifugo:v2
• docker pull centrifugo/centrifugo:v2.7
• docker pull centrifugo/centrifugo:latest

v2.6.2

No backwards incompatible changes here.

Improvements:

• Internal refactoring of WebSocket graceful close, should make things a bit more performant (though only in apps which read lots of messages from WebSocket connections)
• Disconnect code is now uint32 internally
• A bit more performant permission checks for publish, history and presence ops
• Connect proxy request payload can optionally contain name and version of client if set on client side, see updated connect proxy docs
• New blog post Experimenting with QUIC and WebTransport in Go in Centrifugo blog

Fixes:

• fix panic on connect in 32-bit ARM builds, see #387

Docker images

• docker pull centrifugo/centrifugo:v2.6.2
• docker pull centrifugo/centrifugo:v2
• docker pull centrifugo/centrifugo:v2.6
• docker pull centrifugo/centrifugo:latest

v2.6.1

No backwards incompatible changes here.

Improvements:

• Add grpc_api_key option, see in docs

Fixes:

• Fix Redis Engine errors related to missing epoch in Redis HASH. If you see errors in servers logs, like wrong Redis reply epoch or redigo: nil returned, then those should be fixed here. Also take a look at v2.5.2 release which contains backport of this fix if you are on v2.5.x release branch.

Docker images

• docker pull centrifugo/centrifugo:v2.6.1
• docker pull centrifugo/centrifugo:v2
• docker pull centrifugo/centrifugo:v2.6
• docker pull centrifugo/centrifugo:latest

v2.5.2

Fixes:

• Backport Redis Engine epoch fix from v2.6.1

Docker images

• docker pull centrifugo/centrifugo:v2.5.2
• docker pull centrifugo/centrifugo:v2
• docker pull centrifugo/centrifugo:v2.5
• docker pull centrifugo/centrifugo:latest

v2.6.0

No backwards incompatible changes here.

Improvements:

• New section in docs – Centrifugo dev blog, check out first post about scaling WebSocket
• Possibility to scale with Nats server for unreliable at most once PUB/SUB
• Subscribe HTTP proxy, see docs
• Publish HTTP proxy, see docs
• Support for setting Redis Sentinel password, see in docs
• Various documentation improvements since previous release

This release based on massively updated Centrifuge library, we don't expect problems but since many things were refactored – we suggest to carefully test your app.

Docker images

• docker pull centrifugo/centrifugo:v2.6.0
• docker pull centrifugo/centrifugo:v2
• docker pull centrifugo/centrifugo:v2.6
• docker pull centrifugo/centrifugo:latest

v2.5.1

No backwards incompatible changes here.

Improvements:

• refreshed documentation design
• new Quick start chapter for those who just start working with Centrifugo
• faster marshal of disconnect messages into close frame texts, significantly reduces amount of memory allocations during server graceful shutdown in deployments with many connections
• one beautiful Centrifugo integration with Symfony framework from our community - check it out

Fixes:

• add Content-Type: application/json header to outgoing HTTP proxy requests to app backend for better integration with some frameworks. #368
• fix wrong channel name in Join messages sent to client in case of server-side subscription to many channels
• fix disconnect code unmarshalling after receiving response from HTTP proxy requests, it was ignored previously

Docker images

• docker pull centrifugo/centrifugo:v2.5.1
• docker pull centrifugo/centrifugo:v2
• docker pull centrifugo/centrifugo:v2.5
• docker pull centrifugo/centrifugo:latest

v2.5.0

No backwards incompatible changes here.

Starting from this release we begin migration to new offset uint64 client-server protocol field for Publication position inside history stream instead of currently used seq and gen (both uint32) fields. This offset field will be used in Centrifugo v3 by default. This change required to simplify working with history API, and due to this change history API can be later extended with pagination features.

Our client libraries centrifuge-js, centrifuge-go and centrifuge-mobile were updated to support offset field. If you are using these libraries then you can update centrifuge-js to at least 2.6.0, centrifuge-go to at least 0.5.0 and centrifuge-mobile to at least 0.5.0 to work with the newest client-server protocol. As soon as you upgraded mentioned libraries you can enable offset support without waiting for Centrifugo v3 release with v3_use_offset option:

{
  ...
  "v3_use_offset": true
}

All other client libraries except centrifuge-js, centrifuge-go and centrifuge-mobile do not support recovery at this moment and will only work with offset field in the future.

It's important to mention that centrifuge-js, centrifuge-go and centrifuge-mobile will continue to work with a server which is using seq and gen fields for recovery until Centrifugo v3 release. With Centrifugo v3 release those libraries will be updated to only work with offset field.

Command centrifugo genconfig will now generate config file with v3_use_offset option enabled. Documentation has been updated to suggest turning on this option for fresh installations.

Improvements:

• support Redis Streams - radically reduces amount of memory allocations during recovery in large history streams. This also opens a road to paginate over history stream in future releases, see description of new redis_streams option in Redis engine docs
• support Redis Cluster, client-side sharding between different Redis Clusters also works, see more in docs
• faster HMAC-based JWT parsing
• faster Memory engine, possibility to expire history stream metadata (more in docs)
• releases for Centos 8, Debian Buster, Ubuntu Focal Fossa
• new cli-command centrifugo gentoken to quickly generate HMAC SHA256 based connection JWT, see docs
• new cli-command centrifugo checktoken to quickly validate connection JWT while developing application, see docs

Fixes:

• fix server side subscriptions to private channels (were ignored before)
• fix channels counter update frequency in server info – this includes how fast channels counter updated in admin web interface (previously num clients and num users updated once in 3 seconds while num channels only once in a minute, now num channels updated once in 3 seconds too)

This release based on Go 1.14.x

Docker images

• docker pull centrifugo/centrifugo:v2.5.0
• docker pull centrifugo/centrifugo:v2
• docker pull centrifugo/centrifugo:v2.5
• docker pull centrifugo/centrifugo:latest

v2.4.0

This release is a step towards new interesting possibilities with Centrifugo. It adds server-side subscriptions support and some sugar on top of it. With server-side subscriptions you don't need to call Subscribe method on client side at all. Follow release notes to know more.

No backwards incompatible changes here.

Improvements:

• Server-side subscriptions, this functionality requires updating client code so at moment usage is limited to centrifuge-js. Also there is a possibility to automatically subscribe user connection to personal notifications channel. More info in new documentation chapter
• New private subscription JWT eto claim - see its description in docs
• Options to disable WebSocket, SockJS and API handlers – see docs
• New option websocket_use_write_buffer_pool – see docs
• Metrics now include histograms of requests durations - pull request
• Add Linux ARM binary release

Fixes:

• Fix unreliable unsubscriptions from Redis PUB/SUB channels under load, now we unsubscribe nodes from PUB/SUB channels over in-memory queue
• Fix tls_external option regression

Docker images

• docker pull centrifugo/centrifugo:v2.4.0
• docker pull centrifugo/centrifugo:v2
• docker pull centrifugo/centrifugo:v2.4
• docker pull centrifugo/centrifugo:latest

v2.3.1

This release contains several improvements to proxy feature introduced in v2.3.0, no backwards incompatible changes here.

Improvements:

• With proxy_extra_http_headers configuration option it's now possible to set a list of extra headers that should be copied from original client request to proxied HTTP request - see #334 for motivation and updated proxy docs
• You can pass custom data in response to connect event and this data will be available in connect event callback context on client side. See #332 for more details
• Starting from this release Origin header is proxied to your backend by default - see full list in docs

Docker images

• docker pull centrifugo/centrifugo:v2.3.1
• docker pull centrifugo/centrifugo:v2
• docker pull centrifugo/centrifugo:v2.3
• docker pull centrifugo/centrifugo:latest

v2.3.0

This release is a big shift in Centrifugo possibilities due to HTTP request proxy feature. It was a pretty long term work but the final result opens a new commucation direction: from client to server – see details below.

Release has some internal backwards incompatible changes in Redis engine and deprecations. Migration must be smooth but we strongly suggest to test your functionality before running new version in production. Read release notes below for more information.

Improvements:

• It's now possible to proxy some client connection events over HTTP to application backend and react to them in a way you need. For example you can authenticate connection via request from Centrifugo to your app backend, refresh client sessions and answer to RPC calls sent by client over WebSocket or SockJS connections. More information in new documentation chapter
• Centrifugo now supports RSA-based JWT. You can enable this by setting token_rsa_public_key option. See updated authentication chapter in docs for more details. Due to this addition we also renamed secret option to token_hmac_secret_key so it's much more meaningful in modern context. But don't worry - old secret option will work and continue to set token HMAC secret key until Centrifugo v3 release (which is not even planned yet). But we adjusted docs and genconfig command to use new naming
• New option redis_sequence_ttl for Redis engine. It allows to expire internal keys related to history sequnce meta data in Redis – current sequence number in channel and epoch value. See more motivation behind this option in its description in Redis Engine docs. While adding this feature we changed how sequence and epoch values are stored in Redis - both are now fields of single Redis HASH key. This means that after updating to this version your clients won't recover missed messages - but your frontend application will receive recovered: false in subscription context so it should tolerate this loss gracefully recovering state from your main database (if everything done right on your client side of course)
• More validation of configuration file is now performed. Specifically we now check history recovery configuration - see this issue to see how absence of such misconfiguration check resulted in confused Centrifugo behaviour - no messages were received by subscribers
• Go internal logs from HTTP server are now wrapped in our structured logging mechanism - those errors will look as warns in Centrifugo logs now
• Alpine 3.10 instead of Alpine 3.8 as Centrifugo docker image base

Docker images

• docker pull centrifugo/centrifugo:v2.3.0
• docker pull centrifugo/centrifugo:v2
• docker pull centrifugo/centrifugo:v2.3
• docker pull centrifugo/centrifugo:latest