---
schema_version: "1"
id: 8380049c07f3880f8d3ed7b97f9ab7cf8ef1c1a4ba9a3b7a424278462dccea59
title: EventSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_eventsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_eventsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: dc9b2dcad377b21397d0522fbe4c1bd06a67537a039afaee7df9c13a15f27452
description: Represents an org's platform event settings for Event Monitoring.
---
# EventSettings

Represents an org's platform event settings for Event Monitoring.

## File Suffix and Directory Location

EventSettings components have the suffix .settings and are stored in the settings folder.

## Version

EventSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d443109e81">Field Name</th>

              <th class="featureTableHeader  " id="d443109e84">Field Type</th>

              <th class="featureTableHeader  " id="d443109e87">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">bypassMeteringBlock</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Determines the behavior of metering service protection for Transaction Security
                policies. When <samp class="codeph nolang">true</samp>, metering occurs but
                doesn't block the user operation that triggered the policy. When <samp class="codeph nolang">false</samp> and a policy can't be handled within three
                seconds, metering occurs and the user's action is blocked. Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableApexLimitEvents</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) Apex Limit events.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableDeleteMonitoringData</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Allows (<samp class="codeph nolang">true</samp>) or disallows (<samp class="codeph nolang">false</samp>) Apex limits. Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableDynamicStreamingChannel</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the dynamic creation of a streaming channel
                when you subscribe to generic streaming. Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableEventLogGeneration</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the generation of event monitoring log files.
                Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableEventLogWaveIntegration</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the integration of event monitoring log files
                and Analytics apps. Analytics apps help you visualize your user’s activity. Default
                value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableLightningLoggerEvents</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the generation of Lightning Logger events.
                Lightning Logger events track information about custom Lightning web components.
                Default value is <samp class="codeph nolang">false</samp>. Requires Salesforce
                Shield or Salesforce Event Monitoring add-on subscriptions.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableLoginForensics</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the Login Forensics feature. Login Forensics
                helps you track and audit your org's user login activity. Default value is <samp class="codeph nolang">false</samp>. Available in API versions
                47.0–49.0.<div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_tip.png" alt="Tip">
                        <div class="mediaBd">
                          <h4 class="mbs">Tip</h4>
                          <p> In versions 50.0 and later, enable LoginEvent
                            on the Event Manager Setup page.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enablePlatformTracing</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) Platform Tracing in the org. Default value is
                <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableStreamingApi</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) Streaming API in the org. Default value is
                <samp class="codeph nolang">true</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">enableTransactionSecurityPolicies</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">boolean</td>

              <td class="entry" headers="d443109e87" data-title="Description">Enables (<samp class="codeph nolang">true</samp>) or disables (<samp class="codeph nolang">false</samp>) the ability to create and use transaction
                security policies in the Salesforce UI. Default value is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d443109e81" data-title="Field Name"><span class="keyword parmname">eventLogRetentionDuration</span></td>

              <td class="entry" headers="d443109e84" data-title="Field Type">integer</td>

              <td class="entry" headers="d443109e87" data-title="Description">Specifies the number of days (between 30 and 365) that your event log file data
                is retained for. If this value is not set, your event log file data is retained for
                1 year by default. </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of an EventSettings.settings file.

<?xml version="1.0" encoding="UTF-8"?>
<EventSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableDeleteMonitoringData\>true</enableDeleteMonitoringData\>
    <enableDynamicStreamingChannel\>false</enableDynamicStreamingChannel\>
    <enableEventLogWaveIntegration\>true</enableEventLogWaveIntegration\>
    <enableStreamingApi\>true</enableStreamingApi\>
    <enableTransactionSecurityPolicies\>true</enableTransactionSecurityPolicies\>
</EventSettings\>

## Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Event settings metadata:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
       <members\>Event</members\>
       <name\>Settings</name\>
   </types\>
   <version\>47.0</version\>
</Package\>

## Wildcard Support in the Manifest File

The wildcard character \* (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).