Prepare v1.23.0 release (#4492)

FerretDB · Jul 25, 2024 · 291ae91 · 291ae91
1 parent 400b82d
commit 291ae91
Show file tree

Hide file tree

Showing 57 changed files with 363 additions and 155 deletions.
diff --git a/.github/RELEASE_CHECKLIST.md b/.github/RELEASE_CHECKLIST.md
@@ -6,18 +6,18 @@
 2. Check issues and pull requests, update milestones and labels.
 3. Check if there are breaking changes or anything that should be reflected in the changelog and/or user documentation.
 4. Create draft release on GitHub with autogenerated release notes.
-5. Tweak generated release notes:
+5. Copy release notes to `CHANGELOG.md` and tweak them:
    - Ensure that "This section should be empty" section does not exist.
    - Add "All closed issues and pull requests" and "All commits", remove "Full Changelog".
    - Tweak spacing, headers levels.
+   - Add "What's Changed" section if needed.
    - Sort items within sections according to importance and/or alphabetically.
-6. Update CHANGELOG.md with the same release notes:
-   - Check spacing, header levels.
-7. Run `task docs-version VERSION=X.Y`.
+6. Run `task docs-version VERSION=X.Y`.
    Update `versions` in `docusaurus.config.js`.
    Remove the oldest version from `versioned_docs`, `versioned_sidebars`, `versions.json`.
-8. Run `task docs-fmt`.
-9. Commit and push changes, check `git status`.
+7. Run `task docs-fmt`.
+8. Commit and push changes to the PR.
+9. Merge PR, pull and check `git status`.
 
 ## Git tag
 
@@ -30,7 +30,7 @@
 
 ## Release
 
-1. Trim draft release notes.
+1. Copy release notes from `CHANGELOG.md` and trim them.
 2. Wait for the [packages CI build](https://github.com/FerretDB/FerretDB/actions/workflows/packages.yml?query=event%3Apush)
    to finish.
 3. Upload binaries and packages to the draft release.

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,108 @@
 
 <!-- markdownlint-disable MD024 MD034 -->
 
+## [v1.23.0](https://github.com/FerretDB/FerretDB/releases/tag/v1.23.0) (2024-07-25)
+
+### What's Changed
+
+#### Embeddable package
+
+This release switches from the [`zap` logging package](https://github.com/uber-go/zap) to the standard [`slog`](https://pkg.go.dev/log/slog).
+If the logger was configured by Go programs that import [`github.com/FerretDB/FerretDB/ferretdb` package](https://pkg.go.dev/github.com/FerretDB/FerretDB/ferretdb), they should configure the `SLogger` field instead.
+Setting the old `Logger` field will make the program panic and make the issue immediately noticeable.
+
+The next release will completely remove `zap` and rename `SLogger` to just `Logger`.
+
+#### Initial OpenTelemetry tracing support
+
+This release adds initial support for sending OpenTelemetry traces to the OTLP endpoint.
+The set of spans and their attributes is not stable yet and will change over time.
+
+All improvements in observability in this release (OpenTelemetry traces, Kubernetes probes, debug archive)
+are documented [there](https://docs.ferretdb.io/configuration/observability/).
+
+#### Experimental Systemd configuration in `.deb` and `.rpm` packages
+
+This release adds initial unit files for `systemd` that auto-start FerretDB.
+They are likely to change in the future in incompatible ways; for example, we may switch to using a non-root user.
+
+### New Features 🎉
+
+- Add Kubernetes liveness probe by @noisersup in https://github.com/FerretDB/FerretDB/pull/4378
+- Add Kubernetes readiness probe by @noisersup in https://github.com/FerretDB/FerretDB/pull/4426
+- Implement Docker healthcheck by @noisersup in https://github.com/FerretDB/FerretDB/pull/4364
+- Add OpenTelemetry traces and spans by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4477
+- Send OpenTelemetry traces and spans to OTLP endpoint by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4484
+- Implement `/debug/archive` handler by @sachinpuranik in https://github.com/FerretDB/FerretDB/pull/3895
+- Provide systemd unit file in `.deb` and `.rpm` packages by @noisersup in https://github.com/FerretDB/FerretDB/pull/4478
+
+### Enhancements 🛠
+
+- Improve support for named loggers by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4432
+
+### Documentation 📄
+
+- Document Kubernetes probes by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4424
+- Refactor and document `/debug/archive` handler by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4485
+- Document logging by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4436
+- Add release blog post for FerretDB v.1.22.0 by @Fashander in https://github.com/FerretDB/FerretDB/pull/4401
+- Add blog post on running FerretDB and CloudNativePG on Kubernetes by @Fashander in https://github.com/FerretDB/FerretDB/pull/4377
+- Add blogpost on "monitoring FerretDB performance using Coroot" by @Fashander in https://github.com/FerretDB/FerretDB/pull/4279
+- Crush `.png` images by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4441
+- Remove broken links by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4433
+
+### Other Changes 🤖
+
+- Replace deprecated syntax in Dockerfiles by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4397
+- Update comments about interfaces by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4405
+- Check database name for authentication by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4402
+- Refactor runnables by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4404
+- Add tests for `ctxutil.Sigterm` by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4406
+- Setup OpenTelemetry exporter for FerretDB by @rumyantseva in https://github.com/FerretDB/FerretDB/pull/4380
+- Extract `types` and `zap` code into separate files by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4408
+- Bump Go and deps by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4416
+- Implement Kubernetes startup probe by @noisersup in https://github.com/FerretDB/FerretDB/pull/4399
+- Disable OTEL in tests where collection name might have non-UTF-8 symbols by @rumyantseva in https://github.com/FerretDB/FerretDB/pull/4423
+- Stop Otel exporter gracefully in `envtool` by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4425
+- Include `OpReply` error handling by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4420
+- Test `authSource` by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4407
+- Return `connectionStatus` command `db` field by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4419
+- Implement checkswitch to handle regular switches by @PaveenV in https://github.com/FerretDB/FerretDB/pull/4381
+- Cleanup `checkswitch` handling by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4434
+- Bump deps by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4446
+- Ignore `$readPreferences` for `insert` by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4440
+- Readiness probe cleanup by @noisersup in https://github.com/FerretDB/FerretDB/pull/4447
+- Update linters configuration by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4451
+- Add support for named `slog` loggers by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4435
+- Increase setup timeout in tests by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4454
+- Port pgx logger by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4450
+- Handle `authSource` in low level driver by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4449
+- Use single definition of order for `checkswitch` by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4452
+- Clarify the meaning of the passed context by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4455
+- Remove `FuncCall` by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4476
+- Use `slog` in `clientconn` package by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4457
+- Use `slog` in `postgresql` backend by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4466
+- Use `slog` in `sqlite` backend by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4467
+- Use `slog` in `mysql` and `hana` backends by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4463
+- Use `slog` in `oplog` and `cursor` packages by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4471
+- Use `slog` in `otel` by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4474
+- Use `slog` in `debug` package by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4473
+- Use `slog` in integration tests by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4481
+- Use `slog` in `main.go` and embedded `ferretdb` package by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4462
+- Use `slog` in `fsql` by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4464
+- Use `slog` in handler by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4470
+- Use `slog` in envtool by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4480
+- Implement `slog.LogValuer` interface for `types` package by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4479
+- Drop old dependency by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4486
+- Cleanup logging by @chilagrow in https://github.com/FerretDB/FerretDB/pull/4489
+
+### New Contributors
+
+- @PaveenV made their first contribution in https://github.com/FerretDB/FerretDB/pull/4381
+
+[All closed issues and pull requests](https://github.com/FerretDB/FerretDB/milestone/65?closed=1).
+[All commits](https://github.com/FerretDB/FerretDB/compare/v1.22.0...v1.23.0).
+
 ## [v1.22.0](https://github.com/FerretDB/FerretDB/releases/tag/v1.22.0) (2024-06-26)
 
 ### What's Changed

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -49,7 +49,7 @@ const config = {
 
           versions: {
             // the latest minus one minor
-            'v1.21': {
+            'v1.22': {
               banner: 'none',
             },
           },

diff --git a/website/versioned_docs/version-v1.20/configuration/observability.md b/website/versioned_docs/version-v1.20/configuration/observability.md
diff --git a/....20/aggregation-operations/_category_.yml → ....23/aggregation-operations/_category_.yml b/....20/aggregation-operations/_category_.yml → ....23/aggregation-operations/_category_.yml
diff --git a/...ions/aggregation-pipeline-and-commands.md → ...ions/aggregation-pipeline-and-commands.md b/...ions/aggregation-pipeline-and-commands.md → ...ions/aggregation-pipeline-and-commands.md
diff --git a/...regation-operations/aggregation-stages.md → ...regation-operations/aggregation-stages.md b/...regation-operations/aggregation-stages.md → ...regation-operations/aggregation-stages.md
diff --git a/...ion-v1.20/basic-operations/_category_.yml → ...ion-v1.23/basic-operations/_category_.yml b/...ion-v1.20/basic-operations/_category_.yml → ...ion-v1.23/basic-operations/_category_.yml
diff --git a/.../version-v1.20/basic-operations/create.md → .../version-v1.23/basic-operations/create.md b/.../version-v1.20/basic-operations/create.md → .../version-v1.23/basic-operations/create.md
diff --git a/.../version-v1.20/basic-operations/delete.md → .../version-v1.23/basic-operations/delete.md b/.../version-v1.20/basic-operations/delete.md → .../version-v1.23/basic-operations/delete.md
diff --git a/...sion-v1.20/basic-operations/performing.md → ...sion-v1.23/basic-operations/performing.md b/...sion-v1.20/basic-operations/performing.md → ...sion-v1.23/basic-operations/performing.md
diff --git a/...cs/version-v1.20/basic-operations/read.md → ...cs/version-v1.23/basic-operations/read.md b/...cs/version-v1.20/basic-operations/read.md → ...cs/version-v1.23/basic-operations/read.md
@@ -61,10 +61,10 @@ Run `db.scientists.find()` to see the complete list of documents in the collecti
 ### Retrieve documents based on a specific query
 
 Using the `find()` command, you can also filter a collection for only the documents that match the provided query.
-For example, find the document with the field `born` set as 1857.
+For example, find the document with the field `born` set as 1847.
 
 ```js
-db.scientists.find({ born: 1857 })
+db.scientists.find({ born: 1847 })
 ```
 
 ### Retrieve documents using operator queries

diff --git a/.../version-v1.20/basic-operations/update.md → .../version-v1.23/basic-operations/update.md b/.../version-v1.20/basic-operations/update.md → .../version-v1.23/basic-operations/update.md
diff --git a/...ersion-v1.20/configuration/_category_.yml → ...ersion-v1.23/configuration/_category_.yml b/...ersion-v1.20/configuration/_category_.yml → ...ersion-v1.23/configuration/_category_.yml
diff --git a/...docs/version-v1.20/configuration/flags.md → ...docs/version-v1.23/configuration/flags.md b/...docs/version-v1.20/configuration/flags.md → ...docs/version-v1.23/configuration/flags.md
@@ -32,19 +32,19 @@ Some default values are overridden in [our Docker image](../quickstart-guide/doc
 
 ## Interfaces
 
-| Flag                     | Description                                                                           | Environment Variable            | Default Value                                |
-| ------------------------ | ------------------------------------------------------------------------------------- | ------------------------------- | -------------------------------------------- |
-| `--listen-addr`          | Listen TCP address                                                                    | `FERRETDB_LISTEN_ADDR`          | `127.0.0.1:27017`<br />(`:27017` for Docker) |
-| `--listen-unix`          | Listen Unix domain socket path                                                        | `FERRETDB_LISTEN_UNIX`          |                                              |
-| `--listen-tls`           | Listen TLS address (see [here](../security/tls-connections.md))                       | `FERRETDB_LISTEN_TLS`           |                                              |
-| `--listen-tls-cert-file` | TLS cert file path                                                                    | `FERRETDB_LISTEN_TLS_CERT_FILE` |                                              |
-| `--listen-tls-key-file`  | TLS key file path                                                                     | `FERRETDB_LISTEN_TLS_KEY_FILE`  |                                              |
-| `--listen-tls-ca-file`   | TLS CA file path                                                                      | `FERRETDB_LISTEN_TLS_CA_FILE`   |                                              |
-| `--proxy-addr`           | Proxy address                                                                         | `FERRETDB_PROXY_ADDR`           |                                              |
-| `--proxy-tls-cert-file`  | Proxy TLS cert file path                                                              | `FERRETDB_PROXY_TLS_CERT_FILE`  |                                              |
-| `--proxy-tls-key-file`   | Proxy TLS key file path                                                               | `FERRETDB_PROXY_TLS_KEY_FILE`   |                                              |
-| `--proxy-tls-ca-file`    | Proxy TLS CA file path                                                                | `FERRETDB_PROXY_TLS_CA_FILE`    |                                              |
-| `--debug-addr`           | Listen address for HTTP handlers for metrics, pprof, etc<br />(set to `-` to disable) | `FERRETDB_DEBUG_ADDR`           | `127.0.0.1:8088`<br />(`:8088` for Docker)   |
+| Flag                     | Description                                                                               | Environment Variable            | Default Value                                |
+| ------------------------ | ----------------------------------------------------------------------------------------- | ------------------------------- | -------------------------------------------- |
+| `--listen-addr`          | Listen TCP address                                                                        | `FERRETDB_LISTEN_ADDR`          | `127.0.0.1:27017`<br />(`:27017` for Docker) |
+| `--listen-unix`          | Listen Unix domain socket path                                                            | `FERRETDB_LISTEN_UNIX`          |                                              |
+| `--listen-tls`           | Listen TLS address (see [here](../security/tls-connections.md))                           | `FERRETDB_LISTEN_TLS`           |                                              |
+| `--listen-tls-cert-file` | TLS cert file path                                                                        | `FERRETDB_LISTEN_TLS_CERT_FILE` |                                              |
+| `--listen-tls-key-file`  | TLS key file path                                                                         | `FERRETDB_LISTEN_TLS_KEY_FILE`  |                                              |
+| `--listen-tls-ca-file`   | TLS CA file path                                                                          | `FERRETDB_LISTEN_TLS_CA_FILE`   |                                              |
+| `--proxy-addr`           | Proxy address                                                                             | `FERRETDB_PROXY_ADDR`           |                                              |
+| `--proxy-tls-cert-file`  | Proxy TLS cert file path                                                                  | `FERRETDB_PROXY_TLS_CERT_FILE`  |                                              |
+| `--proxy-tls-key-file`   | Proxy TLS key file path                                                                   | `FERRETDB_PROXY_TLS_KEY_FILE`   |                                              |
+| `--proxy-tls-ca-file`    | Proxy TLS CA file path                                                                    | `FERRETDB_PROXY_TLS_CA_FILE`    |                                              |
+| `--debug-addr`           | Listen address for HTTP handlers for metrics, profiling, etc<br />(set to `-` to disable) | `FERRETDB_DEBUG_ADDR`           | `127.0.0.1:8088`<br />(`:8088` for Docker)   |
 
 ## Backend handlers
 
@@ -103,12 +103,13 @@ For example: `file:./?mode=memory`.
 
 ## Miscellaneous
 
-| Flag                  | Description                                       | Environment Variable    | Default Value |
-| --------------------- | ------------------------------------------------- | ----------------------- | ------------- |
-| `--log-level`         | Log level: 'debug', 'info', 'warn', 'error'       | `FERRETDB_LOG_LEVEL`    | `info`        |
-| `--[no-]log-uuid`     | Add instance UUID to all log messages             | `FERRETDB_LOG_UUID`     |               |
-| `--[no-]metrics-uuid` | Add instance UUID to all metrics                  | `FERRETDB_METRICS_UUID` |               |
-| `--telemetry`         | Enable or disable [basic telemetry](telemetry.md) | `FERRETDB_TELEMETRY`    | `undecided`   |
+| Flag                  | Description                                                                     | Environment Variable       | Default Value    |
+| --------------------- | ------------------------------------------------------------------------------- | -------------------------- | ---------------- |
+| `--log-level`         | Log level: 'debug', 'info', 'warn', 'error'                                     | `FERRETDB_LOG_LEVEL`       | `info`           |
+| `--[no-]log-uuid`     | Add instance UUID to all log messages                                           | `FERRETDB_LOG_UUID`        |                  |
+| `--[no-]metrics-uuid` | Add instance UUID to all metrics                                                | `FERRETDB_METRICS_UUID`    |                  |
+| `--otel-traces-url`   | OpenTelemetry OTLP/HTTP traces endpoint URL (e.g. `http://host:4318/v1/traces`) | `FERRETDB_OTEL_TRACES_URL` | empty (disabled) |
+| `--telemetry`         | Enable or disable [basic telemetry](telemetry.md)                               | `FERRETDB_TELEMETRY`       | `undecided`      |
 
 <!-- Do not document `--test-XXX` flags here -->