app.conf - Splunk Documentation (original) (raw)

The following are the spec and example files for app.conf.

app.conf.spec

Version 9.4.2

OVERVIEW

This file maintains the state of a given app in the Splunk platform. It can

also be used to customize certain aspects of an app.

An app.conf file can exist within each app on the Splunk platform.

You must restart the Splunk platform to reload manual changes to app.conf.

To learn more about configuration files (including precedence) please see the

documentation located at

http://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles

email = company =

[id]

group = name = version =

[launcher]

• Settings in this stanza determine how an app appears in the Launcher in the Splunk platform and online on Splunkbase.

Global Settings:

remote_tab =

• Determines whether the Launcher interface connects to apps.splunk.com (Splunkbase).
• This setting only applies to the Launcher app. Do not set it in any other app.
• Default: true

Per-application Settings:

version =

• Version numbers are a number followed by a sequence of dots and numbers.
• The best practice for version numbers for releases is to use three digits formatted as Major.Minor.Revision.
• Pre-release versions can append a single-word suffix like "beta" or "preview" along with a "+" or "-" sign.
• Version must not contain any spaces.
• Examples:
  • 1.2.0
  • 3.2.1
  • 11.0.34
  • 1.1.1+alpha
  • 2.0.0-beta
  • 1.3.4-preview

description =

• A short explanatory string that appears below the title of the app in Launcher.
• Limit descriptions to 200 characters or less for user readability.

author =

• For apps that you intend to upload to Splunkbase, list the username of your splunk.com account.
• For apps that are for internal use only, include your full name and/or contact info, such as your email address.

Your app can include an icon which appears next to your app in Launcher

and on Splunkbase. You can also include a screenshot, which shows up on

Splunkbase when the user views information about your app before downloading it.

If you include an icon file, the file name must end with "Icon" before the

file extension and the "I" must be capitalized. For example, "mynewIcon.png".

Screenshots are optional.

There is no setting in app.conf for screenshot or icon images.

Splunk Web places files you upload with your app into

the $SPLUNK_HOME/etc/apps//static/ directory.

These images do not appear in your app.

Move or place icon images in the $SPLUNK_HOME/etc/apps//static/ directory.

Move or place screenshot images in the $SPLUNK_HOME/etc/apps//static/ directory.

Launcher and Splunkbase automatically detect the images in those locations.

For example:

/static/appIcon.png (the capital "I" is required!)

/static/screenshot.png

An icon image must be a 36px by 36px PNG file.

An app screenshot must be a 623px by 350px PNG file.

[package]

• This stanza defines upgrade-related metadata that streamlines app upgrade to future versions of Splunk Enterprise.

id =

• Omit this setting for apps that are for internal use only and not intended for upload to Splunkbase.
• id is required for all new apps that you upload to Splunkbase. Future versions of Splunk Enterprise will use appid to correlate locally-installed apps and the same app on Splunkbase (e.g. to notify users about app updates).
• id must be the same as the folder name in which your app lives in $SPLUNK_HOME/etc/apps.
• id must adhere to these cross-platform folder name restrictions:
  • must contain only letters, numbers, "." (dot), and "_" (underscore) characters.
  • must not end with a dot character.
  • must not be any of the following names: CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9

check_for_updates =

• Determines whether Splunk Enterprise checks Splunkbase for updates to this app.
• Default: true

show_upgrade_notification =

• Determines whether Splunk Enterprise shows an upgrade notification in Splunk Web for this app.
• Default: false

[install]

• This stanza defines install settings for this app.

state = disabled | enabled

• Determines whether an app is disabled or enabled on the Splunk platform.
• If an app is disabled, its configurations are ignored.
• Default: enabled

state_change_requires_restart =

• Determines whether changing an app's state ALWAYS requires a restart of Splunk Enterprise.
• State changes include enabling or disabling an app.
• When set to true, changing an app's state always requires a restart.
• When set to false, modifying an app's state might or might not require a restart, depending on what the app contains. This setting cannot be used to avoid all restart requirements.
• Default: false

is_configured =

• Stores an indication of whether the application's custom setup has been performed.
• Default: false

build =

• Required.
• Must be a positive integer.
• Increment this whenever you change files in /static.
• Every release must change both 'version' and 'build' settings.
• Ensures browsers don't use cached copies of old static files in new versions of your app.
• 'build' is a single integer, unlike 'version' which can be a complex string, such as 1.5.18.

allows_disable =

• Determines whether an app allows itself to be disabled.
• Default: true

install_source_checksum =

• Records a checksum of the tarball from which a given app was installed.
• Splunk Enterprise automatically populates this value upon install.
• Do not set this value explicitly within your app!

install_source_local_checksum =

• Records a checksum of the tarball from which a given app's local configuration was installed.
• Splunk Enterprise automatically populates this value upon install.
• Do not set this value explicitly within your app!

python.version = {default|python|python2|python3|python3.7|python3.9|latest}

• When 'installit.py' exists, selects which Python version to use.
• Set to either "default" or "python" to use the system-wide default Python version.
• Set to "python3" or "python3.7" to use the Python 3.7 version.
• Set to "python3.9" to use the Python 3.9 version.
• In the context of configuring apps, the "latest" value is not currently supported. It is related to a feature that is still under development.
• Optional.
• Default: Not set; uses the system-wide Python version.

[triggers]

• This stanza controls reloading of custom configuration files included in the app (4.2+ versions only).
• Include this stanza if your app includes custom configuration files.

Conf-level reload triggers

reload. = [ simple | never | rest_endpoints | access_endpoints | http_get | http_post ]

• Splunk Enterprise reloads app configuration after every app-state change: install, update, enable, and disable.
• If your app does not use a custom config file (e.g.myconffile.conf) then it does not require a [triggers] stanza. This is because $SPLUNK_HOME/etc/system/default/app.conf includes a [triggers] stanza, which automatically reloads config files used by Splunk Enterprise.
• If your app uses a custom config file (e.g. myconffile.conf) and you want to avoid unnecessary Splunk Enterprise restarts, you can add a reload value in the [triggers] stanza.
• If you do not include [triggers] settings and your app uses a custom config file, Splunk Enterprise requires a restart after every state change.
• If set to "simple", Splunk Enterprise takes no special action to reload your custom configuration file.
• If you specify "access_endpoints" with a URL to a REST endpoint, Splunk Enterprise calls its _reload() method at every app state change.
• If you specify "http_get" with a URL to a REST endpoint, Splunk Enterprise simulates an HTTP GET request against the URL at every app state change.
• If you specify "http_post" with a URL to a REST endpoint, Splunk Enterprise simulates an HTTP POST request against the URL at every app state change.
• If set to "never", Splunk Enterprise initiates a restart after any state change.
• "rest_endpoints" is reserved for Splunk Enterprise internal use for reloading restmap.conf.
• NOTE: The "conf_file_name" value does not include the file extension ".conf".

Stanza-level reload triggers

reload.. = [ simple | never | access_endpoints | http_get | http_post ]

• Stanza-level reload triggers for indexer-cluster peers to reload only the config file stanzas that are changed in the newly pushed cluster bundle.
• With the stanza level reload triggers, we can have more granular control over which subset of existing reload handlers to invoke depending on which stanzas of a given config file have changed in the newly pushed cluster bundle. See example below for more information.
• Stanza level reload trigger values operate identically to conf-level reload trigger values, i.e. "simple", "never","access_endpoints", "http_get", "http_post".
• For any stanza of that does NOT have a corresponding stanza-level reload trigger listed under the [triggers] section of app.conf, the cluster peer will fallback to the "rolling restart behavior" upon detecting changes of those "missing" stanzas in the newly pushed cluster bundle.
• NOTE: This setting is ONLY used by indexer-cluster peers and ONLY supported by inputs.conf and server.conf.
• NOTE: The "conf_file_name" value does not include the file extension ".conf".

[shclustering]

deployer_lookups_push_mode = preserve_lookups | always_preserve | always_overwrite | overwrite_on_change

• Determines the deployer_lookups_push_mode for the 'splunk apply shcluster-bundle' command.
• If set to "preserve_lookups", the 'splunk apply shcluster-bundle' command honors the '-preserve-lookups' option as it appears on the command line. If '-preserve-lookups' is flagged as "true", then lookup tables for this app are preserved. Otherwise, lookup tables are overwritten.
• If set to "always_preserve", the 'splunk apply shcluster-bundle' command ignores the '-preserve-lookups' option as it appears on the command line and lookup tables for this app are always preserved.
• If set to "always_overwrite", the 'splunk apply shcluster-bundle' command ignores the '-preserve-lookups' option as it appears on the command line and lookup tables for this app are always overwritten.
• If set to "overwrite_on_change", the 'splunk apply shcluster-bundle' command ignores the '-preserve-lookups' option as it appears on the command line and lookup tables for this app are overwritten if the app contents have changed.
• Default: always_preserve

deployer_push_mode = full | merge_to_default | local_only | default_only

• How the deployer pushes the configuration bundle to search head cluster members.
• If set to "full": Bundles all of the app's contents located in default/, local/, users//, and other app subdirs. It then pushes the bundle to the members. When applying the bundle on a member, the non-local and non-user configurations from the deployer's app folder are copied to the member's app folder, overwriting existing contents. Local and user configurations are merged with the corresponding folders on the member, such that member configuration takes precedence. This option should not be used for built-in apps, as overwriting the member's built-in apps can result in adverse behavior.
• If set to "merge_to_default": Merges the local and default folders into the default folder and pushes the merged app to the members. When applying the bundle on a member, the default configuration on the member is overwritten. User configurations are copied and merged with the user folder on the member, such that the existing configuration on the member takes precedence. In versions 7.2 and prior, this was the only behavior.
• If set to "local_only": This option bundles the app's local directory (and its metadata) and pushes it to the cluster. When applying the bundle to a member, the local configuration from the deployer is merged with the local configuration on the member, such that the member's existing configuration takes precedence. Use this option to push the local configuration of built-in apps, such as search. If used to push an app that relies on non-local content (such as default/ or bin/), these contents must already exist on the member.
• If set to "default_only": Bundles all of the configuration files except for local and users//. When applying the bundle on a member, the contents in the member's default folder are overwritten.
• Default (all apps except built-in apps): "merge_to_default"
• Default (built-in apps): "local_only"

Set UI-specific settings for this app

[ui]

• This stanza defines UI-specific settings for this app.

is_visible =

• Indicates if this app is visible/navigable as an app in Splunk Web.
• Apps require at least one view to be available in Splunk Web.

show_in_nav =

• Determines whether this app appears in the global app dropdown.

is_manageable =

• Support for this setting has been removed. It no longer has any effect.

label =

• Defines the name of the app shown in Splunk Web and Launcher.
• Recommended length between 5 and 80 characters.
• Must not include "Splunk For" prefix.
• Label is required.
• Examples of good labels: IMAP Monitor SQL Server Integration Services FISMA Compliance

docs_section_override =

• Defines override for auto-generated app-specific documentation links.
• If not specified, app-specific documentation link includes [:].
• If specified, app-specific documentation link includes [].
• This setting only applies to apps with documentation on the Splunk documentation site.

attribution_link =

• URL that users can visit to find third-party software credits and attributions for assets the app uses.
• External links must start with http:// or https://.
• Values that do not start with http:// or https:// get interpreted as Quickdraw location strings and translated to internal documentation references.

setup_view =

• Optional.
• Defines custom setup view found within the /data/ui/views REST endpoint.

supported_themes =

• A comma-separated list of themes supported by the app.
• Supported values are "dark" and "light".
• This setting is optional.
• If you specify this setting, you must give it a value of "light".
• No default.

[credentials_settings]

• This stanza controls credential-verification scripting (4.2+ versions only).
• Credential entries are superseded by passwords.conf from 6.3 onwards.
• While the entries here are still honored post-6.3, updates to these occur in passwords.conf, which overrides any values present here.

verify_script =

• Optional setting.
• Command line to invoke to verify credentials used for this app.
• For scripts, the command line must include both the interpreter and the script for it to run.
  • Example: "$SPLUNK_HOME/bin/python" "$SPLUNK_HOME/etc/apps//bin/$MY_SCRIPT"
• The invoked program is communicated with over standard in / standard out via the same protocol as splunk scripted auth.
• Paths incorporating variable expansion or explicit spaces must be quoted.
  • For example, a path including $SPLUNK_HOME should be quoted, as likely will expand to C:\Program Files\Splunk

python.version = {default|python|python2|python3|python3.7|python3.9|latest}

• For Python scripts only, selects which Python version to use.
• This setting is used only when the 'verify_script' setting has a value that starts with the canonical path to the Python interpreter, in other words, "$SPLUNK_HOME/bin/python". If you use any other path, the Splunk platform ignores this setting.
• Set to either "default" or "python" to use the system-wide default Python version.
• Set to "python3" or "python3.7" to use the Python 3.7 version.
• Set to "python3.9" to use the Python 3.9 version.
• In the context of configuring apps, the "latest" value is not currently supported. It is related to a feature that is still under development.
• Optional.
• Default: Not set; uses the system-wide Python version.

[credential::]

password =

• Password that corresponds to the given username for the given realm.
• Realm is optional.
• The password can be in clear text, but when saved from splunkd the password is always encrypted.

[diag]

• This stanza applies to diag app extensions, 6.4+ only.

extension_script =

• Setting this variable declares that this app puts additional information into the troubleshooting & support oriented output of the 'splunk diag' command.
• Must be a python script.
• Must be a simple filename, with no directory separators.
• The script must exist in the 'bin' subdirectory in the app.
• Full discussion of the interface is located on the Splunk developer portal. See http://dev.splunk.com/view/SP-CAAAE8H
• Default: not set (no app-specific data collection will occur).

data_limit = [b|kb|MB|GB]

• Defines a soft ceiling for the amount of uncompressed data that can be added to the diag by the app extension.
• Large diags damage the main functionality of the tool by creating data blobs too large to copy around or upload.
• Use this setting to ensure that your extension script does not accidentally produce far too much data.
• After data produced by this app extension reaches the limit, diag does not add any further files on behalf of the extension.
• After diag has finished adding a file which goes over this limit, all further files are not be added.
• Must be a positive number followed by a size suffix.
  • Valid suffixes: b: bytes, kb: kilobytes, mb: megabytes, gb: gigabytes
  • Suffixes are case insensitive.
• Default: 100MB

Other diag settings

default_gather_lookups = [, ...]

• Set this variable to declare that the app contains lookups that diag must always gather by default.
• Essentially, if there are lookups which are useful for troubleshooting an app, and will never contain sensitive (user) data, add the lookups to this list so that they appear in generated diags for use when troubleshooting the app from customer diags.
• Any files in lookup directories that are not listed here are not gathered by default. You can override this behavior with the diag flag --include-lookups.
• This setting is new in Splunk Enterprise/Light version 6.5. Older versions gather all lookups by default.
• This does not override the size-ceiling on files in etc. Large lookups are still excluded unless the etc-filesize-limit is raised or disabled.
• This only controls files in the same app directory as this conf file. For example, if you have an app directory in etc/peer-apps (index clustering), this setting must appear in etc/peer-apps/appname/default/app.conf or local/app.conf
• Additional lists can be created with default_gather_lookups-classname = ...
• Default: not set

app.conf.example

Version 9.4.2

The following are example app.conf configurations. Configure properties for

your custom application.

There is NO DEFAULT app.conf.

To use one or more of these configurations, copy the configuration block into

app.conf in $SPLUNK_HOME/etc/system/local/. You must restart Splunk to

enable configurations.

To learn more about configuration files (including precedence) please see the

documentation located at

http://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles

[launcher] author= description= version=

[triggers] ########## Conf-level reload triggers ##########

Do not force a restart of Splunk Enterprise for state changes of MyApp

Do not run special code to tell MyApp to reload myconffile.conf

Apps with custom config files usually pick this option:

reload.myconffile = simple

Do not force a restart of Splunk Enterprise for state changes of MyApp.

Splunk Enterprise calls the /admin/myendpoint/_reload method in my custom

EAI handler.

Use this advanced option only if MyApp requires custom code to reload

its configuration when its state changes

reload.myotherconffile = access_endpoints /admin/myendpoint

########## Stanza-level reload triggers ##########

For any changed inputs.conf stanzas in the newly pushed cluster

bundle that start with the "monitor" stanza prefix, e.g.

[monitor://*], invoke the corresponding monitor input reload handler

as specified, i.e. /data/inputs/monitor/_reload

NOTE: The scripted input reload handler and the http input reload

will NOT be invoked if the only changed inputs stanzas in the

newly pushed cluster bundle are monitor inputs.

reload.inputs.monitor = access_endpoints /data/inputs/monitor reload.inputs.script = access_endpoints /data/inputs/script reload.inputs.http = access_endpoints /data/inputs/http