Skip to content
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

Jump to bottom

fix(metrics)!: rename mercure_subscribers to mercure_subscribers_connected #725

Merged
merged 3 commits into from
Jan 10, 2023
Merged

fix(metrics)!: rename mercure_subscribers to mercure_subscribers_connected #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de0168e
fix(metrics)!: rename mercure_subscribers to mercure_subscribers_conn…
ndousson Dec 28, 2022
be287a7
docs
dunglas Jan 10, 2023
cf8219b
fix linter
dunglas Jan 10, 2023
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
6 changes: 5 additions & 1 deletion docs/UPGRADE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Upgrade

## 0.14.2

The `mercure_subscribers` field of the Prometheus endpoint has been renamed `mercure_subscribers_connected` for better interoperability (including with Datadog).

## 0.14.1

The default dev key changed from `!ChangeMe!` to `!ChangeThisMercureHubJWTSecretKey!` to respect the specification (they key must longer than 256 bits).
Expand Down Expand Up @@ -33,7 +37,7 @@ We still provide standalone binaries, but it's now a custom build of Caddy inclu

Builds of the legacy server are also available to ease the transition, but starting with version 0.12 only the Caddy-based builds will be provided (they have the `legacy` prefix).

Relying on Caddy allows to use the Mercure.rocks Hub as a [reverse proxy](https://caddyserver.com/docs/quick-starts/reverse-proxy) for your website or API that also adds the Mercure well-known URL (`/.well-known/mercure`). Thanks to this new feature, the well-known URL can be on the same domain as your website or API, so you don't need to deal with [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS).
Relying on Caddy allows to use the Mercure.rocks Hub as a [reverse proxy](https://caddyserver.com/docs/quick-starts/reverse-proxy) for your site or API that also adds the Mercure well-known URL (`/.well-known/mercure`). Thanks to this new feature, the well-known URL can be on the same domain as your site or API, so you don't need to deal with [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS).

All features provided by Caddy are also supported by this custom build: [HTTP/3 and h2c support](https://caddyserver.com/docs/json/apps/http/servers/#experimental_http3), [compression](https://caddyserver.com/docs/caddyfile/directives/encode), [Prometheus metrics](https://caddyserver.com/docs/metrics) (with additional Mercure-specific metrics), profiler (`/debug/pprof/`)...

Expand Down
2 changes: 1 addition & 1 deletion metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ func NewPrometheusMetrics(registry prometheus.Registerer) *PrometheusMetrics {
),
subscribers: prometheus.NewGauge(
prometheus.GaugeOpts{
Name: "mercure_subscribers",
Name: "mercure_subscribers_connected",
Help: "The current number of running subscribers",
},
),
Expand Down
2 changes: 1 addition & 1 deletion server_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ func TestMetricsCollect(t *testing.T) {
body = url.Values{"topic": {"http://example.com/foo/1"}, "data": {"second hello"}, "id": {"second"}}
server.publish(body)

server.assertMetric("mercure_subscribers 3")
server.assertMetric("mercure_subscribers_connected 3")
server.assertMetric("mercure_subscribers_total 4")
server.assertMetric("mercure_updates_total 2")
}
Expand Down