Skip to content
Snippets Groups Projects
Commit d4d49581 authored by al.schwinn's avatar al.schwinn
Browse files

[SIL-262] Review the SILECS logger to make it compliant with the CO-DO 

TRACING standarization fields
parent 9395fe80
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 100 additions and 66 deletions
silecs-communication-cpp/src/silecs-communication/interface/communication/SilecsConnection.cpp
+ 42
− 20
View file @ d4d49581
...@@ -143,14 +143,20 @@ namespace Silecs ...@@ -143,14 +143,20 @@ namespace Silecs
if (thePLC->isSharedConnection()) if (thePLC->isSharedConnection())
{ {
LOG((COMM|DIAG)) << "Shared connection with " << thePLC->getName() << " is established."; std::ostringstream os;
os << "Shared connection with " << thePLC->getName() << " is established.";
if (thePLC->theHeader_ != NULL) TRACE("info") << os.str();
LOG(COMM) << os.str();
} }
else else
{ {
LOG((COMM|DIAG)) << "Connection with " << thePLC->getName() << std::ostringstream os;
":" << thePLC->theCluster_->getClassName() << os << "Connection with " << thePLC->getName() <<
"/v" << thePLC->theCluster_->getClassVersion() << ":" << thePLC->theCluster_->getClassName() <<
" is established."; "/v" << thePLC->theCluster_->getClassVersion() <<
" is established.";
if (thePLC->theHeader_ != NULL) TRACE("info") << os.str();
LOG(COMM) << os.str();
} }
isAlive_ = true; isAlive_ = true;
...@@ -199,14 +205,20 @@ namespace Silecs ...@@ -199,14 +205,20 @@ namespace Silecs
if (thePLC->isSharedConnection()) if (thePLC->isSharedConnection())
{ {
LOG((COMM|DIAG)) << "Shared connection with " << thePLC->getName() << " is closed."; std::ostringstream os;
os << "Shared connection with " << thePLC->getName() << " is closed.";
if (thePLC->theHeader_ != NULL) TRACE("warn") << os.str();
LOG(COMM) << os.str();
} }
else else
{ {
LOG((COMM|DIAG)) << "Connection with " << thePLC->getName() << std::ostringstream os;
" (" << thePLC->theCluster_->getClassName() << os << "Connection with " << thePLC->getName() <<
"/v" << thePLC->theCluster_->getClassVersion() << " (" << thePLC->theCluster_->getClassName() <<
")" << " is closed."; "/v" << thePLC->theCluster_->getClassVersion() <<
")" << " is closed.";
if (thePLC->theHeader_ != NULL) TRACE("warn") << os.str();
LOG(COMM) << os.str();
} }
} }
else else
...@@ -337,17 +349,27 @@ namespace Silecs ...@@ -337,17 +349,27 @@ namespace Silecs
: "Controller " + thePLC->getName() + " does not respond to ping, might be OFF!\n"; : "Controller " + thePLC->getName() + " does not respond to ping, might be OFF!\n";
if (delayConn_ == LongTermConnection) if (delayConn_ == LongTermConnection)
{ if (remainConn_ > 0) {
{ LOG((COMM|DIAG)) << errorMsg << "Periodic attempt to reconnect, delay " << delayConn_ << "s (logging off)."; if (remainConn_ > 0)
remainConn_ = 1; //Try to reconnect again and again (=1 means disable logging). {
} std::ostringstream os;
else os << errorMsg << "Periodic attempt to reconnect, delay " << delayConn_ << "s (tracing off).";
{ if (thePLC->theHeader_ != NULL) TRACE("error") << os.str();
LOG((COMM|DIAG)) << errorMsg << "PLC does not respond anymore. It's probably stopped for a long time. Trying to reconnect with long-term delay"; LOG(COMM) << os.str();
} remainConn_ = 1; //Try to reconnect again and again (=1 means disable tracing).
}
/*else
PLC does not respond anymore. It's probably stopped for a long time.
Do not log error anymore (but still try to reconnect, with long-term delay).
*/
} }
else else
LOG((COMM|DIAG)) << errorMsg << "Next attempt to reconnect in " << delayConn_ << "s if requested. Remains: " << remainConn_; {
std::ostringstream os;
os << errorMsg << "Next attempt to reconnect in " << delayConn_ << "s if requested. Remains: " << remainConn_;
if (thePLC->theHeader_ != NULL) TRACE("error") << os.str();
LOG(COMM) << os.str();
}
} }
//------------------------------------------------------------------------------------------------------------------------------------------------ //------------------------------------------------------------------------------------------------------------------------------------------------
......
silecs-communication-cpp/src/silecs-communication/interface/core/SilecsService.cpp
+ 7
− 5
View file @ d4d49581
...@@ -95,12 +95,12 @@ namespace Silecs ...@@ -95,12 +95,12 @@ namespace Silecs
if (instance_ == NULL) if (instance_ == NULL)
{ {
instance_ = new Service(argc, argv); instance_ = new Service(argc, argv);
LOG((ALLOC|DIAG)) << "SILECS Service create"; LOG((ALLOC)) << "SILECS Service create";
XMLParser::init(); XMLParser::init();
//ACET start-up message (once per process) //ACET start-up message (once per process)
TRACE("process") << "Version=" << semverMajor_ << "." << semverMinor_ << "." << semverPatch_; TRACE("info") << "SILECS service startup: libsilecs-comm " << semverMajor_ << "." << semverMinor_ << "." << semverPatch_;
} }
return instance_; return instance_;
} }
...@@ -109,9 +109,11 @@ namespace Silecs ...@@ -109,9 +109,11 @@ namespace Silecs
{ {
if (!isShutingDown_) if (!isShutingDown_)
{ isShutingDown_ = true; { isShutingDown_ = true;
LOG((ALLOC|DIAG)) << "SILECS Resources release"; LOG((ALLOC)) << "SILECS Resources release";
XMLParser::init(); TRACE("info") << "SILECS service shutdown: libsilecs-comm " << semverMajor_ << "." << semverMinor_ << "." << semverPatch_;
XMLParser::cleanUp();
if (instance_ != NULL) delete instance_; if (instance_ != NULL) delete instance_;
instance_ = NULL; instance_ = NULL;
......
silecs-communication-cpp/src/silecs-communication/interface/equipment/SilecsCluster.cpp
+ 5
− 14
View file @ d4d49581
...@@ -38,18 +38,12 @@ namespace Silecs ...@@ -38,18 +38,12 @@ namespace Silecs
Cluster::Cluster(const std::string className, const std::string classVersion) : className_ (className), classVersion_ (classVersion) Cluster::Cluster(const std::string className, const std::string classVersion) : className_ (className), classVersion_ (classVersion)
{ {
char hostName[128]; hostName_ = Log::getHost();
if (gethostname(hostName, 128) == -1)
throw SilecsException(__FILE__, __LINE__, errno, strerror(errno));
//store the hostname by removing the domain-name (.cern.ch) if any.
hostName_ = std::string(hostName);
removeDomainName(hostName_);
//Default run-time configuration setup //Default run-time configuration setup
configuration.sharedConnection = false; //Do not shared connection with other clusters by default configuration.sharedConnection = false; //Do not shared connection with other clusters by default
LOG((ALLOC|DIAG)) << "CLUSTER (create): " << className_ << "/" << classVersion_; LOG((ALLOC)) << "CLUSTER (create): " << className_ << "/" << classVersion_;
} }
Cluster::~Cluster() Cluster::~Cluster()
...@@ -65,11 +59,6 @@ namespace Silecs ...@@ -65,11 +59,6 @@ namespace Silecs
IPAddrMap_.clear(); //this map refer the same PLC object (not necessary to delete them) IPAddrMap_.clear(); //this map refer the same PLC object (not necessary to delete them)
} }
void Cluster::removeDomainName(std::string& hostName)
{ size_t domain = hostName.find_first_of('.');
if (domain != std::string::npos) hostName.erase(domain);
}
bool Cluster::getHostNameByAddress(const std::string IPAddress, std::string& hostName) bool Cluster::getHostNameByAddress(const std::string IPAddress, std::string& hostName)
{ {
struct hostent *he = NULL; struct hostent *he = NULL;
...@@ -169,7 +158,9 @@ namespace Silecs ...@@ -169,7 +158,9 @@ namespace Silecs
if (!getAddressByHostName(hostName, IPAddress)) if (!getAddressByHostName(hostName, IPAddress))
throw SilecsException(__FILE__, __LINE__, PARAM_UNKNOWN_PLC_HOSTNAME, hostName); throw SilecsException(__FILE__, __LINE__, PARAM_UNKNOWN_PLC_HOSTNAME, hostName);
} }
removeDomainName(hostName); //remove ".cern.ch" if any //remove domain name (.cern.ch) if any
size_t domain = hostName.find_first_of('.');
if (domain != std::string::npos) hostName.erase(domain);
//Then create the new instance of the PLC //Then create the new instance of the PLC
......
silecs-communication-cpp/src/silecs-communication/interface/equipment/SilecsCluster.h
+ 0
− 5
View file @ d4d49581
...@@ -171,11 +171,6 @@ namespace Silecs ...@@ -171,11 +171,6 @@ namespace Silecs
*/ */
~Cluster(); ~Cluster();
/*!
* \brief returns the input hostname without domain-name extension (cern.ch for instance)
*/
void removeDomainName(std::string& hostName);
bool getHostNameByAddress(const std::string IPAddress, std::string& hostName); bool getHostNameByAddress(const std::string IPAddress, std::string& hostName);
bool getAddressByHostName(const std::string hostName, std::string& IPAddress); bool getAddressByHostName(const std::string hostName, std::string& IPAddress);
......
silecs-communication-cpp/src/silecs-communication/interface/equipment/SilecsPLC.cpp
+ 13
− 13
View file @ d4d49581
...@@ -146,19 +146,19 @@ namespace Silecs ...@@ -146,19 +146,19 @@ namespace Silecs
//Warn ACET service that a new connection is established (except for SilecsHeader) //Warn ACET service that a new connection is established (except for SilecsHeader)
if (theHeader_ != NULL) { if (theHeader_ != NULL) {
TRACE("cluster") << "ClassName=" << theCluster_->getClassName() << "|" << TRACE("info") << "Connection setup: ClassName=" << theCluster_->getClassName() << ", " <<
"ClassVersion=" << theCluster_->getClassVersion() << "|" << "ClassVersion=" << theCluster_->getClassVersion() << ", " <<
"Owner=" << localOwner_ << "|" << "Owner=" << localOwner_ << ", " <<
"GenerationRelease=" << localRelease_ << "|" << "GenerationRelease=" << localRelease_ << ", " <<
"GenerationDate=" << localDate_ << "|" << "GenerationDate=" << localDate_ << ", " <<
"PlcChecksum=" << localChecksum_ << "|" << "PlcChecksum=" << localChecksum_ << ", " <<
"PlcDomain=" << domain_ << "|" << "PlcDomain=" << domain_ << ", " <<
"PlcHostname=" << name_ << "|" << "PlcHostname=" << name_ << ", " <<
"PlcBrand=" << brand_ << "|" << "PlcBrand=" << brand_ << ", " <<
"PlcSystem=" << system_ << "|" << "PlcSystem=" << system_ << ", " <<
"PlcModel=" << model_ << "|" << "PlcModel=" << model_ << ", " <<
"ProtocolAddress=" << baseAddr_ << "|" << "ProtocolAddress=" << baseAddr_ << ", " <<
"ProtocolMode=" << protocolMode_ << "|" << "ProtocolMode=" << protocolMode_ << ", " <<
"InstanceNumber=" << deviceCol_.size(); "InstanceNumber=" << deviceCol_.size();
} }
}; };
......
silecs-communication-cpp/src/silecs-communication/interface/utility/SilecsLog.cpp
+ 24
− 9
View file @ d4d49581
...@@ -16,9 +16,10 @@ ...@@ -16,9 +16,10 @@
#include <silecs-communication/interface/utility/SilecsLog.h> #include <silecs-communication/interface/utility/SilecsLog.h>
#include <silecs-communication/interface/utility/StringUtilities.h> #include <silecs-communication/interface/utility/StringUtilities.h>
#include <silecs-communication/interface/utility/TimeStamp.h> #include <silecs-communication/interface/utility/TimeStamp.h>
#include <silecs-communication/interface/utility/SilecsException.h>
#include <syslog.h> #include <syslog.h>
#include <string.h> #include <string.h>
#include <errno.h>
namespace Silecs namespace Silecs
{ {
...@@ -30,6 +31,10 @@ namespace Silecs ...@@ -30,6 +31,10 @@ namespace Silecs
unsigned long Log::topics_ = 0; unsigned long Log::topics_ = 0;
unsigned long Log::systopics_ = TRACE|DIAG; unsigned long Log::systopics_ = TRACE|DIAG;
std::string Log::host_ = "";
pid_t Log::pid_ = -1;
std::string Log::process_ = "";
bool Log::syslogIsStarted_ = false; //syslog not yet started bool Log::syslogIsStarted_ = false; //syslog not yet started
TsCounter Log::timeStamp_(true); TsCounter Log::timeStamp_(true);
...@@ -72,7 +77,6 @@ namespace Silecs ...@@ -72,7 +77,6 @@ namespace Silecs
} }
//Return false if topic parameters are not correct or empty //Return false if topic parameters are not correct or empty
//if (!(wrongTopic || topicCol.size()==0)) // replaced for performance
if (!(wrongTopic || topicCol.empty())) if (!(wrongTopic || topicCol.empty()))
{ {
topics_ = topicsTemp; topics_ = topicsTemp;
...@@ -99,12 +103,11 @@ namespace Silecs ...@@ -99,12 +103,11 @@ namespace Silecs
return os; return os;
} }
std::ostringstream& Log::getTrace(std::string source) std::ostringstream& Log::getTrace(std::string level)
{ {
os << "Environment=prod|MessageType=static|MessageSeverity=info|SenderType=library|SenderDomain=silecs|SenderSubdomain=client|"; os << "host=" << getHost() << ",level=" << level << ",pid=" << getPid() << ",system=SILECS" << ",subsystem=libsilecs-comm" << ",process=" << getProcess() << ",body=";
os << "SenderSource=" << source << "||"; return os;
return os; }
}
std::ostringstream& Log::getLogDelay() std::ostringstream& Log::getLogDelay()
{ {
...@@ -139,7 +142,19 @@ namespace Silecs ...@@ -139,7 +142,19 @@ namespace Silecs
{ {
if (!syslogIsStarted_) if (!syslogIsStarted_)
{ {
systopics_ |= topics; char hostName[128];
if (gethostname(hostName, 128) == -1)
throw SilecsException(__FILE__, __LINE__, errno, strerror(errno));
//remove domain name (.cern.ch) if any
host_ = std::string(hostName);
size_t domain = host_.find_first_of('.');
if (domain != std::string::npos) host_.erase(domain);
pid_ = getpid();
process_ = std::string(ident);
systopics_ |= topics;
/* syslog service uses file configuration (required root access): /* syslog service uses file configuration (required root access):
* /etc/<syslog.conf> : to define the ouput channel (file, console, host) * /etc/<syslog.conf> : to define the ouput channel (file, console, host)
......
silecs-communication-cpp/src/silecs-communication/interface/utility/SilecsLog.h
+ 9
− 0
View file @ d4d49581
...@@ -89,6 +89,10 @@ namespace Silecs ...@@ -89,6 +89,10 @@ namespace Silecs
static void startSyslog(char* ident, unsigned long systopics); static void startSyslog(char* ident, unsigned long systopics);
static void stopSyslog(); static void stopSyslog();
static std::string& getHost() { return host_; }
static pid_t& getPid() { return pid_; }
static std::string& getProcess() { return process_; }
// return valid log arguments as string: '-plcLog topic1[,topic2,..]' // return valid log arguments as string: '-plcLog topic1[,topic2,..]'
static std::string getLogArguments(); static std::string getLogArguments();
...@@ -101,11 +105,16 @@ namespace Silecs ...@@ -101,11 +105,16 @@ namespace Silecs
static unsigned long systopics_;//set of topics to be logged using the syslog mechanism static unsigned long systopics_;//set of topics to be logged using the syslog mechanism
private: private:
friend class SilecsService;
Log(const Log&); Log(const Log&);
Log& operator =(const Log&); Log& operator =(const Log&);
std::ostringstream os; std::ostringstream os;
static TsCounter timeStamp_; static TsCounter timeStamp_;
static bool syslogIsStarted_; static bool syslogIsStarted_;
static std::string host_;
static pid_t pid_;
static std::string process_;
}; };
} // namespace } // namespace
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

https://git.gsi.de is provided by CIT→Linux&Web | GSI Helmholtzzentrum fuer Schwerionenforschung GmbH | Imprint (in German) | Privacy policy