diff --git a/source/administration-guide/configure/environment-configuration-settings.rst b/source/administration-guide/configure/environment-configuration-settings.rst index d4158e56c61..4bec00e2838 100644 --- a/source/administration-guide/configure/environment-configuration-settings.rst +++ b/source/administration-guide/configure/environment-configuration-settings.rst @@ -3665,97 +3665,7 @@ Audit file name .. note:: - The file name must be set to `enable <#auditlog-fileenabled>`__ audit logging. - -.. config:setting:: auditlog-filemaxsizemb - :displayname: Maximum audit file size (Audit Logging) - :systemconsole: Compliance > Audit Logging - :configjson: .ExperimentalAuditSettings.FileMaxSizeMB - :environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXSIZEMB - :description: The maximum size in megabytes for audit log files before they are rotated. Default is 100 MB. - -Maximum file size -^^^^^^^^^^^^^^^^^ - -+--------------------------------------------------+----------------------------------------------------------------------------------------+ -| The maximum size in megabytes for audit log | - System Config path: **Compliance > Audit Logging** | -| files before they are rotated. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxSizeMB`` > ``100`` | -| | - Environment variable: ``MM_EXPERIMENTALAUDITSETTINGS_FILEMAXSIZEMB`` | -| Numerical input. Default is **100** MB. | | -+--------------------------------------------------+----------------------------------------------------------------------------------------+ - -.. config:setting:: auditlog-filemaxagedays - :displayname: Maximum audit file age (Audit Logging) - :systemconsole: Compliance > Audit Logging - :configjson: .ExperimentalAuditSettings.FileMaxAgeDays - :environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXAGEDAYS - :description: The maximum age in days for audit log files before they are deleted. Default is 0 (no limit). - -Maximum file age -^^^^^^^^^^^^^^^^ - -+--------------------------------------------------+----------------------------------------------------------------------------------------+ -| The maximum age in days for audit log files | - System Config path: **Compliance > Audit Logging** | -| before they are deleted. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxAgeDays`` > ``0`` | -| | - Environment variable: ``MM_EXPERIMENTALAUDITSETTINGS_FILEMAXAGEDAYS`` | -| Numerical input. Default is **0** (no limit). | | -+--------------------------------------------------+----------------------------------------------------------------------------------------+ - -.. config:setting:: auditlog-filemaxbackups - :displayname: Maximum audit file backups (Audit Logging) - :systemconsole: Compliance > Audit Logging - :configjson: .ExperimentalAuditSettings.FileMaxBackups - :environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXBACKUPS - :description: The maximum number of audit log file backups to retain. Default is 0 (no limit). - -Maximum file backups -^^^^^^^^^^^^^^^^^^^^ - -+--------------------------------------------------+----------------------------------------------------------------------------------------+ -| The maximum number of audit log file backups | - System Config path: **Compliance > Audit Logging** | -| to retain. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxBackups`` > ``0`` | -| | - Environment variable: ``MM_EXPERIMENTALAUDITSETTINGS_FILEMAXBACKUPS`` | -| Numerical input. Default is **0** (no limit). | | -+--------------------------------------------------+----------------------------------------------------------------------------------------+ - -.. config:setting:: auditlog-filecompress - :displayname: Compress audit log files (Audit Logging) - :systemconsole: Compliance > Audit Logging - :configjson: .ExperimentalAuditSettings.FileCompress - :environment: MM_EXPERIMENTALAUDITSETTINGS_FILECOMPRESS - :description: Whether to compress rotated audit log files. - - - **true**: Rotated audit log files are compressed. - - **false**: **(Default)** Rotated audit log files aren't compressed. - -Compress audit log files -^^^^^^^^^^^^^^^^^^^^^^^^ - -+--------------------------------------------------+-------------------------------------------------------------------------------------------+ -| Whether to compress rotated audit log files. | - System Config path: **Compliance > Audit Logging** | -| | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileCompress`` > ``false`` | -| - **true**: Rotated audit log files are | - Environment variable: ``MM_EXPERIMENTALAUDITSETTINGS_FILECOMPRESS`` | -| compressed. | | -| - **false**: **(Default)** Rotated audit log | | -| files aren't compressed. | | -+--------------------------------------------------+-------------------------------------------------------------------------------------------+ - -.. config:setting:: auditlog-filemaxqueuesize - :displayname: Audit log queue size (Audit Logging) - :systemconsole: Compliance > Audit Logging - :configjson: .ExperimentalAuditSettings.FileMaxQueueSize - :environment: MM_EXPERIMENTALAUDITSETTINGS_FILEMAXQUEUESIZE - :description: The maximum number of audit log entries that can be queued. Default is 1000. - -Audit log queue size -^^^^^^^^^^^^^^^^^^^^ - -+--------------------------------------------------+--------------------------------------------------------------------------------------------+ -| The maximum number of audit log entries that | - System Config path: **Compliance > Audit Logging** | -| can be queued. | - ``config.json`` setting: ``ExperimentalAuditSettings`` > ``FileMaxQueueSize`` > ``1000`` | -| | - Environment variable: ``MM_EXPERIMENTALAUDITSETTINGS_FILEMAXQUEUESIZE`` | -| Numerical input. Default is **1000**. | | -+--------------------------------------------------+--------------------------------------------------------------------------------------------+ +When `output audit logs to file <#auditlog-fileenabled>`__ is enabled, the file name must be set. To configure file rotation and advanced audit log output, use the :ref:`AdvancedLoggingJSON ` setting. .. config:setting:: auditlog-certificate :displayname: Audit log certificate (Audit Logging) diff --git a/source/administration-guide/configure/experimental-configuration-settings.rst b/source/administration-guide/configure/experimental-configuration-settings.rst index 632f704aed7..8bfa027b611 100644 --- a/source/administration-guide/configure/experimental-configuration-settings.rst +++ b/source/administration-guide/configure/experimental-configuration-settings.rst @@ -767,7 +767,7 @@ Enable audit logging .. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: -When audit logging is enabled in a self-hosted instance, you can specify size, backup interval, compression, maximium age to manage file rotation, and timestamps for audit logging, as defined below. You can specify these settings independently for audit events and AD/LDAP events. +When audit logging is enabled in a self-hosted instance, you can specify a file name for audit logging, as defined below. To configure file rotation and advanced audit log output, use the :ref:`AdvancedLoggingJSON ` setting. You can specify these settings independently for audit events and AD/LDAP events. **True**: Audit logging files are enabled, and audit files are written locally to a file for a self-hosted deployment. @@ -796,102 +796,6 @@ Specify the path to the audit file for a self-hosted deployment. | This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileName": ""`` with string input consisting of a user-defined path (e.g. ``/var/log/mattermost_audit.log``). | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. config:setting:: max-file-size - :displayname: File max size MB (Audit Logging > Self-Hosted) - :systemconsole: Experimental > Features - :configjson: FileMaxSizeMB - :environment: N/A - :description: This is the maximum size (measured in megabytes) that the file can grow before triggering rotation for a self-hosted deployment.. Default is **100** MB. - -Max file size -~~~~~~~~~~~~~ - -.. include:: ../../_static/badges/ent-plus.rst - :start-after: :nosearch: - -This is the maximum size, in megabytes, that the file can grow before triggering rotation for a self-hosted deployment. The default setting is ``100``. - -+---------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxSizeMB": 100`` with numerical input. | -+---------------------------------------------------------------------------------------------------------------------+ - -.. config:setting:: max-file-age - :displayname: File max age days (Audit Logging > Self-Hosted) - :systemconsole: Experimental > Features - :configjson: FileMaxAgeDays - :environment: N/A - :description: This is the maximum age in days a file can reach before triggering rotation for a self-hosted deployment.. The default value is **0**, indicating no limit on the age. - -Max file age -~~~~~~~~~~~~~ - -.. include:: ../../_static/badges/ent-plus.rst - :start-after: :nosearch: - -This is the maximum age, in days, a file can reach before triggering rotation for a self-hosted deployment. The default value is ``0``, indicating no limit on the age. - -+--------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxAgeDays": 0`` with numerical input. | -+--------------------------------------------------------------------------------------------------------------------+ - -.. config:setting:: maximum-file-backups - :displayname: File max backups (Audit Logging > Self-Hosted) - :systemconsole: Experimental > Features - :configjson: FileMaxBackups - :environment: N/A - :description: This is the maximum number of rotated files kept for a self-hosted deployment. The oldest is deleted first. The default value is **0**, indicating no limit on the number of backups. - -Maximum file backups -~~~~~~~~~~~~~~~~~~~~ - -.. include:: ../../_static/badges/ent-plus.rst - :start-after: :nosearch: - -This is the maximum number of rotated files kept for a self-hosted deployment. The oldest is deleted first. The default value is ``0``, indicating no limit on the number of backups. - -+--------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxBackups": 0`` with numerical input. | -+--------------------------------------------------------------------------------------------------------------------+ - -.. config:setting:: file-compression - :displayname: File compress (Audit Logging > Self-Hosted) - :systemconsole: Experimental > Features - :configjson: FileCompress - :environment: N/A - :description: When ``true``, rotated files are compressed using ``gzip`` in a self-hosted deployment. Default value is **false**. - -File compression -~~~~~~~~~~~~~~~~ - -.. include:: ../../_static/badges/ent-plus.rst - :start-after: :nosearch: - -When ``true``, rotated files are compressed using ``gzip`` in a self-hosted deployment. - -+-------------------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileCompress": false`` with options ``true`` and ``false``. | -+-------------------------------------------------------------------------------------------------------------------------------------+ - -.. config:setting:: maximum-file-queue - :displayname: File max queue size (Audit Logging > Self-Hosted) - :systemconsole: Experimental > Features - :configjson: FileMaxQueueSize - :environment: N/A - :description: This setting determines how many audit records can be queued/buffered at any point in time when writing to a file for a self-hosted deployment. Default is **1000** records. - -Maximum file queue -~~~~~~~~~~~~~~~~~~~ - -.. include:: ../../_static/badges/ent-plus.rst - :start-after: :nosearch: - -This setting determines how many audit records can be queued/buffered at any point in time when writing to a file for a self-hosted deployment. The default is ``1000`` records. -This setting can be left as default unless you are seeing audit write failures in the server log and need to adjust the number accordingly. - -+-------------------------------------------------------------------------------------------------------------------------+ -| This feature's ``config.json`` setting is ``".ExperimentalAuditSettings.FileMaxQueueSize": 1000`` with numerical input. | -+-------------------------------------------------------------------------------------------------------------------------+ - .. config:setting:: audit-logging-certificate :displayname: Audit logging certificate upload (Audit Logging > Cloud Enterprise) :systemconsole: Audit Log Settings > Certificate diff --git a/source/administration-guide/manage/logging.rst b/source/administration-guide/manage/logging.rst index 8ef0e587649..511b06d1cc7 100644 --- a/source/administration-guide/manage/logging.rst +++ b/source/administration-guide/manage/logging.rst @@ -235,14 +235,9 @@ You can enable and customize advanced audit logging in Mattermost to record acti .. note:: - From Mattermost v10.11, Cloud deployments include certificate-based audit logging capabilities not available within self-hosted deployments. - - Cloud-based deployments use the following self-hosted audit logging default values: + - Cloud-based deployments use the following self-hosted audit logging default values: - FileEnabled: false - - FileMaxSizeMB: 100 - - FileMaxAgeDays: 0 (no limit) - - FileMaxBackups: 0 (retain all) - - FileCompress: false - - FileMaxQueueSize: 1000 - Cloud deployments can't configure local file-based audit logging, and all file-related settings are hidden. diff --git a/source/administration-guide/manage/telemetry.rst b/source/administration-guide/manage/telemetry.rst index 96d36238671..c533f3fd686 100644 --- a/source/administration-guide/manage/telemetry.rst +++ b/source/administration-guide/manage/telemetry.rst @@ -34,7 +34,7 @@ The following data is collected once every 24 hours: - Database type - Database version - Number of teams -- Number of users +- Number of users - Number of activated users - Whether or not the unit tests have been run - Date and time of the last check for security updates @@ -55,10 +55,10 @@ Mattermost error and diagnostic data is collected for the following purposes: - To help improve the quality of Mattermost software and related services. - To make design decisions for future releases. -.. note:: +.. note:: Error and diagnostic reporting is sent by Mattermost to the endpoint ``https://pdat.matterlytics.com``, a custom Rudder domain. When this feature is enabled, any 500 errors will automatically be sent to the Mattermost-hosted `Sentry `_ endpoint. - + Opt out ~~~~~~~ @@ -89,8 +89,8 @@ Server Configuration Settings **Type values (enumerated integer and enumerated boolean)** - **ServiceSettings**: enum WebserverMode, bool EnableSecurityFixAlert, bool EnableInsecureOutgoingConnections, bool EnableIncomingWebhooks, bool EnableOutgoingWebhooks, bool EnableCommands, bool EnableDeveloper, bool EnableOnlyAdminIntegrations, bool EnablePostUsernameOverride, bool EnablePostIconOverride, bool EnableCustomEmoji, enum RestrictCustomEmojiCreation, bool EnableTesting, bool DeveloperFlags, bool EnableClientPerformanceDebugging, bool EnableMultifactorAuthentication, bool EnableOAuthServiceProvider, enum OutgoingIntegrationRequestsDefaultTimeout, enum ConnectionSecurity, bool UseLetsEncrypt, bool Forward80To443, enum ConnectionSecurity, bool TLSStrictTransport, bool EnforceMultifactorAuthentication, bool EnableUserTypingMessages, bool TimeBetweenUserTypingUpdatesMilliseconds, bool EnablePostSearch, bool EnableUserStatuses, bool EnableChannelViewMessages, bool EnableEmojiPicker, bool EnableGifPicker, bool EnableAuthenticationTransfer, enum TeammateNameDisplay, bool EnableUserAccessTokens, enum MaximumLoginAttempts, bool ExtendSessionLengthWithActivity, enum SessionLengthWebInHours, enum SessionLengthMobileInHours, enum SessionLengthSSOInHours, int SessionCacheInMinutes, enum SessionIdleTimeoutInMinutes, enum TimeBetweenUserTypingUpdatesMilliseconds, enum ClusterLogTimeoutMilliseconds, bool CloseUnusedDirectMessages, bool EnablePreviewFeatures, bool EnableTutorial, bool EnableOnboarding, bool ExperimentalEnableDefaultChannelLeaveJoinMessages, bool ExperimentalGroupUnreadChannels, bool AllowCookiesForSubdomains, bool EnableAPITeamDeletion, bool EnableAPITriggerAdminNotifications, bool EnableAPIUserDeletion, bool EnableAPIChannelDeletion, bool ExperimentalEnableHardenedMode, bool DisableLegacyMFA, bool ExperimentalStrictCSRFEnforcement, bool EnableEmailInvitations, bool ExperimentalChannelOrganization, bool EnableLegacySidebar, bool CorsAllowCredentials, bool CorsDebug, bool DisableBotsWhenOwnerIsDeactivated, bool EnableBotAccountCreation, bool RestrictLinkPreviews, bool EnablePermalinkPreviews, bool EnableSVGs, bool EnableLatex, bool EnableInlineLatex, bool Directory, bool RetentionDays, bool EnableLocalMode; **TeamSettings**: bool EnableUserCreation, bool EnableTeamCreation, bool RestrictTeamNames, bool EnableOpenServer, bool EnableUserDeactivation, bool EnableCustomBrand, bool RestrictDirectMessage, enum MaxNotificationsPerChannel, bool EnableConfirmNotificationsToChannel; enum MaxUsersPerTeam, enum MaxChannelsPerTeam, bool EnableJoinLeaveMessageByDefault, bool EnableCustomUserStatuses, bool EnableLastActiveTime, bool RefreshPostStatsRunTime, bool ExperimentalTownSquareIsReadOnly, bool ExperimentalHideTownSquareinLHS, bool EnableXToLeaveChannelsFromLHS, bool ExperimentalEnableAutomaticReplies, bool ExperimentalViewArchivedChannels, bool LockTeammateNameDisplay, bool MaxFieldSize; **ClientRequirementSettings**: enum AndroidLatestVersion; **GuestAccountsSettings**: bool Enable, bool AllowEmailAccounts, bool EnforceMultifactorAuthentication; **SqlSettings**: enum DriverName, bool Trace, enum ConnMaxIdleTimeMilliseconds, bool ConnMaxLifetimeMilliseconds; enum MaxOpenConns, enum QueryTimeout, bool DisableDatabaseSearch; **LogSettings**: bool EnableConsole, enum ConsoleLevel, bool ConsoleJson, bool EnableFile, enum FileLevel, bool FileJson, bool EnableWebhookDebugging; **NotificationLogSettings**: bool EnableConsole, bool ConsoleLevel, bool ConsoleJson, bool EnableFile, bool FileLevel, bool FileJson **PasswordSettings**: bool Lowercase, bool Number, bool Uppercase, bool Symbol, enum MinimumLength; **FileSettings**: bool EnablePublicLink, enum DriverName, enum MaxFileSize, enum FileSettings.MaxImageResolution, enum MaxImageDecoderConcurrency, bool FileSettings.ExtractContent, bool FileSettings.ArchiveRecursion, bool AmazonS3SSL, bool AmazonS3SignV2, bool AmazonS3SSE, bool AmazonS3Trace, bool MaximumPayloadSizeBytes, bool MaximumPayloadSizeBytes, bool EnableFileAttachments, bool EnableMobileUpload, bool EnableMobileDownload; **EmailSettings**: bool EnableSignUpWithEmail, bool EnableSignInWithEmail, bool EnableSignInWithUsername, bool RequireEmailVerification, bool SendEmailNotifications, bool UseChannelInEmailNotifications, bool EmailNotificationContentsType, bool EnableSMTPAuth, enum ConnectionSecurity, bool SendPushNotifications, enum PushNotificationContents, bool EnableEmailBatching, bool SkipServerCertificateVerification, enum EmailBatchingBufferSize, enum EmailBatchingInterval, bool EnablePreviewModeBanner, enum SMTPServerTimeout; **MessageExportSettings**: bool DownloadExportResults; **RateLimitSettings**: bool EnableRateLimiter, bool VaryByRemoteAddr, bool VaryByUser, enum PerSec, enum MaxBurst, enum MemoryStoreSize; **PrivacySettings**: bool ShowEmailAddress, bool ShowFullName; **ThemeSettings**: bool EnableThemeSelection, bool AllowCustomThemes; **GitLabSettings**: bool Enable; **GoogleSettings**: bool Enable; **Office365Settings**: bool Enable; **SupportSettings**: bool CustomTermsOfServiceEnabled, enum CustomTermsOfServiceReAcceptancePeriod, enum ReportAProblemType; **LdapSettings**: bool Enable, bool EnableSync, enum ConnectionSecurity, bool SkipCertificateVerification, enum SyncIntervalMinutes, enum QueryTimeout, enum MaxPageSize, bool EnableAdminFilter; **ComplianceSettings**: bool Enable, bool EnableDaily; **LocalizationSettings**: enum DefaultServerLocale, enum DefaultClientLocale, enum AvailableLocales; **SamlSettings**: bool Enable, bool EnableSyncWithLdap, bool IgnoreGuestsLdapSync, bool EnableSyncWithLdapIncludeAuth, bool Verify, bool Encrypt, bool SignRequest, bool EnableAdminFilter; **ClusterSettings**: bool Enable, bool UseIpAddress, bool ReadOnlyConfig, bool EnableExperimentalGossipEncryption, bool EnableGossipCompression; **MetricsSettings**: bool Enable, bool EnableClientMetrics, bool EnableNotificationMetrics, enum BlockProfileRate; **WebrtcSettings** (only in v5.5 and earlier): bool Enable; **ExperimentalSettings** bool ClientSideCertEnable, bool EnablePostMetadata, bool LinkMetadataTimeoutMilliseconds, bool EnableClickToReply, bool RestrictSystemAdmin, bool CloudBilling, bool AllowSyncedDrafts, bool YoutubeReferrerPolicy; **AnnouncementSettings**: bool EnableBanner, bool AllowBannerDismissal, bool AdminNoticesEnabled, bool UserNoticesEnabled; **ElasticsearchSettings**: bool EnableIndexing, bool EnableSearching, bool Sniff, enum PostIndexReplicas, enum PostIndexShards, enum LiveIndexingBatchSize, enum BatchSize, bool SkipTLSVerification, bool Trace; **PluginSettings**: bool Enable, bool EnableUploads, bool EnableHealthCheck, bool EnableMarketplace, bool EnableRemoteMarketplace, bool AutomaticPrepackagedPlugins, bool RequirePluginSignature; **DataRetentionSettings**: bool EnableMessageDeletion, bool MessageRetentionHours, bool AllowInsecureDownloadUrl, bool EnableFileDeletion, bool FileRetentionHours, enum DeletionJobStartTime; **MessageExportSettings**: bool EnableExport, enum ExportFormat, enum DailyRunTime, enum ExportFromTimestamp, enum BatchSize, enum GlobalRelaySettings.CustomerType; **ExperimentalAuditSettings**: bool SysLogEnabled, bool SysLogInsecure, enum SysLogMaxQueueSize, bool FileEnabled, enum FileMaxSizeMB, enum FileMaxAgeDays, bool FileMaxBackups, bool FileCompress, enum FileMaxQueueSize; **BleveSettings**: bool EnableIndexing, bool EnableSearching, bool EnableAutocomplete, enum BatchSize; bool FeatureFlags - + **ServiceSettings**: enum WebserverMode, bool EnableSecurityFixAlert, bool EnableInsecureOutgoingConnections, bool EnableIncomingWebhooks, bool EnableOutgoingWebhooks, bool EnableCommands, bool EnableDeveloper, bool EnableOnlyAdminIntegrations, bool EnablePostUsernameOverride, bool EnablePostIconOverride, bool EnableCustomEmoji, enum RestrictCustomEmojiCreation, bool EnableTesting, bool DeveloperFlags, bool EnableClientPerformanceDebugging, bool EnableMultifactorAuthentication, bool EnableOAuthServiceProvider, enum OutgoingIntegrationRequestsDefaultTimeout, enum ConnectionSecurity, bool UseLetsEncrypt, bool Forward80To443, enum ConnectionSecurity, bool TLSStrictTransport, bool EnforceMultifactorAuthentication, bool EnableUserTypingMessages, bool TimeBetweenUserTypingUpdatesMilliseconds, bool EnablePostSearch, bool EnableUserStatuses, bool EnableChannelViewMessages, bool EnableEmojiPicker, bool EnableGifPicker, bool EnableAuthenticationTransfer, enum TeammateNameDisplay, bool EnableUserAccessTokens, enum MaximumLoginAttempts, bool ExtendSessionLengthWithActivity, enum SessionLengthWebInHours, enum SessionLengthMobileInHours, enum SessionLengthSSOInHours, int SessionCacheInMinutes, enum SessionIdleTimeoutInMinutes, enum TimeBetweenUserTypingUpdatesMilliseconds, enum ClusterLogTimeoutMilliseconds, bool CloseUnusedDirectMessages, bool EnablePreviewFeatures, bool EnableTutorial, bool EnableOnboarding, bool ExperimentalEnableDefaultChannelLeaveJoinMessages, bool ExperimentalGroupUnreadChannels, bool AllowCookiesForSubdomains, bool EnableAPITeamDeletion, bool EnableAPITriggerAdminNotifications, bool EnableAPIUserDeletion, bool EnableAPIChannelDeletion, bool ExperimentalEnableHardenedMode, bool DisableLegacyMFA, bool ExperimentalStrictCSRFEnforcement, bool EnableEmailInvitations, bool ExperimentalChannelOrganization, bool EnableLegacySidebar, bool CorsAllowCredentials, bool CorsDebug, bool DisableBotsWhenOwnerIsDeactivated, bool EnableBotAccountCreation, bool RestrictLinkPreviews, bool EnablePermalinkPreviews, bool EnableSVGs, bool EnableLatex, bool EnableInlineLatex, bool Directory, bool RetentionDays, bool EnableLocalMode; **TeamSettings**: bool EnableUserCreation, bool EnableTeamCreation, bool RestrictTeamNames, bool EnableOpenServer, bool EnableUserDeactivation, bool EnableCustomBrand, bool RestrictDirectMessage, enum MaxNotificationsPerChannel, bool EnableConfirmNotificationsToChannel; enum MaxUsersPerTeam, enum MaxChannelsPerTeam, bool EnableJoinLeaveMessageByDefault, bool EnableCustomUserStatuses, bool EnableLastActiveTime, bool RefreshPostStatsRunTime, bool ExperimentalTownSquareIsReadOnly, bool ExperimentalHideTownSquareinLHS, bool EnableXToLeaveChannelsFromLHS, bool ExperimentalEnableAutomaticReplies, bool ExperimentalViewArchivedChannels, bool LockTeammateNameDisplay, bool MaxFieldSize; **ClientRequirementSettings**: enum AndroidLatestVersion; **GuestAccountsSettings**: bool Enable, bool AllowEmailAccounts, bool EnforceMultifactorAuthentication; **SqlSettings**: enum DriverName, bool Trace, enum ConnMaxIdleTimeMilliseconds, bool ConnMaxLifetimeMilliseconds; enum MaxOpenConns, enum QueryTimeout, bool DisableDatabaseSearch; **LogSettings**: bool EnableConsole, enum ConsoleLevel, bool ConsoleJson, bool EnableFile, enum FileLevel, bool FileJson, bool EnableWebhookDebugging; **NotificationLogSettings**: bool EnableConsole, bool ConsoleLevel, bool ConsoleJson, bool EnableFile, bool FileLevel, bool FileJson **PasswordSettings**: bool Lowercase, bool Number, bool Uppercase, bool Symbol, enum MinimumLength; **FileSettings**: bool EnablePublicLink, enum DriverName, enum MaxFileSize, enum FileSettings.MaxImageResolution, enum MaxImageDecoderConcurrency, bool FileSettings.ExtractContent, bool FileSettings.ArchiveRecursion, bool AmazonS3SSL, bool AmazonS3SignV2, bool AmazonS3SSE, bool AmazonS3Trace, bool MaximumPayloadSizeBytes, bool MaximumPayloadSizeBytes, bool EnableFileAttachments, bool EnableMobileUpload, bool EnableMobileDownload; **EmailSettings**: bool EnableSignUpWithEmail, bool EnableSignInWithEmail, bool EnableSignInWithUsername, bool RequireEmailVerification, bool SendEmailNotifications, bool UseChannelInEmailNotifications, bool EmailNotificationContentsType, bool EnableSMTPAuth, enum ConnectionSecurity, bool SendPushNotifications, enum PushNotificationContents, bool EnableEmailBatching, bool SkipServerCertificateVerification, enum EmailBatchingBufferSize, enum EmailBatchingInterval, bool EnablePreviewModeBanner, enum SMTPServerTimeout; **MessageExportSettings**: bool DownloadExportResults; **RateLimitSettings**: bool EnableRateLimiter, bool VaryByRemoteAddr, bool VaryByUser, enum PerSec, enum MaxBurst, enum MemoryStoreSize; **PrivacySettings**: bool ShowEmailAddress, bool ShowFullName; **ThemeSettings**: bool EnableThemeSelection, bool AllowCustomThemes; **GitLabSettings**: bool Enable; **GoogleSettings**: bool Enable; **Office365Settings**: bool Enable; **SupportSettings**: bool CustomTermsOfServiceEnabled, enum CustomTermsOfServiceReAcceptancePeriod, enum ReportAProblemType; **LdapSettings**: bool Enable, bool EnableSync, enum ConnectionSecurity, bool SkipCertificateVerification, enum SyncIntervalMinutes, enum QueryTimeout, enum MaxPageSize, bool EnableAdminFilter; **ComplianceSettings**: bool Enable, bool EnableDaily; **LocalizationSettings**: enum DefaultServerLocale, enum DefaultClientLocale, enum AvailableLocales; **SamlSettings**: bool Enable, bool EnableSyncWithLdap, bool IgnoreGuestsLdapSync, bool EnableSyncWithLdapIncludeAuth, bool Verify, bool Encrypt, bool SignRequest, bool EnableAdminFilter; **ClusterSettings**: bool Enable, bool UseIpAddress, bool ReadOnlyConfig, bool EnableExperimentalGossipEncryption, bool EnableGossipCompression; **MetricsSettings**: bool Enable, bool EnableClientMetrics, bool EnableNotificationMetrics, enum BlockProfileRate; **WebrtcSettings** (only in v5.5 and earlier): bool Enable; **ExperimentalSettings** bool ClientSideCertEnable, bool EnablePostMetadata, bool LinkMetadataTimeoutMilliseconds, bool EnableClickToReply, bool RestrictSystemAdmin, bool CloudBilling, bool AllowSyncedDrafts, bool YoutubeReferrerPolicy; **AnnouncementSettings**: bool EnableBanner, bool AllowBannerDismissal, bool AdminNoticesEnabled, bool UserNoticesEnabled; **ElasticsearchSettings**: bool EnableIndexing, bool EnableSearching, bool Sniff, enum PostIndexReplicas, enum PostIndexShards, enum LiveIndexingBatchSize, enum BatchSize, bool SkipTLSVerification, bool Trace; **PluginSettings**: bool Enable, bool EnableUploads, bool EnableHealthCheck, bool EnableMarketplace, bool EnableRemoteMarketplace, bool AutomaticPrepackagedPlugins, bool RequirePluginSignature; **DataRetentionSettings**: bool EnableMessageDeletion, bool MessageRetentionHours, bool AllowInsecureDownloadUrl, bool EnableFileDeletion, bool FileRetentionHours, enum DeletionJobStartTime; **MessageExportSettings**: bool EnableExport, enum ExportFormat, enum DailyRunTime, enum ExportFromTimestamp, enum BatchSize, enum GlobalRelaySettings.CustomerType; **ExperimentalAuditSettings**: bool SysLogEnabled, bool SysLogInsecure, enum SysLogMaxQueueSize, bool FileEnabled; **BleveSettings**: bool EnableIndexing, bool EnableSearching, bool EnableAutocomplete, enum BatchSize; bool FeatureFlags + **Counts (integer)** **SqlSettings**: int DataSourceReplicas, int DataSourceSearchReplicas, int ReplicaLagSettings; **ThemeSettings**: int AllowedThemes; **PluginSettings**: int SignaturePublicKeyFiles @@ -104,7 +104,7 @@ Commercial License Information (Enterprise Edition only) Advanced Access Controls Configuration Information (Enterprise Edition only) Information related to channel moderation, including number of channel schemes, number of channels with posting messages disabled for users or guests, number of channels with emoji reactions disabled for users or guests, number of channels with managing members disabled, number of channels with channel mentions disabled for users or guests. - + Channel Member Management Information (Enterprise Edition only) Information related to bulk user management and team and channel filtering, including number of users added, number of users removed, number of users promoted, number of users demoted, number of times archive and unarchive is used from any channel configuration page, and number of times channel search or team search filters are used. @@ -119,7 +119,7 @@ Permissions Configuration Information (Enterprise Edition only) Aggregated Usage Statistics Non-personally identifiable summations of basic usage statistics: Number of enabled and disabled accounts, number of user logins in the last 24 hours and the last 30 days, number of users active in the last day/month, whether APIv3 endpoints were used in the last 24 hours, number of posts, channels, teams, guest accounts, bots, and file storage. - + True Up Diagnostics Requested help from sales with license true up; attempted to download true up packet. @@ -135,9 +135,9 @@ Reporting Frequency Non-personally Identifiable Error Information, distinguished by end users and system admins Boolean when the following events occur: - + - *Sign-in Error*: Email login error, AD/LDAP login error, SAML login error - + Boolean when the following events occur, including the error message, recently dispatched Redux actions, and non-identifiable information of the device, operating system, and the app: - *Mobile App Errors*: App crashes caused by type errors, exceptions, and failed logins