splunk / splunk/splunk-sdk-python
Custom command have high CPU load / RAM usage
まだ誰も着手していません。
- #800 @shivamsharma2106 による — マージされずにクローズ
- 主要言語
- Python
- スター
- 743
- フォーク
- 387
- 平均マージ
- 42分
- マージ済み PR(30日)
- 4
説明
Describe the bug
I'm tagging this as a bug, but it's mainly a topic for discussion.
We have several custom commands in our environment and we've noticed a few issues:
- Significant CPU and RAM usage
- Preview mode not working
After profiling, we've noticed that our command takes only a few seconds to execute, but the Splunk search takes 5-10 minutes (on average) to complete.
We have observed that this occurs mainly on an SH cluster, and not on a standalone system (but to be confirmed).
To Reproduce
A little complicated to reproduce, but if you have a custom command that processes more than 150,000 Python objects (see 1 million for the test), you may encounter this problem, mainly on SH Cluster
Expected behavior
Fast search time, with or without Preview, affordable CPU/RAM consumption
Logs or Screenshots
For example, our custom command processed 75k events, our command took 3 seconds (calculated before and after the yield), but Splunk measured a Python script execution time of 460 seconds:
Splunk (please complete the following information):
- Version: 9.3.1
- OS: RedHat 9
- Deployment: Search Head Cluster
SDK (please complete the following information):
- Version: 2.1.1
- Language Runtime Version: 3.9
- OS: RedHat 9
Additional context
Our question is, why the Splunk-SDK do a list(records) instead of send data by batch to the output?
https://github.com/splunk/splunk-sdk-python/blob/develop/splunklib/searchcommands/internals.py#L554
We believe that this is the source of the problem. Instead of sending the data in batches to the standard output for Splunkd, Python loads all processed objects into memory, so the yield is no longer relevant from our custom command.
Seeing this, it now seems logical to us that preview mode does not work with custom commands and use lot of memory.
What do you think?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Start at splunklib/searchcommands/internals.py around line 554, where the issue reports list(records) is used. Reproduce with a custom command processing more than 150,000 objects, including the one-million-object test, and compare preview, resource usage, and search duration on standalone and search-head-cluster deployments. Done means identifying whether materializing records causes the reported behavior and documenting the required change or resolution.
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- backend, performance
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 30/100