hound-search/hound

How to track usage of Hound

Open

#295 建立於 2018年9月26日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)JavaScript (5,470 star) (606 fork)batch import
enhancementhelp wanted

描述

What are some ways we could monitor Hound, both usage and specific searches? Is there any systems either built in or that can be added as extensions?

We are running Hound on the intranet but we have no visibility of how it's being used and how much usage it gets.

Currently hound is being installed through a puppet pipeline.

Preliminary ideas:

  1. Add a proxy forwarding endpoint in front of hound to record the "hits" and send it to some DB store. That wouldn't track low level usage of hound (i.e. search queries), just the hits.

  2. Somehow enable server logs and parse through the logs? I'm not sure how much info I would get from the logs and the parsing might get involved. Then send this info to some DB store.

貢獻者指南

技術棧
nodejs
領域
observabilityanalytics
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Node.js basicsUnderstanding of Hound's architecture
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
Investigate Hound's current codebase for any existing logging or metrics hooks. Look at how searches are handled in the server code (likely in the main server file). Consider adding middleware or instrumentation to count requests and log search queries. Evaluate using a library like prom client for Prometheus metrics, or implementing a simple logging endpoint.