#12329 Simplify interface for log messages

This commit is contained in:
Magne Sjaastad committed 2025-04-08 14:26:04 +02:00
1 parent 60d2bf0483
commit 380f559f0d
7 files changed
+77 -82

No files matched your search

@@ -230,6 +230,8 @@ RiaPreferencesSystem::EclipseTextFileReaderMode RiaPreferencesSystem::eclipseTex
//-------------------------------------------------------------------------------------------------- //--------------------------------------------------------------------------------------------------
bool RiaPreferencesSystem::isLoggingActivatedForKeyword( const QString& keyword ) const bool RiaPreferencesSystem::isLoggingActivatedForKeyword( const QString& keyword ) const
{ {
if ( keyword.isEmpty() ) return true;
QStringList keywords = m_keywordsForLogging().split( ";" ); QStringList keywords = m_keywordsForLogging().split( ";" );
if ( keywords.contains( "enable-all" ) ) return true; if ( keywords.contains( "enable-all" ) ) return true;
@@ -18,6 +18,7 @@
#include "RiaLogging.h" #include "RiaLogging.h"
#include "RiaGuiApplication.h" #include "RiaGuiApplication.h"
#include "RiaPreferencesSystem.h"
#include "RiaRegressionTestRunner.h" #include "RiaRegressionTestRunner.h"
#include <iostream> #include <iostream>
@@ -245,8 +246,10 @@ RILogLevel RiaLogging::logLevelBasedOnPreferences()
//-------------------------------------------------------------------------------------------------- //--------------------------------------------------------------------------------------------------
/// ///
//-------------------------------------------------------------------------------------------------- //--------------------------------------------------------------------------------------------------
void RiaLogging::error( const QString& message ) void RiaLogging::error( const QString& message, const QString logKeyword )
{ {
if ( !RiaPreferencesSystem::current()->isLoggingActivatedForKeyword( logKeyword ) ) return;
if ( isSameMessage( message ) ) return; if ( isSameMessage( message ) ) return;
for ( const auto& logger : sm_logger ) for ( const auto& logger : sm_logger )
@@ -264,8 +267,10 @@ void RiaLogging::error( const QString& message )
//-------------------------------------------------------------------------------------------------- //--------------------------------------------------------------------------------------------------
/// ///
//-------------------------------------------------------------------------------------------------- //--------------------------------------------------------------------------------------------------
void RiaLogging::warning( const QString& message ) void RiaLogging::warning( const QString& message, const QString logKeyword )
{ {
if ( !RiaPreferencesSystem::current()->isLoggingActivatedForKeyword( logKeyword ) ) return;
if ( isSameMessage( message ) ) return; if ( isSameMessage( message ) ) return;
for ( const auto& logger : sm_logger ) for ( const auto& logger : sm_logger )
@@ -283,8 +288,10 @@ void RiaLogging::warning( const QString& message )
//-------------------------------------------------------------------------------------------------- //--------------------------------------------------------------------------------------------------
/// ///
//-------------------------------------------------------------------------------------------------- //--------------------------------------------------------------------------------------------------
void RiaLogging::info( const QString& message ) void RiaLogging::info( const QString& message, const QString logKeyword )
{ {
if ( !RiaPreferencesSystem::current()->isLoggingActivatedForKeyword( logKeyword ) ) return;
if ( isSameMessage( message ) ) return; if ( isSameMessage( message ) ) return;
for ( const auto& logger : sm_logger ) for ( const auto& logger : sm_logger )
@@ -302,8 +309,10 @@ void RiaLogging::info( const QString& message )
//-------------------------------------------------------------------------------------------------- //--------------------------------------------------------------------------------------------------
/// ///
//-------------------------------------------------------------------------------------------------- //--------------------------------------------------------------------------------------------------
void RiaLogging::debug( const QString& message ) void RiaLogging::debug( const QString& message, const QString logKeyword )
{ {
if ( !RiaPreferencesSystem::current()->isLoggingActivatedForKeyword( logKeyword ) ) return;
if ( isSameMessage( message ) ) return; if ( isSameMessage( message ) ) return;
for ( const auto& logger : sm_logger ) for ( const auto& logger : sm_logger )
@@ -23,7 +23,8 @@
#include <string> #include <string>
#include <vector> #include <vector>
class QString; #include <QString>
class QWidget; class QWidget;
enum class RILogLevel enum class RILogLevel
@@ -66,10 +67,10 @@ public:
static RILogLevel logLevelBasedOnPreferences(); static RILogLevel logLevelBasedOnPreferences();
static void error( const QString& message ); static void error( const QString& message, const QString logKeyword = "" );
static void warning( const QString& message ); static void warning( const QString& message, const QString logKeyword = "" );
static void info( const QString& message ); static void info( const QString& message, const QString logKeyword = "" );
static void debug( const QString& message ); static void debug( const QString& message, const QString logKeyword = "" );
static void errorInMessageBox( QWidget* parent, const QString& title, const QString& text ); static void errorInMessageBox( QWidget* parent, const QString& title, const QString& text );
@@ -19,7 +19,6 @@
#include "RifReaderOpmCommonActive.h" #include "RifReaderOpmCommonActive.h"
#include "RiaLogging.h" #include "RiaLogging.h"
#include "RiaPreferencesSystem.h"
#include "RiaStdStringTools.h" #include "RiaStdStringTools.h"
#include "RifOpmRadialGridTools.h" #include "RifOpmRadialGridTools.h"
@@ -160,14 +159,10 @@ bool RifReaderOpmCommonActive::importGrid( RigMainGrid* /* mainGrid*/, RigEclips
// grid geometry // grid geometry
{ {
const bool isLoggingEnabled = RiaPreferencesSystem::current()->isLoggingActivatedForKeyword( "RifReaderOpmCommonActive" ); RiaLogging::info( QString( "Loading %0 active of %1 total cells in main grid." )
.arg( QString::fromStdString( RiaStdStringTools::formatThousandGrouping( opmGrid.totalActiveCells() ) ) )
if ( isLoggingEnabled ) .arg( QString::fromStdString( RiaStdStringTools::formatThousandGrouping( opmGrid.totalNumberOfCells() ) ) ),
{ "RifReaderOpmCommonActive" );
RiaLogging::info( QString( "Loading %0 active of %1 total cells in main grid." )
.arg( QString::fromStdString( RiaStdStringTools::formatThousandGrouping( opmGrid.totalActiveCells() ) ) )
.arg( QString::fromStdString( RiaStdStringTools::formatThousandGrouping( opmGrid.totalNumberOfCells() ) ) ) );
}
auto task = progInfo.task( "Loading Active Cell Main Grid Geometry" ); auto task = progInfo.task( "Loading Active Cell Main Grid Geometry" );
transferActiveGeometry( opmGrid, opmGrid, activeGrid, activeGrid, eclipseCaseData ); transferActiveGeometry( opmGrid, opmGrid, activeGrid, activeGrid, eclipseCaseData );
@@ -178,14 +173,12 @@ bool RifReaderOpmCommonActive::importGrid( RigMainGrid* /* mainGrid*/, RigEclips
for ( int lgrIdx = 0; lgrIdx < numLGRs; lgrIdx++ ) for ( int lgrIdx = 0; lgrIdx < numLGRs; lgrIdx++ )
{ {
if ( isLoggingEnabled ) RiaLogging::info( QString( "Loading %0 active of %1 total cells in LGR grid %2." )
{ .arg( QString::fromStdString( RiaStdStringTools::formatThousandGrouping( lgrGrids[lgrIdx].totalActiveCells() ) ) )
RiaLogging::info( .arg( QString::fromStdString(
QString( "Loading %0 active of %1 total cells in LGR grid %2." ) RiaStdStringTools::formatThousandGrouping( lgrGrids[lgrIdx].totalNumberOfCells() ) ) )
.arg( QString::fromStdString( RiaStdStringTools::formatThousandGrouping( lgrGrids[lgrIdx].totalActiveCells() ) ) ) .arg( lgrIdx + 1 ),
.arg( QString::fromStdString( RiaStdStringTools::formatThousandGrouping( lgrGrids[lgrIdx].totalNumberOfCells() ) ) ) "RifReaderOpmCommonActive" );
.arg( lgrIdx + 1 ) );
}
RigGridBase* parentGrid = hasParentInfo ? activeGrid->gridByName( lgr_parent_names[lgrIdx] ) : activeGrid; RigGridBase* parentGrid = hasParentInfo ? activeGrid->gridByName( lgr_parent_names[lgrIdx] ) : activeGrid;
@@ -19,7 +19,6 @@
#include "RigCellFaceGeometryTools.h" #include "RigCellFaceGeometryTools.h"
#include "RiaLogging.h" #include "RiaLogging.h"
#include "RiaPreferencesSystem.h"
#include "RigActiveCellInfo.h" #include "RigActiveCellInfo.h"
#include "RigCell.h" #include "RigCell.h"
@@ -134,8 +133,6 @@ RigConnectionContainer RigCellFaceGeometryTools::computeOtherNncs( const RigMain
// by Eclipse. Use faults as basis for subset of cells to find NNC connection for. The imported connections from // by Eclipse. Use faults as basis for subset of cells to find NNC connection for. The imported connections from
// Eclipse are located at the beginning of the connections vector. // Eclipse are located at the beginning of the connections vector.
const bool isLoggingEnabled = RiaPreferencesSystem::current()->isLoggingActivatedForKeyword( "RigCellFaceGeometryTools" );
std::set<std::pair<unsigned, unsigned>> nativeCellPairs; std::set<std::pair<unsigned, unsigned>> nativeCellPairs;
for ( size_t i = 0; i < nativeConnections.size(); ++i ) for ( size_t i = 0; i < nativeConnections.size(); ++i )
@@ -149,7 +146,7 @@ RigConnectionContainer RigCellFaceGeometryTools::computeOtherNncs( const RigMain
QString message = QString( "Nnc connection imported from Eclipse are not unique\nNNC count : %1\nUnique : %2" ) QString message = QString( "Nnc connection imported from Eclipse are not unique\nNNC count : %1\nUnique : %2" )
.arg( nativeConnections.size() ) .arg( nativeConnections.size() )
.arg( nativeCellPairs.size() ); .arg( nativeCellPairs.size() );
if ( isLoggingEnabled ) RiaLogging::warning( message ); RiaLogging::warning( message, "RigCellFaceGeometryTools" );
} }
const cvf::Collection<RigFault>& faults = mainGrid->faults(); const cvf::Collection<RigFault>& faults = mainGrid->faults();
@@ -205,7 +202,7 @@ RigConnectionContainer RigCellFaceGeometryTools::computeOtherNncs( const RigMain
"inactive cells can be managed from Preferences->Eclipse Grid->Include Inactive Cells" ) "inactive cells can be managed from Preferences->Eclipse Grid->Include Inactive Cells" )
.arg( otherConnections.size() ) .arg( otherConnections.size() )
.arg( nncCountWarningThreshold ); .arg( nncCountWarningThreshold );
if ( isLoggingEnabled ) RiaLogging::warning( txt ); RiaLogging::warning( txt, "RigCellFaceGeometryTools" );
} }
otherConnections.remove_duplicates(); otherConnections.remove_duplicates();
@@ -199,8 +199,8 @@ bool RigNNCData::ensureAllConnectionDataIsProcessed()
{ {
caf::ProgressInfo progressInfo( 3, "Computing NNC Data" ); caf::ProgressInfo progressInfo( 3, "Computing NNC Data" );
bool isLoggingEnabled = RiaPreferencesSystem::current()->isLoggingActivatedForKeyword( "RigNNCData" ); const QString logKeyword = "RigNNCData";
if ( isLoggingEnabled ) RiaLogging::info( "NNC geometry computation - starting process" ); RiaLogging::info( "NNC geometry computation - starting process", logKeyword );
buildPolygonsForEclipseConnections(); buildPolygonsForEclipseConnections();
progressInfo.incrementProgress(); progressInfo.incrementProgress();
@@ -212,28 +212,25 @@ bool RigNNCData::ensureAllConnectionDataIsProcessed()
m_mainGrid->distributeNNCsToFaults(); m_mainGrid->distributeNNCsToFaults();
if ( isLoggingEnabled ) QStringList noCommonAreaText;
const size_t maxItemCount = 20;
size_t noCommonAreaCount = connectionsWithNoCommonArea( noCommonAreaText, maxItemCount );
RiaLogging::info( "NNC geometry computation - completed process", logKeyword );
RiaLogging::info( QString( "Native NNC count : %1" ).arg( eclipseConnectionCount() ), logKeyword );
RiaLogging::info( QString( "Computed NNC count : %1" ).arg( m_connections.size() ), logKeyword );
RiaLogging::info( QString( "NNCs with no common area count : %1" ).arg( noCommonAreaCount ), logKeyword );
if ( !noCommonAreaText.isEmpty() )
{ {
QStringList noCommonAreaText; RiaLogging::info( QString( "Listing first %1 NNCs with no common area " ).arg( noCommonAreaText.size() ), logKeyword );
const size_t maxItemCount = 20;
size_t noCommonAreaCount = connectionsWithNoCommonArea( noCommonAreaText, maxItemCount ); for ( const auto& s : noCommonAreaText )
RiaLogging::info( "NNC geometry computation - completed process" );
RiaLogging::info( QString( "Native NNC count : %1" ).arg( eclipseConnectionCount() ) );
RiaLogging::info( QString( "Computed NNC count : %1" ).arg( m_connections.size() ) );
RiaLogging::info( QString( "NNCs with no common area count : %1" ).arg( noCommonAreaCount ) );
if ( !noCommonAreaText.isEmpty() )
{ {
RiaLogging::info( QString( "Listing first %1 NNCs with no common area " ).arg( noCommonAreaText.size() ) ); RiaLogging::info( s, logKeyword );
for ( const auto& s : noCommonAreaText )
{
RiaLogging::info( s );
}
} }
} }
} }
@@ -22,7 +22,6 @@
#include "RiaEclipseUnitTools.h" #include "RiaEclipseUnitTools.h"
#include "RiaLogging.h" #include "RiaLogging.h"
#include "RiaPorosityModel.h" #include "RiaPorosityModel.h"
#include "RiaPreferencesSystem.h"
#include "RiaResultNames.h" #include "RiaResultNames.h"
#include "RiaWeightedMeanCalculator.h" #include "RiaWeightedMeanCalculator.h"
@@ -68,8 +67,6 @@ void RigWellTargetMapping::generateCandidates( RimEclipseCase* eclips
{ {
if ( !eclipseCase->ensureReservoirCaseIsOpen() ) return; if ( !eclipseCase->ensureReservoirCaseIsOpen() ) return;
bool isLoggingEnabled = RiaPreferencesSystem::current()->isLoggingActivatedForKeyword( "RigWellTargetMapping" );
auto activeCellCount = getActiveCellCount( eclipseCase ); auto activeCellCount = getActiveCellCount( eclipseCase );
if ( !activeCellCount ) if ( !activeCellCount )
{ {
@@ -161,6 +158,8 @@ void RigWellTargetMapping::generateCandidates( RimEclipseCase* eclips
filterVector = std::vector<double>( data.pressure.size(), 1.0 ); filterVector = std::vector<double>( data.pressure.size(), 1.0 );
} }
const QString logKeyword = "RigWellTargetMapping";
std::vector<int> clusters( activeCellCount.value(), 0 ); std::vector<int> clusters( activeCellCount.value(), 0 );
auto start = std::chrono::high_resolution_clock::now(); auto start = std::chrono::high_resolution_clock::now();
int numClusters = limits.maxNumTargets; int numClusters = limits.maxNumTargets;
@@ -172,12 +171,12 @@ void RigWellTargetMapping::generateCandidates( RimEclipseCase* eclips
if ( startCell.has_value() ) if ( startCell.has_value() )
{ {
if ( isLoggingEnabled ) RiaLogging::info( QString( "Cluster %1 start cell: [%2 %3 %4] " )
RiaLogging::info( QString( "Cluster %1 start cell: [%2 %3 %4] " ) .arg( clusterId )
.arg( clusterId ) .arg( startCell->i() + 1 )
.arg( startCell->i() + 1 ) .arg( startCell->j() + 1 )
.arg( startCell->j() + 1 ) .arg( startCell->k() + 1 ),
.arg( startCell->k() + 1 ) ); logKeyword );
growCluster( eclipseCase, startCell.value(), volumeType, limits, data, filterVector, clusters, clusterId, timeStepIdx, maxIterations ); growCluster( eclipseCase, startCell.value(), volumeType, limits, data, filterVector, clusters, clusterId, timeStepIdx, maxIterations );
numClustersFound++; numClustersFound++;
@@ -194,7 +193,7 @@ void RigWellTargetMapping::generateCandidates( RimEclipseCase* eclips
auto finish = std::chrono::high_resolution_clock::now(); auto finish = std::chrono::high_resolution_clock::now();
auto milliseconds = std::chrono::duration_cast<std::chrono::milliseconds>( finish - start ); auto milliseconds = std::chrono::duration_cast<std::chrono::milliseconds>( finish - start );
RiaLogging::info( QString( "Time spent: %1 ms" ).arg( milliseconds.count() ) ); RiaLogging::info( QString( "Time spent: %1 ms" ).arg( milliseconds.count() ), logKeyword );
QString resultName = RigWellTargetMapping::wellTargetResultName(); QString resultName = RigWellTargetMapping::wellTargetResultName();
createResultVector( *eclipseCase, resultName, clusters ); createResultVector( *eclipseCase, resultName, clusters );
@@ -235,28 +234,25 @@ void RigWellTargetMapping::generateCandidates( RimEclipseCase* eclips
int clusterId = 1; int clusterId = 1;
for ( const auto& s : statistics ) for ( const auto& s : statistics )
{ {
if ( isLoggingEnabled ) auto logIfValid = [&logKeyword]( const QString& pattern, double value )
{ {
auto logIfValid = []( const QString& pattern, double value ) if ( !std::isinf( value ) && !std::isnan( value ) ) RiaLogging::info( pattern.arg( value ), logKeyword );
{ };
if ( !std::isinf( value ) && !std::isnan( value ) ) RiaLogging::info( pattern.arg( value ) );
};
RiaLogging::info( QString( "Cluster #%1 Statistics" ).arg( s.id ) ); RiaLogging::info( QString( "Cluster #%1 Statistics" ).arg( s.id ), logKeyword );
RiaLogging::info( QString( "Number of cells: %1" ).arg( s.numCells ) ); RiaLogging::info( QString( "Number of cells: %1" ).arg( s.numCells ), logKeyword );
logIfValid( "Total PORV*SOIL: %1", s.totalPorvSoil ); logIfValid( "Total PORV*SOIL: %1", s.totalPorvSoil );
logIfValid( "Total PORV*SOIL: %1", s.totalPorvSoil ); logIfValid( "Total PORV*SOIL: %1", s.totalPorvSoil );
logIfValid( "Total PORV*SGAS: %1", s.totalPorvSgas ); logIfValid( "Total PORV*SGAS: %1", s.totalPorvSgas );
logIfValid( "Total PORV*(SOIL+SGAS): %1", s.totalPorvSoilAndSgas ); logIfValid( "Total PORV*(SOIL+SGAS): %1", s.totalPorvSoilAndSgas );
logIfValid( "Total FIPOIL: %1", s.totalFipOil ); logIfValid( "Total FIPOIL: %1", s.totalFipOil );
logIfValid( "Total FIPGAS: %1", s.totalFipGas ); logIfValid( "Total FIPGAS: %1", s.totalFipGas );
logIfValid( "Total RFIPOIL: %1", s.totalRfipOil ); logIfValid( "Total RFIPOIL: %1", s.totalRfipOil );
logIfValid( "Total RFIPGAS: %1", s.totalRfipGas ); logIfValid( "Total RFIPGAS: %1", s.totalRfipGas );
logIfValid( "Total SFIPOIL: %1", s.totalSfipOil ); logIfValid( "Total SFIPOIL: %1", s.totalSfipOil );
logIfValid( "Total SFIPGAS: %1", s.totalSfipGas ); logIfValid( "Total SFIPGAS: %1", s.totalSfipGas );
logIfValid( "Average Permeability: %1", s.permeability ); logIfValid( "Average Permeability: %1", s.permeability );
logIfValid( "Average Pressure: %1", s.pressure ); logIfValid( "Average Pressure: %1", s.pressure );
}
addValuesForClusterId( totalPorvSoil, clusters, clusterId, s.totalPorvSoil ); addValuesForClusterId( totalPorvSoil, clusters, clusterId, s.totalPorvSoil );
addValuesForClusterId( totalPorvSgas, clusters, clusterId, s.totalPorvSgas ); addValuesForClusterId( totalPorvSgas, clusters, clusterId, s.totalPorvSgas );