Dear APISIX community,

I would like to propose the deprecation and eventual removal of the
server-info plugin in Apache APISIX.


Background

The server-info plugin periodically reports basic server information
to etcd. While useful in small-scale deployments, this behavior can
cause operational issues in large clusters — especially when many
APISIX instances start simultaneously. These frequent etcd writes may
lead to performance degradation or even startup failures if etcd is
not properly provisioned.


Motivation

Operational Risk: The plugin generates etcd writes from all data plane
nodes, which is not a suitable use case for etcd and can lead to
unnecessary system stress.


Proposal

1. Deprecation (in the next release)

Mark the plugin as deprecated in both documentation and codebase.

Add a warning log when the plugin is enabled:
[warn] server-info plugin is deprecated and will be removed in a future release.

Disable it by default to prevent accidental usage.

Announce deprecation in the release notes and community channels.


2. Removal (in the release after next)

Remove the plugin from the codebase and configuration system.

Clearly document the removal in the changelog and migration guide.

Mark the removal clearly as a breaking change in the release notes.


Breaking Change Notice

This will be a breaking change for users who rely on the server-info
plugin. Affected users should be informed early and encouraged to
prepare for its removal in future versions.


Benefits

Reduces operational risk by minimizing unnecessary etcd writes.


Next Steps

1. Mark the plugin as deprecated and disable it by default in the next release.
Communicate the deprecation clearly in documentation and logs.
2. Fully remove the plugin in the following major/minor release.


Looking forward to your feedback and suggestions.


Best regards,
Yi Sun
GitHub: https://github.com/LiteSun

Reply via email to