File an Issue

If you've tried to troubleshoot an issue yourself, have reached out for help, and are still stumped, you can file an issue in GitHub.

Guidance

Before filing an issue:

• Read the details of the relevant documentation. For example, it's important to understand the function of all flags when starting nodes.
• Review our troubleshooting documentation.
• Check our open issues for existing tickets related to your problem. Specifically, the known limitation, UX surprise and SQL semantics flags. If you've encountered one of these issues, please leave a comment about your use case.
• Use our support resources, including:
  • StackOverflow
  • CockroachDB Community Forum
  • Gitter

Filing an Issue

To file an issue in GitHub, we need the following information:

1. A summary of the issue.

2. The steps to reproduce the issue.

3. The result you expected.

4. The result that actually occurred.

5. The first few lines of the log file from each node in the cluster in a timeframe as close as possible to reproducing the issue. On most Unix-based systems running with defaults, you can get this information using the following command:

   $ grep -F '[config]' cockroach-data/logs/cockroach.log
   

   {{site.data.alerts.callout_info}}You might need to replace cockroach-data/logs with the location of your logs.{{site.data.alerts.end}} If the logs are not available, please include the output of cockroach version for each node in the cluster.

Template

You can use this as a template for filing an issue in GitHub:

## Summary



## Steps to reproduce

1. 
2.
3.

## Expected Result



## Actual Result



## Log files/version

### Node 1



### Node 2



### Node 3