-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(*) document metric name prefixing differences betweeen SDK hosts
- Loading branch information
1 parent
ecdcacb
commit 6afd373
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Proxy-Wasm Host Differences | ||
|
||
Listed here are noteworthy internal discrepancies (implementation differences) | ||
between ngx_wasm_module and other Proxy-Wasm host implementations. | ||
|
||
## Table of Contents | ||
|
||
- [Metrics Prefixing](#metrics-prefixing) | ||
|
||
## Metrics Prefixing | ||
|
||
- Envoy internally prefixes metric names with `wasmcustom.*` and only exposes | ||
this prefix in the output of the `/metrics` endpoint. | ||
- For internal implementation reasons, ngx_wasm_module prefixes metric names | ||
with `pw.[filter_name].*`, where `filter_name` is the name of the filter | ||
that defined the metric. Only the ngx_wasm_module FFI library may expose the | ||
existence of this prefix. | ||
|
||
Proxy-Wasm SDK users need not worry as metric names are never exposed through | ||
the SDK in the first place. | ||
|
||
[Back to TOC](#table-of-contents) |