Skip to content

Releases: superstreamlabs/kafka-analyzer

v1.0.16

14 Aug 11:06
9af091f
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v1.0.15...v1.0.16

v1.0.15

11 Aug 13:08
b645e46
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v1.0.14...v1.0.15

v1.0.10 - Enhanced Health Checks

28 Jun 09:44
Compare
Choose a tag to compare

I'll update the release notes to reflect version 1.0.10:

Release Notes for v1.0.10

�� New Features

Email Collection System

  • Email Collection: Added optional email collection in both interactive and config file modes
  • File Generation Control: File-based reports are only generated when email is provided
  • Supabase Integration: Emails are securely stored in Supabase for report generation
  • Privacy-First: Clear messaging about email usage and storage practices
  • User Experience: Helpful prompts and explanations in interactive mode

Enhanced Health Checks

  • Under-Replicated Partitions: New health check to identify topics with fewer in-sync replicas than configured
  • Min In-Sync Replicas Configuration: Critical check for topics where min.insync.replicas > replication factor
  • Vendor-Specific Checks: Removed Apache Kafka specific checks from generic health checks (kept for AWS MSK)

AWS SDK Migration

  • AWS SDK v3: Migrated from deprecated AWS SDK v2 to v3 for better performance and security
  • Updated Dependencies: Replaced aws-sdk with @aws-sdk/client-kafka
  • Improved Error Handling: Better error handling with AWS SDK v3 error types

�� Improvements

CLI Enhancements

  • Bootstrap Servers: Changed CLI option from --brokers to --bootstrap-servers for consistency
  • Backward Compatibility: Maintained backward compatibility with internal mapping
  • Empty Client ID: Allow empty client ID input in interactive mode (uses default)

Documentation

  • Table of Contents: Added comprehensive table of contents for easy navigation
  • Required Permissions: Added detailed permissions section for each vendor
  • Email Collection Docs: Clear documentation about email collection and privacy
  • Updated Config Examples: All config examples now include email field
  • Permission Requirements: Detailed breakdown of required permissions per vendor

File Management

  • Static Assets: Moved images to dedicated static directory
  • Updated References: All file references updated to use new static directory structure
  • Superstream CTA: Added Superstream CTA image to generated HTML reports

🐛 Bug Fixes

  • Image Paths: Fixed image paths in HTML reports after static directory reorganization
  • AWS SDK Warnings: Eliminated AWS SDK v2 deprecation warnings
  • Error Handling: Improved error handling in health checks

📋 Technical Changes

Dependencies

  • Added: @aws-sdk/client-kafka@^3.835.0
  • Removed: aws-sdk@^2.1531.0
  • Updated: All AWS SDK v3 packages to latest versions

Code Structure

  • Health Checker: Updated to use AWS SDK v3 commands and error handling
  • Analytics: Added email storage functionality with Supabase integration
  • CLI: Enhanced with email collection and improved user experience

�� Security & Privacy

  • Email Storage: Secure email storage in Supabase with proper authentication
  • Privacy Controls: Clear opt-out messaging and privacy notices
  • Permission Documentation: Detailed permission requirements to help users configure access correctly

📚 Documentation Updates

  • README: Comprehensive updates with table of contents, permissions, and email collection
  • Config Examples: Updated all examples to include email field
  • Health Checks: Updated documentation to reflect new checks and requirements

🚀 Migration Guide

For existing users:

  1. Email Collection: No action required - email is optional
  2. AWS SDK: No breaking changes - migration is transparent
  3. CLI Options: --brokers still works but --bootstrap-servers is preferred
  4. Config Files: Add optional email field if you want file-based reports

📦 Installation

npm install -g superstream-kafka-analyzer@1.0.10

🔗 Links


Note: This release includes significant new features while maintaining full backward compatibility. The email collection system is optional and can be skipped if users prefer console-only output.