{"id":367,"date":"2021-03-23T16:32:39","date_gmt":"2021-03-24T00:32:39","guid":{"rendered":"http:\/\/www.antunkarlovac.com\/blog\/?p=367"},"modified":"2021-03-23T16:32:39","modified_gmt":"2021-03-24T00:32:39","slug":"logging-in-salesforce-commerce-cloud","status":"publish","type":"post","link":"https:\/\/www.antunkarlovac.com\/blog\/2021\/03\/23\/logging-in-salesforce-commerce-cloud\/","title":{"rendered":"Logging in Salesforce Commerce Cloud"},"content":{"rendered":"

I’ve been learning SFCC recently, and found that I was missing a simple guide for server logging, so I decided to write one.<\/p>\n

Basic Usage<\/strong>
\nFirst you need to get a reference to a Log object, and then you issue log statements that are the level you want (debug, info, warn, error, fatal):<\/p>\n

\r\nvar Logger = require('dw\/system\/Logger');\r\nvar log = Logger.getLogger('my_category');\r\nlog.warn('createRequest call took {0}ms, which is more than the threshold of {1}ms', 999, 500);\r\n<\/pre>\n
By passing just one argument to getLogger()<\/code>, you will be putting your log statements in the default location – more on that below.<\/p>\n
Finding Log Entries<\/strong>
\nThere are two ways to access logs, through Business Manager (BM), neither of which are immediately obvious:<\/p>\n
    \n
  1. The log center<\/li>\n
  2. The actual log files<\/li>\n<\/ol>\n
    The log center<\/strong> is accessed in Administration \/ Site Development \/ Development Setup, although it requires specific permissions:<\/p>\n
    \"logcenter\"<\/p>\n
    The other way is to access the log files directly – also via BM – in Administration \/ Site Development \/ Development Setup<\/strong>, then click on Folder Browser<\/strong>, and navigate to the Logs<\/strong> directory:<\/p>\n
    \"folder_browser\"<\/p>\n
    Log Files<\/strong>
    \nIf you initialize the log object with one argument (e.g. getLogger('my_category')<\/code>), then you are specifying the category only, and the log entries will appear in a generic file. The file will be named something like customwarn-ecom-sandbox-SANDBOX-appserver-DATE.log where “warn” is the log level.<\/p>\n
    The category will appear in the log entry:<\/p>\n
    [2021-03-23 23:46:32.086 GMT] WARN PipelineCallServlet|212645572|SITE_NAME|CONTROLLER_NAME|PipelineCall|iEHTL3fGnn custom.my_category []  createRequest call took 999ms, which is more than the threshold of 500ms
    \n<\/code><\/p>\n
    You can add a second parameter when getting the log object, which will create a new log file. This may be useful if you are developing a cartridge and want all of that cartridge’s logging information stored in one place:<\/p>\n
    \r\nvar log = Logger.getLogger('my_cartridge', 'my_category');\r\n<\/pre>\n
    That will create a dedicated log file like so, in the same location as the other log files:<\/p>\n
    custom-my_cartridge-ecom-SANDBOX-ITENTIFIERS-DATE.log<\/code><\/p>\n
    Enabling Log Levels<\/strong>
    \nThe log level you want to use must be enabled in BM under Administration \/ Operations \/ Custom Log Settings<\/strong>, in the Custom Log Targets<\/strong> section:<\/p>\n
    \"enabled\"<\/p>\n
    If it’s not, then the log entries won’t appear.<\/p>\n","protected":false},"excerpt":{"rendered":"
    I’ve been learning SFCC recently, and found that I was missing a simple guide for server logging, so I decided to write one. Basic Usage First you need to get a reference to a Log object, and then you issue log statements that are the level you want (debug, info, warn, error, fatal): By passing … Continue reading Logging in Salesforce Commerce Cloud<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[17],"tags":[],"_links":{"self":[{"href":"https:\/\/www.antunkarlovac.com\/blog\/wp-json\/wp\/v2\/posts\/367"}],"collection":[{"href":"https:\/\/www.antunkarlovac.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.antunkarlovac.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.antunkarlovac.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.antunkarlovac.com\/blog\/wp-json\/wp\/v2\/comments?post=367"}],"version-history":[{"count":7,"href":"https:\/\/www.antunkarlovac.com\/blog\/wp-json\/wp\/v2\/posts\/367\/revisions"}],"predecessor-version":[{"id":377,"href":"https:\/\/www.antunkarlovac.com\/blog\/wp-json\/wp\/v2\/posts\/367\/revisions\/377"}],"wp:attachment":[{"href":"https:\/\/www.antunkarlovac.com\/blog\/wp-json\/wp\/v2\/media?parent=367"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.antunkarlovac.com\/blog\/wp-json\/wp\/v2\/categories?post=367"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.antunkarlovac.com\/blog\/wp-json\/wp\/v2\/tags?post=367"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}