|
1 | 1 | # Support
|
2 | 2 |
|
3 |
| -Vector is a growing open source project with a variety of people willing to help you through various mediums. |
| 3 | +Vector is a growing open source project with a variety of people willing to help |
| 4 | +you through various mediums. |
4 | 5 |
|
5 |
| -Take a look at those mediums listed at https://vector.dev/community |
| 6 | +Take a look at those mediums listed at <https://vector.dev/community> |
| 7 | + |
| 8 | +## How to ask a question about Vector |
| 9 | + |
| 10 | +Whether in our community [Discord][discord] server or [GitHub Discussions][discussions], framing |
| 11 | +your question well and providing the right level of details will improve your chances of getting |
| 12 | +your question answered. Here are some tips: |
| 13 | + |
| 14 | +### Before asking |
| 15 | + |
| 16 | +Check the [Vector documentation](https://vector.dev/docs/) first to see if it answers your question. |
| 17 | +If your question is about [VRL](https://vector.dev/docs/reference/vrl/#learn), you can also try out |
| 18 | +the [VRL playground](vrl_playground). |
| 19 | + |
| 20 | +If the docs do not answer your question, try using the search feature on [Discord][discord] or |
| 21 | +[GitHub][vector], to search for keywords related to your issue. It is quite possible someone has |
| 22 | +already asked your question before. This is especially useful if you have a specific error message |
| 23 | +you are observing. |
| 24 | + |
| 25 | +### Provide details |
| 26 | + |
| 27 | +Essential details to include: |
| 28 | + |
| 29 | +- What is the version of Vector (and the Helm chart if deploying via Helm) and |
| 30 | + the versions of any other systems in use (like Elasticsearch, NATS, etc.). |
| 31 | +- What is your Vector configuration. See the below section on [how to format |
| 32 | + your config](#formatting). |
| 33 | +- How are you [deploying](https://vector.dev/docs/setup/deployment/) Vector? |
| 34 | +- What is your complete deployment architecture? For example: I have Logstash |
| 35 | + agents sending to Vector over syslog that is being forwarded to Loki. |
| 36 | + |
| 37 | +Situation specific (not exhaustive): |
| 38 | + |
| 39 | +- Did it occur after upgrading to a new version of Vector? |
| 40 | +- Are you trying out Vector for the first time, or did you have a previous |
| 41 | + working configuration? |
| 42 | + |
| 43 | +These are just some examples of questions that may or may not apply to your |
| 44 | +situation. |
| 45 | + |
| 46 | +### Formatting |
| 47 | + |
| 48 | +When providing snippets of configuration files, or log messages, format these with backticks to |
| 49 | +improve the legibility for readers. |
| 50 | + |
| 51 | +#### Blocks |
| 52 | + |
| 53 | +Blocks should be formatted with three backticks (\`\`\`) |
| 54 | + |
| 55 | +This should be used for any configuration snippets of Vector, Helm values, etc. |
| 56 | +and for Vector console log messages. |
| 57 | + |
| 58 | +See the [markdown documentation](https://www.markdownguide.org/basic-syntax/#fenced-code-blocks) |
| 59 | +for an explanation. |
| 60 | + |
| 61 | +For example: |
| 62 | + |
| 63 | +[sinks.sink0] |
| 64 | + |
| 65 | +inputs = ["source0"] |
| 66 | + |
| 67 | +target = "stdout" |
| 68 | + |
| 69 | +type = "console" |
| 70 | + |
| 71 | +should be written as |
| 72 | + |
| 73 | +```toml |
| 74 | +[sinks.sink0] |
| 75 | +inputs = ["source0"] |
| 76 | +target = "stdout" |
| 77 | +type = "console" |
| 78 | +``` |
| 79 | + |
| 80 | +#### Single word or phrase |
| 81 | + |
| 82 | +Formatting things like component names, versions etc. is done with single |
| 83 | +backticks (\`) around the word or phrase. |
| 84 | + |
| 85 | +This is less critical but also helps readability a lot and is greatly |
| 86 | +appreciated. |
| 87 | + |
| 88 | +See the [markdown documentation](https://www.markdownguide.org/basic-syntax/#code) |
| 89 | +for an explanation. |
| 90 | + |
| 91 | +For example: |
| 92 | + |
| 93 | +> We upgraded from v24 to 25.1 and are seeing the following error output from |
| 94 | +kafka. |
| 95 | + |
| 96 | +should be written as |
| 97 | + |
| 98 | +> We upgraded from `v0.24.0` to `v0.25.1` and are seeing the following error |
| 99 | +output from the `kafka` sink. |
| 100 | + |
| 101 | +[discord]: https://chat.vector.dev |
| 102 | +[discussions]: https://github.com/vectordotdev/vector/discussions |
| 103 | +[vector]: https://github.com/vectordotdev/vector |
| 104 | +[vrl_playground]: https://playground.vrl.dev |
0 commit comments