如何在 Elasticsearch 论坛/社群上提出高质量的技术问题？

铭毅天下

发布于 2023-08-18 21:17:09

1820

发布于 2023-08-18 21:17:09

文章被收录于专栏：铭毅天下铭毅天下

在网络的海洋中寻求帮助，有时可能会让你感到茫然。你可能已经准备好详细描述你的问题，但如果你不知道如何有效地提问，你可能会发现自己在等待回答时感到挫败。

这篇文章的目标是为你提供一些提示，让你更快地获取你在论坛上的技术问题的帮助。

确切的说，如下内容来自 Elastic 官方社区，链接如下：

https://discuss.elastic.co/t/dec-10th-2022-en-asking-top-notch-technical-questions-to-get-you-help-quicker/320300

我针对链接文章做了解读和扩展，目的只有一个——当我们遇到 Elasticsearch 技术问题后，如何高质量的提问，才能得到高质量的解答？

1、如何进行高质量 Elasticsearch 相关问题提问？

当你在论坛上寻求技术帮助时，你提供的信息越多，Elastic 官方社区小伙伴就越可能为你提供帮助。

以下是一些你需要了解的重要事项：

1、遵守行为规范

论坛上的所有行为都需要遵守我们的行为规范。我们致力于创建一个友好的环境，并将对违反行为规范的行为采取适当的行动。

2、正确分类

根据你所使用的 ElasticStack 技术栈（Elasticsearch、Kibana、Logstash、Beats等）选择最合适的类别。

例如，不要在 Elasticsearch 类别下提出 Beats 的问题，也不要在 Elastic Security 类别下提出 TLS 配置的问题。

3、提供上下文

告诉我们你试图实现什么，以及为什么。这将帮助我们更好地理解你的需求，而不仅仅是 "我需要修复 XXXXX"。

4、格式化你的代码或日志

使用 markdown 样式的反引号格式化你的代码、日志或配置。这将使内容更易于阅读和复制。

举例如下：

5、使用外部工具

如果你的帖子因为字符或词数限制而无法完全展示日志、配置或代码，你可以使用 gist/pastebin 等工具，或者在原主题下创建新帖子。

6、保持耐心 Elastic 社区和 Elastic技术爱好者努力帮助每个有问题的人，但请不要期待一定会有人回复你。

我们在这里并不提供服务级别协议（SLA），所以请保持耐心等待回复。

2、提问的时候，要避免下面问题！

1、不要发布文本、日志或代码的图片

这些图片往往难以阅读，无法搜索，也无法复制以尝试复现问题。

2、不要只在标题中提问

不要在主题标题中提问，然后只在正文中放日志或配置。这样做不会提供你正在询问什么的任何上下文，只会让问题变得模糊。

3、不要随意标记人

不要标记那些并未参与你的主题的人。

通俗点说，不要@没有参与你问题的人。

4、不要假设别人会立即理解你的问题

如果有人提出了很多问题，那是因为他们正在寻求弄清问题的来龙去脉，以便帮助你，而不是为了拖延你。

3、如下内容能辅助问题问的更详细、清楚

并非每一项都会相关，但请记住，你提供的信息越多，我们就越容易看到问题所在，以及你正在做什么，重要的是，你使用 ElasticStack 技术栈做了什么。

1、通过如下指令获取输出可以让我们看到你的集群的详情。

 _cluster/stats?pretty&human API

2、发布你的 Elasticsearch 日志，通常来自如下指令。

 /var/log/elasticsearch/elasticsearch.log

尽量发布所有内容，因为即使你没有发现问题，也可能有一些提示。

3、贴出你的 elasticsearch.yml，如果你对它做了非标准的修改，必要时贴出 jvm.options 文件。

4、Elasticsearch 相关问题提示

如果你在对 Elasticsearch 的 API 进行请求/查询或编码时遇到问题，那么需要你分享：

你发送给 Elasticsearch 的完整请求。
来自 Elasticsearch 的完整响应。
与问题相关的代码或代码段。

5、Kibana相关问题求助提示

发布你的 kibana.yml。
发布你的 /var/log/kibana/kibana.log，尽可能多的内容会对我们有所帮助。
如果你在 UI 元素上遇到问题（确切的说，Kibana 功能使用遇到问题），截图会很有帮助。

6、Beats 相关问题求助提示

你的 Beat 的 yml 配置文件，包括你可能做过的任何模块特定的更改。
日志，通常来自 /var/log//.log。

7、Logstash相关问题求助提示

你的核心 /etc/logstash/logstash.conf 文件和任何来自 conf.d 目录的相关文件。
你的日志，通常来自 /var/logstash/logstash.conf。

如上，就是全部内容！

最重要的一点要记住，没有愚蠢的问题，只有未提出的问题。我们都在这里提问，也在尽我们所能互相帮助。

希望这些提示能帮助你更有效地提问，从而更快地得到你需要的答案。

记住，我们（Elastic官方）都是在尽我们所能互相学习和帮助，你的问题可能也会帮助别人解决他们的问题。所以，无论你的问题是什么，都不要害怕提出来。

8、Chatgpt 4 提问注意事项

注意：用 gpt4，不要使用3.5，因为gpt4回答问题的正确率有极大的提升（说通过了图灵测试一点都不夸张）。

如果你想借助ChatGPT更好地询问Elasticsearch相关的问题，以下是一些建议：

明确你的问题。

尽可能清楚地描述你的问题或需求。例如，如果你遇到了一个具体的错误，不仅要提供错误消息，还要提供你在遇到问题时的具体操作步骤和环境配置。

提供足够的背景信息

描述你正在使用Elasticsearch的具体情境，例如你正在使用哪个版本的Elasticsearch，你的数据量大小，你的硬件环境等等。这些信息都可以帮助AI更好地理解你的问题。

明确你的需求

如果你在寻找特定的功能或者想要实现某种操作，清楚地描述你的需求会有所帮助。

例如，你可能想要了解如何优化Elasticsearch的性能，或者如何配置分片和副本，或者如何使用某种查询语法等等。

使用正确的术语

尽可能使用Elasticsearch的专有术语，例如"索引"、"映射"、"分片"、"副本"、"集群"等。

解决技术问题

如果你在使用Elasticsearch时遇到了技术问题，最好能够提供尽可能详细的错误描述、错误日志、或者你已经尝试过的解决方法。这些信息可以帮助AI更准确地定位问题。

尝试使用 gpt browser 功能回答 2021年9月份之后的新问题。

如下两个图的对比可见一斑。

记住，ChatGPT是一个强大的工具，但它不是万能的。

对于一些非常特殊的、复杂的、或者最新的 Elasticsearch 问题，它可能无法提供一个准确的答案。

在这种情况下，你可能需要向Elasticsearch的官方文档或者相关的技术社区寻求帮助。

9、Chatgpt4 Elasticsearch 技术问题提问模版

标题：Elasticsearch 8.7 在使用 Java API 进行批量索引操作时遇到性能问题

我正在使用 Elasticsearch 8.7 和 Java 11 进行开发，我使用的是 Spring Boot 框架。我正在尝试批量索引大量文档（大约 1 百万文档），但我遇到了性能问题，批量索引操作需要的时间过长。

我使用的是 BulkRequest 进行批量操作，如下所示：

codeBulkRequest request = new BulkRequest();
documents.forEach(document -> {
    request.add(new IndexRequest("my_index").source(convertDocumentToMap(document)));
});
BulkResponse bulkResponse = client.bulk(request, RequestOptions.DEFAULT);

错误信息为：

没有具体的错误信息，但批量索引操作需要大约 10 分钟才能完成。

我尝试了调整 Elasticsearch 的 JVM 堆大小，但这并没有明显改善。我还尝试了减少批量请求的大小，但这似乎也没有太大效果。

我应该如何改善我的批量索引操作的性能？有没有关于 Elasticsearch 批量索引的最佳实践？

10、小结

好的提问问题如下表所示：

标题	描述
描述你的环境	你正在使用的 Elasticsearch 版本、操作系统、使用的语言或框架（例如 Java, Python, Spring Boot 等）。
描述你的问题	你正在尝试做什么？你希望实现什么目标或功能？你遇到了什么问题？
提供错误信息	如果你遇到了错误，提供完整的错误信息（包括错误堆栈）。
提供你的尝试	你已经尝试过什么？你在哪个步骤中遇到了问题？你尝试解决问题的方法是什么？
提供代码和配置	如果可能的话，提供一些相关的代码段和配置。不需要提供整个项目的代码，只需要提供出问题的部分。同时，不要忘记移除任何敏感信息。
提问清晰	问题应当清晰、简洁。尽量使用清楚明了的语言描述你的问题。