feat: added interval config option to tell the plugin to run periodically#37
Conversation
|
💚 CLA has been signed |
f5522ba to
6caa27b
Compare
|
@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 |
|
@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! |
6caa27b to
25a88ed
Compare
|
@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? |
|
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 |
|
Yes, we periodically monitor for new releases and trigger the jobs to push changes to docs. |
|
@jsvd Hi João, I hope you're well. I noticed the documentation on https://www.elastic.co/docs/reference/logstash/plugins/plugins-inputs-salesforce still doesn't reflect the latest documentation changes in https://github.com/logstash-plugins/logstash-input-salesforce/blob/main/docs/index.asciidoc . Can you see why it's not pulling through? Thanks! |
|
hi @fransflippo there was an issue with the docs generation, but it's been imported now: https://www.elastic.co/docs/reference/logstash/versioned-plugins/input-salesforce-index v3.3.0 will show up up as the default version in the docs for the next minor release. |
|
@jsvd Thank you, João. What do you mean by "the next minor release"? Minor release of Logstash? Thanks! |
|
It's already listed in https://www.elastic.co/docs/reference/logstash/versioned-plugins/v3-3-0-plugins-inputs-salesforce, in the set of released versions of the plugin. It will show up in the 9.0+ docs soon (https://www.elastic.co/docs/reference/logstash/plugins/plugins-inputs-salesforce), around the release of 9.2.0 Logstash |
This contains the change from #12 to run the plugin continuously and query Salesforce and publish events periodically.
This adds a configuration option
intervalthat 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.