mirror of
https://github.com/fatedier/frp.git
synced 2026-10-20 21:13:28 +08:00
fatedierandGitHub
a73e8a14fc
Record the deprecation of the observability endpoints on webServer in doc/deprecations.md, so the removal target is in one place next to the other active deprecations. The webServer /healthz, the frps webServer /metrics with its top-level enablePrometheus switch, and the pprof handlers with webServer.pprofEnable are deprecated since v0.72.0, when metricsServer was added. They are replaced by metricsServer, whose /healthz, /metrics and pprofEnable are independent of the dashboard listener.
54 lines
3.2 KiB
Markdown
54 lines
3.2 KiB
Markdown
# Deprecations
|
|
|
|
This document tracks deprecated features and APIs that are still shipped but scheduled for removal. Maintainers should review this list before each release to decide whether any items are due for removal.
|
|
|
|
For the version compatibility policy that bounds these support windows, see the latest `Release.md`.
|
|
|
|
## Active
|
|
|
|
### Observability endpoints on `webServer`
|
|
|
|
- **Deprecated since:** v0.72.0 (when `metricsServer` was added).
|
|
- **Removal target:** v0.80.0 or later. v0.71.x is the last line without `metricsServer` and is supported until v0.80.0 is released, so v0.79.x is the last release that must keep these endpoints.
|
|
- **Replacement:** `metricsServer`. Point health probes at its `/healthz`, scrapes at its `/metrics` (frps exposes business metrics there without `enablePrometheus`), and use `metricsServer.pprofEnable` for profiling.
|
|
- **Deprecated items:** `/healthz` on `webServer` in both frps and frpc; `/metrics` on the frps `webServer` and the top-level `enablePrometheus` that gates it; the pprof handlers on `webServer` and `webServer.pprofEnable` in both frps and frpc.
|
|
- **Code references:**
|
|
- `server/api_router.go` — `/healthz`, and `/metrics` when `enablePrometheus` is set.
|
|
- `client/api_router.go` — `/healthz`.
|
|
- `pkg/util/http/server.go` — pprof handlers registered when `webServer.pprofEnable` is set.
|
|
- `server/service.go` — startup deprecation warnings and `metricsCollectors`.
|
|
- `client/service.go` — startup deprecation warnings.
|
|
- `pkg/config/v1/server.go` — `EnablePrometheus`; `pkg/config/v1/common.go` — `WebServerConfig.PprofEnable`.
|
|
- **Notes:** Removal drops the startup warnings and the deprecation notes in `README.md` and the two `conf/*_full_example.toml` files together. `webServer` then serves only the dashboard and the admin API.
|
|
|
|
### Wire protocol v1
|
|
|
|
- **Deprecated since:** v0.70.0 (planned, when v2 becomes the default).
|
|
- **Removal target:** v0.78.0 or later. v0.69.0 (the last release where v1 is the default) is supported until v0.78.0 is released, so v0.77.0 is the last release that must keep v1 support.
|
|
- **Replacement:** wire protocol v2 (`transport.wireProtocol = "v2"` in frpc).
|
|
- **Code references:** v1 message types and codec under `pkg/msg/` and the protocol negotiation path in `client/` and `server/`.
|
|
- **Notes:** Removing v1 will also drop compatibility with any frpc/frps that does not negotiate v2.
|
|
|
|
### INI configuration format
|
|
|
|
- **Deprecated since:** predates this document; startup warning has been in place for several releases.
|
|
- **Removal target:** TBD.
|
|
- **Replacement:** YAML / JSON / TOML.
|
|
- **Code references:**
|
|
- `cmd/frpc/sub/root.go` — frpc startup warning.
|
|
- `cmd/frps/root.go` — frps startup warning.
|
|
- `pkg/config/legacy/` — legacy INI parser; remove together with the warnings.
|
|
|
|
### Visitor connections without `runID`
|
|
|
|
- **Deprecated since:** v0.50.0 (when `runID` was introduced).
|
|
- **Removal target:** TBD.
|
|
- **Replacement:** require `runID` on every visitor connection.
|
|
- **Code references:**
|
|
- `server/service.go` — `RegisterVisitorConn` still accepts empty `runID` for backward compatibility.
|
|
- **Notes:** Removal will break frpc clients released before v0.50.0. Schedule for a release where dropping pre-v0.50.0 frpc is acceptable.
|
|
|
|
## Removed
|
|
|
|
_None yet._
|