Server Configuration
Many Seq options can be configured through the Settings section of the web user interface. Lower-level settings, especially those that control the HTTP endpoint, or require a restart to be applied, are stored in the Seq.json configuration file, and manipulated using the seq config
command-line.
The seq config
command-line
seq config
command-lineFrom an administrative command prompt on the Seq server, running seq config
will list the available settings and their values:
seq config
Setting values can be changed by specifying the setting name and value:
seq config -k api.listenUris -v https://example.com,https://example.com:45341
seq config -k cache.systemRamTarget -v 0.8
seq config -k storage.prefferedEngine --clear
seq restart
Settings that accept multiple values can be specified by listing values separated by a comma ,
.
Values can be reset to their defaults by specifying --clear
and the setting name.
Seq reads settings Seq.json at startup, so the Seq service must be restarted before changes will take effect.
Settings
api.avoidLdap
api.avoidLdap
If True
, the Windows local security authority will be used instead of LDAP in some features (experimental).
api.canonicalUri
api.canonicalUri
The address that the server can be accessed on externally.
api.corsAllowedOrigins
api.corsAllowedOrigins
Origins from which the full API will be accessible using CORS.
In Seq versions before 5.0 this was not necessary for ingestion - events could always be sent to the ingestion endpoint using CORS. Version 5.0 currently requires all origins to be listed, but this may change in 5.1.
api.frameAllowFrom
api.frameAllowFrom
Origins that may embed the Seq UI within an <iframe>
.
api.hardSessionExpirySeconds
api.hardSessionExpirySeconds
If non-null, this will override the various session expiry timeouts used by the different authentication providers.
api.hstsIncludeSubDomains
api.hstsIncludeSubDomains
The includeSubdomains
field set in the HSTS header, if enabled.
api.hstsMaxAge
api.hstsMaxAge
The max-age
specified in the HSTS header, if enabled.
api.ingestionPort
api.ingestionPort
If present, only event ingestion will be allowed on the specified port. Note that a corresponding entry must exist in api.listenUris
.
Make sure that an entry for the port including the protocol and hostname to listen on is present in
api.listenUris
in addition to theingestionPort
setting.
api.integratedAuthenticationScheme
api.integratedAuthenticationScheme
The authentication scheme used for Windows authentication. IntegratedWindowsAuthentication
(the default) and Negotiate
are supported.
api.listenUris
api.listenUris
The addresses that the server will listen on. The first entry listed will be used as the default when generating URIs for apps and notifications.
api.redirectHttpToHttps
api.redirectHttpToHttps
Whether to redirect HTTP requests to the first HTTPS endpoint listed in api.listenUris
. If set to True
, the HSTS header will also be set.
cache.compactLargeObjectHeap
cache.compactLargeObjectHeap
Periodically compact the .NET large object heap to reduce fragmentation. May result in short service availability pauses (experimental).
cache.systemRamTarget
cache.systemRamTarget
Seq uses RAM heavily to speed up query processing. On shared machines (or local developer workstations) it may be desirable to limit this behavior. Specifying a smaller fractional value here (e.g. 0.5
) will cause Seq to release memory once system memory usage surpasses the threshold (e.g. 50%).
diagnostics.internalLoggingLevel
diagnostics.internalLoggingLevel
Seq's own internal logging level. Modifying this value may cause significantly higher I/O load and is not recommended.
diagnostics.internalLogPath
diagnostics.internalLogPath
The location for Seq's own internal log files.
diagnostics.internalLogServerUrl
diagnostics.internalLogServerUrl
Send Seq's internal logs to another Seq server.
diagnostics.telemetryServerUrl
diagnostics.telemetryServerUrl
Send Seq's error telemetry (if enabled) to another Seq server.
storage.lmdb.extentMapSize
(deprecated)
storage.lmdb.extentMapSize
(deprecated)The maximum size, in bytes, of the memory map used for each LMDB storage extent. LMDB storage is deprecated; see storage.preferredEngine
.
storage.masterKey
storage.masterKey
The master encryption key used to protect sensitive values in the Seq document store. This is the master encryption key used when creating backups.
Windows: this value is itself encrypted and must be retrieved using the seq show-key
command for secure backup.
Linux/macOS: this value is stored unencrypted in Seq.json
; use storage.masterKeyEnvironmentVariableName
for secure key management.
On Windows, this value cannot be manipulated directly as DPAPI is used to protect the value stored in Seq.json. Use the
seq.exe show-key
command to retrieve the cleartext key for backup purposes.
storage.masterKeyEnvironmentVariableName
storage.masterKeyEnvironmentVariableName
The name of an environment variable from which Seq will read the master encryption key (256-bit base-64 encoded). storage.masterKey
is ignored if this setting is provided.
storage.preferredEngine
(deprecated)
storage.preferredEngine
(deprecated)The preferred storage engine for new extents. Provided for legacy compatibility; installations should leave this value unset, or use the default value FLARE
.
Seq.json Example
Seq stores configuration in Seq.json under the storage root path.
An example Seq.json file is shown below.
{
"cache": {
"systemRamTarget": 0.9,
"compactLargeObjectHeap": false
},
"diagnostics": {
"internalLogPath": null,
"internalLoggingLevel": "Verbose",
"internalLogServerUrl": null,
"telemetryServerUrl": null
},
"api": {
"listenUris": [
"https://seq.example.com",
"https://seq.example.com:45341"
],
"ingestionPort": 45341,
"corsAllowedOrigins": [],
"frameAllowFrom": [],
"integratedAuthenticationScheme": null,
"redirectHttpToHttps": false,
"avoidLdap": false
},
"storage": {
"masterKey": "pmk.ubqX+TAzV06KRxpQML3zAw==",
"preferredEngine": null,
"lmdb": {
"extentMapSize": 200000000000
}
}
}
Updated almost 6 years ago