LogUtils

java.lang.Object
- com.enremmeta.rtb.LogUtils

```
public class LogUtils
extends Object
```
Centralized place for logging calls (as static methods). Everything is logged at Level.INFO level unless otherwise specified.

CONTRACT NOTE: This class is ONLY concerned with logging. The rationale is: we are only concerned about things that are to be analyzed later by an external actor. We are journalists/chroniclers, not participants in the action.
We will only hold to the following conventions:
- Columns are never removed from logging.
The following things are true unless specified otherwise:
- "Date" is always date/time more or less at the time of logging (which may be slightly later than actual event but not importantly so) formatted as LOG_DATE_FORMAT.
- Unix time stamp is always, well, Unix time stamp more or less (because it's an asynchronous process) at the time of logging.
- Both of the above are in UTC.
- In structured logs, fields are tab-separated.
- Campaign ID corresponds to ad ID.
- Creative ID corresponds to tag ID.
This is opinionated in a sense that:
- Any null or empty field is logged as specified in DelimLayout).
- We only recognize the following logs in the current implementation:
  - Structured (string TSV format suitable for loading into a DB; whenever lists of values are encountered in a field, they are written as CSV):
    - LOG_ACCESS - just the access URLs. See
    - LOG_BID - bids made ( logBid(OpenRtbRequest, long, String, String, String, Bid, int, int, ExchangeAdapter, String)
    - LOG_DEBUG_REQ debug companion to LOG_REQUEST
    - LOG_ABTEST_ASSIGNMENT - status assignment for A/B-test made for Campaign logExperimentCampaign(OpenRtbRequest, String, Ad, UserExperimentAttributes) or for Targeting Strategy logExperimentTargetingStrategy(OpenRtbRequest, String, Ad, UserExperimentAttributes)
    - LOG_REQUEST - all bid requests ( logRequest(OpenRtbRequest, boolean, int))
    - LOG_SESSION - same as LOG_REQUEST, but only for requests on which we bid.
    - URLs (see logRequest(OpenRtbRequest, boolean, int)).
    - LOG_WIN - wins (this is responsible for knowing the winning price). This may or may not be fired at the same time as #logImpression(String, String, String, String, String, String, long, String, String, String, String, String, HttpServletRequest, String, int, String, URI, String, String, String, String, String, MultivaluedMap, boolean, String, String, String, boolean, String) in cases where an exchange requires using NUrl mechanism ( BRX is one such example). See logWin(String, String, String, String, String, String, String, double, long, long, long, String, String, String, String, String, HttpServletRequest, String, Long, String, URI, boolean, String, String, String, String, String, String, boolean, boolean, String)
    - LOG_PSEUDOWIN - pseudo-wins -- same as above but where authoritativeWin is false
    - LOG_IMPRESSION - impressions. See #logImpression(String, String, String, String, String, String, long, String, String, String, String, String, HttpServletRequest, String, int, String, URI, String, String, String, String, String, MultivaluedMap, boolean, String, String, String, boolean, String)
    - LOG_CLICK - clicks. See logClick(String, String, String, String, String, String, String, String, String, String, HttpServletRequest, String, String, URI, String, String, String, String)
    - LOG_LOST- lost bids. See logLost(Long, String, String, String, String, Long, Long, String, String, String, String, HttpServletRequest, String, String, String, String)
  - Semi-structured:
    - LOG_RESPONSE - entire bid response ( logResponse(OpenRtbRequest, OpenRtbResponse, Object))
    - LOG_RAW_REQUEST - raw request as JSON. ( logRawRequest(OpenRtbRequest, Object, UriInfo))
  - Unstructured:
    - LOG_MAIN - free-form logging for troubleshooting. See:
      
      trace(Object)
      
      debug(Object)
      
      info(Object)
      
      error(Object)
      
      error(Object, Throwable)
Author:

Gregory Golberg

Copyright © Enremmeta LLC 2014-2015. All Rights Reserved. This code is licensed under Affero GPL 3.0

See Also:

DelimLayout, Microput

Field Summary

Fields
Modifier and Type	Field and Description
`private static org.apache.logging.log4j.Logger`	`abTestAssignmentLogger`
`private static org.apache.logging.log4j.Logger`	`accessLogger`
`private static org.apache.logging.log4j.Logger`	`bidLogger`
`private static org.apache.logging.log4j.Logger`	`clickLogger`
`private static int`	`CURRENT_LOG_VERSION_NUM`
`private static org.apache.logging.log4j.Logger`	`debugReqLogger`
`private static org.apache.logging.log4j.Logger`	`decisionLogger`
`private static org.apache.logging.log4j.Logger`	`impressionLogger`
`static org.apache.logging.log4j.Logger`	`jettyLogger`
`static String`	`LOG_ABTEST_ASSIGNMENT`
`static String`	`LOG_ACCESS` This is the "access" logger.
`static String`	`LOG_BID`
`static String`	`LOG_CLICK`
`static SimpleDateFormat`	`LOG_DATE_FORMAT` The log date format - human-readable date as "yyyy-MM-dd hh:mm:ss".
`static String`	`LOG_DEBUG_REQ` Fields from `LOG_REQUEST` that are too long to keep there.
`static String`	`LOG_DECISION`
`static String`	`LOG_IMPRESSION` Name for `Logger` that logs data about impressions.
`static String`	`LOG_JETTY`
`static String`	`LOG_LOST`
`static String`	`LOG_MAIN` This is the "main" logger.
`static String`	`LOG_PROUST`
`static String`	`LOG_PSEUDOWIN`
`static String`	`LOG_RAW_REQUEST` Raw requests, as JSON.
`static String`	`LOG_REDIR`
`static String`	`LOG_REQUEST`
`static String`	`LOG_RESPONSE` Full response, at `Level.DEBUG`.
`static String`	`LOG_SESSION`
`static String`	`LOG_TAG_DECISION`
`static String`	`LOG_URLS`
`static String`	`LOG_WIN`
`private static org.apache.logging.log4j.Logger`	`lostLogger`
`private static org.apache.logging.log4j.Logger`	`mainLogger`
`static org.apache.logging.log4j.Marker`	`MARKER_BCM` Marker for `BidCandidateManager`.
`static org.apache.logging.log4j.Marker`	`MARKER_BUDGET`
`static org.apache.logging.log4j.Marker`	`MARKER_WINLOSS`
`private static org.apache.logging.log4j.Logger`	`proustLogger`
`private static org.apache.logging.log4j.Logger`	`pseudowinLogger`
`private static org.apache.logging.log4j.Logger`	`rawRequestLogger`
`private static org.apache.logging.log4j.Logger`	`redirLogger`
`private static org.apache.logging.log4j.Logger`	`requestLogger`
`private static org.apache.logging.log4j.Logger`	`responseLogger`
`private static AtomicLong`	`seqBid`
`private static AtomicLong`	`seqImp`
`private static AtomicLong`	`seqLoss`
`private static AtomicLong`	`seqPseudoWin`
`private static AtomicLong`	`seqWin`
`private static org.apache.logging.log4j.Logger`	`sessionLogger`
`private static org.apache.logging.log4j.Logger`	`tagDecisionLogger`
`private static org.apache.logging.log4j.Logger`	`urlsLogger`
`private static org.apache.logging.log4j.Logger`	`winLogger`

Constructor Summary

Constructors
Constructor and Description

LogUtils()

Constructors
Constructor and Description
`LogUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`debug(org.apache.logging.log4j.Marker m, Object msg)`
`static void`	`debug(Object msg)` Debug message.
`static void`	`debug(Object msg, Throwable t)` Debug message.
`static void`	`error(Object msg)`
`static void`	`error(Object msg, Throwable t)`
`static void`	`fatal(Object msg)`
`static String`	`getDate()` Formats current date with `LOG_DATE_FORMAT`.
`static org.apache.logging.log4j.Logger`	`getLogger(Class klass)` For command-line utilitiies
`private static String`	`getNodeId()`
`static String`	`getPhaseOfDecision(String decisionReason)`
`private static String`	`getRegion()`
`static String`	`getStepOfDecision(String decisionReason)`
`static void`	`info(org.apache.logging.log4j.Marker m, Object msg)`
`static void`	`info(Object msg)`
`static void`	`info(Object msg, Throwable t)`
`static void`	`init(Object o)`
`static void`	`logAccess(javax.ws.rs.core.UriInfo uriInfo)`
`static void`	`logAdLoadingError(long runNumber, Object o, String comment)`
`private static Object`	`logAt(org.apache.logging.log4j.Level curLevel, org.apache.logging.log4j.Level expectedLevel, Object msg)` Log at this level or a finer one.
`static void`	`logBid(OpenRtbRequest req, long timeSpent, String bidRequestId, String userId, String modUid, Bid bid, int candCount, int bidCount, ExchangeAdapter adapter, String outcome)` Log a bid.
`static void`	`logClick(String xch, String cookie, String bId, String iId, String cId, String crId, String redir, String ref, String ua, String xff, javax.servlet.http.HttpServletRequest servletRequest, String xrip, String modUid, URI uri, String brId, String ssp, String cookies, String originatingNodeId)` Log a click.
`static void`	`logDecision(long runNumber, Ad ad, String xch, String type, Long count, Long total, String comment)` Logs the following fields: `Current date` (assume UTC) `Current timestamp` (assume UTC) run number of `AdCache` `Ad ID` Exchange Decision type (e.g., `Lot49Constants.DECISION_BROWSER`) "M1" as literal Count Total Comment (clarifying "decision type") M2 as literal `node ID` Region Phase of decision (e.g., "02" from `Lot49Constants.DECISION_BROWSER`) Step of decision (e.g., "11" from `Lot49Constants.DECISION_BROWSER`)
`static void`	`logExperimentCampaign(OpenRtbRequest req, String modUid, Ad ad, UserExperimentAttributes exptAttributes)` Log an A/B-test assignment on Campaign.
`static void`	`logExperimentTargetingStrategy(OpenRtbRequest req, String modUid, Ad ad, UserExperimentAttributes exptAttributes)` Log an A/B-test assignment on Targeting Strategy.
`static void`	logImpression(String httpCookie, String xch, String bId, String iId, String cId, String crId, long bidCreatedTimestamp, String redir, String ref, String ua, String custom, String xff, javax.servlet.http.HttpServletRequest servletRequest, String xrip, int nurl, String modUid, URI uri, String brId, String ssp, String forceCookieReset, String forceCookieResync, String cookies, javax.ws.rs.core.MultivaluedMap<String,String> headers, boolean createCookie, String exchangeCookie, String origHttpCookie, String cookieComment, boolean suspicious, String originatingNodeId, BidInFlightInfo bif) Log an impression.
`static void`	`logLost(Long bidSentOn, String bId, String iId, String cId, String crId, Long microBid, Long winningBid, String reason, String exchange, String msg, String xff, javax.servlet.http.HttpServletRequest servletRequest, String xrip, String ssp, String brId, String originatingNodeId)` Log a lost bid.
`static void`	`logProust(String cookie, String newCookie, String xch, String bId, String iId, String cId, String crId, String ref, String ua, String xff, javax.servlet.http.HttpServletRequest servletRequest, String xrip, String modUid, URI uri, String brId, String ssp, String fcr, String phase, String redir, String cookies, String urlVersion, String originatingNodeId)` Logs requests to `Proust`.
`static void`	`logRawRequest(OpenRtbRequest req, Object origReq, javax.ws.rs.core.UriInfo uriInfo)` Logs raw request, as JSON.
`static void`	`logRedir(String uriCalled, String uriRedir, int statusCode)`
`static void`	`logRequest(OpenRtbRequest req, boolean didBid, int candidates)` Log every `Impression` request (could be multiple per actual `bid request`).
`static void`	`logResponse(OpenRtbRequest req, OpenRtbResponse br, Object response)` Logs the entire bid response to `LOG_RESPONSE`.
`static void`	`logResponse(String exchange, String ssp, String bidRequestId, String bidId, String tag)`
`static void`	`logTagDecision(long runNumber, Tag tag, String xch, String type, Long count, Long total)` Similar to `logDecision(long, Ad, String, String, Long, Long, String)`.
`static void`	logWin(String cookie, String xch, String bId, String iId, String cId, String crId, String sentWinningPrice, double winningCpm, long microWinningPrice, long microBidPrice, long bidCreatedTimestamp, String redir, String ref, String ua, String custom, String xff, javax.servlet.http.HttpServletRequest servletRequest, String xrip, Long nurlId, String modUid, URI uri, boolean authoritativeWin, String brId, String ssp, String notFoundReason, String clickThroughMacroValue, String clickThroughEncodedMacroValue, String cookies, boolean createCookie, boolean suspiciousWin, String originatingNodeId) Similar to `#logImpression(String, String, String, String, String, String, long, String, String, String, String, String, HttpServletRequest, String, int, String, URI, String, String, String, String, String, MultivaluedMap, boolean, String, String, String, boolean, String)` except that: The four columns after `crId` are not `null` but carry pricing information, as follows: Winning price as sent by the exchange (prior to it being decoded by the method specific to the exchange) Decoded winning price as CPM Decoded winning price as micro$ Bid price, as micro$ Instead of `nurl` column, here we have `nurlId` column. All columns up to 35 ("M5") are otherwise the same.
`static void`	`trace(org.apache.logging.log4j.Marker m, Object msg)`
`static void`	`trace(Object msg)`
`static void`	`trace(Object msg, Throwable t)`
`static void`	`warn(Object msg)`
`static void`	`warn(Object msg, Throwable t)`
`private static String`	`wrapMsg(Object msg)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MARKER_BUDGET
```
public static final org.apache.logging.log4j.Marker MARKER_BUDGET
```
  - MARKER_BCM
```
public static final org.apache.logging.log4j.Marker MARKER_BCM
```
    Marker for BidCandidateManager.
  - LOG_JETTY
```
public static final String LOG_JETTY
```
    See Also:
    
    Constant Field Values
  - jettyLogger
```
public static final org.apache.logging.log4j.Logger jettyLogger
```
  - CURRENT_LOG_VERSION_NUM
```
private static final int CURRENT_LOG_VERSION_NUM
```
    See Also:
    
    Constant Field Values
  - LOG_BID
```
public static final String LOG_BID
```
    See Also:
    
    logBid(OpenRtbRequest, long, String, String, String, Bid, int, int, ExchangeAdapter, String), Constant Field Values
  - bidLogger
```
private static final org.apache.logging.log4j.Logger bidLogger
```
  - LOG_ABTEST_ASSIGNMENT
```
public static final String LOG_ABTEST_ASSIGNMENT
```
    See Also:
    
    logExperimentCampaign(OpenRtbRequest, String, Ad, UserExperimentAttributes), logExperimentTargetingStrategy(OpenRtbRequest, String, Ad, UserExperimentAttributes), Constant Field Values
  - abTestAssignmentLogger
```
private static final org.apache.logging.log4j.Logger abTestAssignmentLogger
```
  - LOG_CLICK
```
public static final String LOG_CLICK
```
    See Also:
    
    logClick(String, String, String, String, String, String, String, String, String, String, HttpServletRequest, String, String, URI, String, String, String, String), Constant Field Values
  - clickLogger
```
private static final org.apache.logging.log4j.Logger clickLogger
```
  - LOG_DATE_FORMAT
```
public static final SimpleDateFormat LOG_DATE_FORMAT
```
    The log date format - human-readable date as "yyyy-MM-dd hh:mm:ss".
  - LOG_IMPRESSION
```
public static final String LOG_IMPRESSION
```
    Name for Logger that logs data about impressions.
    
    See Also:
    
    #logImpression(String, String, String, String, String, String, long, String, String, String, String, String, HttpServletRequest, String, int, String, URI, String, String, String, String, String, MultivaluedMap, boolean, String, String, String, boolean, String), Constant Field Values
  - impressionLogger
```
private static final org.apache.logging.log4j.Logger impressionLogger
```
  - LOG_WIN
```
public static final String LOG_WIN
```
    See Also:
    
    logWin(String, String, String, String, String, String, String, double, long, long, long, String, String, String, String, String, HttpServletRequest, String, Long, String, URI, boolean, String, String, String, String, String, String, boolean, boolean, String), Constant Field Values
  - winLogger
```
private static final org.apache.logging.log4j.Logger winLogger
```
  - LOG_PSEUDOWIN
```
public static final String LOG_PSEUDOWIN
```
    See Also:
    
    logWin(String, String, String, String, String, String, String, double, long, long, long, String, String, String, String, String, HttpServletRequest, String, Long, String, URI, boolean, String, String, String, String, String, String, boolean, boolean, String), Constant Field Values
  - pseudowinLogger
```
private static final org.apache.logging.log4j.Logger pseudowinLogger
```
  - LOG_LOST
```
public static final String LOG_LOST
```
    See Also:
    
    logLost(Long, String, String, String, String, Long, Long, String, String, String, String, HttpServletRequest, String, String, String, String), Constant Field Values
  - lostLogger
```
private static final org.apache.logging.log4j.Logger lostLogger
```
  - LOG_MAIN
```
public static final String LOG_MAIN
```
    This is the "main" logger.
    
    See Also:
    
    Constant Field Values
  - mainLogger
```
private static final org.apache.logging.log4j.Logger mainLogger
```
  - LOG_ACCESS
```
public static final String LOG_ACCESS
```
    This is the "access" logger. Named like this after the NGINX/Apache pattern.
    
    See Also:
    
    Constant Field Values
  - accessLogger
```
private static final org.apache.logging.log4j.Logger accessLogger
```
  - LOG_REQUEST
```
public static final String LOG_REQUEST
```
    See Also:
    
    logRequest(OpenRtbRequest, boolean, int), Constant Field Values
  - requestLogger
```
private static final org.apache.logging.log4j.Logger requestLogger
```
    See Also:
    
    LOG_REQUEST
  - LOG_DEBUG_REQ
```
public static final String LOG_DEBUG_REQ
```
    Fields from LOG_REQUEST that are too long to keep there. At DEBUG level only.
    
    See Also:
    
    logRequest(OpenRtbRequest, boolean, int), Constant Field Values
  - debugReqLogger
```
private static final org.apache.logging.log4j.Logger debugReqLogger
```
    See Also:
    
    LOG_DEBUG_REQ
  - LOG_REDIR
```
public static final String LOG_REDIR
```
    See Also:
    
    Constant Field Values
  - redirLogger
```
private static final org.apache.logging.log4j.Logger redirLogger
```
  - LOG_DECISION
```
public static final String LOG_DECISION
```
    See Also:
    
    Constant Field Values
  - decisionLogger
```
private static final org.apache.logging.log4j.Logger decisionLogger
```
  - LOG_TAG_DECISION
```
public static final String LOG_TAG_DECISION
```
    See Also:
    
    Constant Field Values
  - tagDecisionLogger
```
private static final org.apache.logging.log4j.Logger tagDecisionLogger
```
  - LOG_RESPONSE
```
public static final String LOG_RESPONSE
```
    Full response, at Level.DEBUG.
    
    See Also:
    
    logResponse(OpenRtbRequest, OpenRtbResponse, Object), Constant Field Values
  - responseLogger
```
private static final org.apache.logging.log4j.Logger responseLogger
```
  - LOG_RAW_REQUEST
```
public static final String LOG_RAW_REQUEST
```
    Raw requests, as JSON. See logRawRequest(OpenRtbRequest, Object, UriInfo). Only available when log level is Level.DEBUG.
    
    See Also:
    
    Constant Field Values
  - rawRequestLogger
```
private static final org.apache.logging.log4j.Logger rawRequestLogger
```
    See Also:
    
    logRawRequest(OpenRtbRequest, Object, UriInfo)
  - LOG_PROUST
```
public static final String LOG_PROUST
```
    See Also:
    
    Constant Field Values
  - proustLogger
```
private static final org.apache.logging.log4j.Logger proustLogger
```
  - LOG_SESSION
```
public static final String LOG_SESSION
```
    See Also:
    
    LOG_REQUEST, logRequest(OpenRtbRequest, boolean, int), Constant Field Values
  - sessionLogger
```
private static final org.apache.logging.log4j.Logger sessionLogger
```
  - LOG_URLS
```
public static final String LOG_URLS
```
    See Also:
    
    Constant Field Values
  - urlsLogger
```
private static final org.apache.logging.log4j.Logger urlsLogger
```
  - MARKER_WINLOSS
```
public static final org.apache.logging.log4j.Marker MARKER_WINLOSS
```
  - seqImp
```
private static final AtomicLong seqImp
```
  - seqWin
```
private static final AtomicLong seqWin
```
  - seqPseudoWin
```
private static final AtomicLong seqPseudoWin
```
  - seqLoss
```
private static final AtomicLong seqLoss
```
  - seqBid
```
private static final AtomicLong seqBid
```
- Constructor Detail
  - LogUtils
```
public LogUtils()
```
- Method Detail
  - init
```
public static void init(Object o)
```
  - getLogger
```
public static final org.apache.logging.log4j.Logger getLogger(Class klass)
```
    For command-line utilitiies
    
    Parameters:
    
    klass - the class of logger
    
    Returns:
    
    the logger
  - wrapMsg
```
private static String wrapMsg(Object msg)
```
  - debug
```
public static void debug(Object msg)
```
    Debug message.
  - trace
```
public static void trace(Object msg)
```
  - trace
```
public static void trace(Object msg,
                         Throwable t)
```
  - debug
```
public static void debug(org.apache.logging.log4j.Marker m,
                         Object msg)
```
  - trace
```
public static void trace(org.apache.logging.log4j.Marker m,
                         Object msg)
```
  - debug
```
public static void debug(Object msg,
                         Throwable t)
```
    Debug message.
  - error
```
public static void error(Object msg)
```
  - fatal
```
public static void fatal(Object msg)
```
  - logRedir
```
public static void logRedir(String uriCalled,
                            String uriRedir,
                            int statusCode)
```
  - logAdLoadingError
```
public static void logAdLoadingError(long runNumber,
                                     Object o,
                                     String comment)
```
  - logDecision
```
public static void logDecision(long runNumber,
                               Ad ad,
                               String xch,
                               String type,
                               Long count,
                               Long total,
                               String comment)
```
    Logs the following fields:
    1. Current date (assume UTC)
    2. Current timestamp (assume UTC)
    3. run number of AdCache
    4. Ad ID
    5. Exchange
    6. Decision type (e.g., Lot49Constants.DECISION_BROWSER)
    7. "M1" as literal
    8. Count
    9. Total
    10. Comment (clarifying "decision type")
    11. M2 as literal
    12. node ID
    13. Region
    14. Phase of decision (e.g., "02" from Lot49Constants.DECISION_BROWSER)
    15. Step of decision (e.g., "11" from Lot49Constants.DECISION_BROWSER)
  - logTagDecision
```
public static void logTagDecision(long runNumber,
                                  Tag tag,
                                  String xch,
                                  String type,
                                  Long count,
                                  Long total)
```
    Similar to logDecision(long, Ad, String, String, Long, Long, String). Logs the following: *
    1. Current date (assume UTC)
    2. Current timestamp (assume UTC)
    3. run number of AdCache
    4. Ad ID
    5. Tag ID
    6. Exchange
    7. Decision type (e.g., Lot49Constants.TAG_DECISION_API)
    8. Count of decisions of this type
    9. Total impressions considered
    10. node ID
    11. Region
  - error
```
public static void error(Object msg,
                         Throwable t)
```
  - getDate
```
public static final String getDate()
```
    Formats current date with LOG_DATE_FORMAT.
  - info
```
public static void info(Object msg)
```
  - info
```
public static void info(Object msg,
                        Throwable t)
```
  - info
```
public static void info(org.apache.logging.log4j.Marker m,
                        Object msg)
```
  - logAccess
```
public static void logAccess(javax.ws.rs.core.UriInfo uriInfo)
```
  - getNodeId
```
private static final String getNodeId()
```
  - getRegion
```
private static final String getRegion()
```
  - logBid
```
public static void logBid(OpenRtbRequest req,
                          long timeSpent,
                          String bidRequestId,
                          String userId,
                          String modUid,
                          Bid bid,
                          int candCount,
                          int bidCount,
                          ExchangeAdapter adapter,
                          String outcome)
```
    Log a bid. Will log the following information, in order, to LOG_BID.
    1. Current date (assume UTC)
    2. Current time stamp
    3. Time spent to get this bid
    4. bid request ID
    5. Our User ID
    6. bid ID
    7. impression ID
    8. campaign ID - we define this to be targeting ID
    9. creative ID - we define this to be tag ID
    10. Bid, as $ CPM
    11. Bid, as micro-$ per impression.
    12. M1 literal
    13. M2 literal
    14. Count of bid candidates considered by BidCandidateManager.
    15. Count of bids returned for this bid request.
    16. Exchange
    17. bid choice algo
    18. SSP
    19. "M3" literal
    20. How many bids left to make in this period
    21. How many bids we were originally supposed to make in this period
    22. node ID
    23. seqBid sequential number of bid per node (see above)
    24. Mod UID
    25. Ad.getAdVersion() version of the Ad
    26. Tag.getTagVersion() version of the Tag
    27. Outcome - one of Lot49Constants.BID_OUTCOME_SUBMITTED, @link Lot49Constants.BID_OUTCOME_INTERNAL_AUCTION_LOSS, @link Lot49Constants.BID_OUTCOME_CONTROL.
    Parameters:
    
    userId - User.getBuyeruid()
    
    See Also:
    
    Utils.microToCpm(double), Utils.cpmToMicro(double)
  - logExperimentCampaign
```
public static void logExperimentCampaign(OpenRtbRequest req,
                                         String modUid,
                                         Ad ad,
                                         UserExperimentAttributes exptAttributes)
```
    Log an A/B-test assignment on Campaign. Will log the following information, in order, to LOG_ABTEST_ASSIGNMENT.
    1. Current date (assume UTC)
    2. Current time stamp
    3. bid request ID
    4. Our User ID
    5. Cookie as decoded by Utils.cookieToLogModUid(String)
    6. C literal - experiment assignment on Campaign
    7. Campaign id
    8. Campaign A/B-test status ("T", "C" or "N")
    9. Version of A/B-test.
    10. Full User A/B-test status
    11. User segments as a comma-separated list each encrypted with an advertiser's key.
    12. Campaign id
    13. (region )
    Parameters:
    
    req - Request OpenRtbRequest
    
    modUid - Cookie as decoded by Utils.cookieToLogModUid(String) of assigned user
    
    ad - Targeting Strategy of a Campaign under ExperimentAd
    
    exptAttributes - Experiment Attributes for user UserExperimentAttributes
    
    See Also:
    
    logExperimentTargetingStrategy(OpenRtbRequest, String, Ad, UserExperimentAttributes)
  - logExperimentTargetingStrategy
```
public static void logExperimentTargetingStrategy(OpenRtbRequest req,
                                                  String modUid,
                                                  Ad ad,
                                                  UserExperimentAttributes exptAttributes)
```
    Log an A/B-test assignment on Targeting Strategy. Will log the following information, in order, to LOG_ABTEST_ASSIGNMENT.
    1. Current date (assume UTC)
    2. Current time stamp
    3. bid request ID
    4. Our User ID
    5. Cookie as decoded by Utils.cookieToLogModUid(String)
    6. TS literal - experiment assignment on Targeting Strategy
    7. Targeting strategy ID
    8. Targeting strategy A/B-test status ("C", "T" or "N").
    9. Version of A/B-test.
    10. Full User A/B-test status
    11. User segments as a comma-separated list each encrypted with an advertiser's key.
    12. (region )
    Parameters:
    
    req - Request OpenRtbRequest
    
    modUid - Cookie as decoded by Utils.cookieToLogModUid(String) of assigned user
    
    ad - Targeting Strategy under ExperimentAd
    
    exptAttributes - Experiment Attributes for user UserExperimentAttributes
  - logClick
```
public static void logClick(String xch,
                            String cookie,
                            String bId,
                            String iId,
                            String cId,
                            String crId,
                            String redir,
                            String ref,
                            String ua,
                            String xff,
                            javax.servlet.http.HttpServletRequest servletRequest,
                            String xrip,
                            String modUid,
                            URI uri,
                            String brId,
                            String ssp,
                            String cookies,
                            String originatingNodeId)
```
    Log a click. Logs the following information, in order:
    1. Date, human-readable
    2. Unix timestamp
    3. cookie The value of the cookie that serves as the user ID. The cookie name is taken from USER_ID_COOKIE configuration parameter.
    4. Exchange
    5. Bid ID
    6. Impression ID
    7. RTB's Campaign ID - same as Ad.getId()
    8. Bid.getCrid() RTB's Creative ID) - same as Tag.getId()
    9. Redirect URL
    10. "M1" literal
    11. Referer
    12. "M2" literal
    13. User agent
    14. "M3" literal
    15. X-Forwarded-For header (could be user's, if NGINX is in front, but if there's ELB in front of NGINX, it'll be ELB's)
    16. ServletRequest.getRemoteHost()
    17. ServletRequest.getRemotePort()
    18. ServletRequest.getRemoteAddr()
    19. X-Real-IP header (in case of Load-Balancer - NGINX - Lot49 setup, X-forwarded-for address would be the balancer's, IP would be NGINX's, and X-Real-IP would be remote user's)
    20. Geo.getCity()
    21. Geo.getRegion()
    22. Geo.getZip()
    23. Geo.getMetro()
    24. Geo.getCountry()
    25. ModUID (HEX) format cookie as decoded by Utils.cookieToLogModUid(String)
    26. URI of this request
    27. "M4" literal
    28. Bid request ID
    29. SSP
    30. All our cookies
    31. "M5" literal
    32. Node ID that originated the bid resulting in this click
    33. Node ID of this server
    34. Ad.getAdVersion() version of the Ad
    35. Tag.getTagVersion() version of the Tag
  - logImpression
```
public static void logImpression(String httpCookie,
                                 String xch,
                                 String bId,
                                 String iId,
                                 String cId,
                                 String crId,
                                 long bidCreatedTimestamp,
                                 String redir,
                                 String ref,
                                 String ua,
                                 String custom,
                                 String xff,
                                 javax.servlet.http.HttpServletRequest servletRequest,
                                 String xrip,
                                 int nurl,
                                 String modUid,
                                 URI uri,
                                 String brId,
                                 String ssp,
                                 String forceCookieReset,
                                 String forceCookieResync,
                                 String cookies,
                                 javax.ws.rs.core.MultivaluedMap<String,String> headers,
                                 boolean createCookie,
                                 String exchangeCookie,
                                 String origHttpCookie,
                                 String cookieComment,
                                 boolean suspicious,
                                 String originatingNodeId,
                                 BidInFlightInfo bif)
```
    Log an impression. Log the following, in order, to LOG_IMPRESSION:
    1. Current date (assume UTC)
    2. Current timestamp (assume UTC)
    3. httpCookie The value of the cookie set on the user as a result of this impression. This may or may not be the same cookie as was received (see origHttpCookie below)
    4. bid Id (see Bid.getId())
    5. impression Id (see Bid.getImpid())
    6. campaign Id (see Bid.getCid())
    7. creative Id (see Bid.getCrid())
    8. null (pricing information was formerly in this and next 3 columns, now for that see logWin(String, String, String, String, String, String, String, double, long, long, long, String, String, String, String, String, HttpServletRequest, String, Long, String, URI, boolean, String, String, String, String, String, String, boolean, boolean, String)
    9. null
    10. null
    11. null
    12. bidCreatedTimestamp Timestamp (in millis, UTC) of bid creation
    13. Redirect URL
    14. Literal "M1" (always "M1" - marker)
    16. Referer
    17. Literal "M2" (always "M2" - marker)
    19. User-agent
    20. Literal "M3" (always "M3" - marker)
    22. custom data that we may have decided to pass through the impression back to us (see Tag.getCustomImpPassThruData()) (and a marker - literal "M4" after).
    23. Exchange
    24. X-Forwarded-For header (could be user's, if NGINX is in front, but if there's ELB in front of NGINX, it'll be ELB's)
    25. ServletRequest.getRemoteHost()
    26. ServletRequest.getRemotePort()
    27. ServletRequest.getRemoteAddr() -- which is user's, unless we have something in front like NGINX or ELB, in which case it's kind of useless, it's theirs
    28. X-Real-IP header (in case of Load-Balancer - NGINX - Lot49 setup, X-forwarded-for address would be the balancer's, IP would be NGINX's, and X-Real-IP would be remote user's), followed by, as looked up from it
    29. Geo.getCity()
    30. Geo.getRegion()
    31. Geo.getZip()
    32. Geo.getMetro()
    33. Geo.getCountry()
    34. nurl (1 or 0)
    35. modUid cookie as decoded by Utils.cookieToLogModUid(String)
    36. uri that was requested, followed by M5
    37. Bid request ID
    38. SSP
    39. forceCookieReset
    40. forceCookieResync
    41. All cookies
    42. "M6" literal
    43. All headers at debug level or higher
    44. "M7" literal
    45. whether a cookie logged above was created here (if false, it was received)
    46. exchangeCookie cookie passed from exchange in request that resulted in this impression
    47. Original HTTP cookie we saw in this request (could be different than httpCookie)
    48. free-form text describing logic of createCookie, followed by "M8" literal
    49. whether we consider this impression suspicious
    50. Node which originated the bid that resulted in this event
    51. node ID of self
    52. sequential number (seqImp)
    53. (region )
    54. Browser name as determined from ua
    55. Browser family as determined from ua
    56. OS as determined from ua
    57. Ad.getAdVersion() version of the Ad
    58. Tag.getTagVersion() version of the Tag
    See Also:
    
    StatsSvc.impression(UriInfo, String, String, String, String, String, String, String, String, String, long, String, int, String, String, String, String, String, String, String, HttpServletRequest, String, javax.ws.rs.core.HttpHeaders, String, String), StatsSvc#nurl(UriInfo, String, String, String, String, String, String, String, String, String, String, long, String, String, String, String, String, String, HttpServletRequest, String, String, String, String, String), logWin(String, String, String, String, String, String, String, double, long, long, long, String, String, String, String, String, HttpServletRequest, String, Long, String, URI, boolean, String, String, String, String, String, String, boolean, boolean, String)
  - logProust
```
public static void logProust(String cookie,
                             String newCookie,
                             String xch,
                             String bId,
                             String iId,
                             String cId,
                             String crId,
                             String ref,
                             String ua,
                             String xff,
                             javax.servlet.http.HttpServletRequest servletRequest,
                             String xrip,
                             String modUid,
                             URI uri,
                             String brId,
                             String ssp,
                             String fcr,
                             String phase,
                             String redir,
                             String cookies,
                             String urlVersion,
                             String originatingNodeId)
```
    Logs requests to Proust.
  - logWin
```
public static void logWin(String cookie,
                          String xch,
                          String bId,
                          String iId,
                          String cId,
                          String crId,
                          String sentWinningPrice,
                          double winningCpm,
                          long microWinningPrice,
                          long microBidPrice,
                          long bidCreatedTimestamp,
                          String redir,
                          String ref,
                          String ua,
                          String custom,
                          String xff,
                          javax.servlet.http.HttpServletRequest servletRequest,
                          String xrip,
                          Long nurlId,
                          String modUid,
                          URI uri,
                          boolean authoritativeWin,
                          String brId,
                          String ssp,
                          String notFoundReason,
                          String clickThroughMacroValue,
                          String clickThroughEncodedMacroValue,
                          String cookies,
                          boolean createCookie,
                          boolean suspiciousWin,
                          String originatingNodeId)
```
    Similar to #logImpression(String, String, String, String, String, String, long, String, String, String, String, String, HttpServletRequest, String, int, String, URI, String, String, String, String, String, MultivaluedMap, boolean, String, String, String, boolean, String) except that:
    1. The four columns after crId are not null but carry pricing information, as follows:
      
      Winning price as sent by the exchange (prior to it being decoded by the method specific to the exchange)
      
      Decoded winning price as CPM
      
      Decoded winning price as micro$
      
      Bid price, as micro$
    2. Instead of nurl column, here we have nurlId column.
    3. All columns up to 35 ("M5") are otherwise the same. After that, as follows.
    4. Whether this Win is authoritative (depends who wrote it and on the setting of ExchangeAdapter.trueWinOnNurlOrImpression().
      
      Bid Request ID
      
      SSP
      
      Reason if the information for the bid underlying this win is not found
      
      Click-through macro value (only makes sense if ExchangeAdapter.isMacrosInNurl()).
      
      Literal "M6" as marker.
      
      Encoded click-through macro value (only makes sense if ExchangeAdapter.isMacrosInNurl()).
      
      Literal "M7" as marker.
      
      All cookies
      
      Literal "M8" as marker.
      
      Whether the cookie was created right now
      
      Whether win is suspicious
      
      Node which originated the bid that resulted in this event
      
      node ID of self
      
      next win sequence number
      
      region
      
      Ad.getAdVersion() version of the Ad
      
      Tag.getTagVersion() version of the Tag
    See Also:
    
    LostAuctionTask.cancelLostAuctionTask(String, BidInFlightInfo), StatsSvc#nurl(UriInfo, String, String, String, String, String, String, String, String, String, String, long, String, String, String, String, String, String, HttpServletRequest, String, String, String, String, String), StatsSvc.impression(UriInfo, String, String, String, String, String, String, String, String, String, long, String, int, String, String, String, String, String, String, String, HttpServletRequest, String, javax.ws.rs.core.HttpHeaders, String, String)
  - logLost
```
public static void logLost(Long bidSentOn,
                           String bId,
                           String iId,
                           String cId,
                           String crId,
                           Long microBid,
                           Long winningBid,
                           String reason,
                           String exchange,
                           String msg,
                           String xff,
                           javax.servlet.http.HttpServletRequest servletRequest,
                           String xrip,
                           String ssp,
                           String brId,
                           String originatingNodeId)
```
    Log a lost bid. We consider a bid lost when no impression came from it within winTimeout time, or when we explicitly were told that the bid was lost. The following information is logged to LOG_LOST:
    1. current date (assume UTC)
    2. Current timestamp (assume UTC)
    3. bidSentOn parameter - timestamp when the bid was sent to the exchange
    4. Parameter bId - bid Id (see Bid.getId())
    5. Parameter iId - impression Id (see Bid.getImpid())
    6. Parameter cId - campaign Id (see Bid.getCid())
    7. Parameter crId - creative Id (see Bid.getCrid())
    8. Parameter microBid - the bid price in micro-dollars
    9. Parameter winningBid - bid which won (not always available). In micro$
    10. Parameter reason - reason for losing bid (not always available)
    11. Parameter exchange - exchange
    12. Parameter msg - original message from the exchange
    13. "M1" literal
    14. Parameter xff - X-Forwarded-For header (could be user's, if NGINX is in front, but if there's ELB in front of NGINX, it'll be ELB's).
    15. ServletRequest.getRemoteHost() from parameter servletRequest, which is user's, unless we have something in front like NGINX or ELB, in which case it's kind of useless, it's theirs.
    16. ServletRequest.getRemotePort() ditto
    17. ServletRequest.getRemoteAddr(), ditto
    18. Parameter xrip - X-Real-IP header (in case of Load-Balancer - NGINX - Lot49 setup, X-forwarded-for address would be the balancer's, IP would be NGINX's, and X-Real-IP would be remote user's)
    19. city based on MaxMind lookup from xrip
    20. region, ditto
    21. zip, ditto
    22. metro, ditto
    23. country, ditto
    24. Parameter ssp - SSP
    25. Parameter brId - bid request ID
    26. Parameter originatingNodeId Node which originated the bid that resulted in this event
    27. node ID
    28. region of the node
  - logResponse
```
public static void logResponse(OpenRtbRequest req,
                               OpenRtbResponse br,
                               Object response)
```
    Logs the entire bid response to LOG_RESPONSE. Logged at Level.DEBUG debug level.
  - logResponse
```
public static void logResponse(String exchange,
                               String ssp,
                               String bidRequestId,
                               String bidId,
                               String tag)
```
  - logRawRequest
```
public static final void logRawRequest(OpenRtbRequest req,
                                       Object origReq,
                                       javax.ws.rs.core.UriInfo uriInfo)
```
    Logs raw request, as JSON. Logged at "debug" level. This logs the record with the following columns:
    1. Human-readable timestamp
    2. Unix timestamp
    3. URL of this request
    4. bid request ID
    5. "converted" as literal -- because this record is for a request already converted into OpenRtbRequest, our internal format
    6. Parameter req (OpenRtbRequest) converted to JSON
    Also, if origReq parameter is not null, the new record is written, similar to the above except:
    1. "raw" is written instead of "converted"
    2. Instead of req, origReq in a JSON format is written
    See Also:
    
    LOG_RAW_REQUEST
  - logRequest
```
public static void logRequest(OpenRtbRequest req,
                              boolean didBid,
                              int candidates)
```
    Log every Impression request (could be multiple per actual bid request). Note that not all fields are logged at all levels. Check the documentation per field. When not otherwise specified, everything here applies to INFO level.
    This actually writes more than one log:
    - In case of didBid being false, entries to three logs are written:
      
      request log which has hashed URLs (per standard business agreements with publishers and exchanges that this information cannot be shared with third parties)
      
      URL log where actual URLs and their hashes are stored which can be referred to hashed URLs from the above one (per standard business agreements with publishers and exchanges that this information cannot be shared with third parties)
      
      debug request log which has extra information useful for debugging.
    - If didBid is true (this happens when we decide to bid, and happens after the above, but much less frequently), a copy of the entry written earlier to LOG_REQUEST is now written to LOG_SESSION. The other files are not written at this point.
    Request log
    
    The following fields are logged, in this order (remember that any null or empty field is logged as DelimLayout.getNullChar()).
    1. Current date in human-readable format. We are always assuming this to be in UTC.
    2. Unix epoch time. We are always assuming this to be in UTC.
    3. M0, as a literal.
    4. Exchange (e.g., openx).
    5. Bid request ID
    6. Impression ID
    7. Our cookie, after corrections. See below for original version.
    8. Exchange's user ID
    9. Custom data we synced with Exchange on user
    10. User segments, encrypted with Lot49Config.getLogKey(), or plain text if that is null or empty.
    11. city based on Device.getGeo()
    12. region/state/province based on Device.getGeo()
    13. zip/postal code based on Device.getGeo()
    14. latitude based on Device.getGeo()
    15. longitude based on Device.getGeo()
    16. metro code based on Device.getGeo()
    17. city based on user
    18. region/state/province based on user
    19. zip/postal code based on user
    20. latitude based on user
    21. longitude based on user
    22. metro code based on user
    23. city based on our own lookup
    24. region/state/province based on our own lookup
    25. zip/postal code based on our own lookup
    26. latitude based on our own lookup
    27. longitude based on our own lookup
    28. metro code based on our own lookup
    29. Gender (per Exchange's opinion)
    30. IP address of the user
    31. User-agent of the user's browser
    32. M1 literal (marker)
    33. Make of user's device
    34. Model of user's device
    35. OS of user's device
    36. OS version of user's device
    37. Language of a user's device
    38. MD5 hash of the domain Domain
    39. Categories for site
    40. Keywords for site
    41. Name
    42. MD5-hashed Page URL
    43. Page category
    44. Content categories
    45. Content keywords
    46. Content language
    47. Type ("video" or "banner")
    48. Size (width x height)
    49. Mimes (Banner.getMimes() or Video.getMimes())
    50. Video.getApi() or Banner.getApi()
    51. linearity
    52. protocols
    53. min duration
    54. max duration
    55. X-Forwarded-For header value
    56. Country from Device
    57. Country from User
    58. Country looked up by us
    59. Section categories
    60. timezone
    61. user's domain
    62. user's ISP
    63. organization
    64. connection type
    65. test?
    66. Literal "X1"
    67. Literal marker "M2".
    68. User-data stored at Exchange and passed to us.
    69. Lot49CustomData.getUid()
    70. @param candidates -- how many candidates in BidCandidateManager, that is, how many ads we are considering eligible for this request, pending data request.
    71. Literal "M3".
    72. Lot49Ext.getRealIpHeader()
    73. Lot49Ext.getRemoteHost()
    74. Lot49Ext.getRemotePort()
    75. Lot49Ext.getRemoteAddr()
    76. ext object as is
    77. Literal "M4".
    78. Device type (see section 6.16 of OpenRTB spec.)
    79. User's Unix timestamp
    80. User's day of week
    81. Bidder's day of week
    82. User's hour
    83. Bidder's hour
    84. User's timestamp as string
    85. Literal "M5"
    86. SSP (actual exchange if the request is from an aggregator, or same as exchange).
    87. forceCookieReset
    88. forceCookieResync
    89. receivedBuyerUid
    90. Literal "X2"
    91. Literal "M6"
    92. Integral Ad Science's data
    93. bid choice algo
    94. browser name
    95. browser family
    96. third party provider information
    97. skyhook categories
    98. "M7" as a literal
    99. whether SSL was required
    100. excluded markups, as a list (see MarkupType ).
    101. Bid floor
    102. mod_uid encoding of cookie.
    103. "M8" as a literal
    104. other region names
    105. Private deals info
    106. node ID
    107. region of the node
    108. User segments as a comma-separated list each encrypted with an advertiser's key.
    109. "M9" as a literal
    110. App name
    111. App bundle ID
    URL log
    LOG_URLS is written with the following fields:
    1. Current date in human-readable format. We are always assuming this to be in UTC.
    2. Unix epoch time. We are always assuming this to be in UTC.
    3. Server ID
    4. Exchange
    5. Bid request ID
    6. Impression ID
    7. URL
    8. MD5 hash of the URL
    9. SSP (actual exchange if the request is from an aggregator, or same as exchange).
    10. Our cookie
    11. Exchange's user ID
    12. Custom data we synced with Exchange on user
    13. mod_uid encoding of cookie.
    14. Domain
    15. MD5 hash of the Domain
    Debug request log
    LOG_DEBUG_REQ is written with following fields:
    1. Current date in human-readable format. We are always assuming this to be in UTC.
    2. Unix epoch time. We are always assuming this to be in UTC.
    3. Bid request ID
    4. Impression ID
    5. optout reasons
    6. Literal "M1"
    7. comments
    8. Literal "M2"
  - logAt
```
private static final Object logAt(org.apache.logging.log4j.Level curLevel,
                                  org.apache.logging.log4j.Level expectedLevel,
                                  Object msg)
```
    Log at this level or a finer one.
  - warn
```
public static void warn(Object msg)
```
  - warn
```
public static void warn(Object msg,
                        Throwable t)
```
  - getPhaseOfDecision
```
public static String getPhaseOfDecision(String decisionReason)
```
  - getStepOfDecision
```
public static String getStepOfDecision(String decisionReason)
```

Class LogUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MARKER_BUDGET

MARKER_BCM

LOG_JETTY

jettyLogger

CURRENT_LOG_VERSION_NUM

LOG_BID

bidLogger

LOG_ABTEST_ASSIGNMENT

abTestAssignmentLogger

LOG_CLICK

clickLogger

LOG_DATE_FORMAT

LOG_IMPRESSION

impressionLogger

LOG_WIN

winLogger

LOG_PSEUDOWIN

pseudowinLogger

LOG_LOST

lostLogger

LOG_MAIN

mainLogger

LOG_ACCESS

accessLogger

LOG_REQUEST

requestLogger

LOG_DEBUG_REQ

debugReqLogger

LOG_REDIR

redirLogger

LOG_DECISION

decisionLogger

LOG_TAG_DECISION

tagDecisionLogger

LOG_RESPONSE

responseLogger

LOG_RAW_REQUEST

rawRequestLogger

LOG_PROUST

proustLogger

LOG_SESSION

sessionLogger

LOG_URLS

urlsLogger

MARKER_WINLOSS

seqImp

seqWin

seqPseudoWin

seqLoss

seqBid

Constructor Detail

LogUtils

Method Detail

init

getLogger

wrapMsg

debug

trace

trace

debug

trace

debug

error

fatal

logRedir

logAdLoadingError

logDecision

logTagDecision

error

getDate

info

info

info

logAccess