Docs Menu
Docs Home
/
MongoDB Manual
/ / /

logApplicationMessage

On this page

  • Definition
  • Compatibility
  • Syntax
  • Behavior
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 have clusterAdmin role, or roles that inherit from clusterAdmin, to run the command.

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.

The command has the following syntax:

db.runCommand(
{
logApplicationMessage: <string>
}
)

MongoDB associates these custom messages with the audit operation applicationMessage, and the messages are subject to any filtering.

Back

System Events Auditing Commands

Next

Atlas Search Database Commands