getAuditConfig

Definition定义

getAuditConfig

New in version 5.0.在版本5.0中新增。

getAuditConfig is an administrative command that retrieves audit configurations from mongod and mongos server instances.是一个从mongod和mongos服务器实例检索审计配置的管理命令。

Use the db.adminCommand( { command } ) method to run getAuditConfig against the admin database.使用db.adminCommand( { command } )方法对admin数据库运行getAuditConfig。

db.adminCommand( { getAuditConfig: 1 } )

Behavior行为

Auditing must be enabled in order to use getAuditConfig.必须启用审核才能使用getAuditConfig。

Nodes that are not participating in a runtime audit configuration return their current configuration file settings for auditLog.filter and setParameter.auditAuthorizationSuccess.未参与运行时审核配置的节点返回auditLog.filter和setParameter.auditAuthorizationSuccess的当前配置文件设置。

Nodes that are participating in the runtime audit synthesize their current configuration from memory. 参与运行时审核的节点从内存中合成其当前配置。Configuration updates are distributed via the oplog mechanism which means updates on mongod nodes are distributed to secondary nodes very quickly. 配置更新是通过oplog机制分发的，这意味着mongod节点上的更新会很快分发到次要节点。However, the distribution mechanism is different on mongos nodes. 然而，mongos节点上的分发机制不同。mongos nodes have to poll the primary server at regular intervals for configuration updates. mongos节点必须定期pollprimary服务器以获取配置更新。You may see stale data due to polling delay if you run setAuditConfig on the primary server and getAuditConfig on a shard before the shard has polled the primary server for updated configuration details.如果在主服务器上运行setAuditConfig并在分片轮询主服务器以获取更新的配置详细信息之前在分片上运行getAuditConfig，则可能会由于轮询延迟而看到过时的数据。

// mongosh
signature: {
   hash: Binary(Buffer.from("0000000000000000000000000000000000000000", "hex"), 0),
   keyId: Long("0")
}
// mongo
"signature" : {
                        "hash" : BinData(0,"AAAAAAAAAAAAAAAAAAAAAAAAAAA="),
                        "keyId" : NumberLong(0)
              }

Examples示例

Run getAuditConfig on the admin database .在admin数据库上运行getAuditConfig。

db.adminCommand({getAuditConfig: 1})

The example server is configured to audit read and write operations. 示例服务器被配置为审核读写操作。It has a filter which captures the desired operations and the auditAuthorizationSuccess value has been set to true.它有一个捕获所需操作的筛选器，auditAuthorizationSuccess值已设置为true。

{
  generation: ObjectId("60e73e74680a655705f16525"),
  filter: {
    atype: 'authCheck',
    'param.command': {
      '$in': [ 'find', 'insert', 'delete', 'update', 'findandmodify' ]
    }
  },
  auditAuthorizationSuccess: true,
  ok: 1,
  '$clusterTime': {
    clusterTime: Timestamp(1, 1625767540),
    signature: {
      hash: Binary(Buffer.from("0000000000000000000000000000000000000000", "hex"), 0),
      keyId: Long("0")
    }
  },
  operationTime: Timestamp(1, 1625767540)
}