* [PATCH] doc: document telemetry command name restrictions
@ 2025-10-06 9:47 Sivaprasad Tummala
2025-11-06 13:41 ` Bruce Richardson
0 siblings, 1 reply; 2+ messages in thread
From: Sivaprasad Tummala @ 2025-10-06 9:47 UTC (permalink / raw)
To: mb, david.marchand, ktraynor, thomas, konstantin.ananyev,
konstantin.v.ananyev, bruce.richardson, maxime.coquelin, aconole,
ferruh.yigit
Cc: dev
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 <sivaprasad.tummala@amd.com>
---
doc/guides/prog_guide/telemetry_lib.rst | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/doc/guides/prog_guide/telemetry_lib.rst b/doc/guides/prog_guide/telemetry_lib.rst
index 32f525a67f..6ae5067474 100644
--- a/doc/guides/prog_guide/telemetry_lib.rst
+++ b/doc/guides/prog_guide/telemetry_lib.rst
@@ -157,6 +157,10 @@ command. An example command being registered is shown below:
rte_telemetry_register_cmd("/example_lib/string_example", handle_string,
"Returns an example string. Takes no parameters");
+The command name **must consist only of alphanumeric characters (`A-Z`, `a-z`,
+`0-9`) and the special characters underscore (`_`) and forward slash (`/`)**.
+Any other characters, including spaces, are not permitted and will cause the
+command registration to fail.
Using Commands
--------------
--
2.43.0
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] doc: document telemetry command name restrictions
2025-10-06 9:47 [PATCH] doc: document telemetry command name restrictions Sivaprasad Tummala
@ 2025-11-06 13:41 ` Bruce Richardson
0 siblings, 0 replies; 2+ messages in thread
From: Bruce Richardson @ 2025-11-06 13:41 UTC (permalink / raw)
To: Sivaprasad Tummala
Cc: mb, david.marchand, ktraynor, thomas, konstantin.ananyev,
konstantin.v.ananyev, maxime.coquelin, aconole, ferruh.yigit,
dev
On Mon, Oct 06, 2025 at 09:47:12AM +0000, Sivaprasad Tummala wrote:
> 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 <sivaprasad.tummala@amd.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
> doc/guides/prog_guide/telemetry_lib.rst | 4 ++++
> 1 file changed, 4 insertions(+)
>
> diff --git a/doc/guides/prog_guide/telemetry_lib.rst b/doc/guides/prog_guide/telemetry_lib.rst
> index 32f525a67f..6ae5067474 100644
> --- a/doc/guides/prog_guide/telemetry_lib.rst
> +++ b/doc/guides/prog_guide/telemetry_lib.rst
> @@ -157,6 +157,10 @@ command. An example command being registered is shown below:
> rte_telemetry_register_cmd("/example_lib/string_example", handle_string,
> "Returns an example string. Takes no parameters");
>
> +The command name **must consist only of alphanumeric characters (`A-Z`, `a-z`,
> +`0-9`) and the special characters underscore (`_`) and forward slash (`/`)**.
> +Any other characters, including spaces, are not permitted and will cause the
> +command registration to fail.
>
> Using Commands
> --------------
> --
> 2.43.0
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2025-11-06 13:41 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-10-06 9:47 [PATCH] doc: document telemetry command name restrictions Sivaprasad Tummala
2025-11-06 13:41 ` Bruce Richardson
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).