New Transparent capture is in preview. Record every app's traffic with no proxy configuration, on Windows, macOS and Linux. Learn more

commentSearchFilter Filter

Select exchanges whose attached comment matches a string or regex, useful for grouping and reviewing annotated traffic in the Fluxzy UI.

commentSearchFilter is a review oriented filter. It does not influence live traffic but it is invaluable when you replay a capture, slice it for an after action report, or build saved views that focus on annotated exchanges.

When to use this filter

Use commentSearchFilter when you want to query a capture for exchanges that carry a specific annotation. Comments are typically applied by applyCommentAction during a capture, or manually in the Fluxzy desktop UI. This filter then lets you build follow up rules or view filters that target those exchanges.

Typical situations:

  • Selecting all exchanges that were flagged with the same incident identifier during a review.
  • Filtering the timeline view to focus on a subset of exchanges that share an investigative note.
  • Driving downstream actions in a saved view, for example exporting only annotated exchanges.

This filter runs on the outOfScope evaluation scope, which means it is not invoked during the live HTTP flow. It is meant for view filters and internal actions, not for runtime mutation of traffic.

Real world examples

Build a view filter for an incident review

After tagging every suspicious exchange with a comment during a session, build a view filter that surfaces only those exchanges for quick navigation in the UI.

rules:
- filter:
    typeKind: CommentSearchFilter
    pattern: incident-4821
    operation: Contains
  actions:
  - typeKind: ApplyTagAction
    tag:
      value: review-shortlist

Re tag exchanges previously annotated by hand

Pick up every exchange whose comment starts with 'TODO' and apply a structured tag so the rest of the pipeline can act on them programmatically.

rules:
- filter:
    typeKind: CommentSearchFilter
    pattern: ^TODO
    operation: Regex
  actions:
  - typeKind: ApplyTagAction
    tag:
      value: needs-followup

Exclude exchanges that have been triaged

Invert the filter to select every exchange whose comment does not contain 'triaged', then mark them for the next review pass.

rules:
- filter:
    typeKind: CommentSearchFilter
    pattern: triaged
    operation: Contains
    inverted: true
  actions:
  - typeKind: ApplyCommentAction
    comment: pending review

Reference

commentSearchFilter

Description

Select exchanges by searching a string pattern into the comment property.

Evaluation scope

Evaluation scope defines the timing where this filter will be applied.

outOfScope Means that the filter or action associated to this scope won't be trigger in the regular HTTP flow. This scope is applied only on view filter and internal actions.

YAML configuration name

commentSearchFilter

Settings

The following table describes the customizable properties available for this filter:

Property Type Description DefaultValue
pattern string The string pattern to search
operation exact | contains | startsWith | endsWith | regex The search operation performed contains
caseSensitive boolean true if the Search should be case sensitive false
inverted boolean Negate the filter result false

Example of usage

This filter has no specific usage example

.NET reference

View definition of CommentSearchFilter for .NET integration.

See also

The following filters are related to this filter:

Frequently asked questions

Does this filter run on the live HTTP flow?

No. commentSearchFilter is evaluated on the outOfScope scope, so it only applies inside view filters and internal actions, not during live request processing.

How do exchanges get a comment in the first place?

Either programmatically via applyCommentAction or manually from the Fluxzy UI by adding a note to an exchange. commentSearchFilter then queries that field.

Can I match on partial text?

Yes. The default operation is Contains. Switch to Exact, StartsWith, EndsWith or Regex depending on how strict the match should be.

Is the match case sensitive?

No by default. Set caseSensitive: true if your comments use a specific casing convention.

Learn more about Fluxzy rules