在 spryker 电商平台的开发过程中，我们经常与 elasticsearch 交互进行搜索和数据检索。然而，在早期版本中，我们缺乏对 elasticsearch api 调用细节的有效监控机制。当出现搜索异常或性能问题时，定位问题根源变得异常困难，这严重影响了我们的开发效率和运维效率。 日志信息要么过于简略，要么分散在各个地方，难以整合分析。
为了解决这个问题，我们决定引入一个专门的 Elasticsearch 日志监控方案。在调研了多种方案后，我们选择了 valantic-spryker/elasticsearch-Logging 这个库。这个库专为 Spryker 设计，能够将 Spryker 的日志客户端与 Elasticsearch 集成，并将 Elasticsearch API 调用的详细信息记录到 Elasticsearch 中，方便我们进行集中监控和分析。
安装该库非常简单，只需要使用 composer：
composer require valantic-spryker/elasticsearch-logging
安装完成后，我们需要更新 Spryker 的共享配置 shared/config/config.php 文件，添加命名空间并设置日志级别为 DEBUG：
$config[KernelConstants::PROJECT_NAMESPACES] = [ 'ValanticSpryker', // ... other namespaces];$config[LogConstants::LOG_LEVEL] = Logger::DEBUG;
设置日志级别为 DEBUG 能够确保记录 Elasticsearch API 调用的所有细节。 配置完成后，重新启动 Spryker 应用。之后，所有 Elasticsearch API 调用都会以 json 格式记录到 Elasticsearch 中，包含请求 URL、请求头、请求体、响应状态码和响应体等详细信息。
日志示例如下（Glue 和 Zed 模块的日志格式略有不同）：
Glue 模块日志示例:
{"@timestamp":"2023-02-02T11:51:26.930431+00:00", ...}
Zed 模块日志示例:
{"@timestamp":"2023-02-02T11:53:13.947352+00:00", ...}
这些详细的日志信息为我们提供了丰富的上下文信息，例如请求参数、响应时间等，帮助我们快速定位问题。例如，我们可以根据响应状态码快速筛选出失败的请求，并根据请求参数分析问题原因。
通过使用 Kibana 等工具可视化 Elasticsearch 中的日志数据，我们可以创建仪表盘来监控 Elasticsearch API 的性能指标，例如请求成功率、平均响应时间、请求数量等，从而更好地了解 Elasticsearch 的运行状况，及时发现潜在问题。
总结:
valantic-spryker/elasticsearch-logging 库极大地提升了我们对 Spryker 应用中 Elasticsearch 交互的监控能力。它带来的优势主要体现在以下几个方面：
- 提升可观测性: 提供了对 Elasticsearch API 调用的全面监控，方便我们了解应用的运行状况。
- 简化问题排查: 详细的日志信息帮助我们快速定位和解决 Elasticsearch 相关的问题。
- 性能监控: 可以基于日志数据监控 Elasticsearch API 的性能指标，及时发现性能瓶颈。
- 易于集成: 与 Spryker 的集成非常简单，只需要简单的 Composer 命令和配置修改。
总而言之，valantic-spryker/elasticsearch-logging 是一个非常有用的库，强烈推荐在 Spryker 项目中使用，以提升应用的可观测性和稳定性。 如果你想更深入地学习 Composer 的使用，可以参考这个 Composer 在线学习地址：学习地址。
