splunk / splunk/contentctl

Breakup Lookup into two separate classes

Open
#220 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
139
Forks
52
Avg merge
1h 16m
Merged PRs (30d)
3

Description

  • We currently have a single Lookup model
  • In practice, we have CSV and KV lookups
  • We should break this into 2 classes, CSVLookup and KVLookup
  • Additionally, we should review the setup/structure of fields like fields_list which should be moved from a CSV string to a list[str]; note this would also involve updating the ESCU YAML to have a list of strings instead of a CSV string

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the Lookup model and its CSV and KV usage, then inspect how fields_list is represented in the ESCU YAML. Determine the boundaries for CSVLookup and KVLookup and identify all callers and configuration entries affected. Done means the two lookup classes are separated and fields_list uses a list of strings consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.