Pipeline reference

Comment step

A Comment step is a note in the step list. It does nothing when the pipeline runs.

Settings

It also takes an id, as every step does.

text string required

The note.

Examples
Fields below come from the firewall's syslog header.Drops load-balancer health checks before the lookup, so they cost nothing downstream.

How it works

Use a Comment step to say why the steps around it are there, for the next person who edits the pipeline. The step list shows its text on the card, so it reads without opening the step. Every record passes it unchanged.

A Comment step can sit anywhere a step can, including in an If step's branches. To say why one line of a calculation is the way it is, write a comment inside a Code step instead.

See also