Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
221 lines (205 sloc) 8.67 KB
<title>Logstash for SCAPI - input wilywebsvcs</title>

wilywebsvcs

Synopsis

Connects to Wily Introscope Web Services interface, extracts metrics on a specified schedule, using a set of supplied metric selectors
input {
wilywebsvcs {
  wsdl => ... # string (required)
  username => ... # string (required)
  password => ... # string (required)
  dataSelectors => ... # hash (required)
  start_time => ... # string (optional), default: current time is used
  end_time => ... # string (optional), default: none
  latency => ... # number (optional), default: 0 minutes
  aggregation_interval => ... # number (optional), default: 15 minutes
  last_run_metadata_path => ... # file path (optional), default: $USER_HOME/.logstash_jdbc_last_run
  record_last_run => ... # boolean (optional), default: true
  clean_run => ... # boolean (optional), default: false
  }
}

Details

Connects to Wily Introscope Web Services interfaces, specified in the user supplied WSDL file. As part of the configuration, the user supplies data selectors and time specifications to extract metric data from the Web Services interface. Some basic processing of the returned SOAP data is carried out and simple Logstash events are created and output. Those events contain the following fields
  • group
  • refID
  • timeslice_start_time
  • timeslice_end_time
  • agent_name
  • metric_name
  • metric_value
Note: The above fields are extracted from the SOAP messages returned. The traditional 'message' field is not produced, as the response from Wily is typically a large SOAP message, which is then broken up into those fields listed above. Including the 'message' filed would be somewhat redundant.

wsdl

  • Value type is String
  • There is no default value for this setting

Specify the path to the WSDL file for this environment. This plugin has been tested with 'MetricsDataService.xml' (Built on Apr 22, 2006) from Wily. Note: This file must be provided by the user. The local instance of this file must be edited to provide the wsdlsoap:address location information. For example, find the entry in the file corresponding to wsdlsoap:address location= and change it appropriately for your environment. Usually, this is simply a matter of changing the host/port information in your local MetricsDataService.xml file.

username

  • Value type is String
  • There is no default value for this setting

Username to connect to Introscope

password

  • Value type is String
  • There is no default value for this setting

Password to connect to Introscope

dataSelectors

  • Value type is hash
  • Default value is ""

These are the metric selector specification, used when invoking the WebService interface. Each one of the supplied rows will form the basis for selecting metrics in a SOAP request. They are arranged as groups, and within each group, sets of agent regex, metric regex and data frequency specifications. Please see your Wily Introscope MetricDataService documentation for details on allowable syntax and expected semantics. The output data will have a group attribute and value associated with it, to allow you to relate it to the individual dataSelector entry that was responsible for its creation.

Use .... weblink coming ....

Example entries


 dataSelectors => {
    "GroupA"   => ["agentRegex,metricRegex,300"]
    "WWW"      => [ "hostABC,Frontends\|Apps\|WebSphere Portal Server:Response Per Interval,300",
                    "myhosts(10|11|12).*,CPU:Utilization \% \(process\),300" ]
    "Garbage"  => [ "serverX ,GC Heap:Bytes In Use,300"]
            }

start_time (optional setting)

  • Value type is string
  • There is no default value for this setting.

The plugin will start collecting from the specified time. If start_time is not provided, the plugin will collect data from current time.

times format is ISO8601 e.g.

start_time => "2015-08-21T14:32:00+0000"

end_time (optional setting)

  • Value type is string
  • There is no default value for this setting.

The plugin will stop collecting from the specified time. If end_time is not provided, the plugin will continue to collect data, moving forward, limited only by wallclock time ( it won't go past current time) and the configured latency setting

times format is ISO8601 e.g.

end_time => "2015-08-22T14:32:00+0000"

latency (optional setting)

  • Value type is number in minutes
  • Default 0 mins meaning, run up to current wallclock time

As the plugin moves forward through time, extracting data, it will stay behind current time by the specified amount of latency. This is typically used when the data is slow to become available in Introscope, e.g. due to slow agent loads or other environmental conditions.

aggregation_interval (optional setting)

  • Value type is number in minutes
  • Default 15mins

As the plugin moves through time, it moves forward with this interval. E.g. if it started from 12:00, with this 15min setting, it would poll data for 12:00, then 12:15, then 12:30 and so on. This is usually aligned with the Predictive Insights aggregation interval

last_run_metadata_path (optional setting)

  • Value type is string
  • Default $USER_HOME/.logstash_jdbc_last_run

Path to file where last data time extracted is recorded. The timestamp in this file enables continuation at the appropriate data time following a restart of the plugin/Logstash

record_last_run (optional setting)

  • Value type is string
  • Default: true

Indicates whether the timestamp of the last data extraction should be recorded in the state file (at last_run_metadata_path) or not.

clean_run (optional setting)

  • Value type is boolean
  • Default false

Indicates whether the previous state (timestamp) should be preserved. True will cause the state file (at last_run_metadata_path) to be delete

Hello! I'm your friendly footer. If you're actually reading this, I'm impressed.

<script src="/js/patch.js?1.4.2"></script>