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 0583643D17; Thu, 21 Mar 2024 17:17:26 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 75A1442DC3; Thu, 21 Mar 2024 17:17:25 +0100 (CET) Received: from mail-oo1-f51.google.com (mail-oo1-f51.google.com [209.85.161.51]) by mails.dpdk.org (Postfix) with ESMTP id A445A427E1 for ; Thu, 21 Mar 2024 17:17:24 +0100 (CET) Received: by mail-oo1-f51.google.com with SMTP id 006d021491bc7-5a4789684abso644587eaf.0 for ; Thu, 21 Mar 2024 09:17:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1711037844; x=1711642644; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=xVUryEj8Kq3FPCwIK8H3PBrS7GRSKTDof0Dxl18k0pg=; b=q2PqKZ70DLFdliHZKsP6C7uUQxBrgtifh8LnpAuDt/VCu/fZ9/EjuqbU/wlfQPFujj CoNiwZKBXtaO/DtfEFa/fiul+M5U/ylTDhNE/juGxACaHPO82mpSdtNEjlbkUXl2U9La QtCn/7y1qDA7imonRkSf0Qylyp7QH+cL46ezzHbIchCC63tVbvMOpiqXd61Pr7ZmVNUD li9vhrkV+OPiLwPbks7QclJh7CS/eL/wn+cpbyyY2n9CrCi2kCkKX1w4auMFe1TbmZ6F NtAcXkpVD5MPprnlCYcN7Rn5q5lbNR9Ivf6AT5KIevz6xLdRfU0fLjSU9e7Iy2/bcLQg GAYA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1711037844; x=1711642644; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=xVUryEj8Kq3FPCwIK8H3PBrS7GRSKTDof0Dxl18k0pg=; b=EQ5/wHrI9oGFH8i7dEV4NoXCXWLy2IE6kmHeR+//MRPd8ikaQ/3czJ9zAdBpYOLAyl pgxzgtKGbb1rmHmkyf+YGJCq7lFeN+ri1r1JSXtfDw/3Q2bdkNHJpSWgp893WuHa105G sapEoduDCtrPB5FCH5mdEjycymjiL7sSA7udx6oiylpnfHXymzUr4atgk2AoUNuQQbMF m1qF76sU+yaUhNP3NE4WmoY0V775/kqkBHM1yFCQNvfrMeZQvODtDNEqFCAQs6qwrT3I omH/HiJ2h4GWB6EppVez8hCGXBEIeRdYwkFbP1EClUtBe94a5whVGEE8mznNBuoRHzD+ w7pg== X-Gm-Message-State: AOJu0Yz3nscmycZwOMl7fy7NFq/8rSTM3mV9lQNLf4NN4H1y1KO46ZCi iwIQQl/gfb35AEkBv6TjE+q7y2fpyA7vaMZSmMz6K1alqeSNatrI6KYoXzNXAr18DKMMuBowxSv Q X-Google-Smtp-Source: AGHT+IEvIK3jB9bYH3S7QMVncDNzJ77qQbAzTQ6av2TN2t3HbxrH8ilZWE97MWKmM0Jn58eBMafGsg== X-Received: by 2002:a05:6358:c009:b0:17b:f3f9:117d with SMTP id kv9-20020a056358c00900b0017bf3f9117dmr6159588rwc.16.1711037524351; Thu, 21 Mar 2024 09:12:04 -0700 (PDT) Received: from hermes.local (204-195-123-203.wavecable.com. [204.195.123.203]) by smtp.gmail.com with ESMTPSA id w62-20020a638241000000b005e485fbd455sm41815pgd.45.2024.03.21.09.12.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 21 Mar 2024 09:12:04 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Subject: [PATCH v10 10/10] doc: add documentation of logging options Date: Thu, 21 Mar 2024 09:00:26 -0700 Message-ID: <20240321161146.340421-11-stephen@networkplumber.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240321161146.340421-1-stephen@networkplumber.org> References: <20200814173441.23086-1-stephen@networkplumber.org> <20240321161146.340421-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Add documentation of new log-timestamp and log-color options. Signed-off-by: Stephen Hemminger --- doc/guides/linux_gsg/eal_args.include.rst | 54 +++++++++++++++++++---- 1 file changed, 46 insertions(+), 8 deletions(-) diff --git a/doc/guides/linux_gsg/eal_args.include.rst b/doc/guides/linux_gsg/eal_args.include.rst index 9cfbf7de8456..8ba54a62c0f9 100644 --- a/doc/guides/linux_gsg/eal_args.include.rst +++ b/doc/guides/linux_gsg/eal_args.include.rst @@ -122,6 +122,52 @@ Memory-related options to system pthread stack size unless the optional size (in kbytes) is specified. +Logging options +~~~~~~~~~~~~~~~ + +* ``--log-level `` + + Specify log level for a specific component. For example:: + + --log-level lib.eal:debug + + Can be specified multiple times. + +* ``--log-facility=facility`` + + Specifies the ``syslog`` facility passed to ``openlog``. + The facility can be: ``auth``, ``cron``, ``daemon``, ``ftp``, + ``lpr``, ``mail``, ``news``, ``user``, ``uucp``, + ``local0``, ``local1``, ``local2``, ``local3``, ``local4``, + ``local5``, ``local6``, or ``local7``. The default if + no facility is specified is ``daemon``. + +* ``--log-timestamp[=format]`` + + Add a time stamp to log messages that are sent to the console (stderr). + When format argument is omitted the time stamp is elapsed + seconds since the start of the DPDK application. + Other formats are: + +.. csv-table:: Log time stamp format + :header: "Format", "Description", "Example" + :widths: 6, 30, 32 + + "ctime", "Unix ctime", "``[Wed Mar 20 07:26:12 2024]``" + "delta", "Offset since last", "``[< 3.162373>]``" + "reltime", "Seconds since last or time if minute changed", "``[ +3.001791]`` or ``[Mar20 07:26:12]``" + "iso", "ISO-8601", "``[2024-03-20T07:26:12−07:00]``" + +* ``--log-color[=when]`` + + Colorize the console output. + The optional argument ``when`` can be ``auto``, ``never`` or ``always``. + If the when argument is omitted, it defaults to ``auto``. + To disable use of color:: + + --log-color=none + + Debugging options ~~~~~~~~~~~~~~~~~ @@ -134,14 +180,6 @@ Debugging options Use anonymous memory instead of hugepages (implies no secondary process support). -* ``--log-level `` - - Specify log level for a specific component. For example:: - - --log-level lib.eal:debug - - Can be specified multiple times. - * ``--trace=`` Enable trace based on regular expression trace name. By default, the trace is -- 2.43.0