Create an Attribute:

1. Log in to Fire Scope SPM.
2. Click on Configuration > CIs > Attributes. The Attributes page displays the Attributes for the selected Configuration Item (in the top left corner).
   
3. In Navigate or Search for a description, select the CI you want to create the Attribute for.
4. Click on the Create button (in the top right corner). The Create Attribute page will be displayed.
   
5. Configuration Item : Attributes are associated with a specific CI. Select a Configuration Item that you want this attribute to be associated with.
6. Description: Enter a descriptive name for this item.
7. Status: This field indicates whether Fire Scope is actively collecting data for this attribute. Not Supported indicates that there is a problem with the data being collected.
8. Data Collection Settings: This section defines how Fire Scope should gather values for this attribute, either through the Fire Scope Agent, SNMP or other means. If you are using Fire Scope agent please make sure the selected operation is defined in the Fire Scope Agent’s configuration. For SNMP, you must enter the credentials required to access the SNMP connection (port 161) of the device. The Update interval tells Fire Scope how often to check values. The Value field allows you to either collect the raw value or its rate of change over time.
   1. Type: This determines how Fire Scope SPM should gather values for the Attribute. Depending on what you select, additional form fields may appear.
   2. Operation: Select the operation for gathering data. For e.g. If you are using Fire Scope agent please make sure the selected operation is defined in the Fire Scope Agent’s configuration. For SNMP, you must enter the credentials required to access the SNMP connection (port 161) of the device.
   3. Base Units: Select base unit type appended to the end of all values for this Attribute whenever they are displayed. For example, (%) Percent for processor utilization, (B) Bytes for file system size, and (Bps) Bytes Per Second for network performance.
   4. Use multiplier: In case you want to convert the value mathematically before storing, such as converting bits to bytes, select Custom multiplier. Type the number to multiply in the Custom multiplier field.
   5. Type of Information: Format of values that will be returned by this Attribute.
   6. Value: Option to find how much a value has changed since the last time this Attribute was queried. In this case, select Delta (speed per second) or Delta (simple change) to have Fire Scope SPM only record these values. Select As is to record the actual value.
   7. Update interval (in sec): This field determines how often, in seconds, Fire Scope SPM should retrieve or listen for new data.E.g. Enter 60 to check every minute, 3600 for once an hour, or 86400 for once a day.
   8. CI Profile Field: Name of a field (default or custom) to update for this CI’s profile section. This feature is useful for selecting certain attributes as asset or CMDB information for a particular CI.
9. Flexible intervals (sec): Use this setting to vary how often you want this data sampled.
10. Attribute Display Options: Other options that will be affect the displaying method the data.
    1. Show value: Is the raw value of this attribute meaningful? If not, Fire Scope can display an alternative value using this setting.For example, if the possible results of this attribute are either 1 or 0, you can use value translations to display ‘Good’ for 1 and ‘Bad’ for 0.
    2. Item Type: Classify whether or not this attribute impacts the Security, Availability, Performance or Business Impact of the CI this attribute is associated with. Choose all that apply.
       1. Availability
       2. Performance
       3. Security
       4. Key Performance Indicator: Setting this property will enable some summary views of CIs to display the attributes labeled as KPI.
11. Attribute Sets: Attribute Sets are related groups of attributes, such as My SQL performance attributes or Active Directory lookup metrics.
12. Visual Control Display Setting: Use this section to automatically create graphs, gauges and meters based on the value of this attribute.
    1. Show Performance Display:
    2. Display Type:
13. CI Metadata: 
    Options for using metadata.
    1. Asset Name
    2. Type
    3. Detail
    4. Sub Type
    5. Index
    6. Vendor
    7. Label
14. Tags: Tags are additional identification applied to the main configuration elements: Service Groups, Logical Groups, Configuration Items, Attributes, Event Definitions, Aggregate Event Definitions, Policies, and Visual Controls.Tags are used for search, reports and some specialized displays in the application. System default tags are applied to most agent attributes and some common SNMP (OID) attributes upon creation. You can always create or apply additional tags to any element to further identify each asset.
15. Click on the Save button.

Note: To save time when configuring multiple similar CIs, use a Blueprint.

Edit an Attribute:

1. In the Description column, click on the name of the Attribute you want to edit.
2. If an Attribute is associated with a Blueprint, the Blueprint name precedes the Attribute name and not all fields are editable–such as the operation and type information. If you need to edit an Attribute associated with a Blueprint, select the Blueprint in the Configuration Field (step 3), and edit this Attribute.
3. Edit the form. For more information about the Attribute fields, see Create Attribute.
4. Click on the Save button.

Clone an Attribute:

1. In the Navigation bar, select the appropriate CI and click on the Apply button, Attributes list refreshes for the selected CI.
2. In the Description column, click on the name of the Attribute you want to clone.
3. Edit the form. For more information about the Attribute fields, see Create Attribute.
4. Click on the Save button.

Delete Attribute

1. In the Navigation bar, select the appropriate CI and click on the Apply button, Attributes list refreshes for the selected CI.
2. In the Description column, check the box next to Attribute name you want to delete.
3. From the drop-down in the bottom right corner of the page, select Delete selected.
4. Click Update. A confirmation window will appears.Note: Deleting an Attribute will have a cascading delete effect. All elements that are based on this Attribute will be effected (for e.g. Dashboards, AEDs, ED, Policies etc.. Data collected by this Attribute will be lost for good.)
   

Before You Begin

• Install the Fire Scope Agent on the asset where the log file is stored.
• Ensure that the Fire Scope Agent has access to the asset’s file system in order to read the log file.
• Create a CI for the asset. For more information, see Creating a Configuration Item.

Application Logs:

1. Log in to Fire Scope SPM as a Fire Scope or Configuration Administrator.
2. Click Configuration > CIs > Attributes. The Attributes page displays the Attributes for the selected CI (in the top right corner).
3. In Configuration Item, select the CI you want to create the Attribute for.
4. Click Create. The Create Attribute page will be displayed.
   
5. In Description, enter a descriptive name for the log file.
6. In the Data Collection Settings section
   1. In Type, select Agent Remote.
   2. In Operation, type filesystem_logreader(<path to log file>, <optional parameters>). Refer to the table below for an example.
   3. In Type of Information, select Log.
   4. Complete the rest of the form. For more information about the Attribute fields, see Creating an Attribute.
   5. Click Save. All log entries for this asset will now be collected, associated with this Attribute, and stored as text-based data.

Example

Windows Event Logs

For Microsoft Windows event logs, the process differs in one way. In Operation, type windows_eventvwr(<name of event log>,<optional filter with regex pattern>).

Log name: application, security, system, Optional Filter: Here are the only valid values for <optional filter>:Type, Source, Category, Event ID, Domain, User, Computer, Message. Filters are delimited by pipe ‘|’.Example: windows_eventvwr(system) configures SPM to read the System Event Log.

Example:windows_eventvwr (security,Type:Infomation|Source:Microsoft Windows security|Category:12800|Event ID:5156|Domain:firescope|User:N/A|Computer:N/A|Message:Junk) Note: You do not need to know the exact path for event logs.

Once this data is being collected, you can also quickly access the log entries via the search feature.

Creating the TCP Message

To use the DDA, you must send a TCP message via port 8043, with the following tags and variables. The message format will differ depending on the type of DDA you want to use (see the subsequent sections).

There are two types of DDAs:* Incoming – For sending data elements to view, search, and graph in Fire Scope SPM.

• JSON – For sending associated data elements that will be correlated in Fire Scope SPM. You can view, search, and graph this data too.

The following sections provide examples of each DDA type.

Incoming

The basic template for an Incoming DDA message is:FSCP_PAYLOAD#<ATTRS><ATTR>CIname,operation,value,timestamp</ATTR></ATTRS>

The following example message illustrates a CI named my CI with an Attribute using the fs_incoming(status) operation:FSCP_PAYLOAD#<ATTRS><ATTR>my CI,fs_incoming(status),”Failed”</ATTR></ATTRS>

Here is the same example as above, plus the time stamp:FSCP_PAYLOAD#<ATTRS><ATTR>my CI,fs_incoming(status),”Failed”,1349297031</ATTR></ATTRS>

To send multiple attributes, use the following examples for guidance.

Example 1

The following Incoming DDA message is formatted to send four separate Attributes at once.FSCP_PAYLOAD#<ATTRS><ATTR>my CI,fs_incoming(A1),12345</ATTR><ATTR>my CI,fs_incoming(A2),753861.001</ATTR><ATTR>my CI,fs_incoming(A3),60812</ATTR><ATTR>my CI,fs_incoming(status),Success,1349297031</ATTR></ATTRS>

Example 2

This example shows another way to format an Incoming DDA message. This message sends two Attributes.

FSCP_PAYLOAD#<ATTRS><ATTR><CINAME>my CI</CINAME><OPERATION>fs_incoming(A1)</OPERATION><VALUE>12345</VALUE><TIMESTAMP>5678</TIMESTAMP></ATTR><ATTR><CINAME>my CI</CINAME><OPERATION>fs_incoming(A2)</OPERATION><VALUE>12345</VALUE><TIMESTAMP>5678</TIMESTAMP></ATTR></ATTRS>

JSON

If you want to send correlated data to Fire Scope SPM, use the JSON DDA. With JSON formatting, you can send multiple pieces of data from your system and ensure that those pieces of data will be correlated and available for viewing, searching, and graphing in Fire Scope SPM.

For example, you want to find all the transactions that completed successfully but exceeded your elapsed time threshold. To accomplish this, create a JSON DDA with the following data elements:* Transaction ID

• Status
• Error Code
• Elapsed Time

The following example is a message in JSON format that will send correlated data to Fire Scope SPM:FSCP_PAYLOAD#<ATTRS> <ATTR> <CINAME>my CI</CINAME> <OPERATION>fs_incoming_json(J1)</OPERATION> <VALUE>{“transactionid”:11111,”status”:”Success”,”elapsedtime”:10,”errorcode”:400}</VALUE> <TIMESTAMP>5678</TIMESTAMP> </ATTR></ATTRS>

Note: You can also format a basic Incoming DDA message in the JSON DDA format.

Attribute

To use the DDA in CIs and Templates, create an Attribute in Fire Scope SPM and:# In Type, select the Attribute type you are creating from the following options:

1. Attribute Incoming
2. Attribute JSON Incoming

Once the Attribute is populated with data, the Last Value is displayed on the Attributes page. When you click the link in the Last Value column, a pop-up window displays more information.

Note: You can also create CIs, Logical Groups, and Service Groups, and link CIs to Templates and Groups via Fire Scope’s REST API.

Event Definition

The following two screen shots show the JSON DDA used in an Event Definition.* Configuration for an Event Definition using the JSON DDA

Visual Controls

Visual Controls are available with data obtained by the DDA just as they are for any data in Fire Scope SPM.

Reports

You can use the Reports in Fire Scope SPM to present your data obtained through DDA in an organized, meaningful way.

Group Checked Attribute

Grouped Check Attributes let you group and perform calculations on the same Attribute across multiple Configuration Items (CIs) within a single Logical Group. Multiple functions are supported, including averaging the current attribute value, identifying the maximum or minimum current value, and adding the values together for a group sum. This allows you to define a single event trigger that monitors a metric across multiple CIs, which is especially useful in web farm scenarios. As add or remove CIs from the Logical Group specified, you do not need to modify the Grouped Check Attribute.

Grouped Checks are ideal for scenarios where all CIs in the Logical Group are similar models of hardware, software, and production utilization.

Format

The format for a Grouped Check Attribute is as follows:grouped_operation(group,operation,function,parm)

The following table describes each variable used in the Grouped Check Attribute operation:

Variable

Supported Operations

The following operations are supported with the Grouped Check Attribute:

Supported Functions

The following functions are supported in the Grouped Check Attribute operations:

Examples

Additional examples of keys for Grouped Check Attributes: * Example 1: Total disk space of Logical Group ‘My SQL Servers’ grouped_sum(“My SQL Servers”,”vfs.fs.size[/,total]”,”last”,”0″)

• Example 2: Average processor load of Logical Group ‘My SQL Servers’ grouped_average(“My SQL Servers”,”system.cpu.load[,avg1]”,”last”,”0″)
• Example 3: Average (5min) number of queries per second for Logical Group ‘My SQL Servers’ grouped_average(“My SQL Servers”,”mysql.qps”,”avg”,”300″)

import java.util.Calendar; public class Execution Message Counter implements Execution Message Counter MBean { private int last Index; private long[] per Minute Message Count; public Execution Message Counter() { super(); last Index = 0; per Minute Message Count = new long[1440]; } public long get Per Minute Message Count() { int per Minute Message Count Index = get Minute Index Now(); return per Minute Message Count[per Minute Message Count Index]; } public long get Daily Message Count() { long daily Message Count = 0; for(long one Minute Count : per Minute Message Count) { daily Message Count += one Minute Count; } return daily Message Count; } private synchronized int get Minute Index Now() { Calendar calendar = Calendar.get Instance(); int result Index = calendar.get(Calendar.HOUR_OF_DAY) * 60 + calendar.get(Calendar.MINUTE); return result Index; } } 

Executioin Message Counter counter = new Execution Message Counter(); MBean Server m Bean Server = Management Factory.get Platform MBean Server(); try { Object Name object Name = new Object Name(“example:name=Message Counterâ€); m Bean Server.register MBean(counter, object Name); } catch(Exception exception) { // Add appropriate exception handling } 

LDAP Check

Creating an LDAP Check attribute

Note: Before you can create LDAP Check attributes, you should define appropriate credentials to be used to execute the LDAP Queries.

Once you have working LDAP credentials attached to the CI, you can create the LDAP check attributes. Only attributes of CI’s associated to an LDAP credentials will be able to collect LDAP data.# Click on create button on the upper right hand corner of the Attribute page.Note: Make sure appropriate CI is selected.

1. In the Data Collection Settings section select LDAP Check from the Type dropdown list.

1. Click on the Select Operation button and click on LDAP_Check. This will give you the syntax and examples for this attribute.

Operation	Description	Example
(search DN,ldap Attr Name,ldap Filter)return type: CharacterType: LDAP Check Value returned is attribute dependent	Retrieves information from LDAPParameters:search DN = LDAP search DN, ldap Attr Name = LDAP attribute to be searched, ldap Filter = LDAP search filter	Example: ldap_check(“ou=Users,dc=Your Company,dc=com”,”mail”,” dn=Bugs Bunny”)

1. When defining the LDAP query ensure that you retrieve information which you can use as an attribute. For e.g. If you wanted to test if any account that begins “SVC-“ is locked out, you could write an LDAP query to simply return true or false, but it may well be more useful to write one which returns a list of those accounts which are locked out. This way, when you add this to a notification, the recipient knows which account(s) to investigate. As an example the following LDAP_Check attribute returns a list of accounts starting “SVC-“ which are currently locked out
   ldap_check(“CN=Users,DC=firescope,DC=com”,”cn”,”(&(cn=SVC-*)(lockout Time>=1))”)
2. Select appropriate data type returned from the query from Type of Information dropdown list. In the above example it would be character.
3. Set the Update Interval.
4. Click Save.

Net App DFM Attribute

Operation	Description	Examples
netapp_dfm_volume(volume Id, volume Key)return type: CharacterType: Net App DFM Attribute Value returned is stat dependent	Returns the latest volume stat value for the specified volume Id and volume KeyParameters:volume Id = id of the volumevolume Key = name of the stat	Example: netapp_dfm_volume(123,volume-size:afs-used)Returns the number of bytes used on volume 123

Netapp Check

Operation	Description	Examples
netapp_capacity(algorithm)return type: Numeric (integer 64bit)Type: Net App Check Value returned in Bytes	Returns the latest filer capacity for the specified algorithmParameters:algorithm = The algorithm to be performed:total Raw Capacity, total Formatted Capacity, total Spare Capacity, total Capacity In Raid Space, total Capacity In Wafl Reserve, total Capacity In Reserved Space, total Capacity For Provisioning, total Capacity Allocated, total Capacity Of User Usable Data, total Capacity Available	Example:netapp_capacity(total Spare Capacity) Returns the capacity of all spares on the filer.
netapp_disk(aggregate Name, disk Uid, disk Key)return type: CharacterType: Net App Check Value returned is stat dependent	Returns the latest disk stat value for the specified aggregate Name, disk Uid And disk KeyParameters:aggregate Name = name of the aggregatedisk Uid = UID of the diskdisk Key = name of the stat	Example:netapp_disk(aggr0,5000CCA0:0996A808: 00000000:00000000:00000000:00000000: 00000000:00000000:00000000:00000000,rpm) Returns the rpm for the specified disk on aggr0
netapp_perf(object, instance, counter)return type: CharacterType: Net App Check Value returned is counter dependent	Returns the latest counter value for the specified object and instanceParameters:object = the perf objectinstance = the perf instancecounter = the perf counter	Example:netapp_perf(system, system, http_ops) Returns number of http ops for system instance of the system object.
netapp_snapshot(volume Name, snapshot Name, snapshot Key)return type: CharacterType: Net App Check Value returned is snapshot Key dependent	Returns the latest snapshot stat value for the specified volume Name, snapshot Name And snapshot KeyParameters:volume Name = name of the volumesnapshot Name = name of the snapshotsnapshot Key = name of the stat	Example: netapp_snapshot(vol0,hourly.0,total) Returns total snapshot space for hourly.0 on vol0
netapp_snapshot_aggregate(volume Name, snapshot Key)return type: Numeric (integer 64bit)Type: Net App CheckValue returned is Long	Returns the latest aggregate snapshot stat value for the specified volume Name And snapshot Key Parameters:volume Name = name of the volumesnapshot Key = name of the stat	Example:netapp_snapshot_aggregate(vol0,total) Returns total aggregate snapshot space on vol0
Value returned is Longnetapp_spare(disk Uid, disk Key)return type: CharacterType: Net App Check Value returned is stat dependent	Returns the latest spare disk stat value for the specified disk Uid and disk KeyParameters:disk Uid = UID of the diskdisk Key = name of the stat	Example:netapp_spare(5000CCA0:0996A808: 00000000:00000000:00000000:00000000: 00000000:00000000: 00000000:00000000,rpm) Returns the rpm for the specified spare disk
netapp_volume(volume Name, volume Key)return type: CharacterType: Net App Check Value returned is stat dependent	Returns the latest volume stat value for the specified volume Name and volume KeyParameters:volume Name = name of the volumevolume Key = name of the stat	Example:netapp_volume(vol0,size-used)Returns the number of bytes used on vol0

Percentile

Operation	Description	Examples
percentile_attribute(operation,days_in_period,percentile)return type: Numeric (float)Percentile result Type: Percentile	Value of other attributes at specified percentile Parameters:Example: percentile_attribute (“netapp_volume(vol0,size-used)”,30,95)

SMIS

Operation	Description	Examples
smis_disk_metric(objectpath, property)return type:CharacterType: SMISValue returned is property dependent	Returns the current value of the specified SMIS metric Parameters:object Path= SMI-S path to retrieve the Block Storage Statistical Data instance for the attributeproperty = The name of the property	Example: smis_disk_metric(10.83.26.34/root/emc: Symm_Block Storage Statistical Data.Instance ID= ”SYMMETRIX-+-000198701245-+-Disk-+-0″,Total IOs) Returns the toal number of IO operations for the specified instance
smis_system_metric(objectpath, property)return type: CharacterType: SMISValue returned is property dependent	Returns the current value of the specified SMIS metric Parameters:object Path= SMI-S path to retrieve the Block Storage Statistical Data instance for the attributeproperty = The name of the property	Example: smis_system_metric(10.83.26.34/root/emc: Symm_Block Storage Statistical Data.Instance ID= ”SYMMETRIX-+-000198701245-+-Array-+-0″,EMCTotal Hit IOs) Returns the number of hit IO’s for the specified instance
smis_volume_metric(objectpath, property)return type:CharacterType: SMISValue returned is property dependent	Returns the current value of the specified SMIS metricParameters:object Path= SMI-S path to retrieve the Block Storage Statistical Data instance for the attributeproperty = The name of the property	Example: smis_volume_metric(10.83.26.34/root/emc: Symm_Block Storage Statistical Data.Instance ID= ”SYMMETRIX-+-000198701245-+-Volume-+-00000″,Read IOs) Returns the total number of read IO’s for the specified instance