Function logServerAccess

lib/utilities/serverAccessLogger.js:588–691

(req, res)

}

function logServerAccess(req, res) {
    if (!req.serverAccessLog || !res.serverAccessLog || !serverAccessLogger) {
        return;
    }

    const params = req.serverAccessLog;
    const errorCode = res.serverAccessLog.errorCode;
    const endTurnAroundTime = res.serverAccessLog.endTurnAroundTime;
    const requestID = res.serverAccessLog.requestID;
    const bytesSent = res.serverAccessLog.bytesSent;

    const logEntry = buildLogEntry(req, params, {
        bytesDeleted: params.analyticsBytesDeleted,
        bytesReceived: Number.isInteger(req.parsedContentLength) ? req.parsedContentLength : undefined,
        bodyLength: req.headers['content-length'] !== undefined
            ? parseInt(req.headers['content-length'], 10)
            : undefined,
        contentLength: getObjectSize(req, res),
        // eslint-disable-next-line camelcase
        elapsed_ms: calculateElapsedMS(params.startTime, params.onCloseEndTime),
        operation: getOperation(req),
        requestURI: getURI(req),
        errorCode,
        objectSize: params.objectSize ?? getObjectSize(req, res),
        totalTime: calculateTotalTime(params.startTime, params.onFinishEndTime),
        turnAroundTime: calculateTurnAroundTime(params.startTurnAroundTime, endTurnAroundTime),
        versionId: req.query?.versionId,
        aclRequired: req.serverAccessLog.aclRequired,
        referer: req.headers?.referer,
        userAgent: req.headers?.['user-agent'],
        requestID,
        bytesSent: getBytesSent(res, bytesSent),
        httpCode: res.statusCode,
        objectKey: params.objectKey,
    });

    // Lifecycle expiration is an internal operation.
    // Null out HTTP-layer fields to match AWS access log format.
    if (params.expiration) {
        logEntry.requester = 'ScalityS3LifecycleService';
        logEntry.clientIP = undefined;
        logEntry.requestURI = undefined;
        logEntry.httpCode = undefined;
        logEntry.bytesSent = undefined;
        logEntry.totalTime = undefined;
        logEntry.turnAroundTime = undefined;
        logEntry.signatureVersion = undefined;
        logEntry.cipherSuite = undefined;
        logEntry.authenticationType = undefined;
        logEntry.hostHeader = undefined;
        logEntry.tlsVersion = undefined;
        logEntry.referer = undefined;
        logEntry.userAgent = undefined;
        logEntry.versionId = undefined;
        logEntry.awsAccessKeyID = undefined;
    }

    // Match AWS log shape for replication entries: blank clientIP, userAgent