
Introspection endpoint descriptions
Get information about the system.
- Note: Username and password authentication is required for most endpoints and REST operations. Additional capability or role-based authorization may also be required, particularly for POST or DELETE operations.
data/index-volumes
https://<host>:<mPort>/services/data/index-volumes
Description
Provides information about the volume (logical drives) in use by Splunk Enterprise.
The default update period is 10 minutes, as defined by the collectionPeriodInSecs
attribute in the $SPLUNK_HOME/etc/apps/introspection_generator_addon/default/server.conf
file.
At least one observation period must pass after Splunk Enterprise startup for valid endpoint data to be available. The observation period is defined in the $SPLUNK_HOME/etc/system/default/server.conf
file:
[introspection:generator:disk_objects] collectionPeriodInSecs = 600
Method summary
Method | Description | Formats |
---|---|---|
GET | List the Splunk Enterprise volume(s). | XML, JSON |
GET data/index-volumes
method detail
Request parameters
Pagination and filtering parameters can be used with this method.
Response data keys
Name | Description |
---|---|
max_size | Maximum name volume size limit (MB):
|
name | Volume name. |
total_size | Total name volume capacity (MB). If max_size is infinite , this field is not listed.
|
[ Top ]
data/index-volumes/{name}
https://<host>:<mPort>/services/data/index-volumes/{name}
Description
Provides information about a particular volume (logical drive).
The default update period is 10 minutes, as defined by the collectionPeriodInSecs
attribute in the $SPLUNK_HOME/etc/apps/introspection_generator_addon/default/server.conf
file.
At least one observation period must pass after Splunk Enterprise startup for valid endpoint data to be available. The observation period is defined in the $SPLUNK_HOME/etc/system/default/server.conf
file:
[introspection:generator:disk_objects] collectionPeriodInSecs = 600
Method summary
Method | Description | Formats |
---|---|---|
GET | List specified volume properties. | XML, JSON |
GET data/index-volumes/{name}
method detail
Request parameters
Pagination and filtering parameters can be used with this method.
Response data keys
Name | Description |
---|---|
max_size | Maximum name volume size limit (MB):
|
name | Volume name. |
total_size | Total name volume capacity (MB). If max_size is infinite , this field is not listed.
|
[ Top ]
data/indexes
https://<host>:<mPort>/services/data/indexes
Description
Provides services to create and manage data indexes.
Method summary
Method | Description | Formats |
---|---|---|
GET | Lists the recognized indexes on the server. | XML, JSON |
POST | Creates a new index with the given name. | XML, JSON |
GET data/indexes
method detail
Request parameters
Pagination and filtering parameters can be used with this method.
Response data keys
Name | Description |
---|---|
assureUTF8 | Indicates whether all data retreived from the index is proper UTF8. If enabled (set to True), degrades indexing performance.
This is a global setting, not a per index setting. |
blockSignSize | Controls how many events make up a block for block signatures.
If this is set to 0, block signing is disabled for this index. A recommended value is 100. |
blockSignatureDatabase | The index that stores block signatures of events.
This is a global setting, not a per index setting. |
coldPath | Filepath to the cold databases for the index. |
coldPath_expanded | Absoute filepath to the cold databases. |
coldToFrozenDir | Destination path for the frozen archive. Used as an alternative to a coldToFrozenScript. Splunk Enterprise automatically puts frozen buckets in this directory.
Bucket freezing policy is as follows:
If both coldToFrozenDir and coldToFrozenScript are specified, coldToFrozenDir takes precedence. |
coldToFrozenScript | Path to the archiving script.
See the POST parameter description for details. |
compressRawdata | This value is ignored. splunkd process always compresses raw data. |
currentDBSizeMB | Total size, in MB, of data stored in the index. The total incudes data in the home, cold and thawed paths. |
defaultDatabase | If no index destination information is available in the input data, the index shown here is the destination of such data. |
disabled | Indicates if the index is disabled. |
enableRealtimeSearch | Indicates if this is a real-time search.
This is a global setting, not a per index setting. |
frozenTimePeriodInSecs | Number of seconds after which indexed data rolls to frozen. Defaults to 188697600 (6 years).
Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation. |
homePath | An absolute path that contains the hot and warm buckets for the index. |
homePath_expanded | An absolute filepath to the hot and warm buckets for the index. |
indexThreads | Number of threads used for indexing.
This is a global setting, not a per index setting. |
isInternal | Indicates if this is an internal index (for example, _internal, _audit). |
lastInitTime | Last time the index processor was successfully initialized.
This is a global setting, not a per index setting. |
maxConcurrentOptimizes | The number of concurrent optimize processes that can run against a hot bucket.
This number should be increased if instructed by Splunk Support. Typically the default value should suffice. |
maxDataSize | The maximum size in MB for a hot DB to reach before a roll to warm is triggered. Specifying "auto" or "auto_high_volume" causes Splunk Enterprise to autotune this parameter (recommended). Use "auto_high_volume" for high volume indexes (such as the main index); otherwise, use "auto". A "high volume index" is typically one that gets over 10GB of data per day.
Although the maximum value you can set this is 1048576 MB, which corresponds to 1 TB, a reasonable number ranges anywhere from 100 - 50000. Any number outside this range should be approved by Splunk Support before proceeding. If you specify an invalid number or string, maxDataSize is auto-tuned. Note: The precise size of your warm buckets may vary from maxDataSize, due to post-processing and timing issues with the rolling policy. |
maxHotBuckets | Maximum hot buckets that can exist per index. Defaults to 3.
When maxHotBuckets is exceeded, Splunk Enterprise rolls the least recently used (LRU) hot bucket to warm. Both normal hot buckets and quarantined hot buckets count towards this total. This setting operates independently of maxHotIdleSecs, which can also cause hot buckets to roll. |
maxHotIdleSecs | Maximum life, in seconds, of a hot bucket. Defaults to 0. A value of 0 turns off the idle check (equivalent to INFINITE idle time).
If a hot bucket exceeds maxHotIdleSecs, Splunk Enterprise rolls it to warm. This setting operates independently of maxHotBuckets, which can also cause hot buckets to roll. |
maxHotSpanSecs | Upper bound of target maximum timespan of hot/warm buckets in seconds. Defaults to 7776000 seconds (90 days).
Note: If set too small, you can get an explosion of hot/warm buckets in the filesystem. The system sets a lower bound implicitly for this parameter at 3600, but this is an advanced parameter that should be set with care and understanding of the characteristics of your data. |
maxMemMB | The amount of memory, in MB, allocated for indexing.
This is a global setting, not a per index setting. |
maxMetaEntries | Sets the maximum number of unique lines in .data files in a bucket, which may help to reduce memory consumption. If set to 0, this setting is ignored (it is treated as infinite).
If exceeded, a hot bucket is rolled to prevent further increase. If your buckets are rolling due to Strings.data hitting this limit, the culprit may be the punct field in your data. If you do not use punct, it may be best to simply disable this (see props.conf.spec in $SPLUNK_HOME/etc/system/README). There is a small time delta between when maximum is exceeded and bucket is rolled. This means a bucket may end up with epsilon more lines than specified, but this is not a major concern unless excess is significant. |
maxRunningProcessGroups | Maximum number of processes that the indexer fires off at a time.
This is a global setting, not a per index setting. |
maxTime | ISO8601 formatted timestamp of the newest event time in the index. |
maxTotalDataSizeMB | The maximum size of an index, in MB. |
maxWarmDBCount | The maximum number of warm buckets. If this number is exceeded, the warm bucket/s with the lowest value for their latest times are moved to cold. |
memPoolMB | Determines how much memory is given to the indexer memory pool.
This is a global setting, not a per-index setting. |
minRawFileSyncSecs | Can be either an integer (or "disable"). Some filesystems are very inefficient at performing sync operations, so only enable this if you are sure it is needed
The integer sets how frequently splunkd forces a filesystem sync while compressing journal slices. During this period, uncompressed slices are left on disk even after they are compressed. Then splunkd forces a filesystem sync of the compressed journal and removes the accumulated uncompressed files. If 0 is specified, splunkd forces a filesystem sync after every slice completes compressing. Specifying "disable" disables syncing entirely: uncompressed slices are removed as soon as compression is complete. |
minTime | ISO8601 formatted timestamp of the oldest event time in the index. |
partialServiceMetaPeriod | Related to serviceMetaPeriod. By default it is turned off (zero).
If set, it enables metadata sync every <integer> seconds, but only for records where the sync can be done efficiently in-place, without requiring a full re-write of the metadata file. Records that require full re-write are be sync'ed at serviceMetaPeriod. partialServiceMetaPeriod specifies, in seconds, how frequently it should sync. Zero means that this feature is turned off and serviceMetaPeriod is the only time when metadata sync happens. If the value of partialServiceMetaPeriod is greater than serviceMetaPeriod, this setting has no effect. |
quarantineFutureSecs | Events with timestamp of quarantineFutureSecs newer than "now" that are dropped into quarantine bucket. Defaults to 2592000 (30 days).
This is a mechanism to prevent main hot buckets from being polluted with fringe events. |
quarantinePastSecs | Events with timestamp of quarantinePastSecs older than "now" are dropped into quarantine bucket. Defaults to 77760000 (900 days).
This is a mechanism to prevent the main hot buckets from being polluted with fringe events. |
rawChunkSizeBytes | Target uncompressed size in bytes for individual raw slice in the rawdata journal of the index. Defaults to 131072 (128KB). 0 is not a valid value. If 0 is specified, rawChunkSizeBytes is set to the default value.
Note: rawChunkSizeBytes only specifies a target chunk size. The actual chunk size may be slightly larger by an amount proportional to an individual event size. Warning: This is an advanced parameter. Only change it if instructed to do so by Splunk Support. |
rotatePeriodInSecs | Rotation period, in seconds, that specifies how frequently to check:
|
serviceMetaPeriod | Defines how frequently metadata is synced to disk, in seconds. Defaults to 25 (seconds).
You may want to set this to a higher value if the sum of your metadata file sizes is larger than many tens of megabytes, to avoid the hit on I/O in the indexing fast path. |
summarize | If true, leaves out certain index details, which provides a faster response. |
suppressBannerList | List of indexes for which we suppress "index missing" warning banner messages.
This is a global setting, not a per index setting. |
sync | Specifies the number of events that trigger the indexer to sync events.
This is a global setting, not a per index setting. |
syncMeta | When true, a sync operation is called before file descriptor is closed on metadata file updates. This functionality improves integrity of metadata files, especially in regards to operating system crashes/machine failures.
Note: Do not change this parameter without the input of Splunk Support. |
thawedPath | An absolute path that contains the thawed (resurrected) databases for the index. |
thawedPath_expanded | Absolute filepath to the thawed (resurrected) databases. |
throttleCheckPeriod | Defines how frequently Splunk Enterprise checks for index throttling condition, in seconds. Defaults to 15 (seconds).
Note: Do not change this parameter without the input of Splunk Support. |
totalEventCount | Total number of events in the index. |
POST data/indexes
method detail
Request parameters
Name | Type | Default | Description |
---|---|---|---|
blockSignSize | Number | 0 | Controls how many events make up a block for block signatures.
If this is set to 0, block signing is disabled for this index. A recommended value is 100. |
bucketRebuildMemoryHint | String | auto | Suggestion for the Splunk Enterprise bucket rebuild process for the size of the time-series (tsidx) file to make.
Caution: This is an advanced parameter. Inappropriate use of this parameter causes splunkd to not start if rebuild is required. Do not set this parameter unless instructed by Splunk Support. Default value,
Values other than "auto" must be 16MB-1GB. Highest legal value (of the numerical part) is 4294967295 You can specify the value using a size suffix: "16777216" or "16MB" are equivalent. |
coldPath | String | An absolute path that contains the colddbs for the index. The path must be readable and writable. Cold databases are opened as needed when searching. May be defined in terms of a volume definition (see volume section below).
Required. Splunk Enterprise does not start if an index lacks a valid coldPath. | |
coldToFrozenDir | String | Destination path for the frozen archive. Use as an alternative to a coldToFrozenScript. Splunk Enterprise automatically puts frozen buckets in this directory.
Bucket freezing policy is as follows:
If both coldToFrozenDir and coldToFrozenScript are specified, coldToFrozenDir takes precedence | |
coldToFrozenScript | String | Path to the archiving script.
If your script requires a program to run it (for example, python), specify the program followed by the path. The script must be in $SPLUNK_HOME/bin or one of its subdirectories. Splunk Enterprise ships with an example archiving script in $SPLUNK_HOME/bin called coldToFrozenExample.py. Splunk DOES NOT recommend using this example script directly. It uses a default path, and if modified in place any changes are overwritten on upgrade. Splunk recommends copying the example script to a new file in bin and modifying it for your system. Most importantly, change the default archive path to an existing directory that fits your needs. If your new script in bin/ is named myColdToFrozen.py, set this key to the following:
By default, the example script has two possible behaviors when archiving:
| |
compressRawdata | Boolean | true | This parameter is ignored. The splunkd process always compresses raw data. |
enableOnlineBucketRepair | Boolean | true | Enables asynchronous "online fsck" bucket repair, which runs concurrently with Splunk.
When enabled, you do not have to wait until buckets are repaired to start Splunk. However, you might observe a slight performance degratation. |
frozenTimePeriodInSecs | Number | 188697600 | Number of seconds after which indexed data rolls to frozen. Defaults to 188697600 (6 years).
Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation. |
homePath | String | An absolute path that contains the hot and warm buckets for the index.
Required. Splunk Enterprise does not start if an index lacks a valid homePath. CAUTION: Path MUST be readable and writable. | |
maxBloomBackfillBucketAge | Number | 30d | Valid values are: Integer[m|s|h|d]
If a warm or cold bucket is older than the specified age, do not create or rebuild its bloomfilter. Specify 0 to never rebuild bloomfilters. For example, if a bucket is older than specified with maxBloomBackfillBucketAge, and the rebuilding of its bloomfilter started but did not finish, do not rebuild it. |
maxConcurrentOptimizes | Number | 6 | The number of concurrent optimize processes that can run against a hot bucket.
This number should be increased if instructed by Splunk Support. Typically the default value should suffice. |
maxDataSize | Number | auto | The maximum size in MB for a hot DB to reach before a roll to warm is triggered. Specifying "auto" or "auto_high_volume" causes Splunk Enterprise to autotune this parameter (recommended).Use "auto_high_volume" for high volume indexes (such as the main index); otherwise, use "auto". A "high volume index" would typically be considered one that gets over 10GB of data per day.
Although the maximum value you can set this is 1048576 MB, which corresponds to 1 TB, a reasonable number ranges anywhere from 100 - 50000. Any number outside this range should be approved by Splunk Support before proceeding. If you specify an invalid number or string, maxDataSize is auto-tuned. Note: The precise size of your warm buckets may vary from maxDataSize, due to post-processing and timing issues with the rolling policy. |
maxHotBuckets | Number | 3 | Maximum hot buckets that can exist per index. Defaults to 3.
When maxHotBuckets is exceeded, Splunk Enterprise rolls the least recently used (LRU) hot bucket to warm. Both normal hot buckets and quarantined hot buckets count towards this total. This setting operates independently of maxHotIdleSecs, which can also cause hot buckets to roll. |
maxHotIdleSecs | Number | 0 | Maximum life, in seconds, of a hot bucket. Defaults to 0.
If a hot bucket exceeds maxHotIdleSecs, Splunk Enterprise rolls it to warm. This setting operates independently of maxHotBuckets, which can also cause hot buckets to roll. A value of 0 turns off the idle check (equivalent to INFINITE idle time). |
maxHotSpanSecs | Number | 7776000 | Upper bound of target maximum timespan of hot/warm buckets in seconds. Defaults to 7776000 seconds (90 days).
Note:I f you set this too small, you can get an explosion of hot/warm buckets in the filesystem. The system sets a lower bound implicitly for this parameter at 3600, but this is an advanced parameter that should be set with care and understanding of the characteristics of your data. |
maxMemMB | Number | 5 | The amount of memory, expressed in MB, to allocate for buffering a single tsidx file into memory before flushing to disk. Defaults to 5. The default is recommended for all environments.
IMPORTANT: Calculate this number carefully. Setting this number incorrectly may have adverse effects on your systems memory and/or splunkd stability/performance. |
maxMetaEntries | Number | 1000000 | Sets the maximum number of unique lines in .data files in a bucket, which may help to reduce memory consumption. If set to 0, this setting is ignored (it is treated as infinite).
If exceeded, a hot bucket is rolled to prevent further increase. If your buckets are rolling due to Strings.data hitting this limit, the culprit may be the There is a small time delta between when maximum is exceeded and bucket is rolled. This means a bucket may end up with epsilon more lines than specified, but this is not a major concern unless excess is significant. |
maxTimeUnreplicatedNoAcks | Number | 300 | Upper limit, in seconds, on how long an event can sit in raw slice. Applies only if replication is enabled for this index. Otherwise ignored.
If there are any acknowledged events sharing this raw slice, this paramater does not apply. In this case, maxTimeUnreplicatedWithAcks applies. Highest legal value is 2147483647. To disable this parameter, set to 0. Note: this is an advanced parameter. Understand the consequences before changing. |
maxTimeUnreplicatedWithAcks | Number | 60 | Upper limit, in seconds, on how long events can sit unacknowledged in a raw slice. Applies only if you have enabled acks on forwarders and have replication enabled (with clustering).
Note: This is an advanced parameter. Make sure you understand the settings on all forwarders before changing this. This number should not exceed ack timeout configured on any forwarder, and should actually be set to at most half of the minimum value of that timeout. You can find this setting in outputs.conf readTimeout setting under the tcpout stanza. To disable, set to 0, but this is NOT recommended. Highest legal value is 2147483647. |
maxTotalDataSizeMB | Number | 500000 | The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. |
maxWarmDBCount | Number | 300 | The maximum number of warm buckets. If this number is exceeded, the warm bucket/s with the lowest value for their latest times is moved to cold. |
minRawFileSyncSecs | Number | disable | Specify an integer (or "disable") for this parameter.
This parameter sets how frequently splunkd forces a filesystem sync while compressing journal slices. During this period, uncompressed slices are left on disk even after they are compressed. Then splunkd forces a filesystem sync of the compressed journal and removes the accumulated uncompressed files. If 0 is specified, splunkd forces a filesystem sync after every slice completes compressing. Specifying "disable" disables syncing entirely: uncompressed slices are removed as soon as compression is complete. Note: Some filesystems are very inefficient at performing sync operations, so only enable this if you are sure it is needed |
minStreamGroupQueueSize | Number | 2000 | Minimum size of the queue that stores events in memory before committing them to a tsidx file.
Caution: Do not set this value, except under advice from Splunk Support. |
name required |
String | The name of the index to create. | |
partialServiceMetaPeriod | Number | 0 | Related to serviceMetaPeriod. If set, it enables metadata sync every <integer> seconds, but only for records where the sync can be done efficiently in-place, without requiring a full re-write of the metadata file. Records that require full re-write are be sync'ed at serviceMetaPeriod.
If the value of partialServiceMetaPeriod is greater than serviceMetaPeriod, this setting has no effect. By default it is turned off (zero). |
processTrackerServiceInterval | Number | 1 | Specifies, in seconds, how often the indexer checks the status of the child OS processes it launched to see if it can launch new processes for queued requests. Defaults to 15.
If set to 0, the indexer checks child process status every second. Highest legal value is 4294967295. |
quarantineFutureSecs | Number | 2592000 | Events with timestamp of quarantineFutureSecs newer than "now" are dropped into quarantine bucket. Defaults to 2592000 (30 days).
This is a mechanism to prevent main hot buckets from being polluted with fringe events. |
quarantinePastSecs | Number | 77760000 | Events with timestamp of quarantinePastSecs older than "now" are dropped into quarantine bucket. Defaults to 77760000 (900 days).
This is a mechanism to prevent the main hot buckets from being polluted with fringe events. |
rawChunkSizeBytes | Number | 131072 | Target uncompressed size in bytes for individual raw slice in the rawdata journal of the index. Defaults to 131072 (128KB). 0 is not a valid value. If 0 is specified, rawChunkSizeBytes is set to the default value.
Note: rawChunkSizeBytes only specifies a target chunk size. The actual chunk size may be slightly larger by an amount proportional to an individual event size. WARNING: This is an advanced parameter. Only change it if you are instructed to do so by Splunk Support. |
repFactor | String | 0 | Index replication control. This parameter applies to only Splunk Enterprise clustering slaves.
|
rotatePeriodInSecs | Number | 60 | How frequently (in seconds) to check if a new hot bucket needs to be created. Also, how frequently to check if there are any warm/cold buckets that should be rolled/frozen. |
serviceMetaPeriod | Number | 25 | Defines how frequently metadata is synced to disk, in seconds. Defaults to 25 (seconds).
You may want to set this to a higher value if the sum of your metadata file sizes is larger than many tens of megabytes, to avoid the hit on I/O in the indexing fast path. |
syncMeta | Boolean | true | When true , a sync operation is called before file descriptor is closed on metadata file updates. This functionality improves integrity of metadata files, especially in regards to operating system crashes/machine failures.
Note: Do not change this parameter without the input of a Splunk Support. |
thawedPath | String | An absolute path that contains the thawed (resurrected) databases for the index.
Cannot be defined in terms of a volume definition. Required. Splunk Enterprise does not start if an index lacks a valid
| |
throttleCheckPeriod | Number | 15 | Defines how frequently Splunk Enterprise checks for index throttling condition, in seconds. Defaults to 15 (seconds).
Note: Do not change this parameter without the input of Splunk Support. |
tstatsHomePath | String | Location to store datamodel acceleration TSIDX data for this index. Restart splunkd after changing this parameter.
If specified, it must be defined in terms of a volume definition. Caution: Path must be writable. Default value: volume:_splunk_summaries/$_index_name/tstats | |
warmToColdScript | String | Path to a script to run when moving data from warm to cold.
This attribute is supported for backwards compatibility with Splunk Enterprise versions older than 4.0. Contact Splunk support if you need help configuring this setting. Caution: Migrating data across filesystems is now handled natively by splunkd. If you specify a script here, the script becomes responsible for moving the event data, and Splunk-native data migration is not used. |
Response data keys
Name | Description |
---|---|
assureUTF8 | Boolean value indicating wheter all data retreived from the index is proper UTF8.
If enabled (set to True), degrades indexing performance Can only be set globally. |
blockSignSize | Controls how many events make up a block for block signatures.
If this is set to 0, block signing is disabled for this index. A recommended value is 100. |
blockSignatureDatabase | The index that stores block signatures of events.
This is a global setting, not a per index setting. |
bucketRebuildMemoryHint | Suggestion for the Splunk Enterprise bucket rebuild process for the size of the time-series (tsidx) file to make. |
coldPath | Filepath to the cold databases for the index. |
coldPath_expanded | Absoute filepath to the cold databases. |
coldToFrozenDir | Destination path for the frozen archive. Used as an alternative to a coldToFrozenScript. Splunk Enterprise automatically puts frozen buckets in this directory.
Bucket freezing policy is as follows:
If both coldToFrozenDir and coldToFrozenScript are specified, coldToFrozenDir takes precedence. |
coldToFrozenScript | Path to the archiving script.
See the POST parameter description for details. |
compressRawdata | This value is ignored. splunkd process always compresses raw data. |
currentDBSizeMB | Total size, in MB, of data stored in the index. The total incudes data in the home, cold and thawed paths. |
defaultDatabase | If no index destination information is available in the input data, the index shown here is the destination of such data. |
enableOnlineBucketRepair | Indicates whether to run asynchronous "online fsck" bucket repair, which runs in a process concurrently with Splunk. |
enableRealtimeSearch | Indicates if this is a real-time search.
This is a global setting, not a per index setting. |
frozenTimePeriodInSecs | Number of seconds after which indexed data rolls to frozen. Defaults to 188697600 (6 years).
Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation. |
homePath | An absolute path that contains the hot and warm buckets for the index. |
homePath_expanded | An absolute filepath to the hot and warm buckets for the index. |
indexThreads | Number of threads used for indexing.
This is a global setting, not a per index setting. |
isInternal | Indicates if this is an internal index (for example, _internal, _audit). |
lastInitTime | Last time the index processor was successfully initialized.
This is a global setting, not a per index setting. |
maxBloomBackfillBucketAge | If a bucket (warm or cold) is older than this, Splunk Enterprise does not create (or re-create) its bloom filter. |
maxConcurrentOptimizes | The number of concurrent optimize processes that can run against a hot bucket.
This number should be increased if instructed by Splunk Support. Typically the default value should suffice. |
maxDataSize | The maximum size in MB for a hot DB to reach before a roll to warm is triggered. Specifying "auto" or "auto_high_volume" causes Splunk Enterprise to autotune this parameter (recommended). Use "auto_high_volume" for high volume indexes (such as the main index); otherwise, use "auto". A "high volume index" is typically one that gets over 10GB of data per day.
Although the maximum value you can set this is 1048576 MB, which corresponds to 1 TB, a reasonable number ranges anywhere from 100 - 50000. Any number outside this range should be approved by Splunk Support before proceeding. If you specify an invalid number or string, maxDataSize is auto-tuned. Note: The precise size of your warm buckets may vary from maxDataSize, due to post-processing and timing issues with the rolling policy. |
maxHotBuckets | Maximum hot buckets that can exist per index. Defaults to 3.
When maxHotBuckets is exceeded, Splunk Enterprise rolls the least recently used (LRU) hot bucket to warm. Both normal hot buckets and quarantined hot buckets count towards this total. This setting operates independently of maxHotIdleSecs, which can also cause hot buckets to roll. |
maxHotIdleSecs | Maximum life, in seconds, of a hot bucket. Defaults to 0. A value of 0 turns off the idle check (equivalent to INFINITE idle time).
If a hot bucket exceeds maxHotIdleSecs, Splunk Enterprise rolls it to warm. This setting operates independently of maxHotBuckets, which can also cause hot buckets to roll. |
maxHotSpanSecs | Upper bound of target maximum timespan of hot/warm buckets in seconds. Defaults to 7776000 seconds (90 days).
Note: If set too small, you can get an explosion of hot/warm buckets in the filesystem. The system sets a lower bound implicitly for this parameter at 3600, but this is an advanced parameter that should be set with care and understanding of the characteristics of your data. |
maxMemMB | The amount of memory, in MB, allocated for indexing.
This is a global setting, not a per index setting. |
maxMetaEntries | Sets the maximum number of unique lines in .data files in a bucket, which may help to reduce memory consumption. If set to 0, this setting is ignored (it is treated as infinite).
If exceeded, a hot bucket is rolled to prevent further increase. If your buckets are rolling due to Strings.data hitting this limit, the culprit may be the punct field in your data. If you do not use punct, it may be best to simply disable this (see props.conf.spec in $SPLUNK_HOME/etc/system/README). There is a small time delta between when maximum is exceeded and bucket is rolled. This means a bucket may end up with epsilon more lines than specified, but this is not a major concern unless excess is significant. |
maxTime | ISO8601 timestamp of the newest event time in the index. |
maxTimeUnreplicatedNoAcks | Upper limit, in seconds, on how long an event can sit in raw slice. Applies only if replication is enabled for this index. Otherwise ignored.
If there are any acknowledged events sharing this raw slice, this paramater does not apply. In this case, maxTimeUnreplicatedWithAcks applies. Highest legal value is 2147483647. To disable this parameter, set to 0. Note: this is an advanced parameter. Understand the consequences before changing. |
maxTimeUnreplicatedWithAcks | Upper limit, in seconds, on how long events can sit unacknowledged in a raw slice. Applies only if you have enabled acks on forwarders and have replication enabled (with clustering).
Note: This is an advanced parameter. Make sure you understand the settings on all forwarders before changing this. This number should not exceed ack timeout configured on any forwarder, and should actually be set to at most half of the minimum value of that timeout. You can find this setting in outputs.conf readTimeout setting under the tcpout stanza. To disable, set to 0, but this is NOT recommended. Highest legal value is 2147483647. |
maxTotalDataSizeMB | The maximum size of an index, in MB. |
maxWarmDBCount | The maximum number of warm buckets. If this number is exceeded, the warm bucket/s with the lowest value for their latest times are moved to cold. |
memPoolMB | Determines how much memory is given to the indexer memory pool.
This is a global setting, not a per-index setting. |
minRawFileSyncSecs | Can be either an integer (or "disable"). Some filesystems are very inefficient at performing sync operations, so only enable this if you are sure it is needed
The integer sets how frequently splunkd forces a filesystem sync while compressing journal slices. During this period, uncompressed slices are left on disk even after they are compressed. Then splunkd forces a filesystem sync of the compressed journal and removes the accumulated uncompressed files. If 0 is specified, splunkd forces a filesystem sync after every slice completes compressing. Specifying "disable" disables syncing entirely: uncompressed slices are removed as soon as compression is complete. |
minStreamGroupQueueSize | Minimum size of the queue that stores events in memory before committing them to a tsidx file. |
minTime | ISO8601 timestamp of the oldest event time in the index. |
partialServiceMetaPeriod | Related to serviceMetaPeriod. By default it is turned off (zero).
If set, it enables metadata sync every <integer> seconds, but only for records where the sync can be done efficiently in-place, without requiring a full re-write of the metadata file. Records that require full re-write are be sync'ed at serviceMetaPeriod. partialServiceMetaPeriod specifies, in seconds, how frequently it should sync. Zero means that this feature is turned off and serviceMetaPeriod is the only time when metadata sync happens. If the value of partialServiceMetaPeriod is greater than serviceMetaPeriod, this setting has no effect. |
processTrackerServiceInterval | How often, in seconds, the indexer checks the status of the child OS processes it launched to see if it can launch new processes for queued requests. |
quarantineFutureSecs | Events with timestamp of quarantineFutureSecs newer than "now" are dropped into quarantine bucket. Defaults to 2592000 (30 days).
This is a mechanism to prevent main hot buckets from being polluted with fringe events. |
quarantinePastSecs | Events with timestamp of quarantinePastSecs older than "now" are dropped into quarantine bucket. Defaults to 77760000 (900 days).
This is a mechanism to prevent the main hot buckets from being polluted with fringe events. |
rawChunkSizeBytes | Target uncompressed size in bytes for individual raw slice in the rawdata journal of the index. Defaults to 131072 (128KB). 0 is not a valid value. If 0 is specified, rawChunkSizeBytes is set to the default value.
Note: rawChunkSizeBytes only specifies a target chunk size. The actual chunk size may be slightly larger by an amount proportional to an individual event size. Warning: This is an advanced parameter. Only change it if instructed to do so by Splunk Support. |
repFactor | Index replication control. This parameter applies to only Splunk Enterprise clustering slaves.
|
rotatePeriodInSecs | Rotation period, in seconds, that specifies how frequently to check:
|
serviceMetaPeriod | Defines how frequently metadata is synced to disk, in seconds. Defaults to 25 (seconds).
You may want to set this to a higher value if the sum of your metadata file sizes is larger than many tens of megabytes, to avoid the hit on I/O in the indexing fast path. |
suppressBannerList | List of indexes for which we suppress "index missing" warning banner messages.
This is a global setting, not a per index setting. |
sync | Specifies the number of events that trigger the indexer to sync events.
This is a global setting, not a per index setting. |
syncMeta | When true, a sync operation is called before file descriptor is closed on metadata file updates. This functionality improves integrity of metadata files, especially in regards to operating system crashes/machine failures.
Note: Do not change this parameter without the input of Splunk Support. |
thawedPath | Filepath to the thawed (resurrected) databases for the index. |
thawedPath_expanded | Absolute filepath to the thawed (resurrected) databases. |
throttleCheckPeriod | Defines how frequently Splunk Enterprise checks for index throttling condition, in seconds. Defaults to 15 (seconds).
Note: Do not change this parameter without the input of Splunk Support. |
totalEventCount | Total number of events in the index. |
tstatsHomePath | Location where datamodel acceleration TSIDX data for this index is stored. |
warmToColdScript | Script to run when moving data from warm to cold. See input parameter description for details. |
[ Top ]
data/indexes/{name}
https://<host>:<mPort>/services/data/indexes/{name}
Description
Manage {name} index.
Method summary
Method | Description | Formats |
---|---|---|
DELETE | Removes the index specified by {name} (not just the data contained in it). | XML, JSON |
GET | Retrieves information about the named index. | XML, JSON |
POST | Updates the data index specified by {name} with information specified with index attributes. | XML, JSON |
DELETE data/indexes/{name}
method detail
Request parameters
None
Response data keys
None
Application usage
Before executing this operation, look through all inputs.conf files (on your indexer and on any forwarders sending data to the indexer) and make sure that none of the stanzas are directing data to the index you plan to delete.
In other words, if you want to delete an index called "nogood," make sure the attribute/value pair index=nogood does not appear in any input stanzas. Once the index is deleted, Splunk Enterprise discards any data sent to that index.
For information on deleting indexes and deleting data from indexes, refer to Remove data from Splunk Enterprise in the Splunk Managing Indexers and Clusters manual.
The method returns HTTP status code = 409, if {name} was disabled but Splunk Enterprise was not restarted. Restart Splunk Enterprise and try again.
GET data/indexes/{name}
method detail
Request parameters
Name | Type | Default | Description |
---|---|---|---|
summarize | Boolean | false |
[Optional] Response type:
|
Response data keys
Name | Description |
---|---|
assureUTF8 | Indicates whether all data retreived from the index is proper UTF8. If enabled (set to True), degrades indexing performance.
This is a global setting, not a per index setting. |
blockSignSize | Controls how many events make up a block for block signatures.
If this is set to 0, block signing is disabled for this index. A recommended value is 100. |
blockSignatureDatabase | The index that stores block signatures of events.
This is a global setting, not a per index setting. |
bloomfilterTotalSizeKB | Total size of all bloom filter files, in KB. |
coldPath | Filepath to the cold databases for the index. |
coldPath_expanded | Absoute filepath to the cold databases. |
coldToFrozenDir | Destination path for the frozen archive. Used as an alternative to a coldToFrozenScript. Splunk Enterprise automatically puts frozen buckets in this directory.
Bucket freezing policy is as follows:
If both coldToFrozenDir and coldToFrozenScript are specified, coldToFrozenDir takes precedence. |
coldToFrozenScript | Path to the archiving script.
See the POST parameter description for details. |
compressRawdata | This value is ignored. splunkd process always compresses raw data. |
currentDBSizeMB | Total size, in MB, of data stored in the index. The total incudes data in the home, cold and thawed paths. |
defaultDatabase | If no index destination information is available in the input data, the index shown here is the destination of such data. |
disabled | Indicates if the index is disabled. |
enableRealtimeSearch | Indicates if this is a real-time search.
This is a global setting, not a per index setting. |
frozenTimePeriodInSecs | Number of seconds after which indexed data rolls to frozen. Defaults to 188697600 (6 years).
Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation. |
homePath | An absolute path that contains the hot and warm buckets for the index. |
homePath_expanded | An absolute filepath to the hot and warm buckets for the index. |
indexThreads | Number of threads used for indexing.
This is a global setting, not a per index setting. |
isInternal | Indicates if this is an internal index (for example, _internal, _audit). |
lastInitTime | Last time the index processor was successfully initialized.
This is a global setting, not a per index setting. |
maxConcurrentOptimizes | The number of concurrent optimize processes that can run against a hot bucket.
This number should be increased if instructed by Splunk Support. Typically the default value should suffice. |
maxDataSize | The maximum size in MB for a hot DB to reach before a roll to warm is triggered. Specifying "auto" or "auto_high_volume" causes Splunk Enterprise to autotune this parameter (recommended). Use "auto_high_volume" for high volume indexes (such as the main index); otherwise, use "auto". A "high volume index" is typically one that gets over 10GB of data per day.
Although the maximum value you can set this is 1048576 MB, which corresponds to 1 TB, a reasonable number ranges anywhere from 100 - 50000. Any number outside this range should be approved by Splunk Support before proceeding. If you specify an invalid number or string, maxDataSize is auto-tuned. Note: The precise size of your warm buckets may vary from maxDataSize, due to post-processing and timing issues with the rolling policy. |
maxHotBuckets | Maximum hot buckets that can exist per index. Defaults to 3.
When maxHotBuckets is exceeded, Splunk Enterprise rolls the least recently used (LRU) hot bucket to warm. Both normal hot buckets and quarantined hot buckets count towards this total. This setting operates independently of maxHotIdleSecs, which can also cause hot buckets to roll. |
maxHotIdleSecs | Maximum life, in seconds, of a hot bucket. Defaults to 0. A value of 0 turns off the idle check (equivalent to INFINITE idle time).
If a hot bucket exceeds maxHotIdleSecs, Splunk Enterprise rolls it to warm. This setting operates independently of maxHotBuckets, which can also cause hot buckets to roll. |
maxHotSpanSecs | Upper bound of target maximum timespan of hot/warm buckets in seconds. Defaults to 7776000 seconds (90 days).
Note: If set too small, you can get an explosion of hot/warm buckets in the filesystem. The system sets a lower bound implicitly for this parameter at 3600, but this is an advanced parameter that should be set with care and understanding of the characteristics of your data. |
maxMemMB | The amount of memory, in MB, allocated for indexing.
This is a global setting, not a per index setting. |
maxMetaEntries | Sets the maximum number of unique lines in .data files in a bucket, which may help to reduce memory consumption. If set to 0, this setting is ignored (it is treated as infinite).
If exceeded, a hot bucket is rolled to prevent further increase. If your buckets are rolling due to Strings.data hitting this limit, the culprit may be the punct field in your data. If you do not use punct, it may be best to simply disable this (see props.conf.spec in $SPLUNK_HOME/etc/system/README). There is a small time delta between when maximum is exceeded and bucket is rolled. This means a bucket may end up with epsilon more lines than specified, but this is not a major concern unless excess is significant. |
maxRunningProcessGroups | Maximum number of processes that the indexer fires off at a time.
This is a global setting, not a per index setting. |
maxTime | Timestamp of the newest event time in the index. |
maxTotalDataSizeMB | The maximum size of an index, in MB. |
maxWarmDBCount | Maximum number of warm buckets. |
memPoolMB | Determines how much memory is given to the indexer memory pool.
This is a global setting, not a per-index setting. |
minRawFileSyncSecs | Can be either an integer (or "disable"). Some filesystems are very inefficient at performing sync operations, so only enable this if you are sure it is needed
The integer sets how frequently splunkd forces a filesystem sync while compressing journal slices. During this period, uncompressed slices are left on disk even after they are compressed. Then splunkd forces a filesystem sync of the compressed journal and removes the accumulated uncompressed files. If 0 is specified, splunkd forces a filesystem sync after every slice completes compressing. Specifying "disable" disables syncing entirely: uncompressed slices are removed as soon as compression is complete. |
minTime | Timestamp of the oldest event time in the index. |
numBloomfilters | The number of bloom filters created for this index. |
numHotBuckets | The number of hot buckets created for this index. |
numWarmBuckets | The number of warm buckets created for this index. |
partialServiceMetaPeriod | Related to serviceMetaPeriod. By default it is turned off (zero).
If set, it enables metadata sync every <integer> seconds, but only for records where the sync can be done efficiently in-place, without requiring a full re-write of the metadata file. Records that require full re-write are be sync'ed at serviceMetaPeriod. partialServiceMetaPeriod specifies, in seconds, how frequently it should sync. Zero means that this feature is turned off and serviceMetaPeriod is the only time when metadata sync happens. If the value of partialServiceMetaPeriod is greater than serviceMetaPeriod, this setting has no effect. |
quarantineFutureSecs | Events with timestamp of quarantineFutureSecs newer than "now" that are dropped into quarantine bucket. Defaults to 2592000 (30 days).
This is a mechanism to prevent main hot buckets from being polluted with fringe events. |
quarantinePastSecs | Events with timestamp of quarantinePastSecs older than "now" are dropped into quarantine bucket. Defaults to 77760000 (900 days).
This is a mechanism to prevent the main hot buckets from being polluted with fringe events. |
rawChunkSizeBytes | Target uncompressed size in bytes for individual raw slice in the rawdata journal of the index. Defaults to 131072 (128KB). 0 is not a valid value. If 0 is specified, rawChunkSizeBytes is set to the default value.
Note: rawChunkSizeBytes only specifies a target chunk size. The actual chunk size may be slightly larger by an amount proportional to an individual event size. Warning: This is an advanced parameter. Only change it if instructed to do so by Splunk Support. |
rotatePeriodInSecs | Rotation period, in seconds, that specifies how frequently to check:
|
serviceMetaPeriod | Defines how frequently metadata is synced to disk, in seconds. Defaults to 25 (seconds).
You may want to set this to a higher value if the sum of your metadata file sizes is larger than many tens of megabytes, to avoid the hit on I/O in the indexing fast path. |
summarize | If true, leaves out certain index details, which provides a faster response. |
suppressBannerList | List of indexes for which we suppress "index missing" warning banner messages.
This is a global setting, not a per index setting. |
sync | Specifies the number of events that trigger the indexer to sync events.
This is a global setting, not a per index setting. |
syncMeta | When true, a sync operation is called before file descriptor is closed on metadata file updates. This functionality improves integrity of metadata files, especially in regards to operating system crashes/machine failures.
Note: Do not change this parameter without the input of Splunk Support. |
thawedPath | An absolute path that contains the thawed (resurrected) databases for the index. |
thawedPath_expanded | Absolute filepath to the thawed (resurrected) databases. |
throttleCheckPeriod | Defines how frequently Splunk Enterprise checks for index throttling condition, in seconds. Defaults to 15 (seconds).
Note: Do not change this parameter without the input of Splunk Support. |
totalEventCount | Total number of events in the index. |
POST data/indexes/{name}
method detail
Request parameters
Name | Type | Default | Description |
---|---|---|---|
blockSignSize | Number | 0 | Controls how many events make up a block for block signatures.
If this is set to 0, block signing is disabled for this index. A recommended value is 100. |
bucketRebuildMemoryHint | String | auto | Suggestion for the Splunk Enterprise bucket rebuild process for the size of the time-series (tsidx) file to make.
Caution: This is an advanced parameter. Inappropriate use of this parameter causes splunkd to not start if rebuild is required. Do not set this parameter unless instructed by Splunk Support. Default value,
Values other than "auto" must be 16MB-1GB. Highest legal value (of the numerical part) is 4294967295 You can specify the value using a size suffix: "16777216" or "16MB" are equivalent. |
coldToFrozenDir | String | Destination path for the frozen archive. Use as an alternative to a coldToFrozenScript. Splunk Enterprise automatically puts frozen buckets in this directory.
Bucket freezing policy is as follows:
If both coldToFrozenDir and coldToFrozenScript are specified, coldToFrozenDir takes precedence | |
coldToFrozenScript | String | Path to the archiving script.
If your script requires a program to run it (for example, python), specify the program followed by the path. The script must be in $SPLUNK_HOME/bin or one of its subdirectories. Splunk Enterprise ships with an example archiving script in $SPLUNK_HOME/bin called coldToFrozenExample.py. Splunk DOES NOT recommend using this example script directly. It uses a default path, and if modified in place any changes are overwritten on upgrade. Splunk recommends copying the example script to a new file in bin and modifying it for your system. Most importantly, change the default archive path to an existing directory that fits your needs. If your new script in bin/ is named myColdToFrozen.py, set this key to the following:
By default, the example script has two possible behaviors when archiving:
| |
compressRawdata | Boolean | true | This parameter is ignored. The splunkd process always compresses raw data. |
enableOnlineBucketRepair | Boolean | true | Enables asynchronous "online fsck" bucket repair, which runs concurrently with Splunk.
When enabled, you do not have to wait until buckets are repaired to start Splunk. However, you might observe a slight performance degratation. |
frozenTimePeriodInSecs | Number | 188697600 | Number of seconds after which indexed data rolls to frozen. Defaults to 188697600 (6 years).
Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation. |
maxBloomBackfillBucketAge | Number | 30d | Valid values are: Integer[m|s|h|d]
If a warm or cold bucket is older than the specified age, do not create or rebuild its bloomfilter. Specify 0 to never rebuild bloomfilters. For example, if a bucket is older than specified with maxBloomBackfillBucketAge, and the rebuilding of its bloomfilter started but did not finish, do not rebuild it. |
maxConcurrentOptimizes | Number | 6 | The number of concurrent optimize processes that can run against a hot bucket.
This number should be increased if instructed by Splunk Support. Typically the default value should suffice. |
maxDataSize | Number | auto | The maximum size in MB for a hot DB to reach before a roll to warm is triggered. Specifying "auto" or "auto_high_volume" causes Splunk Enterprise to autotune this parameter (recommended).Use "auto_high_volume" for high volume indexes (such as the main index); otherwise, use "auto". A "high volume index" would typically be considered one that gets over 10GB of data per day.
Although the maximum value you can set this is 1048576 MB, which corresponds to 1 TB, a reasonable number ranges anywhere from 100 - 50000. Any number outside this range should be approved by Splunk Support before proceeding. If you specify an invalid number or string, maxDataSize is auto-tuned. Note: The precise size of your warm buckets may vary from maxDataSize, due to post-processing and timing issues with the rolling policy. |
maxHotBuckets | Number | 3 | Maximum hot buckets that can exist per index. Defaults to 3.
When maxHotBuckets is exceeded, Splunk Enterprise rolls the least recently used (LRU) hot bucket to warm. Both normal hot buckets and quarantined hot buckets count towards this total. This setting operates independently of maxHotIdleSecs, which can also cause hot buckets to roll. |
maxHotIdleSecs | Number | 0 | Maximum life, in seconds, of a hot bucket. Defaults to 0.
If a hot bucket exceeds maxHotIdleSecs, Splunk Enterprise rolls it to warm. This setting operates independently of maxHotBuckets, which can also cause hot buckets to roll. A value of 0 turns off the idle check (equivalent to INFINITE idle time). |
maxHotSpanSecs | Number | 7776000 | Upper bound of target maximum timespan of hot/warm buckets in seconds. Defaults to 7776000 seconds (90 days).
Note:I f you set this too small, you can get an explosion of hot/warm buckets in the filesystem. The system sets a lower bound implicitly for this parameter at 3600, but this is an advanced parameter that should be set with care and understanding of the characteristics of your data. |
maxMemMB | Number | 5 | The amount of memory, expressed in MB, to allocate for buffering a single tsidx file into memory before flushing to disk. Defaults to 5. The default is recommended for all environments.
IMPORTANT: Calculate this number carefully. Setting this number incorrectly may have adverse effects on your systems memory and/or splunkd stability/performance. |
maxMetaEntries | Number | 1000000 | Sets the maximum number of unique lines in .data files in a bucket, which may help to reduce memory consumption. If set to 0, this setting is ignored (it is treated as infinite).
If exceeded, a hot bucket is rolled to prevent further increase. If your buckets are rolling due to Strings.data hitting this limit, the culprit may be the There is a small time delta between when maximum is exceeded and bucket is rolled. This means a bucket may end up with epsilon more lines than specified, but this is not a major concern unless excess is significant. |
maxTimeUnreplicatedNoAcks | Number | 300 | Upper limit, in seconds, on how long an event can sit in raw slice. Applies only if replication is enabled for this index. Otherwise ignored.
If there are any acknowledged events sharing this raw slice, this paramater does not apply. In this case, maxTimeUnreplicatedWithAcks applies. Highest legal value is 2147483647. To disable this parameter, set to 0. Note: this is an advanced parameter. Understand the consequences before changing. |
maxTimeUnreplicatedWithAcks | Number | 60 | Upper limit, in seconds, on how long events can sit unacknowledged in a raw slice. Applies only if you have enabled acks on forwarders and have replication enabled (with clustering).
Note: This is an advanced parameter. Make sure you understand the settings on all forwarders before changing this. This number should not exceed ack timeout configured on any forwarder, and should actually be set to at most half of the minimum value of that timeout. You can find this setting in outputs.conf readTimeout setting under the tcpout stanza. To disable, set to 0, but this is NOT recommended. Highest legal value is 2147483647. |
maxTotalDataSizeMB | Number | 500000 | The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen. |
maxWarmDBCount | Number | 300 | The maximum number of warm buckets. If this number is exceeded, the warm bucket/s with the lowest value for their latest times are moved to cold. |
minRawFileSyncSecs | Number | disable | Specify an integer (or "disable") for this parameter.
This parameter sets how frequently splunkd forces a filesystem sync while compressing journal slices. During this period, uncompressed slices are left on disk even after they are compressed. Then splunkd forces a filesystem sync of the compressed journal and removes the accumulated uncompressed files. If 0 is specified, splunkd forces a filesystem sync after every slice completes compressing. Specifying "disable" disables syncing entirely: uncompressed slices are removed as soon as compression is complete. Note: Some filesystems are very inefficient at performing sync operations, so only enable this if you are sure it is needed |
minStreamGroupQueueSize | Number | 2000 | Minimum size of the queue that stores events in memory before committing them to a tsidx file.
Caution: Do not set this value, except under advice from Splunk Support. |
partialServiceMetaPeriod | Number | 0 | Related to serviceMetaPeriod. If set, it enables metadata sync every <integer> seconds, but only for records where the sync can be done efficiently in-place, without requiring a full re-write of the metadata file. Records that require full re-write are be sync'ed at serviceMetaPeriod.
If the value of partialServiceMetaPeriod is greater than serviceMetaPeriod, this setting has no effect. By default it is turned off (zero). |
processTrackerServiceInterval | Number | 1 | Specifies, in seconds, how often the indexer checks the status of the child OS processes it launched to see if it can launch new processes for queued requests. Defaults to 15.
If set to 0, the indexer checks child process status every second. Highest legal value is 4294967295. |
quarantineFutureSecs | Number | 2592000 | Events with timestamp of quarantineFutureSecs newer than "now" are dropped into quarantine bucket. Defaults to 2592000 (30 days).
This is a mechanism to prevent main hot buckets from being polluted with fringe events. |
quarantinePastSecs | Number | 77760000 | Events with timestamp of quarantinePastSecs older than "now" are dropped into quarantine bucket. Defaults to 77760000 (900 days).
This is a mechanism to prevent the main hot buckets from being polluted with fringe events. |
rawChunkSizeBytes | Number | 131072 | Target uncompressed size in bytes for individual raw slice in the rawdata journal of the index. Defaults to 131072 (128KB). 0 is not a valid value. If 0 is specified, rawChunkSizeBytes is set to the default value.
Note: rawChunkSizeBytes only specifies a target chunk size. The actual chunk size may be slightly larger by an amount proportional to an individual event size. WARNING: This is an advanced parameter. Only change it if you are instructed to do so by Splunk Support. |
repFactor | String | 0 | Index replication control. This parameter applies to only Splunk Enterprise clustering slaves.
|
rotatePeriodInSecs | Number | 60 | How frequently (in seconds) to check if a new hot bucket needs to be created. Also, how frequently to check if there are any warm/cold buckets that should be rolled/frozen. |
serviceMetaPeriod | Number | 25 | Defines how frequently metadata is synced to disk, in seconds. Defaults to 25 (seconds).
You may want to set this to a higher value if the sum of your metadata file sizes is larger than many tens of megabytes, to avoid the hit on I/O in the indexing fast path. |
syncMeta | Boolean | true | When true , a sync operation is called before file descriptor is closed on metadata file updates. This functionality improves integrity of metadata files, especially in regards to operating system crashes/machine failures.
Note: Do not change this parameter without the input of a Splunk Support. |
throttleCheckPeriod | Number | 15 | Defines how frequently Splunk Enterprise checks for index throttling condition, in seconds. Defaults to 15 (seconds).
Note: Do not change this parameter without the input of Splunk Support. |
tstatsHomePath | String | Location to store datamodel acceleration TSIDX data for this index. Restart splunkd after changing this parameter.
If specified, it must be defined in terms of a volume definition. Caution: Path must be writable. Default value: volume:_splunk_summaries/$_index_name/tstats | |
warmToColdScript | String | Path to a script to run when moving data from warm to cold.
This attribute is supported for backwards compatibility with Splunk Enterprise versions older than 4.0. Contact Splunk support if you need help configuring this setting. Caution: Migrating data across filesystems is now handled natively by splunkd. If you specify a script here, the script becomes responsible for moving the event data, and Splunk-native data migration are not used. |
Response data keys
Name | Description |
---|---|
assureUTF8 | Boolean value indicating wheter all data retreived from the index is proper UTF8.
If enabled (set to True), degrades indexing performance Can only be set globally. |
blockSignSize | Controls how many events make up a block for block signatures.
If this is set to 0, block signing is disabled for this index. A recommended value is 100. |
blockSignatureDatabase | The index that stores block signatures of events.
This is a global setting, not a per index setting. |
bucketRebuildMemoryHint | Suggestion for the Splunk Enterprise bucket rebuild process for the size of the time-series (tsidx) file to make. |
coldPath | Filepath to the cold databases for the index. |
coldPath_expanded | Absoute filepath to the cold databases. |
coldToFrozenDir | Destination path for the frozen archive. Used as an alternative to a coldToFrozenScript. Splunk Enterprise automatically puts frozen buckets in this directory.
Bucket freezing policy is as follows:
If both coldToFrozenDir and coldToFrozenScript are specified, coldToFrozenDir takes precedence. |
coldToFrozenScript | Path to the archiving script.
See the POST parameter description for details. |
compressRawdata | This value is ignored. splunkd process always compresses raw data. |
currentDBSizeMB | Total size, in MB, of data stored in the index. The total incudes data in the home, cold and thawed paths. |
defaultDatabase | If no index destination information is available in the input data, the index shown here is the destination of such data. |
enableOnlineBucketRepair | Indicates whether to run asynchronous "online fsck" bucket repair, which runs in a process concurrently with Splunk. |
enableRealtimeSearch | Indicates if this is a real-time search.
This is a global setting, not a per index setting. |
frozenTimePeriodInSecs | Number of seconds after which indexed data rolls to frozen. Defaults to 188697600 (6 years).
Freezing data means it is removed from the index. If you need to archive your data, refer to coldToFrozenDir and coldToFrozenScript parameter documentation. |
homePath | An absolute path that contains the hot and warm buckets for the index. |
homePath_expanded | An absolute filepath to the hot and warm buckets for the index. |
indexThreads | Number of threads used for indexing.
This is a global setting, not a per index setting. |
isInternal | Indicates if this is an internal index (for example, _internal, _audit). |
lastInitTime | Last time the index processor was successfully initialized.
This is a global setting, not a per index setting. |
maxBloomBackfillBucketAge | If a bucket (warm or cold) is older than this, Splunk Enterprise does not create (or re-create) its bloom filter. |
maxConcurrentOptimizes | The number of concurrent optimize processes that can run against a hot bucket.
This number should be increased if instructed by Splunk Support. Typically the default value should suffice. |
maxDataSize | The maximum size in MB for a hot DB to reach before a roll to warm is triggered. Specifying "auto" or "auto_high_volume" causes Splunk Enterprise to autotune this parameter (recommended). Use "auto_high_volume" for high volume indexes (such as the main index); otherwise, use "auto". A "high volume index" is typically one that gets over 10GB of data per day.
Although the maximum value you can set this is 1048576 MB, which corresponds to 1 TB, a reasonable number ranges anywhere from 100 - 50000. Any number outside this range should be approved by Splunk Support before proceeding. If you specify an invalid number or string, maxDataSize is auto-tuned. Note: The precise size of your warm buckets may vary from maxDataSize, due to post-processing and timing issues with the rolling policy. |
maxHotBuckets | Maximum hot buckets that can exist per index. Defaults to 3.
When maxHotBuckets is exceeded, Splunk Enterprise rolls the least recently used (LRU) hot bucket to warm. Both normal hot buckets and quarantined hot buckets count towards this total. This setting operates independently of maxHotIdleSecs, which can also cause hot buckets to roll. |
maxHotIdleSecs | Maximum life, in seconds, of a hot bucket. Defaults to 0. A value of 0 turns off the idle check (equivalent to INFINITE idle time).
If a hot bucket exceeds maxHotIdleSecs, Splunk Enterprise rolls it to warm. This setting operates independently of maxHotBuckets, which can also cause hot buckets to roll. |
maxHotSpanSecs | Upper bound of target maximum timespan of hot/warm buckets in seconds. Defaults to 7776000 seconds (90 days).
Note: If set too small, you can get an explosion of hot/warm buckets in the filesystem. The system sets a lower bound implicitly for this parameter at 3600, but this is an advanced parameter that should be set with care and understanding of the characteristics of your data. |
maxMemMB | The amount of memory, in MB, allocated for indexing.
This is a global setting, not a per index setting. |
maxMetaEntries | Sets the maximum number of unique lines in .data files in a bucket, which may help to reduce memory consumption. If set to 0, this setting is ignored (it is treated as infinite).
If exceeded, a hot bucket is rolled to prevent further increase. If your buckets are rolling due to Strings.data hitting this limit, the culprit may be the punct field in your data. If you do not use punct, it may be best to simply disable this (see props.conf.spec in $SPLUNK_HOME/etc/system/README). There is a small time delta between when maximum is exceeded and bucket is rolled. This means a bucket may end up with epsilon more lines than specified, but this is not a major concern unless excess is significant. |
maxTime | Timestamp of the newest event time in the index. |
maxTimeUnreplicatedNoAcks | Upper limit, in seconds, on how long an event can sit in raw slice. Applies only if replication is enabled for this index. Otherwise ignored.
If there are any acknowledged events sharing this raw slice, this paramater does not apply. In this case, maxTimeUnreplicatedWithAcks applies. Highest legal value is 2147483647. To disable this parameter, set to 0. Note: this is an advanced parameter. Understand the consequences before changing. |
maxTimeUnreplicatedWithAcks | Upper limit, in seconds, on how long events can sit unacknowledged in a raw slice. Applies only if you have enabled acks on forwarders and have replication enabled (with clustering).
Note: This is an advanced parameter. Make sure you understand the settings on all forwarders before changing this. This number should not exceed ack timeout configured on any forwarder, and should actually be set to at most half of the minimum value of that timeout. You can find this setting in outputs.conf readTimeout setting under the tcpout stanza. To disable, set to 0, but this is NOT recommended. Highest legal value is 2147483647. |
maxTotalDataSizeMB | The maximum size of an index, in MB. |
maxWarmDBCount | The maximum number of warm buckets. If this number is exceeded, the warm bucket/s with the lowest value for their latest times are moved to cold. |
memPoolMB | Determines how much memory is given to the indexer memory pool.
This is a global setting, not a per-index setting. |
minRawFileSyncSecs | Can be either an integer (or "disable"). Some filesystems are very inefficient at performing sync operations, so only enable this if you are sure it is needed
The integer sets how frequently splunkd forces a filesystem sync while compressing journal slices. During this period, uncompressed slices are left on disk even after they are compressed. Then splunkd forces a filesystem sync of the compressed journal and removes the accumulated uncompressed files. If 0 is specified, splunkd forces a filesystem sync after every slice completes compressing. Specifying "disable" disables syncing entirely: uncompressed slices are removed as soon as compression is complete. |
minStreamGroupQueueSize | Minimum size of the queue that stores events in memory before committing them to a tsidx file. |
minTime | Timestamp of the oldest event time in the index. |
partialServiceMetaPeriod | Related to serviceMetaPeriod. By default it is turned off (zero).
If set, it enables metadata sync every <integer> seconds, but only for records where the sync can be done efficiently in-place, without requiring a full re-write of the metadata file. Records that require full re-write are be sync'ed at serviceMetaPeriod. partialServiceMetaPeriod specifies, in seconds, how frequently it should sync. Zero means that this feature is turned off and serviceMetaPeriod is the only time when metadata sync happens. If the value of partialServiceMetaPeriod is greater than serviceMetaPeriod, this setting has no effect. |
processTrackerServiceInterval | How often, in seconds, the indexer checks the status of the child OS processes it launched to see if it can launch new processes for queued requests. |
quarantineFutureSecs | Events with timestamp of quarantineFutureSecs newer than "now" are dropped into quarantine bucket. Defaults to 2592000 (30 days).
This is a mechanism to prevent main hot buckets from being polluted with fringe events. |
quarantinePastSecs | Events with timestamp of quarantinePastSecs older than "now" are dropped into quarantine bucket. Defaults to 77760000 (900 days).
This is a mechanism to prevent the main hot buckets from being polluted with fringe events. |
rawChunkSizeBytes | Target uncompressed size in bytes for individual raw slice in the rawdata journal of the index. Defaults to 131072 (128KB). 0 is not a valid value. If 0 is specified, rawChunkSizeBytes is set to the default value.
Note: rawChunkSizeBytes only specifies a target chunk size. The actual chunk size may be slightly larger by an amount proportional to an individual event size. Warning: This is an advanced parameter. Only change it if instructed to do so by Splunk Support. |
repFactor | Index replication control. This parameter applies to only Splunk Enterprise clustering slaves.
|
rotatePeriodInSecs | Rotation period, in seconds, that specifies how frequently to check:
|
serviceMetaPeriod | Defines how frequently metadata is synced to disk, in seconds. Defaults to 25 (seconds).
You may want to set this to a higher value if the sum of your metadata file sizes is larger than many tens of megabytes, to avoid the hit on I/O in the indexing fast path. |
suppressBannerList | List of indexes for which we suppress "index missing" warning banner messages.
This is a global setting, not a per index setting. |
sync | Specifies the number of events that trigger the indexer to sync events.
This is a global setting, not a per index setting. |
syncMeta | When true, a sync operation is called before file descriptor is closed on metadata file updates. This functionality improves integrity of metadata files, especially in regards to operating system crashes/machine failures.
Note: Do not change this parameter without the input of Splunk Support. |
thawedPath | Filepath to the thawed (resurrected) databases for the index. |
thawedPath_expanded | Absolute filepath to the thawed (resurrected) databases. |
throttleCheckPeriod | Defines how frequently Splunk Enterprise checks for index throttling condition, in seconds. Defaults to 15 (seconds).
Note: Do not change this parameter without the input of Splunk Support. |
totalEventCount | Total number of events in the index. |
tstatsHomePath | Location where datamodel acceleration TSIDX data for this index is stored. |
warmToColdScript | Script to run when moving data from warm to cold. See input parameter description for details. |
[ Top ]
data/indexes-extended
https://<host>:<mPort>/services/data/indexes-extended
Description
Provide Splunk Enterprise index bucket-level information. There are three bucket super-directories per index:
- home
- cold
- thawed
The default update period is 10 minutes, as defined by the collectionPeriodInSecs
attribute in the $SPLUNK_HOME/etc/apps/introspection_generator_addon/default/server.conf
file.
Note: At least one observation period must pass after Splunk Enterprise startup for valid endpoint data to be available. The observation period is defined in the $SPLUNK_HOME/etc/system/default/server.conf
file:
[introspection:generator:disk_objects] collectionPeriodInSecs = 600
The default period is 10 seconds, but 10 minutes (600 seconds) on a Universal Forwarder.
Method summary
Method | Description | Formats |
---|---|---|
GET | List bucket attributes for all indices. | XML, JSON |
GET data/indexes-extended
method detail
Request parameters
Pagination and filtering parameters can be used with this method.
Response data keys
Name | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
bucket_dirs | (If total_size > 0 ) List the following attributes for each index bucket super-directory (home , cold , thawed ) as indicated:
| ||||||||||||||||||||||||||||||||||||||||
name | Index name. | ||||||||||||||||||||||||||||||||||||||||
total_bucket_count | (If total_size > 0 ) Number of index buckets.
| ||||||||||||||||||||||||||||||||||||||||
total_event_count | (If total_size > 0 ) Number of events for index, excluding frozen events. Approximately equal to the event_count sum of all buckets.
| ||||||||||||||||||||||||||||||||||||||||
total_raw_size | (If total_size > 0 ) Cumulative size (fractional MB) on disk of the <bucket>/rawdata/ directories of all buckets in this index, excluding frozen .
| ||||||||||||||||||||||||||||||||||||||||
total_size | Size (fractional MB) on disk of this index. |
[ Top ]
data/indexes-extended/{name}
https://<host>:<mPort>/services/data/indexes-extended/{name}
Description
Provide bucket-level information for the specified index. There are three bucket super-directories per index:
- home
- cold
- thawed
The default update period is 10 minutes, as defined by the collectionPeriodInSecs
attribute in the $SPLUNK_HOME/etc/apps/introspection_generator_addon/default/server.conf
file.
Note: At least one observation period must pass after Splunk Enterprise startup for valid endpoint data to be available. The observation period is defined in the $SPLUNK_HOME/etc/system/default/server.conf
file:
[introspection:generator:disk_objects] collectionPeriodInSecs = 600
The default period is 10 seconds, but 10 minutes (600 seconds) on a Universal Forwarder.
Method summary
Method | Description | Formats |
---|---|---|
GET | List bucket attributes for the specified index. | XML, JSON |
GET data/indexes-extended/{name}
method detail
Request parameters
None
Response data keys
Name | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
bucket_dirs | (If total_size > 0 ) List the following attributes for each index bucket super-directory (home , cold , thawed ) as indicated:
| ||||||||||||||||||||||||||||||||||||||||
name | Index name. | ||||||||||||||||||||||||||||||||||||||||
total_bucket_count | (If total_size > 0 ) Number of index buckets.
| ||||||||||||||||||||||||||||||||||||||||
total_event_count | (If total_size > 0 ) Number of events for index, excluding frozen events. Approximately equal to the event_count sum of all buckets.
| ||||||||||||||||||||||||||||||||||||||||
total_raw_size | (If total_size > 0 ) Cumulative size (fractional MB) on disk of the <bucket>/rawdata/ directories of all buckets in this index, excluding frozen .
| ||||||||||||||||||||||||||||||||||||||||
total_size | Size (fractional MB) on disk of this index. |
[ Top ]
server/info
https://<host>:<mPort>/services/server/info
Description
Provides access to configuration information about the server.
Method summary
Method | Description | Formats |
---|---|---|
GET | Enumerate information about the server. | XML, JSON |
GET server/info
method detail
Request parameters
Pagination and filtering parameters can be used with this method.
Response data keys
Name | Description |
---|---|
activeLicenseGroup | Type of Splunk Enterprise license:
Enterprise Forwarder Free Invalid Trial |
addOns | Names of active Splunk Enterprise add-ons. |
build | The build number for this version of Splunk. |
cpu_arch | The architecture type for the CPU hosting splunkd. |
guid | Globally unique identifier for this server. |
host | Server name. |
host_fqdn | host fully-qualified domain name. |
isFree | Indicates if this server is running Splunk Enterprise under a free license. |
isTrial | Indicates if this server is using a trial license. |
kv_store_status | App KV store availability. |
license_labels | Labels associated with the license for this server. |
licenseKeys | License key unique for each license. |
licenseSignature | Hash signature for the license for this server. |
licenseState | Specifies the status of the license, which can be either OK or Expired. |
master_guid | Globally unique identifier for this server. |
max_users | Maximum number of users. |
mode | Indicates whether the server is a dedicated forwarder. Possible values are:
normal dedicated forwarder |
numberOfCores | Server number of processor cores. Not useful if host is a VM guest. 0 if the respective result cannot be acquired for some reason. That reason is logged to splunkd.log. |
os_build | Software build for this os_version. |
os_name | Operating system. |
os_version | Operating system version. |
physicalMemoryMB | Server physical memory (MB). Same as mem field of server/status/resource-usage/hostwide. 0 if the respective result cannot be acquired for some reason. That reason is logged to splunkd.log. |
product_type | Splunk Enterprise product type:
enterprise hunk lite lite_free splunk |
rtsearch_enabled | Indicates if real-time search is enabled for this server. |
server_roles | Zero or more of the following possible server roles:
cluster_search_head cluster_master cluster_slave deployment_server deployment_client heavyweight_forwarder indexer kv_store lightweight_forwarder license_master license_slave search_head search_peer shc_deployer universal_forwarder See also: server/roles endpoint. |
serverName | Server DNS domain name. |
startup_time | Server platform start time, in seconds since January 1, 1970 (UNIX epoch). |
version | os_build software version number. |
[ Top ]
server/introspection
https://<host>:<mPort>/services/server/introspection
Description
List system introspection artifacts.
Only the indexer artifact is a supported REST API endpoint.
See also
Method summary
Method | Description | Formats |
---|---|---|
GET | List introspection resources. | XML, JSON |
GET server/introspection
method detail
Request parameters
None
Response data keys
None
The endpoint returns a list of introspection artifacts.
[ Top ]
server/introspection/indexer
https://<host>:<mPort>/services/server/introspection/indexer
Description
Get the current indexer status and reason for a non-nominal status.
See also
Method summary
Method | Description | Formats |
---|---|---|
GET | Get indexer information. | XML, JSON |
GET server/introspection/indexer
method detail
Request parameters
None
Response data keys
Name | Description |
---|---|
average_KBps | Average indexer throughput (kbps). |
reason | Reason message associated with a non-normal status:
|
status | Current indexer status:
|
[ Top ]
server/introspection/kvstore
https://<host>:<mPort>/services/server/introspection/kvstore
Description
List app kvstore resources.
See also
Method summary
Method | Description | Formats |
---|---|---|
GET | List app KV store resources. | XML, JSON |
GET server/introspection/kvstore
method detail
Request parameters
None
Response data keys
None.
Returns links to each of the app /server/introspection/kvstore resources:
[ Top ]
server/introspection/kvstore/collectionstats
https://<host>:<mPort>/services/server/introspection/kvstore/collectionstats
Description
Get storage statistics for a collection.
See also
Method summary
Method | Description | Formats |
---|---|---|
GET | Get storage statistics for a collection. | XML, JSON |
GET server/introspection/kvstore/collectionstats
method detail
Request parameters
None
Response data keys
Name | Description |
---|---|
data | Returns the following JSON document:
|
[ Top ]
server/introspection/kvstore/replicasetstats
https://<host>:<mPort>/services/server/introspection/kvstore/replicasetstats
Description
Get the status of the replica set from the point of view of the current server.
See also
Method summary
Method | Description | Formats |
---|---|---|
GET | Get the status of the replica set from the point of view of the current server. | XML, JSON |
GET server/introspection/kvstore/replicasetstats
method detail
Request parameters
None
Response data keys
Name | Description |
---|---|
data | Returns the following JSON document:
|
[ Top ]
server/introspection/kvstore/serverstatus
https://<host>:<mPort>/services/server/introspection/kvstore/serverstatus
Description
Get an overview of the database process state.
Monitoring applications periodically run this command to get statistical information about the database instance.
See also
Method summary
Method | Description | Formats |
---|---|---|
GET | Get an overview of the database process state. | XML, JSON |
GET server/introspection/kvstore/serverstatus
method detail
Request parameters
None
Response data keys
The response data are platform-dependent.
Name | Description |
---|---|
data | Returns the following CDATA items:
|
[ Top ]
server/introspection/search/dispatch
https://<host>:<mPort>/services/server/introspection/search/dispatch
Description
Provides vital statistics for distributed search framework, including details on search peer performance.
Method summary
Method | Description | Formats |
---|---|---|
GET | Enumerate scheduled search details. | XML, JSON |
GET method detail
Request parameters
None
Response data keys
Name | Description |
---|---|
Bundle_Directory_Reaper_Average_Time(ms) | Average time for dispatch reaper to walk search peer directory and reap obsolete bundles. |
Bundle_Directory_Reaper_Max_Time(ms) | Maximum time for dispatch reaper to walk search peer directory and reap obsolete bundles. |
Compute_User_Search_Quota_Average_Time(ms) | Average time for computing user search quota. |
Compute_User_Search_Quota_Max_Time(ms) | Maximum time for computing user search quota. |
Dispatch_Directory_Reaper_Average_Time(ms) | Average time for dispatch reaper to walk dispatch directory and reap stale artifacts. |
Dispatch_Directory_Reaper_Max_Time(ms) | Maximum time for dispatch reaper to walk dispatch directory and reap stale artifacts. |
Search_StartUp_Time_Average_Time(ms) | Average time for preprocessing before search startup. Counted from time search state is set to RUNNING .Startup time indicates that parsing is complete and the distributed search infrastructure is set up. At startup, the Splunk platform is ready to wait for responses from indexers. |
Search_StartUp_Time_Max_Time(ms) | Maximum time for preprocessing before search startup. Counted from time search state is set to RUNNING .Startup time indicates that parsing is complete and the distributed search infrastructure is set up. At startup, the Splunk platform is ready to wait for responses from indexers. |
[ Top ]
server/introspection/search/dispatch/Bundle_Directory_Reaper
https://<host>:<mPort>/services/server/introspection/search/dispatch/Bundle_Directory_Reaper
Description
Provides average and maximum time for dispatch reaper to walk the search peer directory and reap obsolete bundles.
Method summary
Method | Description | Formats |
---|---|---|
GET | Enumerate routine distributed search method execution times for each peer | XML, JSON |
GET method detail
Request parameters
None
Response data keys
Name | Description |
---|---|
Bundle_Directory_Reaper_Average_Time(ms) | Average time for dispatch reaper to walk search peer directory and reap obsolete bundles. |
Bundle_Directory_Reaper_Max_Time(ms) | Maximum time for dispatch reaper to walk search peer directory and reap obsolete bundles. |
[ Top ]
server/introspection/search/dispatch/Compute_User_Search_Quota
https://<host>:<mPort>/services/server/introspection/search/dispatch/Compute_User_Search_Quota
Description
Provides average and maximum time for computing user search quotas.
Method summary
Method | Description | Formats |
---|---|---|
GET | Enumerate average and maximum time for user search quota computation. | XML, JSON |
GET method detail
Request parameters
None
Response data keys
Name | Description |
---|---|
Compute_User_Search_Quota_Average_Time(ms) | Average time for computing user search quota. |
Compute_User_Search_Quota_Max_Time(ms) | Maximum time for computing user search quota. |
[ Top ]
server/introspection/search/dispatch/Dispatch_Directory_Reaper
https://<host>:<mPort>/services/server/introspection/search/dispatch/Dispatch_Directory_Reaper
Description
Provides average and maximum time for dispatch reaper to walk the dispatch directory and reap stale artifacts.
Method summary
Method | Description | Formats |
---|---|---|
GET | Show dispatch directory reaper times for reaping stale artifacts. | XML, JSON |
GET method detail
Request parameters
None
Response data keys
Name | Description |
---|---|
Dispatch_Directory_Reaper_Average_Time(ms) | Average time for dispatch reaper to walk dispatch directory and reap stale artifacts. |
Dispatch_Directory_Reaper_Max_Time(ms) | Maximum time for dispatch reaper to walk dispatch directory and reap stale artifacts. |
[ Top ]
server/introspection/search/dispatch/Search_StartUp_Time
https://<host>:<mPort>/services/server/introspection/search/dispatch/Search_StartUp_Time
Description
Provides average and maximum time for search preprocessing before startup.
Startup time indicates that parsing is complete and the distributed search infrastructure is set up. At startup, the Splunk platform is ready to wait for responses from indexers.
Method summary
Method | Description | Formats |
---|---|---|
GET | Enumerate average and maximum time for search preprocessing before startup. | XML, JSON |
GET method detail
Request parameters
None
Response data keys
Search_StartUp_Time_Average_Time(ms) | Average time for preprocessing before search startup. Counted from time search state is set to RUNNING .
|
Search_StartUp_Time_Max_Time(ms) | Maximum time for preprocessing before search startup. Counted from time search state is set to RUNNING .
|
[ Top ]
server/introspection/search/distributed
https://<host>:<mPort>/services/server/introspection/search/distributed
Description
Provides information about the search knowledge bundle replication, if current instance is the search head. Provides details about maximum and average time to execute routine distributed search methods, including peer info, peer bundles list, and authentication token requests from search heads.
The default update period is 10 minutes, as defined by the collectionPeriodInSecs
attribute in the $SPLUNK_HOME/etc/apps/introspection_generator_addon/default/server.conf
file. If startup occurs within the last 10 minutes, counts are shown from startup to the current time.
Method summary
Method | Description | Formats |
---|---|---|
GET | Enumerate routine distributed search method execution times for each peer. | XML, JSON |
GET method detail
Request parameters
Pagination and filtering parameters can be used with this method.
Response data keys
The following information is provided for each peer.
Name | Description |
---|---|
Get_Authentication_Max_Time(ms) | Maximum time for search head to get authentication from this peer. |
Get_Authentication_Mean_Time(ms) | Average time for search head to get authentication from this peer. |
Get_BundleList_Max_Time(ms) | Maximum time for search head to get bundle list from this peer. |
Get_ServerInfo_Max_Time(ms) | Maximum time for search head to get server information back from this peer. |
Get_ServerInfo_Mean_Time(ms) | Average time for search head to get server information back from this peer. |
[ Top ]
server/introspection/search/saved
https://<host>:<mPort>/services/server/introspection/search/saved
Authentication: Required
Description
Access most recent scheduled search priority scores and score calculation adjustments.
Method summary
Method | Description | Formats |
---|---|---|
GET | Enumerate scheduled search details. | XML, JSON |
GET server/introspection/search/saved
method detail
Request parameters
None
Response data keys
- Note: These response data keys are for informational purposes only. They are subject to change or removal at any time.
Name | Description |
---|---|
final_score | Most recent calculated priority score, based on adjustments and original score. |
name | Scheduled search name. |
orig_score | A score based on a search's originally scheduled run time. |
owner | Search scope or context owner. This could be a specific user or "nobody" for a search defined in an app or system-level scope. |
priority_no | Most recent calculated priority number for this search. |
real_time_adj | Real-time search priority adjustment. Real-time searches default to -80000 and continuous scheduled searches default to 0. This particular value is for internal purposes only and is subject to change. |
runtime_adj | Calculated value based on average search runtime. |
skipped_adj | Adjustment for number of times search has been skipped and search period. 0 means the search has not been skipped. |
window_adj | Adjustment for remaining time in search run window. |
[ Top ]
server/status
https://<host>:<mPort>/services/server/status
Description
Access system status information.
Method summary
Method | Description | Formats |
---|---|---|
GET | Enumerate server/status endpoints. | XML, JSON |
GET server/status
method detail
Request parameters
None
Response data keys
List of /server/status/ child endpoints.
[ Top ]
server/status/dispatch-artifacts
https://<host>:<mPort>/services/server/status/dispatch-artifacts
Description
Access search job information.
Note: At least one observation period must pass after Splunk Enterprise startup for valid endpoint data to be available. The observation period is defined in the $SPLUNK_HOME/etc/system/default/server.conf file:
[introspection:generator:disk_objects] collectionPeriodInSecs = 600
The default period is 10 seconds, but 10 minutes (600 seconds) on a Universal Forwarder.
Method summary
Method | Description | Formats |
---|---|---|
GET | Get information about dispatched search jobs. | XML, JSON |
GET server/status/dispatch-artifacts
method detail
Request parameters
None
Response data keys
Name | Description |
---|---|
count_realtime | Jobs active in the immediate past observation period, not including historical jobs. |
count_scheduled | Jobs active in the immediate past observation period, not including real-time jobs. |
count_summary | Jobs active in the immediate past observation period, not including non-summary jobs. |
top_apps | Top 15 apps in the past observation period, inapp:count key-value pair format. |
top_named_searches | Top 15 named searches in the past observation period, in savedSearchName:count key-value pair format. |
top_users | Top 15 users in the past observation period, in username:count key-value pair format, with count as the number of app contexts for the user. |
total_count | Number of dispatched search jobs since start-up. |
[ Top ]
server/status/fishbucket
https://<host>:<mPort>/services/server/status/fishbucket
Description
Access information about the private BTree database.
Note: At least one observation period must pass after Splunk Enterprise startup for valid endpoint data to be available. The observation period is defined in the $SPLUNK_HOME/etc/system/default/server.conf file:
[introspection:generator:disk_objects] collectionPeriodInSecs = 600
The default period is 10 seconds, but 10 minutes (600 seconds) on a Universal Forwarder.
Method summary
Method | Description | Formats |
---|---|---|
GET | Get private Btree database information. | XML, JSON |
GET server/status/fishbucket
method detail
Request parameters
None
Response data keys
Name | Description |
---|---|
key_count | Number of file input records (keys) seen since start-up. |
total_size | Total number of file input records (keys). |
[ Top ]
server/status/limits/search-concurrency
https://<host>:<mPort>/services/server/status/limits/search-concurrency
Description
Access search concurrency metrics.
Method summary
Method | Description | Formats |
---|---|---|
GET | Get search concurrency limits for a standalone Splunk Enterprise instance. | XML, JSON |
GET server/status/limits/search-concurrency
method detail
Request parameters
None
Response data keys
Name | Description |
---|---|
max_auto_summary_searches | Maximum number of auto summary searches. |
max_hist_scheduled_searches | Maximum number of historical scheduled searches. |
max_hist_searches | Maximum number of historical searches. |
max_rt_scheduled_searches | Maximum number of scheduled searches. |
max_rt_searches | Maximum number of real-time searches. |
[ Top ]
server/status/partitions-space
https://<host>:<mPort>/services/server/status/partitions-space
Description
Access disk utilization information for filesystems that have Splunk Enterprise disk objects, such as indexes, volumes, and logs. A filesystem can span multiple physical disk partitions.
Note: At least one observation period must pass after Splunk Enterprise startup for valid endpoint data to be available. The observation period is defined in the $SPLUNK_HOME/etc/system/default/server.conf file:
[introspection:generator:disk_objects] collectionPeriodInSecs = 600
The default period is 10 seconds, but 10 minutes (600 seconds) on a Universal Forwarder.
Method summary
Method | Description | Formats |
---|---|---|
GET | Enumerate filesystem endpoints. | XML, JSON |
GET server/status/partitions-space
method detail
Request parameters
Pagination and filtering parameters can be used with this method.
Response data keys
Name | Description |
---|---|
capacity | Disk capacity (MB). |
free | Disk free space (MB). |
fs_type | File system type.
Example values:
|
mount_point | Absolute path of the directory where this partition is mounted. |
[ Top ]
server/status/resource-usage
https://<host>:<mPort>/services/server/status/resource-usage
Description
Learn the current levels of resource (CPU, RAM, VM, I/O, file handle) utilization for entire host, and per Splunk-related processes.
Note: At least one observation period must pass after Splunk Enterprise startup for valid endpoint data to be available. The observation period is defined in the $SPLUNK_HOME/etc/system/default/server.conf file:
[introspection:generator:resource_usage] collectionPeriodInSecs = 600
The default period is 10 seconds, but 10 minutes (600 seconds) on a Universal Forwarder.
Method summary
Method | Description | Formats |
---|---|---|
GET | Enumerate server/status/resource-usage/ endpoints. | XML, JSON |
GET server/status/resource-usage
method detail
Request parameters
Pagination and filtering parameters can be used with this method.
Response data keys
List of server/status/resource-usage/ endpoints.
[ Top ]
server/status/resource-usage/hostwide
https://<host>:<mPort>/services/server/status/resource-usage/hostwide
Description
Access host-level, dynamic CPU utilization and paging information.
Note: At least one observation period must pass after Splunk Enterprise startup for valid endpoint data to be available. The observation period is defined in the $SPLUNK_HOME/etc/system/default/server.conf file:
[introspection:generator:resource_usage] collectionPeriodInSecs = 600
The default period is 10 seconds, but 10 minutes (600 seconds) on a Universal Forwarder.
Method summary
Method | Description | Formats |
---|---|---|
GET | Get host-level, dynamic CPU utilization and paging information. | XML, JSON |
GET server/status/resource-usage/hostwide
method detail
Request parameters
None
Response data keys
Name | Description |
---|---|
cpu_idle_pct | Percentage of time CPU is idle. Value reported as 100.0 on Windows except for Vista+ and XP/Win2003 English-only OSes. |
cpu_system_pct | Percentage of time CPU is running in system mode. Missing from Windows except for Vista+ and XP/Win2003 English-only OSes. |
cpu_user_pct | Percentage of time CPU is running in user mode. Missing from Windows except for Vista+ and XP/Win2003 English-only OSes. |
forks | Cumulative number of forked processes since OS startup. Not available on Windows. |
mem | Total physical memory installed (MB). |
mem_used | Total physical memory used (MB). The amount of actual physical memory minus the amount of physical memory currently available. This is the amount of physical memory that can be immediately reused without having to first write its contents to disk. On Unix, mem_used = total_phys_ram - (free_mem + buffer_mem + cached_mem) On Windows, mem_used = (memoryStatus.ullTotalPhys - memoryStatus.ullAvailPhys); See GlobalMemoryStatusEx function |
normalized_load_avg_1min | Normalized load average of runnable_process_count across all cores (cumulative_load_avg / number_of_cores). This value is not reliable for a VM guest. |
pg_paged_out | Cumulative VM page count paged since OS startup. Not available on Windows. |
pg_swapped_out | Cumulative pages swapped out since OS startup. Not available on Windows. |
runnable_process_count | Number of process running or in the runnable queue. Value reported as 1 on Windows except for Vista+ and XP/Win2003 English-only OSes. |
swap | Amount of disk allocated to swap (fractional MB). |
swap_used | Swap space currently in use (fractional MB). |
[ Top ]
server/status/resource-usage/splunk-processes
https://<host>:<mPort>/services/server/status/resource-usage/splunk-processes
Description
Access operating system resource utilization information.
Note: At least one observation period must pass after Splunk Enterprise startup for valid endpoint data to be available. The observation period is defined in the $SPLUNK_HOME/etc/system/default/server.conf file:
[introspection:generator:resource_usage] collectionPeriodInSecs = 600
The default period is 10 seconds, but 10 minutes (600 seconds) on a Universal Forwarder.
Method summary
Method | Description | Formats |
---|---|---|
GET | Get process operating system resource utilization information. | XML, JSON |
GET server/status/resource-usage/splunk-processes
method detail
Request parameters
None
Response data keys
Name | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args | Non-search process arguments. | ||||||||||||||||||
cpu_system_time | Cumulative time this process has spent executing in kernel (incl. system calls). Extra field. | ||||||||||||||||||
cpu_user_time | Cumulative time this process has spent executing in user space (incl. library functions). Extra field. | ||||||||||||||||||
elapsed | Elapsed wall time, accurate to within the collection period. | ||||||||||||||||||
fd_used | Number of currently open files used by this process. | ||||||||||||||||||
mem_unshared_data_used | Amount of heap and stack used. Not available on Windows. Extra field. | ||||||||||||||||||
mem_used | Current amount of resident physical memory used (MB). (Usually far less deceiving than virtual memory because operating systems can be liberal with virtual memory size but never with resident memory size.) On Windows, mem_used is obtained by reading the WorkingSetSize property returned by the GetProcessMemoryInfo() function (see GetProcessMemoryInfo function and PROCESS_MEMORY_COUNTERS structure). | ||||||||||||||||||
normalized_pct_cpu | Percentage of CPU usage across all cores. 100% is equivalent to all CPU resources on the machine.
| ||||||||||||||||||
page_faults | Number of major page faults. Extra field. | ||||||||||||||||||
pct_cpu | Percentage of CPU usage, relative to one core. 100% is equivalent to 1 core.
| ||||||||||||||||||
pct_memory | Percentage of physical memory used hostwide ((mem_used/available_host_memory) * 100). | ||||||||||||||||||
pid | Process ID. | ||||||||||||||||||
ppid | Parent process ID. Not available for all processes. | ||||||||||||||||||
process | Process name. The .exe suffix is stripped on Windows operating systems.
| ||||||||||||||||||
read_mb | Amount of data read (MB), excluding cache reads. | ||||||||||||||||||
search_props | Search properties map of the following key:value pairs:
| ||||||||||||||||||
status | Status from the OS scheduler. Can be R (runnable or running), W (waiting), stopped, Z (zombie), or O (other). W includes voluntary sleep or blocking on I/O. O means status is knowable but does not fit into one of those categories. Not available on Windows. | ||||||||||||||||||
t_count | Current number of threads. | ||||||||||||||||||
written_mb | Amount of data written (MB), excluding canceled writes. |
[ Top ]
PREVIOUS Input endpoint examples |
NEXT Introspection endpoint examples |
This documentation applies to the following versions of Splunk® Enterprise: 6.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.3.12, 6.3.13, 6.3.14
Feedback submitted, thanks!