Skip to content

Commit 994644d

Browse files
sivapt12tmonjalo
authored andcommitted
doc: add telemetry command name restrictions
Telemetry command names must contain only alphanumeric characters (`A-Z`, `a-z`, `0-9`), underscore (`_`), and forward slash (`/`). Other characters, including hyphens (`-`), are not allowed and cause registration to fail. This patch updates the documentation to explicitly state these restrictions and highlights the existing invalid example "/l3fwd-power/stats" (in l3fwd-power app). Signed-off-by: Sivaprasad Tummala <[email protected]> Acked-by: Bruce Richardson <[email protected]>
1 parent 44a4784 commit 994644d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/guides/prog_guide/telemetry_lib.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,11 @@ command. An example command being registered is shown below:
157157
rte_telemetry_register_cmd("/example_lib/string_example", handle_string,
158158
"Returns an example string. Takes no parameters");
159159
160+
The command name **must consist only of alphanumeric characters (`A-Z`, `a-z`, `0-9`)
161+
and the special characters underscore (`_`) and forward slash (`/`)**.
162+
Any other characters, including spaces, are not permitted
163+
and will cause the command registration to fail.
164+
160165

161166
Using Commands
162167
--------------

0 commit comments

Comments
 (0)