splunk / splunk/splunk-sdk-python

Custom command have high CPU load / RAM usage

Abierto
#687 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

  • #800 de @shivamsharma2106 — cerrado sin fusionar
bug Custom Search Commands
Lenguaje dominante
Python
Estrellas
743
Forks
387
Merge medio
42 min
PR fusionados (30 d)
4

Descripción

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?

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
backend, performance
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.