docs: add Apache APISIX to software exposing Prometheus metrics - #3064
Merged
jan--f merged 3 commits intoAug 12, 2026
Conversation
Signed-off-by: Yilia Lin <Yilialin@apache.org>
Yilialinn
force-pushed
the
docs-add-apache-apisix-prometheus
branch
from
August 12, 2026 09:54
c86379a to
f264ca2
Compare
Member
|
This does not seem to be direct which is for users of prometheus official libraries (which do not exist for lua). |
Signed-off-by: Yilia Lin <Yilialin@apache.org>
jan--f
approved these changes
Aug 12, 2026
jan--f
left a comment
Contributor
There was a problem hiding this comment.
lgtm, the build failure has been addressed on main.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Apache APISIX registers gateway metrics through its bundled
nginx-lua-prometheus-api7client library and exposes them from itsfirst-party
prometheusplugin, so no separate exporter is required. Theentry is placed in the same section as other software with directly
instrumented Prometheus endpoints.
Representative output from Apache APISIX 3.17.0:
Validation:
environment after requests reached a test upstream
promtool 3.13.2 check metricsreports that the existingapisix_http_statuscounter does not use the recommended_totalsuffixapisix_http_latencyreports milliseconds, while Prometheus recommends baseunits and unit suffixes for metric names
These are existing APISIX metric-convention gaps. This directory change does
not modify the metric surface or claim full compliance with Prometheus naming
guidance.
Disclosure: I am an Apache APISIX Committer.
@RichiH, could you review this small integrations-directory addition when you
have time?