Skip to main content

The Comment Function

In this section, we'll cover how to use the Comment Function to document the Pipeline. The Comment Function adds a text comment in a Pipeline. It makes no changes to event data. The added comment is visible only within the Pipelines UI, where it is useful for labeling Pipeline steps.

Steps – Adding a Comment Function​

important

Display the Pipeline

  1. On Stream's top nav, make sure Manage is active, then select the Processing submenu and click Pipelines.
  2. Select the XML Pipeline at the bottom of the stack.
    If Pipeline names are truncated, drag the divider to the right to collapse the right Sample Data pane.
  3. As shown below, select the Add Functionon button, search for Comment, and select it to add it to the Pipeline.

addFunction

Before we add logic, we want add some information about the Pipeline, so others can quickly understand its purpose.

Steps – Adding Comment Information​

important

Fill In the Comment

  1. Add a description, author, and date to the comment. You can copy and paste the example below.
Description: Parse and Reduce Windows XML Events
Author:  Cribl User
Date:    2024-02-07
  1. Select Save when you are done.

Your comment might look something like this:
Comment

Next, we are going to capture some new data for use within our tutorial.