LoggingBestPracticesCheatSheet

From CEDPS

Contents 1 Logging Best Practices Summary 2 Examples 2.1 Globus Gatekeeper 2.2 Globus GridFTP Server

Logging Best Practices Summary

• Use name=value pairs only
• Required fields:
  • ts=ISO8601 timestamp {ts=2007-06-12T14:32:15.145455Z}
  • event=hierarchical event name {event=org.foo.component.start}
• Strongly suggested fields:
  • guid=global identifier or id=local identifier. {guid=8AE1154D-B79E-49B6-AB77-575D956FCE4D} or {id=1143}
  • level=Logging level {level=INFO}
    • Levels: FATAL, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFO, DEBUG, TRACE
• Other standard fields:
  • prog=Program name {prog=GridFTP-v4.0.2}
  • status=Status of .end event status=-1
    • integer: < 0 is an error, >= 0 is success
• Wrap actions with two events: one .start and one .end:
  • (start) event=org.foo.component.loop.start
  • (end) event=org.foo.component.loop.end status=0

Examples

Globus Gatekeeper

• ts=2006-12-08T18:39:23.114369Z event=org.globus.gatekeeper.start guid=55A0DF43-D7AB-40BF-A023-04444B93F76E remoteHost=gridhost.yoursite.gov:NNNN localHost=myhost.foo.gov:NNNN requestType=jobSubmit
• ts=2006-12-08T18:39:23.114369Z event=org.globus.gatekeeper.authn.x509.start guid=55A0DF43-D7AB-40BF-A023-04444B93F76E DN=”/O=CEDS/CN=Some User”
• ts=2006-12-08T18:39:23.114369Z event=org.globus.gatekeeper.authn.x509.end guid=55A0DF43-D7AB-40BF-A023-04444B93F76E DN=”/O=CEDS/CN=Some User” status=0
• ts=2006-12-08T18:39:23.114369Z event=org.globus.gatekeeper.authz.GUMS.start guid=55A0DF43-D7AB-40BF-A023-04444B93F76E DN=”/O=CEDS/CN=Some User” mappingService="https://cmssrv08.fnal.gov:8443/gums/services/ GUMSAuthorizationServicePort”
• ts=2006-12-08T18:39:23.114369Z event=org.globus.gatekeeper.authz.GUMS.end guid=55A0DF43-D7AB-40BF-A023-04444B93F76E DN=”/O=CEDS/CN=Some User” localUser=gridex localUID=10657 localGID=10657 gridSecurityHTTPBodyFD=8 status=0
• ts=2006-12-08T18:39:23.114369Z event=org.globus.gatekeeper.jobManager.start guid=55A0DF43-D7AB-40BF-A023-04444B93F76E path="/opt/globus/libexec/globus-job-manager" gatekeeperJmId="2006-11-09.00:06:28.0000006577.0000000000" executionHost=128.105.121.51 securityContextFD=11 childID=6639
• ts=2006-12-08T18:39:23.114369Z event=org.globus.gatekeeper.jobManager.end guid=55A0DF43-D7AB-40BF-A023-04444B93F76E status=0
• ts=2006-12-08T18:39:23.114369Z event=org.globus.gatekeeper.end guid=55A0DF43-D7AB-40BF-A023-04444B93F76E status=0

Globus GridFTP Server

• ts=2006-12-08T18:39:23.114369Z event=org.globus.gridFTP.start prog=GridFTP-4.0.3 localHost=myhost remoteHost=somehost.gov:56010 serverMode=inetd guid=D4E922E1-6F7D-4752-B126-013BFE71C80B
• ts=2006-12-08T18:39:23.114567Z event=org.globus.gridFTP.authn.x509.start DN=“/DC=org/DC=doegrids/OU=People/CN=Somebody” guid=D4E922E1-6F7D-4752-B126-013BFE71C80B
• ts=2006-12-08T18:39:23.114567Z event=org.globus.gridFTP.authn.x509.end DN=“/DC=org/DC=doegrids/OU=People/CN=Somebody” guid=D4E922E1-6F7D-4752-B126-013BFE71C80B status=0
• ts=2006-12-08T18:39:23.114567Z event=org.globus.gridFTP.authz.gridmap.start DN=“/DC=org/DC=doegrids/OU=People/CN=Somebody” guid=D4E922E1-6F7D-4752-B126-013BFE71C80B
• ts=2006-12-08T18:39:25.514369Z event=org.globus.gridFTP.authz.gridmap.end DN=“/DC=org/DC=doegrids/OU=People/CN=Somebody” localUser=uscmspool381 guid=D4E922E1-6F7D-4752-B126-013BFE71C80B status=0
• ts=2006-12-08T18:39:25.864369Z event=org.globus.gridFTP.transfer.start infile=/tmp/myfile tcpBufferSize=128KB dataBlockSize=262144 numStreams=1 numStripes=1 destHost=129.79.4.64 guid=D4E922E1-6F7D-4752-B126-013BFE71C80B
• ts=2006-12-08T18:45:02.214369Z event=org.globus.gridFTP.transfer.end infile=/tmp/myfile bytesTransferred=678433 guid=D4E922E1-6F7D-4752-B126-013BFE71C80B status=0
• ts=2006-12-08T18:45:02.214386Z event=org.globus.gridFTP.end guid=D4E922E1-6F7D-4752-B126-013BFE71C80B status=226