A guide on debugging and troubleshooting Vector
type: guidedomain: operations

This guide covers troubleshooting Vector. The sections are intended to be followed in order.

First, we're sorry to hear that you are having trouble with Vector. Reliability and operator friendliness are very important to us, and we urge you to open an issue to let us know what's going on. This helps us improve Vector.

1. Check for any known issues

Start by searching Vector's issues. You can filter to the specific component via the lable filter.

2. Check Vector's logs

We've taken great care to ensure Vector's logs are high-quality and helpful. In most cases the logs will surface the issue:

If you are not using a service manager, and you're redirecting Vector's output to a file then you can use a utility like tail to access your logs:

tail /var/log/vector.log

3. Enable backtraces

If you see an exception in Vector's logs then we've clearly found the issue. Before you report a bug, please enable backtraces:

RUST_BACKTRACE=full vector --config=/etc/vector/vector.toml

Backtraces are critical for debugging errors. Once you have the backtrace please open a bug report issue.

4. Enable debug logging

If you do not see an error in your Vector logs, and the Vector logs appear to be frozen, then you'll want to drop your log level to debug:

LOG=debug vector --config=/etc/vector/vector.toml

5. Get help

At this point we recommend reaching out to the community for help.

  1. If encountered a bug, please file a bug report
  2. If encountered a missing feature, please file a feature request.
  3. If you need help, join our chat community. You can post a question and search previous questions.