Admin Logs

From the Studio's main menu, click Manage Server.

From the debug menu, click Admin Logs.

Admin Logs view

1. Logs on this view
   Use this section to adjust how the live log stream is displayed.
   You can filter the streamed data and export it in JSON format.
2. Logs on disk
   Use this section to customize RavenDB's logging to your local storage.
   Filters can be applied here too, and you can download selected portions of your logs.
3. Log stream
   This section shows the live stream of RavenDB's logs as they are generated.
   You can search within the stream and expand individual log entries for more detail.

Use these controls to:

• Adjust monitor controls.
• Set the minimum logging level from which log entries are displayed.
• Create additional filters to select the precise data that you want to view.
• Export the displayed log data to files.

Logs on this view

1. Active filters
   A lit funnel symbol indicates that filters were created and are now active.
   See Settings below to learn what filters do and how to create and remove them.
2. Min level
   The minimum logging level from which log entries are displayed on this view.
   For example, selecting Warn (warning) will display log entries from this level and up,
   including Warn, Error, and Fatal.
3. Monitor controls
   • Pause - Pause log entries from streaming to the display.
   • Clear - Clear the displayed log entries.
   • Monitor (tail -f) - When enabled, the display automatically scrolls to the latest log entry as new ones appear.
     Clicking an entry and expanding its details automatically disables this option.
4. Export
   Export all log entries in expanded form to a JSON file.

5. Settings
   Click to create and apply filters that control which new log entries will be displayed.
   Only entries that match both the selected min level (see no. 2 above) and the filter's conditions will be displayed. Existing entries remain unaffected.

   

   Logs on this view - Settings

   • A. Default Filter Action
     Once at least one filter has been defined, a default filter can also be created.
     The default filter determines how log entries are handled when they either match no filter,
     or when all the filters they match apply a Neutral action.

   • B. Filters
     Use this section to define new filters and manage existing ones.
     Only entries that match all filter criteria will be displayed.

     • Minimum level - The filter condition will apply to log entries with this level and above.
     • Maximum level - The filter condition will apply to log entries up to this level.

     • Action - How to handle entries that match the filter rule.

       Action	Meaning
       Ignore	The log entry will Not be logged.
       IgnoreFinal	The log entry will Not be logged. Any subsequent filters with the same logging-rules as this filter will be ignored.
       Log	The log entry will be logged.
       LogFinal	The log entry will be logged. Any subsequent filters with the same logging-rules as this filter will be ignored.
       Neutral	Take no immediate action (do not Ignore matching entries nor Log them). If no subsequent filters match the entry or all matching filters are Neutral, the entries will be handled by the default filter action.

     • Condition
       Enter an expression that will be evaluated against log entries.
       Hover over the info ⓘ symbol for a few examples.
       Find more information about NLog filter conditions here.

     • Delete filter
       Click to remove this filter.

     • Add filter
       Click to add a new filter.
       Filters are evaluated successively, from the top down.

   • C. Close/Save
     Click Close to exit without applying changes,
     or Save to apply changes and exit.

Use these controls to:

• Set the minimum logging level from which log entries are stored in log files on the server disk.
• Create additional filters to select the precise data that you want to log.
• Download existing log files from the server disk by a date range of your choice.

Logs on disk

1. Active filters
   A lit funnel symbol indicates that filters were created and are now active.
   Use Settings (see below) to create, apply and remove filters.

2. Min level
   The minimum logging level from which log entries are stored in log files.
   Use Settings (see below) to set the minimum logging level.

3. Download
   Download log entries from the server in a single compressed file of plain text *.log files.
   

   • A. Select start date
     Select a date for the start of the period for which you want to download RavenDB logs.
     Alternatively, toggle Use minimum start date ON to load logs starting from the earliest log stored on your disk.
   • B. Select end date
     Select a date for the end of the period for which you want to download RavenDB logs.
     Alternatively, toggle Use maximum end date ON to load logs up to the latest log stored on your disk.
   • C. Close/Download
     Click Close to exit without downloading logs,
     or Download to retrieve logs from the selected period.

4. Settings
   Use this section to set the minimum logging level you require and to create and apply logging filters.
   Only entries that match both the selected min level (see no. 2 above) and the filter's conditions will be written to the logs. Existing entries remain unaffected.

   

   Logs on disk - Select logging target to set

   • Select the logging target you want to customize.
     Below, we go through the Logs section - RavenDB logging settings.
   

   Logs on disk - Settings

   • Current Minimum Level
     The minimum logging level from which log entries will be stored in log files.
     For example, selecting Warn (warning) will store log entries from this level and up, including Warn, Error, and Fatal.
     • Save the minimum level in settings.json
       Check this box to save the minimum log level in the settings.json file.
       If you don't save your configuration in settings.json, it will be overridden by the current configuration on the next server restart.
   • B. Default Filter Action
     Once at least one filter has been defined, a default filter can also be applied.
     The default filter determines how log entries are handled when they either match no filter,
     or when all the filters they match apply a Neutral action.

   • C. Filters
     Use this section to define new filters and manage existing ones.

     • Minimum level - The filter condition will apply to log entries with this level and above.
     • Maximum level - The filter condition will apply to log entries up to this level.
     • Action - How to handle selected log entries.

     Action	Meaning
     Ignore	The log entry will Not be logged.
     IgnoreFinal	The log entry will Not be logged. Any subsequent filters with the same logging-rules as this filter will be ignored.
     Log	The log entry will be logged.
     LogFinal	The log entry will be logged. Any subsequent filters with the same logging-rules as this filter will be ignored.
     Neutral	Take no immediate action (do not Ignore matching entries nor Log them). If no subsequent filters match the entry or all matching filters are Neutral, the entries will be handled by the default filter action.

     • Condition
       Enter an expression that will be evaluated against log entries.
       Hover over the info ⓘ symbol for a few examples.
       Find more information about NLog filter conditions here.

     • Delete filter
       Click to remove this filter.

     • Add filter
       Click to Add a new filter.
       Filters are evaluated successively, from the top down.

   • D. Save
     Apply your changes and close the settings window.

• This area displays live log entries as they are generated by the server, filtered by the Logs on this view settings. You can search and expand individual entries for more details.

  

  Log stream

  1. Search
     Only log entries containing the text you enter here will be displayed.
     Leave empty to display all entries.
  2. Expand all/Collapse all
     Toggle to expand or collapse a structured, easy to read layout of all log entries content.
  3. Display settings
     Set the maximum number of log entries displayed in this view.
     
  4. Log entry
     • Each log entry follows this pipe-separated (|) pattern:
       <Timestamp>|<Level>|<ThreadId>|<Resource>|<Component>|<Logger>|<Message>|<Data>
       All fields are always present (empty if not applicable).
       • Timestamp - UTC timestamp of the event.
       • Level - The entry's logging level.
       • ThreadId - ID of the thread that generated the log entry.
       • Resource - Affected resource, e.g., the server or the database name.
       • Component - The subsystem where the entry was generated, e.g., an index name.
       • Logger - The full class name of the originating logger.
       • Message - Event description + exception details (if any).
       • Data - Additional JSON context.
     • Click a log entry to expand or collapse its details:
       

• The structure of each log entry is defined internally by the following default layout string: "${longdate:universalTime=true}|${level:uppercase=true}|${threadid}|${event-properties:item=Resource}|${event-properties:item=Component}|${logger}|${message:withexception=true}|${event-properties:item=Data}"

• You can apply filter conditions to one or more of these fields to determine whether a log entry should be included or excluded from the logs.

• Conditions can be simple or complex. For example:

  • contains('${event-properties:item=Resource}', 'DB1') and exception != null
    Matches entries where the Resource contains DB1 and an exception is present.
  • length(message) > 200
    Matches entries where the length of the message exceeds 200 characters.
  • contains('${event-properties:item=Component}', 'MyIndex')
    Matches entries associated with index MyIndex.
  • logger == 'Voron.Impl.Journal.WriteAheadJournal'
    Matches entries from a specific logger.

• Learn more in NLog conditions.