CrowdStrike client and coordinator implementation #5678
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,27 +3,94 @@ | |
| import org.opensearch.dataprepper.model.acknowledgements.AcknowledgementSet; | ||
| import org.opensearch.dataprepper.model.buffer.Buffer; | ||
| import org.opensearch.dataprepper.model.event.Event; | ||
| import org.opensearch.dataprepper.model.event.EventType; | ||
| import org.opensearch.dataprepper.model.event.JacksonEvent; | ||
| import org.opensearch.dataprepper.model.record.Record; | ||
| import org.opensearch.dataprepper.plugins.source.crowdstrike.models.CrowdStrikeIndicatorResult; | ||
| import org.opensearch.dataprepper.plugins.source.crowdstrike.models.CrowdStrikeThreatIntelApiResponse; | ||
| import org.opensearch.dataprepper.plugins.source.crowdstrike.models.ThreatIndicator; | ||
| import org.opensearch.dataprepper.plugins.source.source_crawler.base.CrawlerClient; | ||
| import org.opensearch.dataprepper.plugins.source.source_crawler.coordination.state.CrowdStrikeWorkerProgressState; | ||
| import org.opensearch.dataprepper.plugins.source.source_crawler.model.ItemInfo; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import javax.inject.Named; | ||
| import java.time.Instant; | ||
| import java.util.Iterator; | ||
| import java.time.Duration; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import static org.opensearch.dataprepper.plugins.source.crowdstrike.utils.Constants.NEXT_PAGE; | ||
|
|
||
| /** | ||
| * This class represents a CrowdStrike client. | ||
| */ | ||
| @Named | ||
| public class CrowdStrikeClient implements CrawlerClient<CrowdStrikeWorkerProgressState> { | ||
| CrowdStrikeService crowdStrikeService; | ||
| private static final Logger log = LoggerFactory.getLogger(CrowdStrikeClient.class); | ||
| private final CrowdStrikeSourceConfig configuration; | ||
| private final int bufferWriteTimeoutInSeconds = 10; | ||
|
|
||
|
|
||
| public CrowdStrikeClient(final CrowdStrikeService crowdStrikeService, | ||
| final CrowdStrikeSourceConfig sourceConfig) { | ||
| log.info("Creating CrowdStrike Crawler"); | ||
| this.crowdStrikeService = crowdStrikeService; | ||
| this.configuration = sourceConfig; | ||
| log.info("Created CrowdStrike Crawler"); | ||
| } | ||
| @Override | ||
| public Iterator<ItemInfo> listItems(Instant lastPollTime) { | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * Executes the data ingestion process for a given time-based partition of CrowdStrike threat intelligence data. | ||
| * This method fetches threat indicators from the CrowdStrike API for the specified time range defined in | ||
| * CrowdStrikeWorkerProgressState. It handles pagination using the `next-page` link header and continues | ||
| * fetching data until all pages are exhausted. Each batch of threat indicators is converted into | ||
| * JacksonEvent records and written to the provided Buffer | ||
| */ | ||
| @Override | ||
| public void executePartition(CrowdStrikeWorkerProgressState state, Buffer<Record<Event>> buffer, AcknowledgementSet acknowledgementSet) { | ||
|
|
||
| final Instant startTime = state.getStartTime(); | ||
| final Instant endTime = state.getEndTime(); | ||
| Optional<String> paginationLink = Optional.empty(); | ||
|
|
||
| do { | ||
| CrowdStrikeThreatIntelApiResponse response = crowdStrikeService.getThreatIndicators(startTime, endTime, paginationLink); | ||
| CrowdStrikeIndicatorResult result = response.getBody(); | ||
| List<ThreatIndicator> indicators = result.getResults(); | ||
| if (indicators == null || indicators.isEmpty()) { | ||
| log.info("No threat indicators found for the time window {} to {}", startTime, endTime); | ||
|
Member
There was a problem hiding this comment. if it's empty should we continue to next page at all? |
||
| } else { | ||
| writeIndicatorsToBuffer(indicators, buffer); | ||
| } | ||
| paginationLink = response.getFirstHeaderValue(NEXT_PAGE); | ||
| } while (paginationLink.isPresent()); | ||
|
|
||
| if (configuration.isAcknowledgments()) { | ||
| acknowledgementSet.complete(); | ||
| } | ||
| } | ||
|
|
||
| private void writeIndicatorsToBuffer(List<ThreatIndicator> indicators, Buffer<Record<Event>> buffer) { | ||
| List<Record<Event>> records = indicators.parallelStream() | ||
| .map(indicator -> (Event) JacksonEvent.builder() | ||
| .withEventType(EventType.DOCUMENT.toString()) | ||
| .withData(indicator) | ||
| .build()) | ||
| .map(Record::new) | ||
| .collect(Collectors.toList()); | ||
|
|
||
| try { | ||
| buffer.writeAll(records, (int) Duration.ofSeconds(bufferWriteTimeoutInSeconds).toMillis()); | ||
| } catch (Exception e) { | ||
|
There was a problem hiding this comment. Its better to catch the expected exception rather than generalising it. This might mask the actual actual code error as service failure.
Contributor
Author
There was a problem hiding this comment. WriteAll method doesn't throw a specific exception, that's why I had to catch Exception. Here is the method signature. |
||
| log.error("Failed to write {} indicators to buffer", records.size(), e); | ||
| throw new RuntimeException("Buffer write failed for CrowdStrike indicators", e); | ||
|
There was a problem hiding this comment. Convert this to a custom exception rather than throwing runtime exception
Contributor
Author
There was a problem hiding this comment. I can address it in follow-up PR, I see all the other clients also have same implementation I can check with @san81 and create a specific exception for all Saas crawlers. |
||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be configurable?