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.

Sign up for GitHub

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

Jump to bottom

Restructure loggers and log calls #236

Draft
wants to merge 31 commits into
base: master
Choose a base branch
from
Draft

Restructure loggers and log calls #236

wants to merge 31 commits into from

Conversation

JTS22
Copy link
Contributor

@JTS22 JTS22 commented Jul 24, 2023 •
edited by dinkelbachjan
Loading

This PR improves upon the existing logging system in multiple ways:

  • Logs are grouped into different categories Simulation, Component and additional debugging logs (e.g. CIMReader,CSVReader)
  • Log levels can be configured for file and CLI output independently
  • The log levels for the existing log calls have been adapted to match the updated DPsim logging guidelines (https://dpsim.fein-aachen.org/docs/development/guidelines/#logging)

Closes #88

JTS22 added 22 commits July 24, 2023 13:55
@JTS22
log all components to the same file
eeeeddb 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
enable debug logging
9b9c9e2 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
set max log level according to build type
653f90c 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
introduce custom sink type
115a266 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
remove name argument for csvreader log
0e530da 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
remove solver name variable
85a5ab6 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
clean up scheduler and MNASolverPlugin loggers
8efb2bf 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
remove CIMReader name and add cli log level
8af1b59 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
do not use logger registry to allow duplicates
a265cdb 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
fix log file names
3c58a45 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
demote all CIMReader info log to debug
4470443 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
demote scheduler info log to debug
891cdb8 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
add separate cli log level for simulation and scheduler
d43597f 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
change solver logs to debug level
f7703c3 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
add a new logger for interfaces
0e1dd5d 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
change some simulation logs to debug level
b33f6b9 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
update component log levels
83a3b69 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
allow multiple simulation loggers for different filepaths
d60a9b6 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
propagate simulation cliLevel to solvers
0adb4cc 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
set component cliLevel according to logLevel
d81463a 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
update log levels for component initialize methods
4a0c9e0 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
log domain on simulation init
83ce14f 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22 JTS22 force-pushed the improve-logging branch from d8b0791 to 83ce14f Compare July 24, 2023 14:01
@JTS22
add an internal logger to simulation for logging iteration counts
7d4d5f4 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22 JTS22 force-pushed the improve-logging branch from 5cc87e3 to 51ae163 Compare July 25, 2023 13:48
@JTS22
remove old python log_attribute methods
5fad5b6 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22 JTS22 force-pushed the improve-logging branch from 51ae163 to 5fad5b6 Compare July 26, 2023 09:47
JTS22 added 3 commits July 26, 2023 10:04
@JTS22
allow overwriting the simulation default logger
0181cb0 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
only create left/right-vector logs on trace level
5772700 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
manually open / close non-simulation data loggers
22ce8b9 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
change log level in notebooks using LeftVector log
d3e84de 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@sonarcloud
Copy link

sonarcloud bot commented Jul 26, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

Bug C 2 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 32 Code Smells

0.0% 0.0% Coverage
16.0% 16.0% Duplication

idea Catch issues before they fail your Quality Gate with our IDE extension sonarlint SonarLint

@JTS22 JTS22 mentioned this pull request Jul 27, 2023
Open
JTS22 added 3 commits July 27, 2023 16:23
@JTS22
update some log levels
d5d6183 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
update logging guidelines in documentation
88be7bd 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@JTS22
use the DataLogger for trace logging in DP_Ph1_Capacitor
f66fe17 
Signed-off-by: Jonas Schroeder <jonas.schroeder1@rwth-aachen.de>
@leonardocarreras leonardocarreras mentioned this pull request Jun 6, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m-mirz m-mirz Awaiting requested review from m-mirz m-mirz will be requested when the pull request is marked ready for review m-mirz is a code owner

@stv0g stv0g Awaiting requested review from stv0g stv0g will be requested when the pull request is marked ready for review stv0g is a code owner

@pipeacosta pipeacosta Awaiting requested review from pipeacosta pipeacosta will be requested when the pull request is marked ready for review pipeacosta is a code owner

@gnakti gnakti Awaiting requested review from gnakti gnakti will be requested when the pull request is marked ready for review gnakti is a code owner

@n-eiling n-eiling Awaiting requested review from n-eiling n-eiling will be requested when the pull request is marked ready for review n-eiling is a code owner

@dinkelbachjan dinkelbachjan Awaiting requested review from dinkelbachjan dinkelbachjan will be requested when the pull request is marked ready for review dinkelbachjan is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
DPsim
Status: In Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Guideline on logging level choice
1 participant
@JTS22