Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ccc: Add logging and debugging section #36

Merged

Conversation

FaHaGit
Copy link
Contributor

@FaHaGit FaHaGit commented Mar 7, 2025

No description provided.

@FaHaGit FaHaGit requested review from barsnick and lategoodbye March 7, 2025 09:15
Copy link

@barsnick barsnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some nits.

But a very useful text! Every customer should read this before submitting a support ticket. 😉

journalctl -f -u everest

The -f flag is used to follow the logs live when they are written. The -u flag is used to filter the logs
for the everest service. To stop following the logs, press :code:`Ctrl + C`.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To view log lines which have already passed when launching the command, add the :code:`-n <num>` option:

.. code-block:: console

    journalctl -f -n 100 -u everest

# The filter expression consists of two parts:
# 1. Logs with severity level INFO or higher (affects all EVerest modules).
# 2. Logs from the EvseManager process with severity level DEBUG or higher.
Filter="(%Severity% >= INFO) or (%Process% contains EvseManager and %Severity% >= DEBG)"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Due to a bug in liblog (EVerest/liblog#18), this will not work, as the filter only matches (e.g.) connector:EvseM, which is what is displayed in the console/journal log. I suggest using a different example.


tcpdump -i eth1 -w /srv/charge_com_01.pcap

This command captures all packets on the eth1 (QCA interface) interface and writes them to
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicated word.

Suggested change
This command captures all packets on the eth1 (QCA interface) interface and writes them to
This command captures all packets on the eth1 (QCA) interface and writes them to

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please avoid platform specific words like QCA. Also most of the new users do not know what QCA means.

PLC or Green PHY is better

#. Using the EVerest "PacketSniffer" module

The `PacketSniffer <https://github.com/EVerest/everest-core/tree/main/modules/PacketSniffer>`_ module
is part of EVerest-core and can be used to capture pcap traces automatically. Please look into
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
is part of EVerest-core and can be used to capture pcap traces automatically. Please look into
is part of everest-core and can be used to capture pcap traces automatically. Please look into

is part of EVerest-core and can be used to capture pcap traces automatically. Please look into
the module manifest to see how to configure the PacketSniffer module.

pcap traces with V2G communication can be analyzed using Wireshark with a V2G plugin like from `dSPACE <https://www.dspace.com/de/gmb/home/news/wireshark-charging-plug-in.cfm>`_.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This linked page is in German (/de), let's use the English language link:

Suggested change
pcap traces with V2G communication can be analyzed using Wireshark with a V2G plugin like from `dSPACE <https://www.dspace.com/de/gmb/home/news/wireshark-charging-plug-in.cfm>`_.
pcap traces with V2G communication can be analyzed using Wireshark with a V2G plugin like from `dSPACE <https://www.dspace.com/en/pub/home/news/wireshark-charging-plug-in.cfm>`_.

Session logging of the EVSEManager
----------------------------------
The EVerest "EVSEManager" is able to generate session log files with information about e.g. current session state,
configured, CP state, duty cycle and is also able to decode and log the content of the V2G messages.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's with the comma , after "configured"?


There are different ways to analyze the EVerest charging software. In the following, different
ways are described. In preparation for starting this chapter, it is necessary to be connected to the board
via Ethernet. This is also necessary to copy logs and traces from the board to the local PC via an FTP
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SFTP makes a difference here


tcpdump -i eth1 -w /srv/charge_com_01.pcap

This command captures all packets on the eth1 (QCA interface) interface and writes them to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please avoid platform specific words like QCA. Also most of the new users do not know what QCA means.

PLC or Green PHY is better

Copy link

@barsnick barsnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice!

@FaHaGit FaHaGit force-pushed the everest/ccc_add_logging_and_debugging_section branch from 2899041 to 6de256a Compare March 10, 2025 10:38
@FaHaGit FaHaGit merged commit d7fe2a4 into everest/charge_control_c Mar 10, 2025
1 check passed
@FaHaGit FaHaGit deleted the everest/ccc_add_logging_and_debugging_section branch March 10, 2025 10:40
FaHaGit added a commit that referenced this pull request Mar 11, 2025
* ccc: Add logging and debugging section

Signed-off-by: Fabian Hartung <[email protected]>

* Add links to the new logging_and_debugging chapter

Signed-off-by: Fabian Hartung <[email protected]>

---------

Signed-off-by: Fabian Hartung <[email protected]>
FaHaGit added a commit that referenced this pull request Mar 11, 2025
* ccc: Add logging and debugging section

Signed-off-by: Fabian Hartung <[email protected]>

* Add links to the new logging_and_debugging chapter

Signed-off-by: Fabian Hartung <[email protected]>

---------

Signed-off-by: Fabian Hartung <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants