Cheat Sheet

Here’s a quick rundown of handy ksconf commands:


Note that for clarity, most of the command line arguments are given in their long form.

Long commands may be broken across line for readability. When this happens, a trailing backslash (\) is shown. This can be copied verbatim into many shells.

General purpose

Extracting a single value

Grabbing the definition of a single macro using ksconf attr-get. Note in the case of a complex or multi-line expression, any line continuation characters will be removed.

ksconf attr-get macros.conf --stanza 'unroll_json_array(6)' --attribute definition

Updating a single value

Suppose you have a macro called mydata_index that defines the source indexes for your dashboards. The following command uses ksconf attr-set to update that macro directly from the CLI without opening an editor.

ksconf attr-set macros.conf --stanza mydata_index --attribute definition --value 'index=mydata1 OR index=otheridx'

In this case the definition is a single line, but multi-line input is handled automatically. It’s also possible to pull a vale from an existing file or from an environment variable, should that be useful.

Comparing files

Show the differences between two conf files using ksconf diff.

ksconf diff savedsearches.conf savedsearches-mine.conf

Sorting content

Create a normalized version of a configuration file, making conf files easier to merge with git. Run an in-place sort like so:

ksconf sort --inplace savedsearches.conf


Use the ksconf-sort pre-commit hook to do this for you.

Extract specific stanza

Say you want to grep your conf file for a specific stanza pattern:

ksconf filter search/default/savedsearches.conf --stanza 'Errors in the last *'

Say you want to list stanzas containing cron_schedule:

ksconf filter Splunk_TA_aws/default/savedsearches.conf --brief \
    --attr-present 'cron_schedule'

Remove unwanted settings

Say you want to remove vsid from a legacy savedsearches file:

ksconf filter search/default/savedsearches.conf --reject-attrs "vsid"

To see just to the scheduled time and enablement status of scheduled searches, run:

ksconf filter Splunk_TA_aws/default/savedsearches.conf \
    --attr-present cron_schedule \
    --keep-attrs 'cron*' \
    --keep-attrs enableSched
    --keep-attrs disabled

List apps configured in the deployment server

ksconf filter -b serverclass.conf --stanza 'serverClass:*:app:*' | \
    cut -d: -f4 | sort | uniq

Find saved searches with earliest=-1d@d

ksconf filter apps/*/default/savedsearches.conf \
    --attr-eq dispatch.earliest_time "-1d@d"

Cleaning up

Reduce cruft in local

If you’re in the habit of copying the default files to local in the TAs you deploy, here is a quick way to ‘minimize’ your files. This will reduce the local file by removing all the default settings you copied but didn’t change. (The importance of this is outlined in Minimizing files.)

ksconf minimize Splunk_TA_nix/default/inputs.conf --target Splunk_TA_nix/local/inputs.conf

Pushing local changes to default

App developers can push changes from the local folder to the default folder:

ksconf promote --interactive myapp/local/props.conf myapp/default/props.conf

You will be prompted to pick which items you want to promote. Alternatively, use the --batch option to promote everything in one step, without reviewing the changes first.

Packaging and building apps

Quick package and install

Use the --release-file option of the package command to write out the name of the final created tarball. This helps when the final tarball name isn’t known in advance because it contains a version string, for example. By simply placing the latest release in a static location, this allows commonly repeated operations, like build+install to be chained together in a convenient way making iterations quite fast.

cd my-apps
ksconf package --release-file .release kintyre_app_speedtest &&
    "$SPLUNK_HOME/bin/splunk" install app "$(<.release)" -update 1

A build process for the same package, where the version is defined by the latest git tag, would look something like this:

ksconf package -f "dist/kintyre_app_speedtest-{{version}}.tar.gz" \
    --set-version="{{git_tag}}" \
    --set-build=$GITHUB_RUN_NUMBER \
    --release-file .release \
echo "Go upload $(<.release) to Splunkbase"

Advanced usage

Migrating content between apps

Say you want to move a bunch of savedsearches from search into a more appropriate app. First create a file that lists all the names of your searches (one per line) in corp_searches.txt. Next, copy just the desired stanzas, to your new corp_app application using the following command:

ksconf filter --match string --stanza 'file://corp_searches.txt' \
    search/local/savedsearches.conf --output corp_app/default/savedsearches.conf

Because we want to move, not just copy, the searches, they can now be removed from the search app using the following steps:

ksconf filter --match string --stanza 'file://corp_searches.txt' \
    --invert-match search/local/savedsearches.conf \
    --output search/local/savedsearches.conf.NEW

# Backup the original
mv search/local/savedsearches.conf \
    /my/backup/location/search-savedsearches-$(date +%Y%M%D).conf

# Move the updated file in place
mv search/local/savedsearches.conf.NEW search/local/savedsearches.conf


Setting the matching mode to string prevents any special characters that may be present in your search names from being interpreted as wildcards.

Migrating the ‘users’ folder

Say you stood up a new Splunk server and the migration took longer than expected. Now you have two users folders and don’t want to loose all the goodies stored in either one. You’ve copied the users folder to user_old. You’re working from the new server and would generally prefer to keep whatever is on the new server over what is on the old. (This is because some of your users copied over some of their critical alerts manually while waiting for the migration to complete, and they’ve made updates they don’t want to lose.)

After stopping Splunk on the new server, run the following commands.

mv /some/share/users_old  $SPLUNK_HOME/etc/users.old
mv $SPLUNK_HOME/etc/users $SPLUNK_HOME/etc/

ksconf combine $SPLUNK_HOME/etc/users.old $SPLUNK_HOME/etc/ \
    --target $SPLUNK_HOME/etc/users --banner ''

Now double check the results and start Splunk.

Using --banner essentially disables the output banner feature. Because, in this case, the combine operation is a one-time job and therefore no top-of-file warning is needed.

Maintaining apps stored in a local git repository

Extract and commit a new/updated app

ksconf unarchive --git-mode=commit my-package-112.tgz

For apps that use layers (default.d folder), then use a command like so:

ksconf unarchive --git-mode=commit \
    --default-dir=default.d/10-upstream \
    --keep 'default.d/*' my-package-112.tgz

If you’d like to disable git hooks, like pre-commit, when importing a new release of an upsteam app, add --git-commit-args="--no-verify to the above commands.

Putting it all together

Pulling out a stanza defined in both default and local

Say you wanted to count the number of searches containing the word error

ksconf merge default/savedsearches.conf local/savedsearches.conf \
    | ksconf filter - --stanza '*Error*' --ignore-case --count

This is a simple example of chaining two basic ksconf commands together to perform a more complex operation. The first command handles the merge of default and local savedsearches.conf into a single output stream. The second command filters the resulting stream finding stanzas containing the word ‘Error’.

Building an all-in one TA for your indexing tier

Say you need to build a single TA containing all the index-time settings for your indexing tier. (Note: Enterprise Security does something similar when generating the indexer app.)

ksconf merge etc/apps/*TA*/{default,local}/props.conf \
    | ksconf filter - --output=TA-for-indexers/default/props.conf \
      --include-attr 'TRANSFORMS*' \
      --include-attr 'TIME_*' \
      --include-attr 'MUST_BREAK*' \
      --include-attr 'SHOULD_LINEMERGE' \
      --include-attr 'EVENT_BREAKER*' \
      --include-attr 'LINE_BREAKER*'

This example is incomplete because it doesn’t list every index-time props.conf attribute, and leaves out transforms.conf and fields.conf, but hopefully you get the idea.