com.splunk

Class WindowsPerfmonInput

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.Input

com.splunk.WindowsPerfmonInput

All Implemented Interfaces:

Map<String,Object>

public class WindowsPerfmonInput
extends Input

The WindowsPerfmonInput class represents a Windows Performance Monitor (Perfmon) data input.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.splunk.Entity

content, toUpdate

Fields inherited from class com.splunk.Resource

actions, path, refreshArgs, service, title, updated

Method Summary

Modifier and Type	Method and Description
String[]	getCounters() Returns a list of monitored counters for this Windows Perfmon input.
String	getIndex() Returns the index name of this Windows Perfmon input.
String[]	getInstances() Returns the counter instances of this Windows Perfmon input.
int	getInterval() Returns the interval at which to poll the performance counters for this Windows Perfmon input.
InputKind	getKind() Returns the input kind of this input.
String	getObject() Returns the performance monitor object for this Windows Perfmon input (for example, "Process", "Server", or "PhysicalDisk").
void	setCounters(String counter) Sets a counter to monitor.
void	setCounters(String[] counters) Sets the counters to monitor.
void	setDisabled(boolean disabled) Sets whether this input is enabled or disabled.
void	setIndex(String index) Sets the index in which to store all generated events.
void	setInstances(String instance) Sets a counter instance to monitor.
void	setInstances(String[] instances) Sets the counter instances to monitor.
void	setInterval(int interval) Sets the frequency to poll the performance counters.
void	setObject(String object) Sets the performance monitor object (for example, "Process", "Server", or "PhysicalDisk").

Methods inherited from class com.splunk.Entity

actionPath, clear, containsKey, containsValue, disable, enable, entrySet, get, getContent, getMetadata, isDisabled, isEmpty, isNameChangeAllowed, keySet, put, putAll, refresh, remove, remove, size, update, update, validate, values

Methods inherited from class com.splunk.Resource

getName, getPath, getService, getTitle, getUpdated, invalidate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

getCounters

public String[] getCounters()

Returns a list of monitored counters for this Windows Perfmon input. An asterisk (*) is equivalent to all counters.

Returns:

A string array list of counters, or null if not specified.

getIndex

public String getIndex()

Returns the index name of this Windows Perfmon input.

Returns:

The index name, or null if not specified.

getInstances

public String[] getInstances()

Returns the counter instances of this Windows Perfmon input. An asterisk (*) is equivalent to all instances.

Returns:

A string array of counter instances, or null if not specified.

getInterval

public int getInterval()

Returns the interval at which to poll the performance counters for this Windows Perfmon input.

Returns:

The polling interval, in seconds.

getKind

public InputKind getKind()

Returns the input kind of this input.

Overrides:

getKind in class Input

Returns:

The input kind.

getObject

public String getObject()

Returns the performance monitor object for this Windows Perfmon input (for example, "Process", "Server", or "PhysicalDisk").

Returns:

A string containing the performance monitor object.

setCounters

public void setCounters(String[] counters)

Sets the counters to monitor.

Parameters:

counters - An array of counters to monitor.

setCounters

public void setCounters(String counter)

Sets a counter to monitor. A wildcard value of an asterisk (*) means all counters. Use this method to set a single counter rather than an array.

Parameters:

counter - The counter to monitor.

setDisabled

public void setDisabled(boolean disabled)

Sets whether this input is enabled or disabled. Note: Using this method requires you to restart Splunk before this setting takes effect. To avoid restarting Splunk, use the Entity.disable and Entity.enable methods instead, which take effect immediately.

Parameters:

disabled - true to disable this input, false to enable it.

setIndex

public void setIndex(String index)

Sets the index in which to store all generated events.

Parameters:

index - The index name.

setInstances

public void setInstances(String[] instances)

Sets the counter instances to monitor.

Parameters:

instances - The counter instances to monitor.

setInstances

public void setInstances(String instance)

Sets a counter instance to monitor. A wildcard value of an asterisk (*) means all instances. Use this method to set a single instance rather than an array.

Parameters:

instance - A counter instance to monitor.

setInterval

public void setInterval(int interval)

Sets the frequency to poll the performance counters.

Parameters:

interval - The polling frequency, in seconds.

setObject

public void setObject(String object)

Sets the performance monitor object (for example, "Process", "Server", or "PhysicalDisk").

Parameters:

object - The performance monitor object.