Support for SQLCommenter in Ruby on Rails varies, depending on your versions of Rails.
If you are on Rails version:
- 7.1 and above: SQLCommenter is supported by default. Enable query_log_tags, and SQLCommenter formatting will be enabled by default.
- 7.0: Enable query_log_tags and install the PlanetScale SQLCommenter gem for SQLCommenter support.
- Below 7.0: Refer to the sqlcommenter_rails gem in this directory for adding SQLCommenter support. Note that this requires additional work because you will have to install a fork of the marginalia gem, which has since been consolidated into Rails 7.0 and up.
Tracing support has been implemented in the [marginalia-opencensus gem]: https://github.com/google/sqlcommenter/tree/master/ruby/sqlcommenter-ruby/marginalia-opencensus. Note that this only works for Rails versions below 7.0, before the marginalia gem was consolidated into Rails.
Re-purposing that gem for Rails versions >=7.0 should only require minor modifications (contributions are welcome!).