logApplicationMessage
On this page
Definition
logApplicationMessage
Note
Available only in MongoDB Enterprise and MongoDB Atlas.
The
logApplicationMessage
command allows users to post a custom message to the audit log. If running with authorization, users must haveclusterAdmin
role, or roles that inherit fromclusterAdmin
, to run the command.
Compatibility
This command is available in deployments hosted in the following environments:
MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud
Note
This command is supported in all MongoDB Atlas clusters. For information on all commands, see Unsupported Commands.
MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB
Syntax
The command has the following syntax:
db.runCommand( { logApplicationMessage: <string> } )
Behavior
MongoDB associates these custom messages with the audit
operation applicationMessage
,
and the messages are subject to any filtering.