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 6497142CB6; Wed, 14 Jun 2023 10:37:20 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 382DE40E0F; Wed, 14 Jun 2023 10:37:20 +0200 (CEST) Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) by mails.dpdk.org (Postfix) with ESMTP id 030F040DDB for ; Wed, 14 Jun 2023 10:37:17 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1686731838; x=1718267838; h=date:from:to:cc:subject:message-id:references: content-transfer-encoding:in-reply-to:mime-version; bh=FyMdmyPSL2Ql18VU9yZJVXOZMFRQ1QoriTuCM/JCL4I=; b=FH9SXV5PaQt21J6NLp+yFiUNFe9QvugSXExkvm4Xo1IC0agVihNBnfg6 XJrCmFq9EfWutr3EsplU27svwLlvPFGVZMuR5eSjRw0VyIYU5WFAf7ZgP H5QVPKl9ktx4hDVNDCV5zJm2hfripEQ36XfZYVIJISF985E3cGLSbMs+4 xLMY1AkrDc7aUmDfYex+nvI/lv8IKPpLEE/3jbyDfg6hi+krWZ45m6G1d +iiB8JRtsGGMTTlFm4WwncxoT05S09MkP2/PV4Z3u/JGWST2nwSGmgCe+ 9LyAZjU8XBoMnWzF5Vra3z+MnBNwMEmazpF/Yki/k0eCtjJPusvXALlPG Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10740"; a="343254791" X-IronPort-AV: E=Sophos;i="6.00,242,1681196400"; d="scan'208";a="343254791" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga106.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 14 Jun 2023 01:37:07 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10740"; a="711976298" X-IronPort-AV: E=Sophos;i="6.00,242,1681196400"; d="scan'208";a="711976298" Received: from orsmsx601.amr.corp.intel.com ([10.22.229.14]) by orsmga002.jf.intel.com with ESMTP; 14 Jun 2023 01:37:07 -0700 Received: from orsmsx610.amr.corp.intel.com (10.22.229.23) by ORSMSX601.amr.corp.intel.com (10.22.229.14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.23; Wed, 14 Jun 2023 01:37:06 -0700 Received: from orsmsx610.amr.corp.intel.com (10.22.229.23) by ORSMSX610.amr.corp.intel.com (10.22.229.23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.23; Wed, 14 Jun 2023 01:37:06 -0700 Received: from orsedg603.ED.cps.intel.com (10.7.248.4) by orsmsx610.amr.corp.intel.com (10.22.229.23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.23 via Frontend Transport; Wed, 14 Jun 2023 01:37:06 -0700 Received: from NAM11-CO1-obe.outbound.protection.outlook.com (104.47.56.169) by edgegateway.intel.com (134.134.137.100) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.23; Wed, 14 Jun 2023 01:37:05 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Osu7y3bK7Bj/etbV1C6d2AkSWRdUBEnuYshxBGZvEeWsMcxIYLemEwIWZ9r6kjE/J/NaT2w0fxdvYjfMbCuo6rx/Yjq1P5yJG02WxyeR4pkje4OqVWWpouyAnb/nAJUAW78HegKx8Hzfys/PbFU18eVB0HUUF8Yn2owqW350IhNkcZNrU76F0sbVp6RAETF2iz7hB5KWQEWMgdCYJ70S85UXMNofju44bCdnvcfIEwzD55dkwd9WI3fDYiegaVLFCx+qEP9aDcVOI4sAs500gR2UUI/2Tnf7tD1pXO/PBSB0uFLVnoG3cieBQ1lG4nVfGiDEMcVYTh/Wv9I6vLIM2A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=bYmSiZ+GnbSIE7zhEy3zGu2yP0rons9YjjHbdlLfrRg=; b=dIQyyAYtOnWZMOW5XCXn78Eur7A4sthe0n81sw4plLUQWm5CVaWukGyMUEXliXwMo1hR0tzCfIUOrsaCme0Apa5smtycbmSMRH73U6sSZHurGouXOJJvDP/p7LDE3doOvzmkqZoc3cQYPtLFQrDyrAKMxnMQaujrNacgxEA9lYW6jCqwpf6dXgwiavvOXu6+TXww622+R/NUDwJ4D+3i+cJ0xrVAxGNc3ryhxs33A4znwMLNqc3pii+1VWkGe5/Mv4wGOrsNoenpU7PpK7mIV7twjHhCq+51tS5W1QD+P5OY5VQkojOSlHalQGmntyPhJ6v3jSMJr4rZZa2jCv0rSw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=intel.com; Received: from DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) by PH7PR11MB5767.namprd11.prod.outlook.com (2603:10b6:510:13a::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6477.29; Wed, 14 Jun 2023 08:37:04 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::b8f3:958:d2c5:2232]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::b8f3:958:d2c5:2232%3]) with mapi id 15.20.6477.037; Wed, 14 Jun 2023 08:37:03 +0000 Date: Wed, 14 Jun 2023 09:36:58 +0100 From: Bruce Richardson To: Morten =?iso-8859-1?Q?Br=F8rup?= CC: Subject: Re: [PATCH 2/2] doc/contributing: guidelines for logging, tracing and telemetry Message-ID: References: <20230613143355.77914-1-bruce.richardson@intel.com> <20230613143355.77914-3-bruce.richardson@intel.com> <98CBD80474FA8B44BF855DF32C47DC35D879CA@smartserver.smartshare.dk> Content-Type: text/plain; charset="iso-8859-1" Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <98CBD80474FA8B44BF855DF32C47DC35D879CA@smartserver.smartshare.dk> X-ClientProxiedBy: LO2P265CA0387.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:f::15) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|PH7PR11MB5767:EE_ X-MS-Office365-Filtering-Correlation-Id: 471686e3-a0e2-4362-16dd-08db6cb28769 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: xHl0SPlCIHXDUjoUSy/GFaREVxkF2d5M46P7FMIVM0xwWfjTdnPml5JZ1KRnRMVuxI0+S9VzEZSittiCBQSZzgHbYYOYfD/j9vQboNvRYP87dkHNApRnnXw3eiT1GAXOMuCpMVPMJqP7eb4nUe6/WQdt1oXdnUPhZnhbkDHGBXPePzZJrAdiiJsVIgEUhaKcelcomrtGHDM1x4bxBNPnmi/d2bJ6HMD0qDl/jJQ35Yktp47GXEq4ME1e1mKLiFl8ZU488wPxuo2LEnJ5vOe63bk6Qe0CkKSDBjhUCjh+O5FsjFlsngqSP8ulcLjaxIF7QwBmw7DcnC5aMTUqZQDUJTfRlt5//27LP+ILP7DR+7AUUyUipv1bcXwHjCFC1mjSn5OKVaYHH5hkqyg6IbYguFX9wBBod1lV2mISo2Kbl85xzdY1wcndh/dod7PJF1WTnZ3H8ioKqDqUVbIaSlXo+8Am1pPdOFHmEEkpVJmtSdsRKCqzA2Zk6c11B06t6/XAfAnwVB9VOQCahrTj5bJ4BMyqJch/oMaLBpvP2ozQ36Y= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DS0PR11MB7309.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230028)(366004)(376002)(346002)(396003)(39860400002)(136003)(451199021)(66556008)(66946007)(966005)(316002)(6666004)(66476007)(4326008)(478600001)(6916009)(86362001)(66574015)(26005)(186003)(6506007)(6512007)(83380400001)(5660300002)(8676002)(41300700001)(8936002)(44832011)(2906002)(6486002)(82960400001)(38100700002); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?iso-8859-1?Q?f+sN0HM+DE/HGZxWHWiapsLhHcCLn7tpvgiIlK/4w0b/NNd6/dnZDsOj+l?= =?iso-8859-1?Q?Xuxe3381EMQIkGKROYslSI0nOYJ0+m+0/hpg8Zm/0f1A2w9OTz4zGvOEpJ?= =?iso-8859-1?Q?589ojmTzx+VoEFt1i7+wQNg0+iGzJSM6hztRTk41vwiZB6NQoMrfYx+mJ1?= =?iso-8859-1?Q?VJEm7YVh1ue2VAwetV7vLAI2a95XGD9ZfUMOtUXckbn3vM50RNiERAYlzg?= =?iso-8859-1?Q?8LcNigQ1HqCsit4PrjjCAaQ9yrryF2sKiObrR7CHzky+m09H9lJr/7Y5T1?= =?iso-8859-1?Q?lPq5pqt+gd60jVoAr+eJq5YQPhxKsczBKsTSwCjBWxCQiHW4PpXA/PU00O?= =?iso-8859-1?Q?3DhFz2QPWu32YS10fFWO5X2BTJJPsNIFsnOx0iYs25jmmJX0AsKdj7VGnI?= =?iso-8859-1?Q?cGAWY5p4RHlw5yaaiQTSd7PHY4SHq764kdwFwiv7+8xs8I17I8v+PAmCOA?= =?iso-8859-1?Q?SZihql3NFyrEQNFgHN1Jd9D5Ui1OaaQfASXMDWX6mUsd17CGSy9Gcjuooa?= =?iso-8859-1?Q?KLrrVxcIGzRhXOWvphp0kwsWRdEb/FUZLtanGn9NF4MPUc3BKa6F/CfL3J?= =?iso-8859-1?Q?gEdVJe5yvEEpGVPnQxPUImmOpA98SztBuhDFyM9HD2hhm/edoOIe3Xmw7F?= =?iso-8859-1?Q?lxhkl4gx1ngh6aKOY6Q1dcb9bh6uzZ5Ud5K0I+Qb4XU1cOevLEygDb048i?= =?iso-8859-1?Q?CHPhui7ZlMuXVgHBrJ9AtbG1GX6pCULYxIawotNP48Bj4Fh0tIoYMqaLVz?= =?iso-8859-1?Q?y7wEXqXAlOVsHD0TFhn2XpaWF2qYWmf/2mQWsLoUJ8s3GZGTth/2uQDDOB?= =?iso-8859-1?Q?bzJBYmOK3Bamo9Zmgi+GslbWugIo82aidco3fd8Bs6OCdIjS3pNCMK8Iqu?= =?iso-8859-1?Q?IXcGHKR2ej+TOYKw1HUVwioJBmddT3pT+r3ReM3Recc6mcNYdkAESBuFJ1?= =?iso-8859-1?Q?CA5OC7m7QsoehjtApJy5WdpO9hPwAcsa6KzwSpGT209sx4gByoseuhVWq6?= =?iso-8859-1?Q?1nX564KAIz5KWFiWgYbTYH/T5wntSn7eM3AWpadzHyPY4UuVoodgJgYgmL?= =?iso-8859-1?Q?P8m9IZmvUv/jpKIf98noZPrDe/EbYysoVNiXEvzH2A1WiCI6zFxtQJ+iTQ?= =?iso-8859-1?Q?AA165pvcaxmEESJKTSz3r8vr1aSHLb6cfAjT4Vc2Q/YHDv4OVyhftyfK29?= =?iso-8859-1?Q?kqlvUMB+h+OPt9zUF0wG6NQTg4KwobaXR+vCHVmaIoZ8M2eNL8VVBlXZvh?= =?iso-8859-1?Q?xMIRU2xfV54f9/awNzC1XtsOs86c01eiQvGOtnLJwfo4JD1mMCCg56APah?= =?iso-8859-1?Q?3m3Z4W0Q+YvHId7LCZ7lnH7L/xoKOdxv7ZgxyVpoQtMVdK/zTWNIuulMWc?= =?iso-8859-1?Q?RUfKdKjEdfydjZg+QM+e0c05Cuxlxg2QQeNQSpaYusU+fSPivJ42BALp9A?= =?iso-8859-1?Q?w4+lyuNn+TNplOhu3K0GDNnTsPL6tIsGcYXdLmq9P9mUpheo5lfa9KqlN3?= =?iso-8859-1?Q?4ACZyonNc8X31ndbkogJBpsSS3h98fQVJygVqoAU3e21eMfjvJ+tOpjUQ4?= =?iso-8859-1?Q?u8BREfm4oLMVSnledn5XJ2fYxGRkrrOlsCgvWdEVG2VtkZijqrJJjix5OU?= =?iso-8859-1?Q?iWsSTpwKd3S2Abl1aMHrXAHO1Wk/DX3Ew/uW4iJCAJXDhsmsmAvT4CdA?= =?iso-8859-1?Q?=3D=3D?= X-MS-Exchange-CrossTenant-Network-Message-Id: 471686e3-a0e2-4362-16dd-08db6cb28769 X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Jun 2023 08:37:03.8080 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: eA6+mGfIAHDT4v/Scoe75BYDUcuUWkDOrCPNjJHm5haDWhkcaU3lrY4R4qfde2fGPLuzT4ZJ9+//4WmnM2l6QCZENmZluC+he0tn+13exLM= X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR11MB5767 X-OriginatorOrg: intel.com 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 Tue, Jun 13, 2023 at 09:38:55PM +0200, Morten Brørup wrote: > > From: Bruce Richardson [mailto:bruce.richardson@intel.com] > > Sent: Tuesday, 13 June 2023 16.34 > > > > As discussed by DPDK technical board [1], out contributor guide should > > Typo: out -> our > > > include some details as to when to use logging vs tracing vs telemetry > > to provide the end user with information about the running process and > > the DPDK libraries it uses. > > > > [1] https://mails.dpdk.org/archives/dev/2023-March/265204.html > > > > Signed-off-by: Bruce Richardson > > --- > > Debug logging can be more verbose than trace in the one-off cases, so I have a slightly different personal preference. But perhaps this is mainly relevant in the abnormal execution paths, and thus already covered. > Feel free to suggest alternate wordings if you have any. That particular item is hard to come up with good guidelines for - especially ones that are not pages long! :-) > Anyway, I agree with everything in this patch. > > Acked-by: Morten Brørup > Thanks. > You might also consider mentioning the xyz_dump(FILE *f) functions such as rte_mempool_list_dump(FILE *f). > > I find this type of semi-structured verbose dumping very useful for investigating the state of systems in production. Our debug CLI provides access to these _dump() functions, including some of our own, from various subsystems in the application. > I'll try and put some mention of that in V2. /Bruce