Splunk Cloud Platform

Search Manual

Manage search jobs

You can use the Jobs page to review and manage any job that you own.

If you have the Admin role, or a role with an equivalent set of capabilities, you can manage the search jobs run by all users of your Splunk implementation.

Opening the Jobs page

  • In Splunk Web, to view a list of your jobs select Activity > Jobs. This opens the Jobs page.
This screen image shows the Jobs page. This example shows several search jobs in a table. The table column names are: Owner, Application, Events, Size, Created at, Expires, Runtime, Status, and Actions. There are callouts on the page to show the number of active jobs, the column on which the list is sorted, and how to display the full search criteria for a job.

The Jobs page displays a list of different types of search jobs.

  • Jobs resulting from ad hoc searches or pivots that you have recently run manually.
  • Jobs for searches that are run when dashboards are loaded or reports are opened.
  • Jobs for scheduled searches.

Refreshing the jobs list

The list of jobs in the Jobs page does not automatically refresh.

  • Jobs that are created after you display the Jobs page are not visible until you reload the Jobs page.
  • If a job expires while you have the Jobs page open, the job appears in the Jobs page list, but you cannot view the job results.

To refresh the Jobs page, reload the page.

Job actions

You can use the Actions column to perform actions on a job.

This image shows the Status and Actions columns. In the Status column, the first job has a status of Running (13%). The second job has as status of Done. The actions column shows the Job drop-down and the four action icons.

Use the Job drop-down to edit the job settings, extend the job lifetime, inspect the job, or delete the job.

Use the action icons to pause, stop, share, and export jobs.

To perform these actions on multiple jobs, select the jobs and click Edit Selected. Then select the action that you want to perform.

View and compare jobs

You can see a list of the jobs you have recently dispatched or saved for later review. Use the list to compare job statistics such as run time, total count of events matched, size, and so on.

Active job count

In the upper right corner of the Jobs page there is a count of the total number of jobs in the list.

The count reflects the number of jobs at the moment you opened the Jobs page. If a job expires while the Jobs page is open, the job count does not refresh.

Sort the job list

By default, the list of jobs is sorted by the Created at column.

You can sort the list by any column that displays a sort button in the column heading. For example, you can sort the list by the job expiration or by the job owner.

  • Click once on the column heading to sort the list in ascending order. Click again to sort the list in descending order.

Filter the job list

You can filter the list of jobs by application, by owner, and by status.

  • In the Filter box, type a term or expression that appears in the search criteria to filter the list.

For example, you can specify diskUsage, EMBED AND diskUsage=8*, or label=EMBED AND diskUsage=8* in the Filter box.

View job search results

You can view the results of a search that is listed on the Jobs page.

  1. Click on the search link to view the results associated with a specific job.
    • For ad hoc searches the link is the search criteria.
    • For saved searches the link is the name of the report, dashboard panel, or pivot.

    The results open in the Search app view.

Check the progress of ongoing jobs

You can check on jobs that are dispatched by scheduled searches, real-time searches, and long-running historical searches.

Use the Status column to check on the progress of ongoing jobs. The Status column shows the percent of the events that have been processed. Current jobs have a status of Running. Jobs that are running in the background have a status of Backgrounded.

Change the per page job count

You can change the number of jobs that appear on each page in the list. The default is to display ten jobs on each page. On the right side of the window, you can display 10, 20 or 50 jobs per page.

Inspect jobs

You can inspect a job to take a closer look at what a search is doing and see where the Splunk software is spending most of its processing time.

Use the Search Job Inspector to view information about the current job, such as the search ID (sid), job execution costs, and search job properties.

  1. In the Actions column for the specific job, select Job.
  2. Select Inspect Job.

For more information about the using the Search Job Inspector, see View search job properties.

Extending search job lifetimes

From the Jobs page, there are several ways to change the lifetime of a job. To learn more about lifetimes for specific types of jobs, see Extending job lifetimes.

Quickly extend job lifetimes

You can quickly extend the lifetime of a job.

  1. In the Actions column for the specific job, select Job.
  2. Select Extend Job Expiration.

Extend the lifetimes for multiple jobs

You can extend the lifetimes of multiple jobs at the same time.

  1. Select the jobs whose lifetimes you want to extend.
  2. Above the job list, click Edit Selected.
  3. Select Extend Expiration.
    This image shows the Edit Selected button expanded. The editing choices are Resume, Pause, Stop, Extend Expiration, and Delete.

Choose the period of time for the lifetime extension

Use this method to select the time period for the extension.

  1. In the Actions column for the specific job, select Job.
  2. Select Edit Job Settings.
  3. Select either 10 minutes or 7 days.
  4. Click Save.

Share jobs

You can share a job by changing the job permissions, or by sharing a URL to the job.

Change job permissions

You can share a job by changing the permissions on that job. By default, all jobs are set to Private.

  1. From the Job menu, select Edit Job Settings to display the Job Settings dialog box.
  2. Change Read Permissions to Everyone.
  3. Click Save.

Share a job URL

You can share a job with other Splunk users by sending them a link to the job.

The users that you send the link to must also have permissions to use the app that the job belongs to.

  1. In the Actions column, click the Share icon for the job that you want to share.
  2. In Share Job dialog box, copy the URL in the Link To Job.
  3. Send the link to the users that you want to share the job results with.
The permissions on the job are changed to Everyone and the lifetime of the job is extended to 7 days.

You can also obtain the URL from the Job Settings window. If you use this method to share a job, you must change the Read Permissions to Everyone and the Lifetime to 7 days.

Export jobs

You can export the event data from a job in a variety of formats such as CSV, JSON, PDF, Raw Events, and XML. You can then archive the file, or use the file with a third-party charting application. The format options depend on the type of job artifact that you are working with.

  1. In the Actions column, click the Export icon for the event data that you want to export.
  2. Click Format and select the format that you want the search results to be exported in.
  3. In the File Name field, type a name for the export file where the event data will be stored.
  4. In the Number of Results field, specify the number of results that you want to export.
  5. Click Export to save the job events in the export file.

The export file is saved in the default download directory for your browser or operating system.

Note: If your search returns a large number of results, you can access all of the results in the Search app. However, the full set of results might not be stored with the search job artifact. When you export search results, the export process is based on the search job artifact, not the results in the Search app. If the artifact does not contain the full set of results, a message appears at the bottom of the Export Results dialog box to tell you that the search will be rerun by the Splunk software before the results are exported.

For more information, see Export search results.

If the Export icon is not visible, the icon has been hidden by your system administrator to prevent data export.

Extend the session timeout when exporting large amounts of data

When you try to export large amounts of data using the Export button, the session might timeout.

Users with the Admin role, or a role with an equivalent set of capabilities, can use the following procedure to extend the session timeout limit.

  1. Click Settings > Server Settings > General Settings.
  2. In the Splunk Web section, increase the number in the Session timeout field.
  3. Click Save.

Increasing the timeout settings allows Splunk Web more time for the connection between your browser and Splunk Web.

Delete jobs

You can delete one or more jobs from the jobs list.

Delete a single job

You can delete a job from the job list.

  1. In the Actions column for the specific job, select Job.
  2. Select Delete Job.

Delete multiple jobs

You can delete multiple jobs at one time.

  1. Select the jobs that you want to delete.
  2. Above the job list, click Edit Selected.
  3. Select Delete.
Last modified on 20 August, 2020
Share jobs and export results   View search job properties

This documentation applies to the following versions of Splunk Cloud Platform: 9.2.2403, 8.2.2201, 8.2.2202, 8.2.2112, 8.2.2203, 9.0.2205, 9.0.2208, 9.0.2209, 9.0.2303, 9.0.2305, 9.1.2308 (latest FedRAMP release), 9.1.2312

Was this topic useful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters