mysql_alter_monitoring 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22f662537cec8e934e80799545292630642eb0062266f48bca2a669121cb7a04
+  data.tar.gz: 5bb3d3069b2d221b36321528df3a7299bffa4e56c1808e28c89305fef7d81c21
+SHA512:
+  metadata.gz: d821d17de14ed007b75be479c1edf02fa401a09e040c6a922eb676212ed966d2f5734fb3bfefe987ad9a30e6c98bcb90a82857f5d580fb4965f1633c6e26144a
+  data.tar.gz: cd6a171834427e6738814bc45a751cacbc67133512835af17947e62f54ac78309fbbe86da125c65966b62ea6a138dda1b90435310122446125195a9be27d5fb6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-thread_safety
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 52433677+akito-fujisaki@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Dockerfile

@@ -0,0 +1,18 @@
+FROM ruby:3.2.0-slim
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+      build-essential \
+      git \
+      libmariadb-dev-compat \
+      libmariadb-dev \
+      mariadb-client && \
+    apt-get clean
+
+WORKDIR /src
+
+COPY bin/setup ./bin/
+COPY Gemfile Gemfile.lock mysql_alter_monitoring.gemspec ./
+COPY lib/mysql_alter_monitoring/version.rb ./lib/mysql_alter_monitoring/
+
+RUN bundle install -j4

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mysql_alter_monitoring.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-performance'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'rubocop-thread_safety'
+gem 'yard'

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    mysql_alter_monitoring (0.1.0)
+      mysql2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    mysql2 (0.5.5)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.45.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    rubocop-thread_safety (0.4.4)
+      rubocop (>= 0.53.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  aarch64-linux
+  arm64-darwin-21
+
+DEPENDENCIES
+  mysql_alter_monitoring!
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  rubocop-thread_safety
+  yard
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Akito Fujisaki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,122 @@
+# MysqlAlterMonitoring
+
+Monitoring ALTER TABLE Progress for InnoDB Tables Using Performance Schema.
+
+See: https://dev.mysql.com/doc/refman/8.0/en/monitor-alter-table-performance-schema.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'mysql_alter_monitoring'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install mysql_alter_monitoring
+```
+
+## Usage
+
+### Command line
+
+All commands require the specification of host, user name, password.
+
+It can also be specified in URL format using the --url option.
+
+#### Enable monitoring settings for the performance schema
+
+```
+$ mysql-alter-monitoring enable --url mysql2://root:pass@localhost:3306
+
+# When specifying host, user, password, etc. separately
+$ mysql-alter-monitoring enable --host localhost --port 3306 --user root --password pass
+```
+
+#### Disable monitoring settings for the performance schema
+
+```
+$ mysql-alter-monitoring disable --url mysql2://root:pass@localhost:3306
+```
+
+#### Start monitoring until event empty
+
+```
+$ mysql-alter-monitoring run --url mysql2://root:pass@localhost:3306
+```
+
+#### Start monitoring forever
+
+```
+$ mysql-alter-monitoring run-forever --url mysql2://root:pass@localhost:3306
+```
+
+#### Show help
+
+```
+$ mysql-alter-monitoring -h
+```
+
+## Development
+
+To develop on docker, build first.
+
+```
+$ docker compose build
+```
+
+Enter docker container and run rake task etc.
+
+```
+$ docker compose run --rm gem bash
+```
+
+### rspec
+
+```
+# Run all specs
+$ bin/rake spec
+
+# Run specs individually
+$ bin/rspec spec/mysql_alter_monitoring/monitor_spec.rb
+```
+
+### rubocop
+
+```
+# Run lint
+$ bin/rake rubocop
+
+# Run rubocop autocorrect
+$ bin/rake lint:fix
+```
+
+### yard
+
+```
+# Generate and Check code documents
+# Output to doc/index.html
+$ bin/rake doc
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/akito-fujisaki/mysql_alter_monitoring.
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/akito-fujisaki/mysql_alter_monitoring/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MysqlAlterMonitoring project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/akito-fujisaki/mysql_alter_monitoring/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:lint) do |t|
+  t.options = %w[--parallel]
+end
+namespace :lint do
+  desc 'Lint fix (Rubocop)'
+  task fix: :autocorrect
+end
+
+desc 'Generate and Check code documents'
+task :doc do
+  require 'yard'
+  YARD::CLI::CommandParser.run
+  output = `yard`.lines(chomp: true)
+  exit(1) if output.first.include?('[warn]') || output.last.match(/\d+/)[0].to_i != 100
+end
+
+task default: %i[spec lint doc]

data/compose.yml

@@ -0,0 +1,22 @@
+version: "3"
+
+services:
+  db:
+    image: mysql:8.0
+    environment:
+      - MYSQL_ROOT_PASSWORD=pass
+    volumes:
+      - db-data:/var/lib/mysql
+  gem:
+    build: .
+    image: mysql-alter-logging
+    volumes:
+      - .:/src
+    environment:
+      - DATABASE_URL=mysql2://root:pass@db
+    depends_on:
+      - db
+
+volumes:
+  db-data:
+    driver: local

data/exe/mysql-alter-monitoring

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'mysql_alter_monitoring'
+
+MysqlAlterMonitoring::CLI.new(ARGV).run

data/lib/mysql_alter_monitoring/cli.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module MysqlAlterMonitoring
+  # MysqlAlterMonitoring::CLI
+  class CLI
+    # @param args [Array<String>]
+    # @param io [::IO]
+    # @return [void]
+    def initialize(args, io: $stdout)
+      @args = args
+      @io = io
+      @options = {}
+    end
+
+    # @return [void]
+    # @raise [MysqlAlterMonitoring::Error]
+    def run # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+      parse!
+
+      return if help? || version?
+
+      client = Client.new(build_config)
+
+      case options[:command]
+      when 'enable'
+        PerformanceSchemaSetting.new(client, io).enable!
+      when 'disable'
+        PerformanceSchemaSetting.new(client, io).disable!
+      when 'run'
+        Monitor.new(client, io).run_until_empty_event
+      when 'run-forever'
+        Monitor.new(client, io).run_forever
+      else
+        raise ArgumentError, "Invalid command: #{options[:command]}"
+      end
+    rescue OptionParser::InvalidOption, ArgumentError => e
+      io.puts e.message
+      io.puts help
+    rescue Interrupt
+      io.puts 'Bye!'
+    end
+
+    # @return [String]
+    def help
+      parser.help
+    end
+
+    private
+
+    # @!attribute [r] args
+    # @return [Array<String>]
+    attr_reader :args
+    # @!attribute [r] options
+    # @return [Hash]
+    attr_reader :options
+    # @!attribute [r] io
+    # @return [::IO]
+    attr_reader :io
+
+    # @return [OptionParser]
+    def parser # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = 'Usage: mysql-alter-monitoring [command] [options]'
+        opts.separator <<~COMMANDS
+          Commands:
+                  enable      Enable monitoring settings for the performance schema
+                  disable     Disable monitoring settings for the performance schema
+                  run         Start monitoring until event empty
+                  run-forever Start monitoring forever
+        COMMANDS
+        opts.separator('Options:')
+        opts.on('--url VALUE', String, 'example: mysql2://root:pass@localhost:3306') { @options[:url] = _1 }
+        opts.on('--host VALUE', String) { @options[:host] = _1 }
+        opts.on('--port VALUE', Integer, "default: #{Config::DEFAULT_PORT}") { @options[:port] = _1 }
+        opts.on('--user VALUE', String) { @options[:user] = _1 }
+        opts.on('--password VALUE', String) { @options[:password] = _1 }
+        opts.on_tail('-h', '--help', 'Show help') { @options[:help] = true }
+        opts.on_tail('--version', 'Show version') { @options[:version] = true }
+      end
+    end
+
+    # @return [Boolean]
+    def help?
+      options.key?(:help).tap { io.puts help if _1 }
+    end
+
+    # @return [Boolean]
+    def version?
+      options.key?(:version).tap { io.puts "MysqlAlterMonitoring #{MysqlAlterMonitoring::VERSION}" if _1 }
+    end
+
+    # @return [MysqlAlterMonitoring::Config]
+    def build_config
+      return Config.build_by_url(options[:url] || '') if options.key?(:url)
+
+      Config.new(
+        host: options[:host] || '',
+        port: options[:port] || 0,
+        user: options[:user] || '',
+        password: options[:password] || ''
+      )
+    end
+
+    # @return [Hash]
+    # @raise OptionParser::InvalidOption
+    def parse!
+      command = parser.parse(args).first || ''
+      @options.merge!(command: command)
+    end
+  end
+end

data/lib/mysql_alter_monitoring/client.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module MysqlAlterMonitoring
+  # MysqlAlterMonitoring::Client
+  class Client
+    extend Forwardable
+
+    class << self
+      # @param url [String]
+      # @return [MysqlAlterMonitoring::Client]
+      def build_by_url(url)
+        Config.build_by_url(url).then { new(_1) }
+      end
+    end
+
+    # @!method query
+    #   @return [Object]
+    delegate query: :mysql2_client
+
+    # @param config [MysqlAlterMonitoring::Config]
+    # @return [void]
+    def initialize(config)
+      @mysql2_client = Mysql2::Client.new(
+        host: config.host,
+        port: config.port,
+        username: config.user,
+        password: config.password
+      )
+    end
+
+    private
+
+    # @!attribute [r] mysql2_client
+    # @return [Mysql2::Client]
+    attr_reader :mysql2_client
+  end
+end

data/lib/mysql_alter_monitoring/config.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module MysqlAlterMonitoring
+  # MysqlAlterMonitoring::Config
+  class Config
+    # @return [String]
+    SUPPROTED_URI_SCHEME = 'mysql2'
+    private_constant :SUPPROTED_URI_SCHEME
+    # @return [Integer]
+    DEFAULT_PORT = 3306
+    public_constant :DEFAULT_PORT
+
+    class << self
+      # Build config in DATABSE_URL format used in Rails.
+      # URI scheme must be mysql2.
+      # Example: mysql2://root:pass@0.0.0.0:3306/foo?pool=5
+      #
+      # @param url [String]
+      # @return [MysqlAlterMonitoring::Config]
+      def build_by_url(url)
+        uri = URI.parse(url)
+
+        raise ArgumentError, 'URL scheme must be mysql2' if uri.scheme != SUPPROTED_URI_SCHEME
+
+        new(
+          host: uri.hostname,
+          port: uri.port,
+          user: uri.user,
+          password: uri.password
+        )
+      end
+    end
+
+    # @!attribute [r] host
+    # @return [String]
+    attr_reader :host
+    # @!attribute [r] port
+    # @return [Integer]
+    attr_reader :port
+    # @!attribute [r] user
+    # @return [String]
+    attr_reader :user
+    # @!attribute [r] password
+    # @return [String]
+    attr_reader :password
+
+    # @param host [String]
+    # @param port [Integer]
+    # @param user [String]
+    # @param password [String]
+    # @return [void]
+    # @raise [ArgumentError]
+    def initialize(host:, port:, user:, password:)
+      @host = host
+      @port = port || DEFAULT_PORT
+      @user = user
+      @password = password
+      validate!
+    end
+
+    private
+
+    # @return [void]
+    # @raise [ArgumentError]
+    def validate!
+      raise ArgumentError, 'host must be specified' if host.empty?
+      raise ArgumentError, 'port must be positive' unless port.positive?
+      raise ArgumentError, 'user must be specified' if user.empty?
+      raise ArgumentError, 'password must be specified' if password.empty?
+    end
+  end
+end

data/lib/mysql_alter_monitoring/json_logger.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module MysqlAlterMonitoring
+  # MysqlAlterMonitoring::JsonLogger
+  class JsonLogger
+    # @return [Proc]
+    FORMATTER = (proc do |severity, timestamp, _progname, msg|
+                   JSON.parse(String(msg), symbolized_name: true)
+                       .merge(level: severity, timestamp: timestamp)
+                       .then { "#{JSON.generate(_1)}\n" }
+                 end).freeze
+    private_constant :FORMATTER
+
+    # @param io [::IO]
+    # @return [void]
+    def initialize(io)
+      @logger = ::Logger.new(io, formatter: FORMATTER)
+    end
+
+    # @param hash [Hash]
+    # @return [void]
+    def info(hash)
+      build_message(hash).then { logger.info(_1) }
+    end
+
+    # @param error [Exception]
+    # @param hash [Hash]
+    # @return [void]
+    def error(error, hash = {})
+      hash.merge(error_class: error.class.name, error_message: error.message)
+          .then { build_message(_1) }
+          .then { logger.error(_1) }
+    end
+
+    private
+
+    # @!attribute [r] logger
+    # @return [Logger]
+    attr_reader :logger
+
+    # @param hash [Hash]
+    # @return [String]
+    def build_message(hash)
+      JSON.generate(hash)
+    end
+  end
+end

data/lib/mysql_alter_monitoring/monitor.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module MysqlAlterMonitoring
+  # MysqlAlterMonitoring::Monitor
+  class Monitor
+    # @return [Integer]
+    EMPTY_EVENT_MAX_COUNT = 10
+    public_constant :EMPTY_EVENT_MAX_COUNT
+
+    # @param client [MysqlAlterMonitoring::Client]
+    # @param io [::IO]
+    # @param logging_interval [Numeric]
+    # @return [void]
+    def initialize(client, io, logging_interval: 10)
+      @client = client
+      @logger = JsonLogger.new(io)
+      @logging_interval = logging_interval
+      @performance_schema_setting = PerformanceSchemaSetting.new(client, io)
+    end
+
+    # Fetch ALTER TABLE events at specified intervals and output in JSON format to specified IO.
+    # Exit when a total of 10 empty ALTER TABLE events are fetched.
+    #
+    # @return [void]
+    def run_until_empty_event
+      empty_event_count = 0
+
+      run do |event|
+        empty_event_count += 1 if event.empty?
+        empty_event_count > EMPTY_EVENT_MAX_COUNT
+      end
+
+      logger.info({ message: 'Finish monitoring' })
+    end
+
+    # @return [void]
+    def run_forever
+      run { false }
+    end
+
+    private
+
+    # @!attribute [r] client
+    # @return [MysqlAlterMonitoring::Client]
+    attr_reader :client
+    # @!attribute [r] logger
+    # @return [JsonLogger]
+    attr_reader :logger
+    # @!attribute [r] logging_interval
+    # @return [Numeric]
+    attr_reader :logging_interval
+    # @!attribute [r] performance_schema_setting
+    # @return [MysqlAlterMonitoring::PerformanceSchemaSetting]
+    attr_reader :performance_schema_setting
+
+    # Must specify finish condition in block
+    #
+    # @yieldparam event [Hash]
+    # @yieldreturn [Boolean]
+    # @return [void]
+    def run # rubocop:todo Metrics/AbcSize
+      raise Error, 'performance schema monitoring setting is not enabled' unless performance_schema_setting.enable?
+
+      Enumerator.produce { fetch_event_stages_current }.each do |event|
+        raise StopIteration if yield(event)
+
+        build_log_hash(event).then { logger.info(_1) }
+        sleep(logging_interval)
+      end
+    rescue StandardError => e
+      logger.error(e)
+    end
+
+    # @return [Hash]
+    def fetch_event_stages_current
+      client.query('SELECT * FROM performance_schema.events_stages_current').to_a.first || {}
+    end
+
+    # @param event [Hash]
+    # f@return [Hash]
+    def build_log_hash(event)
+      return { message: 'Event is empty' } if event.empty?
+
+      { progress: calculate_progress(event), raw: event }
+    end
+
+    # @param event [Hash]
+    # @return [String]
+    def calculate_progress(event)
+      (BigDecimal(event['WORK_COMPLETED']) / BigDecimal(event['WORK_ESTIMATED']))
+        .then { _1 * 100 }
+        .then { _1.round(3) }
+        .then { format('%<progress>3.3f(%%)', progress: _1) }
+    end
+  end
+end

data/lib/mysql_alter_monitoring/performance_schema_setting.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module MysqlAlterMonitoring
+  # MysqlAlterMonitoring::PerformanceSchemaSetting
+  class PerformanceSchemaSetting
+    # @param client [MysqlAlterMonitoring::Client]
+    # @param io [::IO]
+    # @return [void]
+    def initialize(client, io)
+      @client = client
+      @logger = JsonLogger.new(io)
+    end
+
+    # @return [void]
+    def enable!
+      client.query <<~SQL
+        UPDATE performance_schema.setup_instruments SET ENABLED = 'YES'
+        WHERE NAME LIKE 'stage/innodb/alter%'
+      SQL
+
+      client.query <<~SQL
+        UPDATE performance_schema.setup_consumers SET ENABLED = 'YES'
+        WHERE NAME LIKE '%stages%'
+      SQL
+
+      logger.info({ message: 'Enable monitoring settings for the performance schema' })
+    end
+
+    # @return [Boolean]
+    def enable?
+      disabled_instruments = client.query <<~SQL
+        SELECT * FROM performance_schema.setup_instruments
+        WHERE NAME LIKE 'stage/innodb/alter%' AND ENABLED = 'NO'
+      SQL
+      disabled_consumers = client.query <<~SQL
+        SELECT * FROM performance_schema.setup_consumers
+        WHERE NAME LIKE '%stages%' AND ENABLED = 'NO'
+      SQL
+
+      disabled_instruments.count.zero? && disabled_consumers.count.zero?
+    end
+
+    # @return [void]
+    def disable!
+      client.query <<~SQL
+        UPDATE performance_schema.setup_instruments SET ENABLED = 'NO'
+        WHERE NAME LIKE 'stage/innodb/alter%'
+      SQL
+
+      client.query <<~SQL
+        UPDATE performance_schema.setup_consumers SET ENABLED = 'NO'
+        WHERE NAME LIKE '%stages%'
+      SQL
+
+      logger.info({ message: 'Disable monitoring settings for the performance schema' })
+    end
+
+    private
+
+    # @!attribute [r] client
+    # @return [MysqlAlterMonitoring::Client]
+    attr_reader :client
+    # @!attribute [r] logger
+    # @return [JsonLogger]
+    attr_reader :logger
+  end
+end

data/lib/mysql_alter_monitoring/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MysqlAlterMonitoring
+  # @return [String]
+  VERSION = '0.1.0'
+end

data/lib/mysql_alter_monitoring.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'forwardable'
+require 'json'
+require 'logger'
+require 'uri'
+require 'mysql2'
+require_relative 'mysql_alter_monitoring/version'
+require_relative 'mysql_alter_monitoring/config'
+require_relative 'mysql_alter_monitoring/performance_schema_setting'
+require_relative 'mysql_alter_monitoring/json_logger'
+require_relative 'mysql_alter_monitoring/client'
+require_relative 'mysql_alter_monitoring/monitor'
+require_relative 'mysql_alter_monitoring/cli'
+
+# MysqlAlterMonitoring
+module MysqlAlterMonitoring
+  # MysqlAlterMonitoring::Error
+  class Error < StandardError; end
+end

data/mysql_alter_monitoring.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mysql_alter_monitoring/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'mysql_alter_monitoring'
+  spec.version = MysqlAlterMonitoring::VERSION
+  spec.authors = ['Akito Fujisaki']
+  spec.email = ['52433677+akito-fujisaki@users.noreply.github.com']
+
+  spec.summary = 'MySQL ALTER TABLE monitoring tool.'
+  spec.description = 'Monitoring ALTER TABLE Progress for InnoDB Tables Using Performance Schema.'
+  spec.homepage = 'https://github.com/akito-fujisaki/mysql_alter_monitoring'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mysql2'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: mysql_alter_monitoring
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akito Fujisaki
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Monitoring ALTER TABLE Progress for InnoDB Tables Using Performance Schema.
+email:
+- 52433677+akito-fujisaki@users.noreply.github.com
+executables:
+- mysql-alter-monitoring
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- compose.yml
+- exe/mysql-alter-monitoring
+- lib/mysql_alter_monitoring.rb
+- lib/mysql_alter_monitoring/cli.rb
+- lib/mysql_alter_monitoring/client.rb
+- lib/mysql_alter_monitoring/config.rb
+- lib/mysql_alter_monitoring/json_logger.rb
+- lib/mysql_alter_monitoring/monitor.rb
+- lib/mysql_alter_monitoring/performance_schema_setting.rb
+- lib/mysql_alter_monitoring/version.rb
+- mysql_alter_monitoring.gemspec
+homepage: https://github.com/akito-fujisaki/mysql_alter_monitoring
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/akito-fujisaki/mysql_alter_monitoring
+  source_code_uri: https://github.com/akito-fujisaki/mysql_alter_monitoring
+  changelog_uri: https://github.com/akito-fujisaki/mysql_alter_monitoring/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: MySQL ALTER TABLE monitoring tool.
+test_files: []