Skip to content

feat: added interval config option to tell the plugin to run periodically #37

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

Merged
merged 2 commits into from
May 14, 2025

Conversation

fransflippo
Copy link
Collaborator

This contains the change from #12 to run the plugin continuously and query Salesforce and publish events periodically.

This adds a configuration option interval that indicates the interval at which the plugin should re-run the query and publish events. The interval is from start to start, in other words, the time that the plugin spent actually doing work is subtracted from the interval, and that is how long the plugin will sleep until it starts again.

Important: No functionality is added for "incremental" updates. The same query is run every time and all result records are published as events, regardless of whether they were already retrieved and published before.

Copy link

cla-checker-service bot commented May 7, 2025

💚 CLA has been signed

@jsvd
Copy link
Member

jsvd commented May 7, 2025

@fransf-wtax failing the CLA check typically means you didn't sign with the email that is shown as the author of this PR's commits: https://patch-diff.githubusercontent.com/raw/logstash-plugins/logstash-input-salesforce/pull/37.patch

@jsvd
Copy link
Member

jsvd commented May 7, 2025

@fransf-wtax we have a different user for you, @fransflippo ?

@fransf-wtax
Copy link

@fransf-wtax we have a different user for you, @fransflippo ?

Ugh, I'm juggling work and personal GitHub accounts and e-mail addresses. I pushed using my personal GitHub account, but the commits were originally created from my work account.

Let me try to rewrite the commits so they have my personal e-mail address on them instead and see if that works. Thanks!

@fransf-wtax
Copy link

@jsvd I'll also need to update the documentation at https://github.com/elastic/logstash-docs-md/edit/main/docs/lsr/plugins-inputs-salesforce.md with the new configuration option. What's the procedure for that?

@jsvd
Copy link
Member

jsvd commented May 8, 2025

Once the plugin is released we will be updating that. though with 9.0.0 we moved from asciidoc to markdown and are still dealing with some build issues, so it could take a bit longer to show the new plugin version docs.

@fransf-wtax
Copy link

Once the plugin is released we will be updating that. though with 9.0.0 we moved from asciidoc to markdown and are still dealing with some build issues, so it could take a bit longer to show the new plugin version docs.

Got it. So for now I should just update doc/index.asciidoc in the plugin project?

@jsvd
Copy link
Member

jsvd commented May 9, 2025

Yes, we periodically monitor for new releases and trigger the jobs to push changes to docs.

@fransflippo fransflippo merged commit 14bc7a3 into main May 14, 2025
4 checks passed
@fransflippo fransflippo deleted the feature/interval branch May 14, 2025 08:24
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

Successfully merging this pull request may close these issues.

3 participants