Related Documentation
Incompatible with
on-prem
Related Resources

The Skip Records policy ensures that only valid and relevant records continue through the policy execution chain. If the record is skipped, it won’t be processed any further.

Use cases

Common use cases for the Skip Record policy:

Use case

Description

Skip records with a specific name pattern Identify records with a specific suffix and skip processing them.

How it works

This policy runs in the consume phase.

  1. Event Gateway consumes messages from a Kafka broker.
  2. Event Gateway checks records against a pattern.
    • If the record matches a defined pattern, it skips processing the record and passes it on.
    • If the record doesn’t match the pattern, it applies further policies in the chain.
 
sequenceDiagram
  autonumber
  participant broker as Event broker
  participant egw as Event Gateway
  participant client as Client


  broker->>egw: consume message
  egw->>egw: check message validity
  
  alt message matches name pattern

  egw->>client: skip processing and pass to client

  else message doesn't match name pattern
  egw ->> egw: apply other policies
  egw->>client: pass to client

  end

  

Nested policies

This policy can be applied directly to the virtual cluster, or be nested within a Schema Validation policy. See the policy nesting example to learn how to apply a Skip Records policy to a parent.

Nested policies are sorted into an index. You can re-order nested policies within the parent policy by adjusting this index. See the reference for nested policies for more detail.

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!