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

cef: improve documentation and testing #3465

Merged
merged 3 commits into from
Jun 15, 2022
Merged

cef: improve documentation and testing #3465

merged 3 commits into from
Jun 15, 2022

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Jun 3, 2022

What does this PR do?

This adds field descriptions to a number of ostensibly undocumented fields and adds other fields that were undocumented (some leaving out descriptions where they were not available).

It also adds pipeline and system tests for a variety of inputs that were not previously tested.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

How to test this PR locally

Related issues

Screenshots

@efd6 efd6 added documentation Improvements or additions to documentation enhancement New feature or request Team:Security-External Integrations Integration:cef Common Event Format (CEF) labels Jun 3, 2022
@efd6 efd6 self-assigned this Jun 3, 2022
@efd6 efd6 force-pushed the arcsight_cef branch 2 times, most recently from e67a37d to 3b35fe9 Compare June 3, 2022 01:57
@elasticmachine
Copy link

elasticmachine commented Jun 3, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-06-06T22:22:50.567+0000

  • Duration: 16 min 22 sec

Test stats 🧪

Test Results
Failed 0
Passed 89
Skipped 0
Total 89

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link

elasticmachine commented Jun 3, 2022

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (1/1) 💚
Files 100.0% (3/3) 💚 3.432
Classes 100.0% (3/3) 💚 3.432
Methods 95.0% (19/20) 👍 5.916
Lines 89.474% (408/456) 👎 -0.284
Conditionals 100.0% (0/0) 💚

@efd6 efd6 marked this pull request as ready for review June 3, 2022 02:38
@efd6 efd6 requested a review from a team as a code owner June 3, 2022 02:38
@elasticmachine
Copy link

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

efd6 added 3 commits June 7, 2022 07:52
The new inputs here were obtained from the golden files for the cef parser with
some modification:

- IP addresses were made to conform to the elastic-package requirements
- invalid inputs were either edited or the events were removed
The new inputs here were obtained from the input files for the cef parser with
some modification:

- invalid inputs were either edited or the events were removed
description: Identifies the Layer-4 protocol used. The possible values are protocols such as TCP or UDP.
- name: ad
type: flattened
- name: TrendMicroDsDetectionConfidence
Copy link
Member

@andrewkroh andrewkroh Jun 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My assumption is that these TrendMicro* keyword fields are added to make the tests pass. They don't add much value otherwise. If we had a way to ignore allow the tests to pass without defining these then I would say we should use it here. They would still get mapped as keyword dynamically, but they would not grow size of the template or mapping for the users that are not ingesting Trend Micro logs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes this is exactly why they were added. Is there a way to ignore these?

@efd6 efd6 merged commit d876637 into elastic:main Jun 15, 2022
@efd6 efd6 deleted the arcsight_cef branch June 15, 2022 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request Integration:cef Common Event Format (CEF)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants