industrial data forwarder for splunk · 2017. 5. 3. · industrial data forwarder for splunk...

30
Industrial Data Forwarder for Splunk ©2016 Kepware, Inc.

Upload: others

Post on 02-Feb-2021

10 views

Category:

Documents


0 download

TRANSCRIPT

  • Industrial Data Forwarderfor Splunk

    ©2016 Kepware, Inc.

  • Industrial Data Forwarder for Splunk

    Table of ContentsTable of Contents 2Industrial Data Forwarder for Splunk 3

    Overview 3

    User Interface 4

    Quick Start 5Plug-In Setup 9Creating a New Splunk Connection 10IDF for Splunk Connection 11

    Creating a New Splunk Item 12

    Tag Browser 14

    IDF for Splunk Item 15

    Multiple Splunk Items 16

    Importing / Exporting CSV Files 17Warning and Error Messages 19

    Connection failed to connect to server: :. Please verifythis connection information is correct and that the host can be reached. 20

    Dropping data for connection (server: :), the maximumqueue is . Slow down the data collection rate or verify the server is responsive. 20

    Error adding item to connection . 20

    Error adding item . This item already exists in connection . 21

    Error importing CSV item record . Deadband is invalid; setting to . 21

    Error importing CSV item record . No Deadband value found; setting to . 21

    Error importing CSV item record . Deadband is out of range; setting to . 21

    Error importing CSV header information. Duplicate field name: . 22

    Error importing CSV data. Invalid CSV header. 22

    Error importing CSV data. Header fields are out of order. Metadata must be the final field. 22

    Error importing CSV data. Memory allocation failed. 22

    Error importing CSV item record . Invalid Metadata string, setting to default value. 23

    Error importing CSV header information. Missing field identification record. 23

    Error importing CSV data. No Splunk item records found in CSV file. 23

    Error importing CSV item record . Server Tag is invalid. 23

    Error importing CSV header information. Unrecognized field name: . 24

    Error importing CSV item record . No Update Rate found; setting to . 24

    Error importing CSV item record . Update Rate is out of range; setting to . 24

    Failed to export connection to CSV. 25

    Failed to load XML project. Item already exists in Splunk connection . 25

    Internal error occurred while sorting the Splunk item list. 25

    Unable to send data for item on connection . The licensed item count of items has been reached. 26

    Index 27

    www. kepware.com

    2

  • Industrial Data Forwarder for Splunk

    Industrial Data Forwarder for SplunkHelp version 1.014

    CONTENTS

    OverviewWhat is the Industrial Data Forwarder for Splunk?What can the Industrial Data Forwarder for Splunk do?

    Quick StartHow can I set up data forwarding?

    Setup & ConfigurationHow do I add an Industrial Data Forwarder for Splunk connection?How do I add an Industrial Data Forwarder for Splunk item?How do I edit Splunk items?Can I export Splunk items?

    Warning and Error MessagesWhat messages does the Industrial Data Forwarder for Splunk produce?

    OverviewThe Industrial Data Forwarder for Splunk enables users to forward tag data to Splunk® servers over TCP/IPthrough one or more connections. When the value for a configured tag changes, or at the specified scan rate ofthe tag, an update is sent to the Splunk server as a string. Each update contains a UTC timestamp for when thetag value changed, as well as the name, value, quality, and metadata for the tag. An example of an update isshown below:

    2014-07-10 14:17:25.049 +0000 Tag="Simulators.Sim1.Ramp1" Value="42" Quality="good"

    See Also:User InterfaceQuick Start

    www. kepware.com

    3

  • Industrial Data Forwarder for Splunk

    User InterfaceThe IDF for Splunk plug-in interface consists of a toolbar, a Connection View, a Detail View, and an Event Log.

    ToolbarThe toolbar provides functions to add connections and items, enable or disable connections, and cut/-copy/paste/undo actions. Access the full set of options by clicking Edit | IDF for Splunk.

    Connection ViewThe Connection View, on the left, displays the IDF for Splunk connections. Right-click in this view to add, edit,copy, cut, paste, delete, enable, disable, import, and export Splunk connections.

    Detail ViewThe Detail View, on the right, displays the items in the connection currently selected in the Connection View.Right-click in this view to add, edit, copy, cut, paste, and delete Splunk items within a connection. Users can alsocut, copy, and paste items from one connection to another.

    Event LogThe Event Log, in the bottom pane, displays three types of messages: General Messages, Warnings, and Errors.The Source column displays “IDF for Splunk” to indicate events from this plug-in.

    www. kepware.com

    4

  • Industrial Data Forwarder for Splunk

    Quick Start

    Prerequisites

    1. To receive data, the Splunk server must be configured to accept TCP input on a specific port. The defaultport for data from KEPServerEX is 51112. For more information on how to configure a TCP input for aSplunk server, consult the Splunk documentation.

    2. The project must already have at least one static tag defined to begin. This tutorial assumes the projecthas a channel, “Simulator,” and a device, “Sim1,” with static tags defined. For more information aboutprojects, see the server help.

    Adding the Connection

    1. In the toolbar, select IDF for Splunk from the drop-down menu.

    2. In the server configuration window, select Click to add a new Splunk connection.

    3. In the IDF for Splunk Connection dialog, enter a new connection name. For more information, refer toIDF for Splunk Connection.

    4. Specify the IP address or hostname of the Splunk server. A local host may be specified by entering “loc-alhost” or “127.0.0.1”.

    5. Enter the port configured for TCP input on the Splunk server.

    Note: If the IP/Hostname or port is changed after the connection is created, only values that were pre-viously buffered or change after the modification are delivered to the new endpoint.

    www. kepware.com

    5

  • Industrial Data Forwarder for Splunk

    6. Leave the Enabled setting checked (default) to allow the new connection to communicate with the spe-cified Splunk server immediately.

    7. ClickOK.

    8. Verify that the Event Log in the bottom pane indicates the connection to the server by displaying the mes-sage, “Connection ‘’ is connected to server: ‘:.’” with the cor-rect date and time stamp.

    Adding Items

    1. Right-click on the new connection and select New Splunk item. To add several new Splunk items atonce, select New Splunk items.

    2. In the IDF for Splunk Item dialog, click the Browse (…) button to open the Tag Browser.

    www. kepware.com

    6

  • Industrial Data Forwarder for Splunk

    3. Use the Tag Browser to locate and select the tag for the new item. Once finished, click Apply.

    4. Specify the Update Rate and Deadband. Leaving a field unchanged uses the default value shown. Formore information, refer to IDF for Splunk Item.

    5. Under the Publish section, chooseOnly on Data Changes or Every Scan. Choosing “Every scan”sends data to the Splunk endpoint on each scan even when there is no change in value.

    6. Specify the optional Metadata for the new item(s). For more information, refer to IDF for Splunk Item.

    7. Once finished, clickOK.

    8. Verify that the new item appears correctly in the Detail View.

    www. kepware.com

    7

  • Industrial Data Forwarder for Splunk

    See Also:IDF for Splunk ConnectionIDF for Splunk Item

    www. kepware.com

    8

  • Industrial Data Forwarder for Splunk

    Plug-In SetupFor more information, select a link from the list below.

    IDF for Splunk ConnectionCreating a New Splunk ConnectionIDF for Splunk ItemCreating a New Splunk Item

    www. kepware.com

    9

  • Industrial Data Forwarder for Splunk

    Creating a New Splunk ConnectionThe Industrial Data Forwarder for Splunk supports up to 1024 Splunk connections. For more information on cre-ating a new Splunk connection, refer to the instructions below.

    1. In the toolbar, select IDF for Splunk from the drop-down menu.

    2. In the server configuration window, select Click to add a new Splunk connection.

    3. In the IDF for Splunk Connection dialog, enter a new connection name. For more information, refer to IDFfor Splunk Connection.

    4. Specify the IP address or hostname of the Splunk server. A local host may be specified by entering “loc-alhost” or “127.0.0.1”.

    Note: Splunk recognizes “localhost” and “127.0.0.1” as different data sources. Even if a certain host-name resolves to a specific IP and they are logically equivalent, Splunk differentiates between them.

    5. Enter the port configured for TCP input on the Splunk server.

    Note: If the IP/Hostname or port is changed after the connection is created, only values that were pre-viously buffered or change after the modification are delivered to the new endpoint.

    6. Leave the Enabled setting checked (default) to allow the new connection to communicate with the spe-cified Splunk server immediately.

    7. ClickOK.

    www. kepware.com

    10

  • Industrial Data Forwarder for Splunk

    8. Verify that the Event Log in the bottom pane indicates the connection to the server by displaying the mes-sage, “Connection ‘’ is connected to server: ‘:.’” with the cor-rect date and time stamp.

    See Also:IDF for Splunk ConnectionIDF for Splunk Item

    IDF for Splunk ConnectionAn IDF for Splunk Connection contains information about the Splunk server receiving the forwarded data. Up to1024 connections may be made to the same Splunk server, but each connection namemust be unique.

    Descriptions of the parameters are as follows:

    l Connection Name: This parameter specifies the unique identity of the Splunk connection. It may be upto 256 characters in length; but cannot contain periods, double quotation marks, a leading underscore,or leading or trailing spaces. The default setting is IDF for Splunk Connection.

    l IP/Hostname: This parameter specifies the IP address or DNS hostname of the Splunk server. Thedefault setting is 127.0.0.1.

    l Port: This parameter specifies the port number used to communicate with the Splunk server. This settingmust match the port number for the TCP Input configured in the Splunk server. The valid range is 0through 65535. The default setting is 51112.

    www. kepware.com

    11

  • Industrial Data Forwarder for Splunk

    l Item Count: This provides the total number of Splunk items currently in this connection.l Total Item Count: This provides the total number of Splunk items in the project. This equals the sum ofeach connection’s Item Count.

    l License Limit: This provides the maximum number of active Splunk items allowed by the active productlicense. Please contact Sales or Support for more information about licensing and to manage the licenselimits.

    l Enabled:When checked, this option allows forwarding of data for the Splunk items. When unchecked,data is not retained or forwarded to the Splunk server. The default setting is checked.

    Note: If the IP/Hostname or port is changed after the connection is created, only values that were previously buf-fered or change after the modification are delivered to the new endpoint.

    Creating a New Splunk ItemTo specify a server tag and the properties used to forward this data to the Splunk server, follow the steps below.

    1. Right-click on the new connection and select New Splunk item. To add several new Splunk items atonce, select New Splunk items.

    2. In the IDF for Splunk Item dialog, click the Browse (…) button to open the Tag Browser.

    www. kepware.com

    12

    http://www.kepware.com/contact/sales.asphttp://www.kepware.com/contact/technical-support.asp

  • Industrial Data Forwarder for Splunk

    3. Use the Tag Browser to locate and select the tag for the new item. Once finished, click Apply.

    4. Specify the Update Rate, Deadband, Only on Data changes or Every Scan, and optional Metadata for thenew item(s).

    5. Once finished, clickOK.

    6. Verify that the new item appears correctly in the Detail View.

    See Also:IDF for Splunk ConnectionMultiple Splunk Items

    www. kepware.com

    13

  • Industrial Data Forwarder for Splunk

    Tag Browser

    www. kepware.com

    14

  • Industrial Data Forwarder for Splunk

    IDF for Splunk ItemThe IDF for Splunk Item dialog, shown below, specifies a server tag and the properties used to forward this datato the Splunk server.

    Descriptions of the parameters are as follows:

    l Server Tag: This parameter specifies the fully-qualified name of the referenced server tag for the newIDF for Splunk item. Specify the server tag manually or click the Browse (…) button to use the TagBrowser to locate and select one. This parameter must contain at least one character that is not either anunderscore (‘_’) or a period (‘.’). The maximum length of field is 256 characters. Dynamic addresses mayalso be used to specify a server tag (see server help for more information).Note: Each server tag may only be specified once per connection. The same server tag may be specifiedin multiple Splunk connections.

    l Update Rate: This parameter specifies the minimum time interval that must elapse before the server tagmay be scanned for changing data. The valid range is 10 to 99999 milliseconds (inclusive). The defaultsetting is 1000 milliseconds.

    l Only on Data Changes: This option sends data to the Splunk endpoint only when there is a data changeduring the previous scan period.

    l Deadband: This parameter specifies the tag value threshold as a percentage and is used to filterwhen updates are sent to the Splunk server. If the difference between the current value and theprevious value of the server tag is greater than the specified percentage of the server tag’sscaled range, the current value is forwarded to the Splunk server. If this difference is less thanor equal to the specified percentage, the current value is not forwarded. If the server tag doesnot have a configured scaled range, the minimum or maximum values for the server tag’s datatype are used. The valid range is 0 through 100 percent. The default value is 0 (no deadband). Ifthe Every scan option is enabled, deadband is disabled.Note: If the server tag is of a data type that does not support deadband, then this value is

    www. kepware.com

    15

  • Industrial Data Forwarder for Splunk

    ignored and “N/A” is displayed in the item list Deadband (%) column. Data types that do not sup-port deadband include the String, Boolean, and Date.

    l Every Scan: This option sends data on every scan of the tag even if the value has not changed during theprevious scan period.

    l Metadata: This optional parameter specifies additional string data sent to the Splunk server with eachupdate for this item. The metadata may not contain backslash (“\”) or line break/newline characters.Otherwise, this accepts any ANSI text string. Below is an example of an update string sent to the Splunkserver with metadata:

    2014-07-10 14:17:25.049 +0000 Tag="Simulators.Sim1.Ramp1" Value="71" Quality="good"MachineID=”C42”

    Note: Using the key-value pair format where key is a field name and value is the value of that field, allowsfor field extraction by the Splunk server. Key-value pairs should be separated by whitespace.

    See Also:Multiple Splunk ItemsCreating a New Splunk Item

    Multiple Splunk ItemsThe IDF for Splunk Items dialog can be used to edit the Update Rate, Deadband, Publish Type, and Metadata prop-erties for multiple items simultaneously.

    To open the IDF for Splunk Items dialog; select the items to be edited, then right-click and select Properties….The dialog can also be opened by selecting the items and then clicking the Properties button in the toolbar orselecting the Edit | Properties…menu option.

    Any values entered in this dialog are applied to all of the selected items, overwriting existing values. To preserveexisting values for a property, leave that field blank. For more information on these properties and restrictions ontheir values, see IDF for Splunk Item.

    See Also:IDF for Splunk Item

    www. kepware.com

    16

  • Industrial Data Forwarder for Splunk

    Importing / Exporting CSV FilesThe Industrial Data Forwarder for Splunk supports importing and exporting a connection’s items using a Comma-Separated Value (CSV) file. This allows users to edit the properties of a connection’s items using external tools orto move Splunk items between connections and/or server instances. The easiest way to create an import CSV fileis to export one to use as a template.

    Note: CSV Export does not export the connection’s settings.

    Creating a Template

    1. Select an IDF for Splunk Connection.

    2. Right-click on the connection to select it.

    3. Choose Export to CSV.

    4. Name and save the CSV file to the desired location.

    5. View or edit this CSV file outside the software or import it to another instance.

    CSV File Format

    l Lines beginning with a semicolon “;” are considered comments.l The CSV header must be unchanged from the template (including the commented section).l Field titles in the header may be in any order, but Metadata must be the final field. Everything from thebeginning of a Metadata field until the end of line (EOL) is considered Metadata.

    l The “Server Tag” column is the only required field.l Splunk items are assigned the default property value for any optional field that is blank or missing and awarning appears in the Event Log.

    l Each record must be on its own line.

    Exporting a Connection Item ListExporting generates a CSV file that contains a list of Splunk items and their associated parameters (Server Tag,Update Rate, Deadband, Metadata) from the selected connection.

    Importing a CSV File into a Connection

    www. kepware.com

    17

  • Industrial Data Forwarder for Splunk

    A CSV file can be imported into the IDF for Splunk plug-in by right-clicking on the desired connection and select-ing Import from CSV. This adds the tags specified in the CSV file to the connection. If a tag already exists in theconnection, its properties are overwritten with the values from the CSV file.

    Using Other Characters as the DelimiterFor information on specifying a character to use as the server-specified delimiter, refer toOptions – General inthe server help file.When using a CSV file that does not use a comma or semicolon delimiter, perform a search-and-replace on thedelimiter in the CSV file and replace the delimiter with a comma or semicolon.

    See Also:IDF for Splunk ConnectionCreating a new Splunk ConnectionIDF for Splunk Item

    www. kepware.com

    18

  • Industrial Data Forwarder for Splunk

    Warning and Error Messages

    The following messages may be generated. Click on the link for a description of the message.

    WarningsDropping data for connection (server: :), the maximum queueis . Slow down the data collection rate or verify the server is responsive.Error importing CSV item record . Deadband is invalid, setting to .Error importing CSV item record . Deadband is out of range, setting to .Error importing CSV item record . No Deadband value found, setting to .Error importing CSV item record . No Update Rate found, setting to .Error importing CSV item record . Invalid Metadata string, setting to default value.Error importing CSV item record . Server Tag is invalid.Error importing CSV item record . Update Rate is out of range, setting to .Unable to send data for item on connection . The licensed item count of items has been reached.

    ErrorsConnection failed to connect to server: :. Please verify thisconnection information is correct and that the host can be reached.Error adding item to connection .Error adding item . This item already exists in connection .Error importing CSV data. Header fields are out of order. Metadata must be the final field.Error importing CSV data. Invalid CSV header.Error importing CSV data. Memory allocation failed.Error importing CSV data. No Splunk item records found in CSV file.Error importing CSV header information. Duplicate field name: .Error importing CSV header information. Missing field identification record.Error importing CSV header information. Unrecognized field name: .Failed to export connection to CSV.Internal error occurred while sorting the Splunk item list.Failed to load XML project. Item already exists in Splunk connection .

    www. kepware.com

    19

  • Industrial Data Forwarder for Splunk

    Connection failed to connect to server: :. Please verify this connection information is correct and thatthe host can be reached.Error Type:Serious

    Possible Cause:The IP/hostname and/or port configured in the IDF for Splunk Connection Properties may be incorrect or theSplunk server is not running.

    Solution:

    1. Verify that the Splunk server is running.

    2. Verify that the IP/ hostname and port of the Splunk server match those specified in the Splunk connectionproperties.

    See Also:IDF for Splunk Connection

    Dropping data for connection (server: :), the maximum queue is . Slow down the data collectionrate or verify the server is responsive.Error Type:Serious

    Possible Cause:Server tag values are changing faster than updates can be sent to the Splunk server.

    Solution:

    1. Verify that the network connection to the Splunk server is not being congested by other sources.

    2. Slow down the Update Rate on the IDF for Splunk items.

    3. Decrease the number of Splunk items in the connection.

    See Also:IDF for Splunk Item

    Error adding item to connection .Error Type:Serious

    Possible Cause:The Server Tag specified by this Splunk item is invalid or is not readable.

    Solution:

    1. Add the Server Tag specified by this Splunk item to the project as a static tag.

    2. Correct spelling or syntax errors in the item’s fully qualified path to the Server Tag, where the syntax isChannel.Device.Tag.

    3. Edit security policy settings to permit read access to the specified Server Tag.

    4. Confirm that the data type of the referenced tag is supported.

    www. kepware.com

    20

  • Industrial Data Forwarder for Splunk

    Error adding item . This item already exists in connection .Error Type:Serious

    Possible Cause:A duplicate Splunk item cannot be added to the connection. A server tag may only be referenced once per con-nection.

    Solution:

    1. Remove the existing item from the connection, then add the new item.

    2. Edit the existing item to match the desired settings of the new item.

    Error importing CSV item record . Deadband is invalid; set-ting to .Error Type:Warning

    Possible Cause:The Deadband value for the CSV record is not a numeric value.

    Solution:Verify that the Deadband value is a number between 0.0 and 100.0 (inclusive).

    See Also:Importing / Exporting CSV FilesIDF for Splunk Item

    Error importing CSV item record . No Deadband value found; settingto .Error Type:Warning

    Possible Cause:The CSV record doesn’t have a value in the Deadband field.

    Solution:

    1. Verify that the CSV file has a Deadband field in the file header.

    2. Verify that the CSV record has a value in the Deadband field.

    See Also:Importing / Exporting CSV FilesIDF for Splunk Item

    Error importing CSV item record . Deadband is out ofrange; setting to .Error Type:Warning

    Possible Cause:The Deadband value for the CSV record is outside the range of 0.0 – 100.0 (inclusive).

    Solution:Update the Deadband value to be between 0.0 and 100.0 (inclusive).

    See Also:

    www. kepware.com

    21

  • Industrial Data Forwarder for Splunk

    Importing / Exporting CSV FilesIDF for Splunk Item

    Error importing CSV header information. Duplicate field name: .Error Type:Serious

    Possible Cause:The CSV file header contains multiple instances of a field.

    Solution:Verify that each field is only listed once in the CSV file header.

    See Also:Importing / Exporting CSV Files

    Error importing CSV data. Invalid CSV header.Error Type:Serious

    Possible Cause:The header portion of the CSV file is missing or incorrect.

    Solution:

    1. Add or complete the CSV file with a valid header.

    2. Verify that the CSV file header is in the correct format. See Importing / Exporting CSV Files for instruc-tions to generate a CSV template for the correct header format.

    See Also:Importing / Exporting CSV Files

    Error importing CSV data. Header fields are out of order. Metadata must be thefinal field.Error Type:Serious

    Possible Cause:The Metadata field is not the final field in the CSV file header.

    Solution:Correct the CSV file format so that the Metadata information is the final field.

    See Also:Importing / Exporting CSV Files

    Error importing CSV data. Memory allocation failed.Error Type:Serious

    Possible Cause:Insufficient system resources.

    Solution:Verify that sufficient RAM and hard disk space are available or make additional resources available.

    See Also:Importing / Exporting CSV Files

    www. kepware.com

    22

  • Industrial Data Forwarder for Splunk

    Error importing CSV item record . Invalid Metadata string, setting todefault value.Error Type:Warning

    Possible Cause:The Metadata value for the CSV record contains backslashes or line break / newline characters.

    Solution:Remove special characters from the Metadata value for the CSV record.

    See Also:Importing / Exporting CSV FilesIDF for Splunk Item

    Error importing CSV header information. Missing field identification record.Error Type:Serious

    Possible Cause:The CSV file header does not contain any field identifiers.

    Solution:

    1. Verify that the CSV file header contains at least the Server Tag field identifier.

    2. Add or complete the CSV file with a valid header.

    See Also:Importing / Exporting CSV Files

    Error importing CSV data. No Splunk item records found in CSV file.Error Type:Warning

    Possible Cause:The CSV file does not contain any Splunk item records.

    Solution:

    1. Add valid Splunk item records to the CSV file.

    2. Verify that the CSV file contains valid Splunk item records.

    3. Verify that the CSV file header is in the correct format. See CSV Import/Export for instructions to generatea CSV template for the correct header format.

    See Also:IDF for Splunk ItemImporting / Exporting CSV Files

    Error importing CSV item record . Server Tag is invalid.Error Type:Serious

    Possible Cause:The Server Tag value in the CSV file is invalid or blank.

    Solution:

    www. kepware.com

    23

  • Industrial Data Forwarder for Splunk

    1. Verify that the Server Tag value is not blank.

    2. Verify that the Server Tag value contains at least one character other than underscores and periods.

    See Also:Importing / Exporting CSV FilesIDF for Splunk Item

    Error importing CSV header information. Unrecognized field name: .Error Type:Serious

    Possible Cause:The CSV file header contains an unexpected field or one of the field names is misspelled.

    Solution:

    1. Verify that each field name is spelled correctly (Server Tag, Update Rate, Deadband, Metadata).

    2. Verify that the CSV file header does not contain any extra fields.

    3. Add or complete the CSV file with a valid header.

    See Also:Importing / Exporting CSV Files

    Error importing CSV item record . No Update Rate found; setting to.Error Type:Warning

    Possible Cause:The CSV record does not have a value in the Update Rate field.

    Solution:

    1. Verify that the CSV file has an Update Rate field in the file header.

    2. Verify that the CSV record has a value in the Update Rate field.

    See Also:Importing / Exporting CSV FilesIDF for Splunk Item

    Error importing CSV item record . Update Rate is out ofrange; setting to .Error Type:Warning

    Possible Cause:The Update Rate value for the CSV record is outside the allowable range or is not an integer value.

    Solution:Verify that the Update Rate value for this record is an integer between 10 and 99,999 (inclusive).

    See Also:Importing / Exporting CSV FilesIDF for Splunk Item

    www. kepware.com

    24

  • Industrial Data Forwarder for Splunk

    Failed to export connection to CSV.Error Type:Serious

    Possible Cause:

    1. The user may not have permission to write to the selected export location.

    2. The systemmay have insufficient disk space to create the CSV file.

    Solution:

    1. Verify that the user has permission to write to the selected location.

    2. Change the export location to one where the user has write permissions.

    3. Verify that sufficient system resources are available to create the file.

    See Also:Importing / Exporting CSV Files

    Failed to load XML project. Item already exists in Splunk connection.Error Type:Serious

    Possible Cause:There are duplicate Splunk items defined in the XML project file.

    Solution:Edit the project file to remove duplicate items. See below for an example of a duplicated Splunk item in XML.

    Internal error occurred while sorting the Splunk item list.Error Type:Serious

    Possible Cause:Insufficient system resources.

    Solution:

    www. kepware.com

    25

  • Industrial Data Forwarder for Splunk

    1. Verify that sufficient system resources are available.

    2. Shut down and restart the server configuration software.

    See Also:Importing / Exporting CSV Files

    Unable to send data for item on connection . The licenseditem count of items has been reached.Error Type:Serious

    Possible Cause:More items have been added to the plug-in than are allowed by the installed IDF for Splunk license.

    Solution:

    1. Remove Splunk items from the connection(s).

    2. License the IDF for Splunk plug-in with a higher item limit.

    www. kepware.com

    26

  • Industrial Data Forwarder for Splunk

    Index

    A

    Adding Items 6

    Adding the Connection 5

    C

    Comma-Separated Value (CSV) 17

    Connection failed to connect to server. Please verify this connection information is correct and that the hostcan be reached. 20

    Connection Name 11

    Connection View 4

    Creating a New Splunk Connection 10

    Creating a New Splunk Item 12

    CSV File Format 17

    D

    Deadband 13, 15

    Delimiter 18

    Detail View 4

    Dropping data for connection (server), the maximum queue size is reached. Slow down the data collectionrate or verify the server is responsive. 20

    E

    Enabled 12

    Error adding item to connection. 20

    Error adding item. This item already exists in connection. 21

    Error importing CSV data. Header fields are out of order. Metadata must be the final field. 22

    Error importing CSV data. Invalid CSV header. 22

    Error importing CSV data. Memory allocation failed. 22

    Error importing CSV data. No Splunk item records found in CSV file. 23

    Error importing CSV header information. Duplicate field name. 22

    Error importing CSV header information. Missing field identification record. 23

    Error importing CSV header information. Unrecognized field name. 24

    Error importing CSV item record. Deadband is invalid - setting to new value. 21

    Error importing CSV item record. Deadband is out of range - setting to new value. 21

    Error importing CSV item record. Invalid Metadata string, setting to default value. 23

    Error importing CSV item record. No Deadband value found - setting to new value. 21

    Error importing CSV item record. No Update Rate found - setting to value. 24

    Error importing CSV item record. Server Tag is invalid. 23

    www. kepware.com

    27

  • Industrial Data Forwarder for Splunk

    Error importing CSV item record. Update Rate is out of range - setting to new value. 24

    Errors 4, 19

    Event Log 4

    Every Sca 13

    Every Scan 16

    Exporting 17

    F

    Failed to export connection to CSV. 25

    Failed to load XML project. Item already exists in Splunk connection. 25

    H

    Help Contents 3

    I

    IDF for Splunk Connection 11

    IDF for Splunk Item 15

    Importing 17

    Importing / Exporting CSV Files 17

    Internal error occurred while sorting the Splunk item list. 25

    IP/Hostname 10-11

    Item Count 12

    L

    License Limit 12

    M

    Messages 19

    Metadata 16

    Multiple Splunk Items 16

    O

    Only on Data changes 13

    Only on Data Changes 15

    Overview 3

    www. kepware.com

    28

  • Industrial Data Forwarder for Splunk

    P

    Plug-In Setup 9

    Port 11

    Prerequisites 5

    Q

    Quick Start 5

    S

    Server Tag 15

    Splunk item 12

    T

    Tag Browser 12, 14

    Template 17

    Toolbar 4

    Total Item Count 12

    U

    Unable to send data for item on connection. The licensed item count has been reached. 26

    Update Rate 13, 15

    User Interface 4

    W

    Warning and Error Messages 19

    Warnings 4, 19

    www. kepware.com

    29

  • www. kepware.com

    Industrial Data Forwarder for Splunk

    30

    Table of ContentsIndustrial Data Forwarder for SplunkOverviewUser Interface

    Quick StartPlug-In SetupCreating a New Splunk ConnectionIDF for Splunk ConnectionCreating a New Splunk ItemTag BrowserIDF for Splunk ItemMultiple Splunk Items

    Importing / Exporting CSV FilesWarning and Error MessagesConnection failed to connect to server: :