Skip to content

HDFS-15516.Add info for create flags in NameNode audit logs. #2281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
+71 −16
Open

HDFS-15516.Add info for create flags in NameNode audit logs. #2281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .../hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/server/namenode/DefaultAuditLogger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,9 @@ public abstract void logAuditEvent(boolean succeeded, String userName,
CallerContext callerContext, UserGroupInformation ugi,
DelegationTokenSecretManager dtSecretManager);

public abstract void logAuditEvent(boolean succeeded, String userName,
InetAddress addr, String cmd, String src, String dst, FileStatus stat,
CallerContext callerContext, UserGroupInformation ugi,
DelegationTokenSecretManager dtSecretManager, String extra);

}
50 changes: 34 additions & 16 deletions ...roject/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/server/namenode/FSNamesystem.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,35 +415,40 @@ private void logAuditEvent(boolean succeeded, String cmd, String src,
}
}

private void logAuditEvent(boolean succeeded, String cmd, String src,
HdfsFileStatus stat) throws IOException {
if (!isAuditEnabled() || !isExternalInvocation()) {
return;
}
FileStatus status = null;
private FileStatus converHdfsFileStatus(String src, HdfsFileStatus stat) {
if (stat != null) {
Path symlink = stat.isSymlink()
? new Path(DFSUtilClient.bytes2String(stat.getSymlinkInBytes()))
: null;
Path path = new Path(src);
status = new FileStatus(stat.getLen(), stat.isDirectory(),
return new FileStatus(stat.getLen(), stat.isDirectory(),
stat.getReplication(), stat.getBlockSize(),
stat.getModificationTime(),
stat.getAccessTime(), stat.getPermission(), stat.getOwner(),
stat.getGroup(), symlink, path);
}
logAuditEvent(succeeded, cmd, src, null, status);

return null;
}

private void logAuditEvent(boolean succeeded,
UserGroupInformation ugi, InetAddress addr, String cmd, String src,
String dst, FileStatus status) {
final String ugiStr = ugi.toString();
logAuditEvent(succeeded, ugi, addr, cmd, src, dst, status, null);
}

private void logAuditEvent(boolean succeeded,
UserGroupInformation ugi, InetAddress addr, String cmd, String src,
String dst, FileStatus status, String extra) {
String ugiStr = null;
if (ugi != null) {
ugiStr = ugi.toString();
}
for (AuditLogger logger : auditLoggers) {
if (logger instanceof HdfsAuditLogger) {
HdfsAuditLogger hdfsLogger = (HdfsAuditLogger) logger;
hdfsLogger.logAuditEvent(succeeded, ugiStr, addr, cmd, src, dst,
status, CallerContext.getCurrent(), ugi, dtSecretManager);
status, CallerContext.getCurrent(), ugi, dtSecretManager, extra);
} else {
logger.logAuditEvent(succeeded, ugiStr, addr, cmd, src, dst, status);
}
Expand Down Expand Up @@ -2660,10 +2665,12 @@ HdfsFileStatus startFile(String src, PermissionStatus permissions,
createParent, replication, blockSize, supportedVersions, ecPolicyName,
storagePolicy, logRetryCache);
} catch (AccessControlException e) {
logAuditEvent(false, "create", src);
logAuditEvent(false, Server.getRemoteUser(), Server.getRemoteIp(),
"create", src, null, null, flag.toString());
throw e;
}
logAuditEvent(true, "create", src, status);
logAuditEvent(true, Server.getRemoteUser(), Server.getRemoteIp(),
"create", src, null, converHdfsFileStatus(src, status), flag.toString());
return status;
}

Expand Down Expand Up @@ -8713,10 +8720,9 @@ public void initialize(Configuration conf) {

@Override
public void logAuditEvent(boolean succeeded, String userName,
InetAddress addr, String cmd, String src, String dst,
FileStatus status, CallerContext callerContext, UserGroupInformation ugi,
DelegationTokenSecretManager dtSecretManager) {

InetAddress addr, String cmd, String src, String dst, FileStatus status,
CallerContext callerContext, UserGroupInformation ugi,
DelegationTokenSecretManager dtSecretManager, String extra) {
if (auditLog.isDebugEnabled() ||
(auditLog.isInfoEnabled() && !debugCmdSet.contains(cmd))) {
final StringBuilder sb = STRING_BUILDER.get();
Expand Down Expand Up @@ -8773,10 +8779,22 @@ public void logAuditEvent(boolean succeeded, String userName,
CallerContext.SIGNATURE_ENCODING));
}
}
if (extra != null) {
sb.append("\t").append("extra=").append(extra);
}
logAuditMessage(sb.toString());
}
}

@Override
public void logAuditEvent(boolean succeeded, String userName,
InetAddress addr, String cmd, String src, String dst,
FileStatus status, CallerContext callerContext, UserGroupInformation ugi,
DelegationTokenSecretManager dtSecretManager) {
logAuditEvent(succeeded, userName, addr, cmd, src, dst, status,
callerContext, ugi, dtSecretManager, null/*extra*/);
}

@Override
public void logAuditEvent(boolean succeeded, String userName,
InetAddress addr, String cmd, String src, String dst,
Expand Down
12 changes: 12 additions & 0 deletions ...ect/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/server/namenode/HdfsAuditLogger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,17 @@ public abstract void logAuditEvent(boolean succeeded, String userName,
FileStatus stat, CallerContext callerContext, UserGroupInformation ugi,
DelegationTokenSecretManager dtSecretManager);

/**
* Same as
* {@link #logAuditEvent(boolean, String, InetAddress, String, String,
* String, FileStatus, CallerContext, UserGroupInformation,
* DelegationTokenSecretManager, String)} add {@link String} information.
*/
public abstract void logAuditEvent(boolean succeeded, String userName,
InetAddress addr, String cmd, String src, String dst,
FileStatus stat, CallerContext callerContext, UserGroupInformation ugi,
DelegationTokenSecretManager dtSecretManager, String extra);

/**
* Same as
* {@link #logAuditEvent(boolean, String, InetAddress, String, String,
Expand All @@ -76,4 +87,5 @@ public abstract void logAuditEvent(boolean succeeded, String userName,
InetAddress addr, String cmd, String src, String dst,
FileStatus stat, UserGroupInformation ugi,
DelegationTokenSecretManager dtSecretManager);

}
20 changes: 20 additions & 0 deletions ...ect/hadoop-hdfs/src/test/java/org/apache/hadoop/hdfs/server/namenode/TestAuditLogger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,26 @@ public void testAuditLogForAcls() throws Exception {
}
}

@Test
public void testAuditLogWithExtra() throws Exception {
MiniDFSCluster cluster = null;
try {
Configuration conf = new HdfsConfiguration();
cluster = new MiniDFSCluster.Builder(conf).build();
cluster.waitClusterUp();
LogCapturer auditlog = LogCapturer.captureLogs(FSNamesystem.auditLog);
FileSystem fs = cluster.getFileSystem();
Path p = new Path("/debug.log");
fs.create(p, true);
String content = auditlog.getOutput();
assertTrue(content.contains("extra="));
auditlog.clearOutput();
} finally {
if (cluster != null) {
cluster.shutdown();
}
}
}

/**
* Tests that a broken audit logger causes requests to fail.
Expand Down