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

Allow 'observables' in attributes #964

Closed
query-jeremy opened this issue Feb 13, 2024 · 4 comments
Closed

Allow 'observables' in attributes #964

query-jeremy opened this issue Feb 13, 2024 · 4 comments
Assignees

Comments

@query-jeremy
Copy link
Contributor

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

  • As this is an additive change, it is non-breaking and does not require a major semver bump. Consumers and producers that don't support it will continue to operate as before.
  • This provides a (slightly) more flexible way to define observables.

Downside

  • This would need to be implemented in the OCSF server.
  • It (slightly) increases effort involved in troubleshooting observables.
  • All validators will need to be updated.
  • Platform implementations of observables may need to be updated.
@rmouritzen-splunk rmouritzen-splunk self-assigned this Feb 20, 2024
@pagbabian-splunk
Copy link
Contributor

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

@query-jeremy
Copy link
Contributor Author

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
Copy link
Contributor

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

@rmouritzen-splunk
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants