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 D4104A0032; Mon, 11 Jul 2022 12:54:01 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C910B410DD; Mon, 11 Jul 2022 12:54:01 +0200 (CEST) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by mails.dpdk.org (Postfix) with ESMTP id C342641156 for ; Mon, 11 Jul 2022 12:54:00 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1657536841; x=1689072841; h=date:from:to:cc:subject:message-id:references: mime-version:content-transfer-encoding:in-reply-to; bh=AtIodu6uNPgohFfkH02IxyrNTCas3iMi77EMsWXTkEQ=; b=dl59goDYYe9qJx6b/3DG7tGuvq67NANZcu9EK74L4WiUozsAZ0+r0Bmc tEGeQHS907Y3ZdFv2GVvtWMQYFOAWbZSoU6J41JFowULDnTTMG6I1PHlL yEsBXTriKfEghz3NskTQmNy9J+7wLpKj4T5rUM0Difa6fyUP6h7fEUrYM l05uAp48U5NMmBEvjyg7PrvalDplfgyYjVyvHHSlJxKgZaqsIUYNxuLyJ DLMEp7tiUA4jueyfhTdql2aVWi3nYab2KdJcU7hZ87zARp4LLq81xcyU5 26B/BxRABpA2vsxJVQeQXHtKAAt3ijl3Tu6n+md6wT2s7NUOD1QQRAZwG w==; X-IronPort-AV: E=McAfee;i="6400,9594,10404"; a="310233814" X-IronPort-AV: E=Sophos;i="5.92,262,1650956400"; d="scan'208";a="310233814" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 11 Jul 2022 03:53:59 -0700 X-IronPort-AV: E=Sophos;i="5.92,262,1650956400"; d="scan'208";a="652407404" Received: from bricha3-mobl.ger.corp.intel.com ([10.252.3.200]) by fmsmga008-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-SHA; 11 Jul 2022 03:53:58 -0700 Date: Mon, 11 Jul 2022 11:53:55 +0100 From: Bruce Richardson To: Morten =?iso-8859-1?Q?Br=F8rup?= Cc: dev@dpdk.org, stephen@networkplumber.org, ciara.power@intel.com Subject: Re: [PATCH] doc: add deprecation for restrictions in telemetry naming Message-ID: References: <20220707133931.752248-1-bruce.richardson@intel.com> <98CBD80474FA8B44BF855DF32C47DC35D871B2@smartserver.smartshare.dk> MIME-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <98CBD80474FA8B44BF855DF32C47DC35D871B2@smartserver.smartshare.dk> 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 Fri, Jul 08, 2022 at 12:06:31AM +0200, Morten Brørup wrote: > > From: Bruce Richardson [mailto:bruce.richardson@intel.com] > > Sent: Thursday, 7 July 2022 15.40 > > > > 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 > > json -> JSON > Capital idea! (pun very much intended :-) ) > > telemetry commands will > > + be similarly limited. > > Perhaps also add a comment about parameters to telemetry commands, for completeness. > I was not intending to impose restrictions on the parameters themselves since currently they are not output as part of any json. However, now you have got me thinking that perhaps we should look to scan parameters for invalid characters before we hand them over to the individual functions. That would allow the possibility of including parameters in any replies in a future format. Was this what you had in mind, or any other thoughts? /Bruce