> For the complete documentation index, see [llms.txt](https://docs.expel.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.expel.io/connect-your-technology/q-z-integrations/splunk/splunk-core-alerts-via-collector-setup-for-workbench.md).
# Splunk Core Alerts (via Collector) Setup for Workbench
## Prerequisites
1. You must have a [Splunk Collector](/connect-your-technology/q-z-integrations/splunk/splunk-collector-setup-for-workbench.md) onboarded as a Security Device in Expel Workbench to add this integration.
2. You must have already provided console access to Expel. [Why do we need console access?](/connect-your-technology/about-integrations/why-expel-asks-for-console-access.md)
## Step 1: Create a New Splunk Index to Log Alerts
**This step is required in order for Expel to accurately review your environment.** In this section, you will create a new Splunk index to hold the results of your alerts.
{% hint style="info" %}
There may be other Alerts configured in apps added to Splunk. Please contact your Splunk administrator to ensure there aren't any alerts you will miss editing in this step.
{% endhint %}
1. [Log in to Splunk](https://login.splunk.com/).
2. Navigate to **Settings > Indexes**.
3. Select **New Index** in the upper right corner.
4. **Index Name** - enter a name for the new index.
5. Select **Save**.
6. At this point, you can choose one of two methods to configure alerts to log to the index: 1) create a macro for the new index and add it to each of your alerts, or 2) edit each alert to use the new index.
{% hint style="info" %}
For easier maintenance, consider creating a macro. Editing the macro will apply to all searches using it, preventing the need to edit each search individually.
{% endhint %}
{% tabs %}
{% tab title="Option 1: Create a Macro" %}
1. Navigate to **Settings > Advanced Search**.
2. To the right of Search macros, select **Add new**.
3. **Name** - enter "send\_to\_expel".
4. **Definition** - enter the following string, replacing **\** with your index's name from step 4 above. Do **not** include a leading pipe ( | ).
```
tojson | collect index=
```
5. Select **Save**.
6. Select **Permissions**.
7. Next to Everyone, select **Read** to give everyone Read permissions from the Search app.
8. Select **Save**.
9. Select **Alerts**.
10. Choose an alert from the list and select **Open In Search**.
11. Add the macro to the last line of the query:
```
| `send_to_expel`
```
12. Select **Save As > Alert**.
13. Configure the alert as desired. We strongly recommend providing an informative Description.
14. Select **Save**.
15. Repeat steps 10 through 14 for each alert in your list.
{% endtab %}
{% tab title="Option 2: Edit Alerts to Use New Index" %}
1. For each alert in the list, select **Open In Search** and add the following line to the bottom of the query, replacing `` with the name of your index from step 4 above:
```
| tojson | collect index=
```
2. Select **Save As > Alert**.
3. Configure the alert as desired.
4. Select **Save**.
5. When finished editing all alerts, proceed to [Add Splunk Core Alerts as a Security Device in Workbench](#step-2-add-splunk-core-alerts-as-a-security-device-in-workbench).
{% endtab %}
{% endtabs %}
## Step 2: Add Splunk Core Alerts as a Security Device in Workbench
{% hint style="warning" %}
Please ensure you have onboarded a [Splunk Collector](/connect-your-technology/q-z-integrations/splunk/splunk-collector-setup-for-workbench.md) before proceeding with this step.
{% endhint %}
Now that you have configured Splunk to log alerts and completed other recommended configurations, you will add Splunk Core Alerts as a security device in Workbench.
1. [Log in to Workbench](https://workbench.expel.io/auth/login?orig=%2F).
2. In the side menu, navigate to **Organization Settings > Security Devices**.
3. Select **Add Security Device**.
4. In the search box, type “Splunk” and then select the **Splunk Core Alerts (via Collector)** integration.
5. A configuration pane displays. Complete the fields as follows:
* **SIEM** - select **Splunk Collector** from the dropdown.
* **Name** - enter a name that might help you more easily identify this integration, such as “CompanyName Splunk Core Alerts”; this name will display in Workbench under the Name column, and is a text string that you can filter on.
* **Location** - enter the location of your integration, for example “cloud.” This is also a text string that you can filter on, so we recommend being consistent with location naming across your Expel integrations.
* **Collector query** - enter the following query, replacing **\** with the name of the index you configured in [Step 1](#step-1-create-a-new-splunk-index-to-log-alerts):
```
index=
```
6. Select **Save**.
7. Your device should be created successfully within a few seconds. A few reminders:
* After your connection is healthy, it will take some time for your device to begin receiving data.
* To check on the status, click on the downward arrow for your device in the first column and choose **View details**. You can then scroll to the **Connection** section to see if your device is fully connected.
* Polling will happen first; data will be received after that. **You must refresh the page to see updates.**
* If your device does not begin polling within 15 minutes, and does not begin receiving data within 30 minutes, check out the [Troubleshooting](#troubleshooting) section below. Beyond that, [contact Expel support](/support/how-to-reach-us.md) for help.
8. Once you have successfully onboarded the device, [contact Expel support](/support/how-to-reach-us.md) to request a rule review by Expel’s Detection & Response (D\&R) team. The D\&R Team will review the alerts you have enabled and make projections on if and how Expel can support them.
## Additional Criteria for Support
The three actions below improve our ability to normalize custom alerts so they are properly presented in Workbench. They also equip our analysts with necessary context so they can make informed decisions.
#### CIM Compliance
To properly display alert evidence in Workbench, fields must be normalized according to Splunk's Common Information Model. Expel only uses a portion of the 500 CIM fields available for alert normalization. Expel uses version 6 of CIM Compliance.
Proper normalization also enables Ruxie to perform automated actions on the alert. We rely on proper normalization to create detections, suppressions, bloom for detections (alert deduplication), BOLOs, and in-depth DUET messages. If a CIM field isn't being used and is requested to be a part of alert normalization or DUET messages, then we typically can't support the request.
Please review the fields being returned from Splunk searches to ensure they map to what is shown in [Splunk's Common Information Model Add-on Manual](https://help.splunk.com/en/splunk-cloud-platform/common-information-model/6.1/data-models/cim-fields-per-associated-data-model).
#### Rich Evidence
Our analysts need enough context to make a decision when triaging custom rules. While Splunk Core does not include the Drilldown Search capability that Splunk Enterprise Security offers, Expel can automatically run investigative queries to add more context to the alert. Please share this with your Customer Success Manager (CSM), and the Detection & Response Team will configure them.
Additional capabilities of Splunk Core that may help further enrich alerts include:
* [Subsearches](https://help.splunk.com/en/splunk-enterprise/get-started/search-tutorial/9.2/part-4-searching-the-tutorial-data/use-a-subsearch)
* [Lookup Tables](https://help.splunk.com/en/splunk-enterprise/manage-knowledge-objects/knowledge-management-manual/9.2/use-lookups-in-splunk-web/about-lookups)
#### Use the Description Field
Any additional information about the custom rule that may be useful for our analysts should be included in the Description. Examples include the detection’s intent and suggested steps to triage.
## Troubleshooting
What if a long time has passed and Expel isn’t ingesting any events from my device?
1. Run the Collector Query you specified in the device configuration (Step 2, 5d) in your Splunk console and confirm there are results with timestamps after the device was onboarded.
2. If you expect results but there are none, the Collector Query may need to be revised.
3. Ask your Customer Success Manager (CSM) to request support from D\&R on your behalf.
What if a long time has passed and Expel hasn’t surfaced any alerts to Workbench?
1. First confirm that Expel is properly ingesting events by viewing the [Alert Analysis dashboard](/workbench-reference/dashboards/alert-analysis-dashboard.md).\
2. Has Expel’s Detection & Response D\&R) team performed a Rule Review? If not, [contact Expel support](/support/how-to-reach-us.md) to request one on your behalf.
3. Run the Collector Query you specified in the device configuration ([Step 2](#step-2-add-splunk-core-alerts-as-a-security-device-in-workbench)) in your Splunk console and confirm the results include alerts that D\&R projected Expel could support by sending to the SOC. Also ensure they occurred after your device was onboarded.
4. [Contact Expel support](/support/how-to-reach-us.md) to request assistance from D\&R on your behalf.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.expel.io/connect-your-technology/q-z-integrations/splunk/splunk-core-alerts-via-collector-setup-for-workbench.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.