Docs Menu
Docs Home
/ /
Atlas App Services

Log Forwarder Configuration Files

Note

This page describes a legacy configuration file format. You should only use this information if you're using the deprecated realm-cli.

Any configuration files you pull with App Services CLI or export from the UI use the latest configuration version. For detailed information on the current configuration file format, see App Configuration.

You define log forwarder configuration files in the /log_forwarders directory.

app/
└── log_forwarders/
└── <Name>.json
log_forwarders/<name>.json
{
"name": "<name>",
"log_types": [ "<type>", ... ],
"log_statuses": [ "<status>", ... ],
"policy": { batching policy },
"action": { action configuration }
}
Field
Description
name
String
A unique name for the log forwarder.
log_types
Array<String>

An array of one or more log types that the forwarder should send to a service. Atlas App Services only forwards a log if its type is listed and its status is listed in log_statuses.

The array may contain the following log types:

  • auth

  • endpoint

  • function

  • graphql

  • push

  • schema

  • service

  • sync

  • trigger

  • trigger_error_handler

log_statuses
Array<String>

An array of one or more log statuses that the forwarder should send to a service. App Services only forwards a log if its type is listed and its type is listed in log_types.

The array may contain the following log statuses:

  • error

  • success

policy
Object

An object that configures the forwarder's batching policy.

To forward logs individually:

{ "type": "single" }

To group logs into batches:

{ "type": "batch" }
action
Object

An object that configures where and how the forwarder sends logs.

To forward logs to a linked MongoDB collection:

{
"type": "collection",
"data_source": "<data source name>",
"database": "<database name>",
"collection": "<collection name>"
}

To forward logs with a custom function:

{
"type": "function",
"name": "<function name>"
}

Next

What are the Atlas Application Services?