From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1190AA0543; Thu, 7 Jul 2022 17:16:17 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AC42F406B4; Thu, 7 Jul 2022 17:16:16 +0200 (CEST) Received: from shelob.oktetlabs.ru (shelob.oktetlabs.ru [91.220.146.113]) by mails.dpdk.org (Postfix) with ESMTP id F314E4069D for ; Thu, 7 Jul 2022 17:16:14 +0200 (CEST) Received: from [192.168.1.38] (unknown [188.170.75.69]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by shelob.oktetlabs.ru (Postfix) with ESMTPSA id 18FD1C6; Thu, 7 Jul 2022 18:16:14 +0300 (MSK) DKIM-Filter: OpenDKIM Filter v2.11.0 shelob.oktetlabs.ru 18FD1C6 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=oktetlabs.ru; s=default; t=1657206974; bh=oqMns5lkFp8oikv0z/VoxppL/jZdrYV9CrEplmrK7MA=; h=Date:Subject:To:Cc:References:From:In-Reply-To:From; b=XygZR5ULLgDX0jkK4IvB8vT9hTtjymJaTPlj5zPm78Pl4tbazpgvZ3K3mpve6gSWm 79CSaoPX+EreIB1+L8nIXPBkhgnQub0SMqGpyIZKlph8nCvbg88iYNKjJqxgbO9rCw ZLBG/UWe00y0ORyb3+9+FYZYcqnEkXIuvjwKdwaw= Message-ID: <3204022d-0d92-c8fb-e9cf-ff6b360872b1@oktetlabs.ru> Date: Thu, 7 Jul 2022 18:16:05 +0300 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.10.0 Subject: Re: [PATCH] doc: add deprecation for restrictions in telemetry naming Content-Language: en-US To: Bruce Richardson , dev@dpdk.org Cc: mb@smartsharesystems.com, stephen@networkplumber.org, ciara.power@intel.com References: <20220707133931.752248-1-bruce.richardson@intel.com> From: Andrew Rybchenko In-Reply-To: <20220707133931.752248-1-bruce.richardson@intel.com> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On 7/7/22 16:39, Bruce Richardson wrote: > Following discussion on-list [1], we will look to limited the allowed > characters in names for items in telemetry. This will simplify the > escaping needed for json output, or any future output formats. The lists > will initially be minimal, since expansion to allow more characters can > be done without affecting compatibility, while reducing the set cannot. > > Cc: mb@smartsharesystems.com > Cc: stephen@networkplumber.org > Cc: ciara.power@intel.com > > Signed-off-by: Bruce Richardson > > [1] http://inbox.dpdk.org/dev/20220623164245.561371-1-bruce.richardson@intel.com/#r > --- > doc/guides/rel_notes/deprecation.rst | 6 ++++++ > 1 file changed, 6 insertions(+) > > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst > index 4e5b23c53d..9366690ec5 100644 > --- a/doc/guides/rel_notes/deprecation.rst > +++ b/doc/guides/rel_notes/deprecation.rst > @@ -119,6 +119,12 @@ Deprecation Notices > * metrics: The function ``rte_metrics_init`` will have a non-void return > in order to notify errors instead of calling ``rte_exit``. > > +* telemetry: The allowed characters in names for dictionary values will be limited to > + alphanumeric characters and a small subset of additional printable characters. > + This will ensure that all dictionary parameter names can be output without escaping > + in json - or in any future output format used. Names for the telemetry commands will > + be similarly limited. > + > * raw/ioat: The ``ioat`` rawdev driver has been deprecated, since it's > functionality is provided through the new ``dmadev`` infrastructure. > To continue to use hardware previously supported by the ``ioat`` rawdev driver, Acked-by: Andrew Rybchenko