Skip to content

checkpoint: avoid data loss from loguid collisions - #6483

Merged
efd6 merged 1 commit into
elastic:mainfrom
efd6:6355-checkpoint
Jun 7, 2023
Merged

checkpoint: avoid data loss from loguid collisions#6483
efd6 merged 1 commit into
elastic:mainfrom
efd6:6355-checkpoint

Conversation

@efd6

@efd6 efd6 commented Jun 6, 2023

Copy link
Copy Markdown
Contributor

What does this PR do?

Because Checkpoint reuse loguids, it is possible for two logged events to be given the same fingerprint. So use the segment_time as well in the fingerprint args. Also document that if collisions are important, the user should enable semi-unified logging on the device's dashboard.

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

Because Checkpoint reuse loguids, it is possible for two logged events
to be given the same fingerprint. So use the segment_time as well in
the fingerprint args. Also document that if collisions are important,
the user should enable semi-unified logging on the device's dashboard.
@efd6
efd6 force-pushed the 6355-checkpoint branch from 357407a to 4fe4b88 Compare June 6, 2023 03:53
@elasticmachine

elasticmachine commented Jun 6, 2023

Copy link
Copy Markdown

💚 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: 2023-06-06T03:53:46.452+0000

  • Duration: 15 min 0 sec

Test stats 🧪

Test Results
Failed 0
Passed 16
Skipped 0
Total 16

🤖 GitHub comments

Expand to view the GitHub comments

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

  • /test : Re-trigger the build.

@elasticmachine

Copy link
Copy Markdown

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (1/1) 💚
Files 100.0% (1/1) 💚 1.266
Classes 100.0% (1/1) 💚 1.266
Methods 100.0% (17/17) 💚 5.582
Lines 86.969% (901/1036) 👎 -6.594
Conditionals 100.0% (0/0) 💚
@efd6
efd6 marked this pull request as ready for review June 6, 2023 04:26
@efd6
efd6 requested a review from a team as a code owner June 6, 2023 04:26
@elasticmachine

Copy link
Copy Markdown

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

@kcreddy kcreddy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Minor clarification. LGTM 👍🏼

Comment on lines +42 to +43
In some instances firewall events may have the same Checkpoint `loguid` and arrive during the same timestamp resulting in a fingerprint collision. To avoid this [enable semi-unified logging](https://sc1.checkpoint.com/documents/R81/WebAdminGuides/EN/CP_R81_LoggingAndMonitoring_AdminGuide/Topics-LMG/Log-Exporter-Appendix.htm?TocPath=Log%20Exporter%7C_____9) in the Checkpoint dashboard.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Does it make sense to add this bit to Troubleshooting section instead? or does it look good here?
https://github.com/elastic/integrations/blob/main/docs/documentation_guidelines.md#troubleshooting

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The intention is that this be considered at set-up so that users don't need to get to the stage of trouble-shooting.

@efd6
efd6 merged commit c9d9974 into elastic:main Jun 7, 2023
@elasticmachine

Copy link
Copy Markdown

Package checkpoint - 1.22.0 containing this change is available at https://epr.elastic.co/search?package=checkpoint

sodhikirti07 pushed a commit that referenced this pull request Jun 15, 2023
Because Checkpoint reuse loguids, it is possible for two logged events
to be given the same fingerprint. So use the segment_time as well in
the fingerprint args. Also document that if collisions are important,
the user should enable semi-unified logging on the device's dashboard.
@efd6
efd6 deleted the 6355-checkpoint branch February 5, 2025 22:05
orestisfl pushed a commit to orestisfl/integrations that referenced this pull request May 15, 2026
Because Checkpoint reuse loguids, it is possible for two logged events
to be given the same fingerprint. So use the segment_time as well in
the fingerprint args. Also document that if collisions are important,
the user should enable semi-unified logging on the device's dashboard.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request Integration:checkpoint Check Point

3 participants