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

Export missing records to ES #10697

Merged
merged 2 commits into from
Oct 14, 2022
Merged

Conversation

lzgabel
Copy link
Contributor

@lzgabel lzgabel commented Oct 13, 2022

Description

Currently, the Zeebe Elasticsearch exporter doesn't allow to export all records. The following records are missing:

  • timer
  • message_start_event_subscription
  • process_event
  • deployment_distribution

Related issues

closes #8337

Definition of Done

Code changes:

  • The changes are backwards compatibility with previous versions
  • If it fixes a bug then PRs are created to backport the fix to the last two minor versions. You can trigger a backport by assigning labels (e.g. backport stable/1.3) to the PR, in case that fails you need to create backports manually.

Testing:

  • There are unit/integration tests that verify all acceptance criterias of the issue
  • New tests are written to ensure backwards compatibility with further versions
  • The behavior is tested manually
  • The change has been verified by a QA run
  • The impact of the changes is verified by a benchmark

Documentation:

  • The documentation is updated (e.g. BPMN reference, configuration, examples, get-started guides, etc.)
  • New content is added to the release announcement
  • If the PR changes how BPMN processes are validated (e.g. support new BPMN element) then the Camunda modeling team should be informed to adjust the BPMN linting.

Please refer to our review guidelines.

@lzgabel
Copy link
Contributor Author

lzgabel commented Oct 13, 2022

Hi @remcowesterhoud. Please take a moment to check this out. 🙇

@github-actions
Copy link
Contributor

github-actions bot commented Oct 13, 2022

Test Results

   939 files  ±  0     939 suites  ±0   1h 44m 56s ⏱️ +9s
7 495 tests +96  7 488 ✔️ +95  7 💤 +1  0 ±0 
7 685 runs  +96  7 676 ✔️ +95  9 💤 +1  0 ±0 

Results for commit fef28f6. ± Comparison against base commit 7c7a652.

♻️ This comment has been updated with latest results.

@remcowesterhoud
Copy link
Contributor

remcowesterhoud commented Oct 13, 2022

@saig0 We had an issue before to export these records by default. We never got around to doing it for these records since they were more work than flipping a boolean. Do we still want to export these by default?

@saig0
Copy link
Member

saig0 commented Oct 13, 2022

@remcowesterhoud good point. 👍

Yes, let's export these records by default. 🚀 Except, the process_event records. Reasoning:

  • we write a lot of process_event records, at least one for each completed job
  • I'm not sure how useful these records are for analyzing

Copy link
Contributor

@remcowesterhoud remcowesterhoud left a comment

Choose a reason for hiding this comment

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

Thanks for another contribution @lzgabel 🏅

The indexes themselves look good. There is a few other things that require some attention though.

  1. This wasn't in the issue so you couldn't have known, but please change exporting of the timer, message_start_event_subscription and deployment_distribution to true by default.
  2. We'll have to add these records to the ElasticSearchExporter
  3. We should modify the toString() method of the ElasticSearchExporterConfiguration.
  4. We have some parametrised tests these tests use this TestSupport class. We will have to add the value types of these records to the setIndexingForValueType() method and remove them from the provideValueTypes() method.

If you will, please make these changes in a separate commit. This makes it easier for me as I'll only have to review the new commit 🙂

@lzgabel
Copy link
Contributor Author

lzgabel commented Oct 13, 2022

Hi @remcowesterhoud. Please check this out. 🙇

@remcowesterhoud
Copy link
Contributor

You are lightning fast ⚡ I will have a look tomorrow!

Copy link
Contributor

@remcowesterhoud remcowesterhoud left a comment

Choose a reason for hiding this comment

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

Awesome! 🏆

The issue is not marked as hacktoberfest, but I reckon it still deserves it so I'll add the hacktoberfest-accepted label to this PR. If you have 4 PRs within Camunda labelled with hacktoberfest-accepted you have completed the hacktoberfest challenge. In this case please submit the entry form here 🙂

bors merge

@remcowesterhoud remcowesterhoud added the hacktoberfest-accepted Marks an issue as having been accepted as a Hacktoberfest contribution label Oct 14, 2022
@lzgabel
Copy link
Contributor Author

lzgabel commented Oct 14, 2022

Hi @remcowesterhoud. Seems like bors is not working again? Do I need to rebase this PR on main again?

@remcowesterhoud
Copy link
Contributor

@lzgabel Yes, please do a rebase

@remcowesterhoud
Copy link
Contributor

bors cancel

@lzgabel
Copy link
Contributor Author

lzgabel commented Oct 14, 2022

Done.

@remcowesterhoud
Copy link
Contributor

bors merge

@zeebe-bors-camunda
Copy link
Contributor

Build succeeded:

@zeebe-bors-camunda zeebe-bors-camunda bot merged commit 35dd152 into camunda:main Oct 14, 2022
@lzgabel lzgabel deleted the 8337-lz-es-export branch October 14, 2022 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Marks an issue as having been accepted as a Hacktoberfest contribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Export missing records to ES
3 participants