Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/vpp/configuration/dataplane/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
VPP Logging Configuration
#########################

VPP logging is an important part of monitoring and troubleshooting the performance and behavior of the VPP dataplane.

Check warning on line 11 in docs/vpp/configuration/dataplane/logging.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=117

VPP stores logs in two places:

- ``/var/log/vpp.log`` — This file contains logs related to daemon startup and log of commands executed directly via VPP CLI. Pay attention, VyOS does not use VPP CLI for configuration, so this log will not contain any configuration changes made via VyOS CLI, and will not be informative in most cases.

Check warning on line 15 in docs/vpp/configuration/dataplane/logging.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=302
- System journal — contains logs related to the VPP daemon work, including errors, warnings, and informational messages. It is the main destination of logs generated by VPP.

Check warning on line 16 in docs/vpp/configuration/dataplane/logging.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=173

Logging detalization can be configured via the next command:

Expand All @@ -24,22 +24,22 @@
- ``emerg`` (Emergency) - System is unusable.
- ``alert`` (Alert) - Immediate action required.
- ``crit`` (Critical) - Critical conditions.
- ``err`` (Error) - Error conditions.
- ``error`` (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.

Check warning on line 34 in docs/vpp/configuration/dataplane/logging.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=211

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``)

Check warning on line 41 in docs/vpp/configuration/dataplane/logging.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=81
- Missing critical information if the logging level is set too low (e.g., ``alert``)

Check warning on line 42 in docs/vpp/configuration/dataplane/logging.rst

View workflow job for this annotation

GitHub Actions / lint-doc / doc-lint

Line too long: len=84
- Performance degradation due to excessive logging overhead

Consider adjusting the logging level if you experience issues mentioned above.
Loading