diff options
| author | Christian Breunig <christian@breunig.cc> | 2025-09-04 21:32:29 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-09-04 21:32:29 +0200 |
| commit | 7bf883d61beaaea28ab1cb5f0d24e55e55ce5bfb (patch) | |
| tree | c3f113c225d092301d1992e3a9c13075818c5d38 /docs/vpp/configuration/dataplane/logging.rst | |
| parent | 4081daff9c6ee1917fd5a351882d7c1d9cc14e9a (diff) | |
| parent | 00faafed96d86a970bf566c79f1bfd304630ccaa (diff) | |
| download | vyos-documentation-7bf883d61beaaea28ab1cb5f0d24e55e55ce5bfb.tar.gz vyos-documentation-7bf883d61beaaea28ab1cb5f0d24e55e55ce5bfb.zip | |
Merge pull request #1679 from zdc/vpp-current
VPP: Add comprehensive VPP documentation
Diffstat (limited to 'docs/vpp/configuration/dataplane/logging.rst')
| -rw-r--r-- | docs/vpp/configuration/dataplane/logging.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/vpp/configuration/dataplane/logging.rst b/docs/vpp/configuration/dataplane/logging.rst new file mode 100644 index 00000000..41da367a --- /dev/null +++ b/docs/vpp/configuration/dataplane/logging.rst @@ -0,0 +1,42 @@ +:lastproofread: 2025-09-04 + +.. _vpp_config_dataplane_logging: + +.. include:: /_include/need_improvement.txt + +######################### +VPP Logging Configuration +######################### + +VPP logging is an important part of monitoring and troubleshooting the performance and behavior of the VPP dataplane. + +VPP logs are stored in the ``/var/log/vpp.log`` file. Additionally daemon logs can be found in the system journal. + +Logging detalization can be configured via the next command: + +.. cfgcmd:: set vpp settings logging default-log-level <level> + +Where ``<level>`` can be one of the following: + +- ``emerg`` (Emergency) - System is unusable. +- ``alert`` (Alert) - Immediate action required. +- ``crit`` (Critical) - Critical conditions. +- ``err`` (Error) - Error conditions. +- ``warn`` (Warning) - Warning conditions. +- ``notice`` (Notice) - Normal but significant. +- ``info`` (Informational) - Routine informational messages. +- ``debug`` (Debug) - Detailed debugging messages. +- ``disabled`` (Disabled) - Logging disabled. + +It is recommended to set logging level to ``debug`` only for troubleshooting purposes, as it can generate a large volume of log data. For regular operation, a level of ``info`` or ``warn`` is usually sufficient. + +Potential Issues and Troubleshooting +==================================== + +Improper logging configuration can lead to various issues, including: + +- Excessive log file sizes if the logging level is set too high (e.g., ``debug``) +- Missing critical information if the logging level is set too low (e.g., ``alert``) +- Performance degradation due to excessive logging overhead + +Consider adjusting the logging level if you experience issues mentioned above. |