Static Checker Flink banner
awslabs awslabs

Static Checker Flink

Productivity community

Description

Maven plugin to detect known connector incompatibility and other Apache Flink issues at build time

Installation

This entry records only its repository, not the path inside it, so there is no exact command to give. Open the source below and copy the folder into ~/.claude/skills/, or the file into ~/.claude/agents/.

README

Why this project exists

The goal of this project is to catch certain issues with Apache Flink applications fast (during build/packaging).

Covered cases:

  • Kinesis connector compatibility issues & known bugs
  • Kafka connector compatibility issues & known bugs
  • MSK IAM Auth library issues & known bugs

For instance did you know that you have to use AWS Kinesis Connector 1.15.4 or above for Flink 1.15 apps? This plugin is there to stop you from building an app that has such incompatible connector versions.

What this project is

Maven plugin to find issues with Apache Flink applications at build time.

Example usage:

Run the following Maven command in your Maven (Apache Flink) project dir:

mvn software.amazon.kinesis:static-checker-flink:0.0.1:check

Checker results should also appear in `target/` folder in jUnit format, so you can integrate it with a CI tool.

How to include it in project pom.xml so it runs on every build

Include plugin in `pom.xml`


    
        
            software.amazon.kinesis
            static-checker-flink
            0.0.1
            
                
                    
                        check
                    
                
            
        
    

Verify project

mvn clean verify

You should get a warning about issues in your project:

![](./screenshots/static-checker-lenient-mode.png)

If you want to fail the build because of the detected issues, enable strict mode:


    
        
            software.amazon.kinesis
            static-checker-flink
            0.0.1
            
                
                    
                        check