CLDSRV-750: add analytics fields to server access logs

Author: leif-scality

lib/api/api.js

@@ -172,9 +172,10 @@ const api = {
             log.addDefaultFields({
                 objectKey: request.objectKey,
             });
-            if (request.serverAccessLog) {
-                request.serverAccessLog.objectKey = request.objectKey;
-            }
+        }
+        if (request.serverAccessLog) {
+            request.serverAccessLog.objectKey = request.objectKey;
+            request.serverAccessLog.analyticsAction = actionLog;
         }
         let returnTagCount = true;
 
@@ -243,6 +244,10 @@ const api = {
                     authNames.sessionName = userInfo.getShortid().split(':')[1];
                 }
                 log.addDefaultFields(authNames);
+                if (request.serverAccessLog) {
+                    request.serverAccessLog.analyticsAccountName = authNames.accountName;
+                    request.serverAccessLog.analyticsUserName    = authNames.userName;
+                }
                 if (apiMethod === 'objectPut' || apiMethod === 'objectPutPart') {
                     return next(null, userInfo, authorizationResults, streamingV4Params, infos);
                 }

lib/api/multipartDelete.js

@@ -55,6 +55,10 @@ function multipartDelete(authInfo, request, log, callback) {
                 log.addDefaultFields({
                     bytesDeleted: partSizeSum,
                 });
+                if (request.serverAccessLogs) {
+                    // eslint-disable-next-line no-param-reassign
+                    request.serverAccessLogs.analyticsBytesDeleted = partSizeSum;
+                }
             }
             return callback(null, corsHeaders);
         }, request);

lib/api/objectDelete.js

@@ -111,6 +111,10 @@ function objectDeleteInternal(authInfo, request, log, isExpiration, cb) {
                     log.end().addDefaultFields({
                         bytesDeleted: objMD['content-length'],
                     });
+                    if (request.serverAccessLogs) {
+                        // eslint-disable-next-line no-param-reassign
+                        request.serverAccessLogs.analyticsBytesDeleted = objMD['content-length'];
+                    }
                 }
                 return next(null, bucketMD, objMD);
             });

lib/utilities/serverAccesssLogger.js

@@ -269,6 +269,21 @@ function logServerAccess(params, req, res) {
     const authInfo = params.authInfo;
 
     serverAccessLogger.info('SERVER_ACCESS_LOG', {
+        // Analytics
+        action: params.analyticsAction || null,
+        accountName: params.analyticsAccountName || null,
+        accountDisplayName: authInfo ? authInfo.getAccountDisplayName() : null,
+        userName: params.analyticsUserName || null,
+        clientPort: req.socket.remotePort || null,
+        httpMethod: req.method || null,
+        bytesDeleted: params.analyticsBytesDeleted || null,
+        bytesReceived: req.parsedContentLength || 0,
+        bodyLength: parseInt(req.headers['content-length'], 10) || 0,
+        contentLength: req.parsedContentLength || 0,
+        // eslint-disable-next-line camelcase
+        elapsed_ms: params.startTime && params.endTime ? Number(params.endTime - params.startTime) / 1_000_000 : null,
+        httpURL: req.url || null,
+
         // AWS access server logs fields https://docs.aws.amazon.com/AmazonS3/latest/userguide/LogFormat.html
         startTime: params.startTime ? params.startTime.toString() : null, // AWS "Time" field
         requester: getRequester(authInfo),