Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kit Resources: document expected fields in shipped resources that cannot automatically resolve #199

Open
kris-watts-gravwell opened this issue Jun 27, 2024 · 0 comments
Labels
03 - Low low priority 05 - feature new feature that does not currently exist 14 - customer request change requested by customer

Comments

@kris-watts-gravwell
Copy link
Contributor

What is the feature to be added?

Add documentation into kits that ship resources when the resource cannot "auto resolve" field names. For example, the maxmind DB formats that we ship in the network enrichment kit cannot automatically resolve fields because it is not a pure column store, each IP walks a B-tree and grabs an object with arbitrary key/value pairs associated with that leave node. This type of DB structure cannot actually be auto hinted or dumped with the dump module.

So we need to call out the field names that we know exist in each db (like the ASN, country, city, etc...)

Why should we add this feature? (Business justification? What problem is the feature trying to solve?)

It is unclear exactly what is available in our two DBs, so call them out explicitly in the description or playbook.

How does this feature address the above problem?

Lets users know in a concrete way what exists in these network enrichment DBs.

Any other comments?

I think this could be documented in the resource description AND network enrichment playbook (as a nice markdown table).

@kris-watts-gravwell kris-watts-gravwell added 05 - feature new feature that does not currently exist 14 - customer request change requested by customer 03 - Low low priority labels Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
03 - Low low priority 05 - feature new feature that does not currently exist 14 - customer request change requested by customer
Projects
None yet
Development

No branches or pull requests

1 participant