Viewing or adding notes to an event

For annotating and providing more information about an event, use the Events page in the TrueSight console to add notes to the event.

The following information is displayed in the notes table:

  • Notes added to the event.
  • Details of any operations executed on the event.
  • Details of notifications.
  • Details of alarm actions.
  • Details of annotations, if any. If annotation data is available for an event on the PATROL Agent, you can view its details in the TrueSight console.

Note

Annotation data can be seen in the TrueSight console if you are using TrueSight Infrastructure Management Server version 11.0 and later.

To view the annotation data on Events page

On the Events page, click the  icon for an event to view the logs and notes associated with it. The  icon is available for the events that have notes or annotation data on the PATROL  Agent. If annotation data is available for an event, on the Logs & Notes tab, scroll down to view the annotation details. 

To add notes from the Events page

  1. Click the action menu for the event to which you want to add a note and select Add Notes.
    You can also select multiple events from the Events page and add a common note.
  2. Enter the note and click OK.
  3. The  icon in the Message column of the event indicates that the event has a note. Click the  icon to go to the Logs & Notes tab in the Event Details page.

To add notes from the Event Details page

  1. Click the Logs & Notes tab. 
    You can view the associated notes, if any.
  2. To add a new note, enter the note in the box above the Add Note button and select Add Note.

To change the size of the annotation data

By default, only up to 256 characters are displayed in the annotation data in the TrueSight console. If the annotation data contains more than 256 characters, only the first 256 characters are displayed. However, you can increase or decrease the number of characters that are displayed in the TrueSight console.

Complete the following steps to customize the number of data annotation characters that can be seen in the TrueSight console:

  1. Navigate to the TSIM_INSTALLATION_HOME\pw\custom\conf\pronet.conf file.
  2. Change the value of the following property to customize the number of characters:
    pronet.attach.annotation.data.size.characters=256
    The default value is 256.
  3. Restart the TrueSight Infrastructure Management Server by running the following command:
    pw system start

Note

The change in the pronet.attach.annotation.data.size.characters property affects all incoming annotation data. For the existing annotation data, the number of characters that are displayed in the TrueSight console remains 256.

To limit the annotations associated with an event

By default, you can view a maximum of 20 annotations associated with an event. Run the following command to increase this default value:

msetrec -n <cell_name> -r EM_KB_OPTIONS -S max_notes -V <any value>
Example: msetrec -n cell_1 -r EM_KB_OPTIONS -S max_notes -V 50

To enable attaching the annotation data to the events in the TrueSight console

By default you cannot view the annotation data if annotation data is available for an event on the PATROL Agent. However, if you want to view the annotation data in the TrueSight console, do the following:

  1. Open the TSIM_INSTALLATION_HOME\pw\custom\conf\pronet.conf file, and change the value of this parameter to true as shown below:
    pronet.attach.annotation.with.patrol.event=true

    Note

    When you set the pronet.attach.annotation.with.patrol.event parameter value to true, annotation data for new events is displayed in the TrueSight console. The annotation data for the existing events will no longer be displayed in the TrueSight console.

  2. Restart the TrueSight Infrastructure Management Server by running the following command to make your change effective:
     pw system start

Troubleshooting annotation related issues

Due to the parameter pronet.attach.annotation.with.patrol.event is enabled, you might face certain issues related to annotation data. Following information helps you to troubleshoot the issues.

Symptoms when issues detected with annotation data

    • The data collection stops.
    • Long delays in data collection (30 minutes to 1 hour).
    • The frequency of the incoming annotation is too high. For example, 2500 in 15 minutes.
    • System stops responding.
    • TrueSight Presentation Server stops responding as the index server process does not respond.

Find out the annotation issues from the log lines

By default, the TrueSight.log inside logs directory shows messages similar to the following log lines when annotations are enabled:

    • DataCollection [PatrolPerfDataBolt_7] 600002 Annotation value string for new event : Error 1
    • DataCollection [PatrolPerfDataBolt_1] 600002 Annotation value string for new event : Remote host instance <host name> is still not configured for LOG instance <host server>.
    • DataCollection [PatrolPerfDataBolt_7] 600002 Annotation Attach Event not created as the Annotation Data Size is more than : 256

Probable KM to generate annotation rate

    • Mostly Event Management, MS SQL Server, and MS Exchange KM generates a huge number of annotations. Run the following query to find annotation count applications by class wise, which gives an idea of rate of annotation/application:
      runjava scripts.runsqli "select MM.DISPLAYNAME, MM.UNIQUENAME, AN.MOTYPEID, count(*) COUNT from ANNOTATIONS AN join MO_META MM on AN.MOTYPEID = MM.MOTYPEID GROUP by MM.DISPLAYNAME, AN.MOTYPEID,MM.UNIQUENAME order by COUNT DESC"

Enable PATROL Agent configuration to stop sending the annotation data to the TrueSight Infrastructure Management Server

    • Create and apply infrastructure policy for the specific PATROL Agent and set the following configuration variable value to zero:
      /ConfigData/AgentSetup/annotateLength

      This stops sending the annotation data to the TrueSight Infrastructure Management Server.

If you want the annotations to be enabled for specific KM, disable it from the PATROL Agent side.

To disable the insertion of annotations into database
When the TrueSight Infrastructure Management Server receives annotations, it inserts annotations into the database. Due to receiving a large number of annotations or high rate of annotation you might face server instability. This impacts statistically the data collected in the database insertion. To avoid the impact on data statistically, do the following:

  1. Open the TSIM_INSTALLATION_HOME\pw\custom\conf\pronet.conf file, add this parameter and set the value to false as shown below :
    pronet.insert.annotation.to.db=false
  2. Restart the TrueSight Infrastructure Management Server by running the following command:
    pw system start

This stops inserting annotations into the database.

To disable the annotation data again, change the value of this parameter to false as shown below:
pronet.attach.annotation.with.patrol.event=false

Important

If you set the parameter pronet.insert.annotation.to.db to false , it will not associate annotations to the events even if the event association parameter pronet.attach.annotation.with.patrol.event is set to true.

Was this page helpful? Yes No Submitting... Thank you

Comments