Customizing event definitions

Event definitions are pre-formatted events that describe the ongoing progress about Venafi or your own add-applications. When an event fires, the Logging application formats the event and it appears on a Policy folder General tab and in a MSSQL Logging channel, such as the Default SQL Channel. When you upgrade to a future version of Trust Protection Platform, any add-on events automatically migrate.

We strongly recommend that you avoid making changes directly to the Log schema for events. Instead, you can customize log events that appear in the Event Definitions folder of the Logging tree. For more information, see About the Log schema.

For add-on application events:

• Make sure each add-on has its own unique Group ID. Use the reserved decimal range of 0200-0299.
• EventIDs must be unique. For example, you can use Group ID 0200 and assign EventIDs from 0200000 through 0200FFFF.

• Comma separate each field and leave unnecessary fields blank.

• Use macros to allow the Logging application to add dynamic information. For more information, see Using the $Event.Formatter$ macro. For example:

  02001FAF,Custom App - Certificate Expiration Processing,,,,,,,,,,,"Service module for the engine $CN [$EHvent.Component$]$ is examining certificates for expiration."

  When this event triggers, the Log server records the following event:
  127.0.0.1, 17/08/2009 22:17:42: Service module for the engine Jupiter is examining certificates for expiration.

To customize a log event definition

1. (Optional) To create events that track the progress of add-in applications, use a line editor. You can copy this example of a single event, and then update the fields as necessary.

   02000001,Custom App - Authorize Successful,Prefixed Name,Prefixed Universal ID,,,,,Session,Plain Text,IP Address,Plain Text,"User $Event.Component$ from IP Address $Event.Data$ successfully issued API Key. Prefixed name: $Event.Text1$. Prefixed universal ID: $Event.Text2$."

2. From the Platform menu bar, click Policy Tree.
3. Navigate to the Logging Event Definitions folder.
4. Right-click Event Definitions > Permissions, and then verify that you have the required View and Write permissions.

5. Under Event Definitions, click the add-in group name.

6. (Optional) If the name is missing, right-click Event Definitions > Add > Event. Specify these parameters:

   Add New Log Application parameters

   Parameter	Description
   Event Name	The group name that appears in the Logging tree.
   Description	The add-on description.
   Name	The add-on application name.

7. In the Schema box, paste your event definitions.

   

8. When you're done, click Save.

Related Topics