ocsf / ocsf-schema

OCSF Schema
Apache License 2.0
625 stars 132 forks source link

Allow 'observables' in attributes #964

Open query-jeremy opened 8 months ago

query-jeremy commented 8 months ago

Background

While discussing #960 today, it was raised that altering the type of attributes from string_t or int_t to more specific types like user_agent_t is a breaking change.

We could wait until the 2.x line to introduce this, or we could break with semver and accept a breaking change in 1.x. But neither of these are desirable.

Proposal

An alternative solution is to add the observable property to attributes. Currently, only types and objects support the observable property.

This could be defined in any event, object, or dictionary.

Example:

{
  "attributes": {
    "user_agent": {
      "observable": 19,
      ...
    },
    ...
}

Upside

Downside

pagbabian-splunk commented 8 months ago

Thanks Jeremy, late comment but we are going down this path that you suggest.

query-jeremy commented 8 months ago

Should we delete this issue? I wrote it to capture the outcome of our discussion about #960, but it may now be redundant to #960...

rmouritzen-splunk commented 8 months ago

I'll sort it out as I dig in. I might just close both when this is resolve.

rmouritzen-splunk commented 6 months ago

@query-jeremy : This will work now and be properly validated.