splunk / splunk/splunk-sdk-python

Custom command have high CPU load / RAM usage

Offen
#687 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

  • #800 von @shivamsharma2106 — ohne Merge geschlossen
bug Custom Search Commands
Vorherrschende Sprache
Python
Sterne
743
Forks
387
Ø Merge
42 Min.
Gemergte PRs (30 T.)
4

Beschreibung

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:

Image

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?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
backend, performance
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.