Collecting Information on Incidents for Support

• Description:

  • Provide a detailed description of the incident you are experiencing.
  • Include any error messages, warnings, or unexpected behavior you have encountered.

• Exceptions:

  • If applicable, attach the full-stack exception including the error message as plain text.
  • Specify the origin of the exception
    (e.g. from RavenDB Studio, from the client, from server logs, etc.).

• Versions:

  • Specify the RavenDB Server, Studio, and the client versions that you are using.

If the issue you encounter is still ongoing,
then enable the following logs (if not enabled yet) before downloading existing log files:

Enable logs

1. Navigate to Manage Server > Admin Logs and click 'Settings'.

2. Server logs - Log Mode:

   • Set the RavenDB server logs level to 'Information'.

3. Traffic Watch log:

   • Click 'Configure' to enable Traffic Watch logging to the server logs.
   • Keep the default values shown in the popup dialog.

4. Microsoft logs:

   • This is an advanced option, set it only if requested by the support team.
   • Click 'Configure' to enable the logging of Microsoft logs to the server logs.
   • Use the following suggested log configuration:

   {
      "Microsoft.AspNetCore":"Debug"
      // Available levels: Trace, Debug, Information, Warning, Error, Critical, None 
   }

Perform the following for each node in your cluster:

Download logs

• If the incident is over and you can reproduce it, then first verify logging level is set to 'Information'.

• See how to enable the logs in Enable logs.

• If possible, it is advised to create a unit test that showcases the failure in your client code.

• Refer to Writing your unit test to learn how to use RavenDB's TestDriver.