lint

Author: xuan-cao-swi

CHANGELOG.md

@@ -13,9 +13,9 @@ This release includes the following features:
 * OTLP trace and metric exporter are the now default exporters for swo backend
 * NH-103815: Added resource detectors for Kubernetes and UAMS client
 * Added Lambda instrumentation for 6.1.2
-* Update tag_sql section by @cheempz in https://github.com/solarwinds/apm-ruby/pull/176
-* NH-103804: reverselab scan gem by @xuan-cao-swi in https://github.com/solarwinds/apm-ruby/pull/179
-* Bump DavidAnson/markdownlint-cli2-action from 19 to 20 by @dependabot in https://github.com/solarwinds/apm-ruby/pull/193
+* Update tag_sql section by @cheempz in <https://github.com/solarwinds/apm-ruby/pull/176>
+* NH-103804: reverselab scan gem by @xuan-cao-swi in <https://github.com/solarwinds/apm-ruby/pull/179>
+* Bump DavidAnson/markdownlint-cli2-action from 19 to 20 by @dependabot in <https://github.com/solarwinds/apm-ruby/pull/193>
 
 ## solarwinds_apm 6.1.2 (02/28/2025)
 

CONFIGURATION.md

@@ -75,11 +75,13 @@ All SolarWinds APM-specific settings are prefixed with `SW_APM_`. Standard OpenT
 The SolarWinds backend uses the OTLP exporter by default. You can configure additional exporters for debugging or multi-backend scenarios:
 
 **Console Exporter (for debugging):**
+
 ```bash
 export OTEL_TRACES_EXPORTER=console
 ```
 
 **Multiple Exporters:**
+
 ```bash
 export OTEL_TRACES_EXPORTER=otlp,console
 ```
@@ -95,6 +97,7 @@ gem 'solarwinds_apm'
 ```
 
 Then configure:
+
 ```bash
 export OTEL_TRACES_EXPORTER=jaeger
 ```
@@ -104,18 +107,21 @@ export OTEL_TRACES_EXPORTER=jaeger
 The service name is extracted from your service key by default, but can be overridden:
 
 **Service key format:**
+
 ```bash
 export SW_APM_SERVICE_KEY=<api-token>:<service-name>
 ```
 
 **Override with OpenTelemetry variables:**
+
 ```bash
 # Service name will be 'production-api', not 'my-service'
 export SW_APM_SERVICE_KEY=<api-token>:my-service
 export OTEL_SERVICE_NAME=production-api
 ```
 
 **Resource attributes:**
+
 ```bash
 export OTEL_RESOURCE_ATTRIBUTES=service.name=production-api,service.version=1.2.3
 ```
@@ -125,12 +131,14 @@ export OTEL_RESOURCE_ATTRIBUTES=service.name=production-api,service.version=1.2.
 Fine-tune individual instrumentation libraries using OpenTelemetry environment variables:
 
 **Disable specific instrumentation:**
+
 ```bash
 export OTEL_RUBY_INSTRUMENTATION_SINATRA_ENABLED=false
 export OTEL_RUBY_INSTRUMENTATION_REDIS_ENABLED=false
 ```
 
 **Configure instrumentation options:**
+
 ```bash
 # Include full SQL statements (disable obfuscation)
 export OTEL_RUBY_INSTRUMENTATION_MYSQL2_CONFIG_OPTS='db_statement=include;'
@@ -140,6 +148,7 @@ export OTEL_RUBY_INSTRUMENTATION_NET_HTTP_CONFIG_OPTS='untraced_hosts=localhost,
 ```
 
 Set inside file through ENV hash
+
 ```ruby
 # Set before requiring solarwinds_apm
 ENV['OTEL_RUBY_INSTRUMENTATION_SINATRA_ENABLED'] = 'false'
@@ -273,6 +282,7 @@ SolarWindsAPM::Config[:transaction_settings] = [
 Control which transactions are traced using pattern-based filtering. This is useful for excluding static assets, health checks, or other requests that don't need tracing.
 
 **Configuration:**
+
 ```ruby
 SolarWindsAPM::Config[:transaction_settings] = [
   {
@@ -292,6 +302,7 @@ SolarWindsAPM::Config[:transaction_settings] = [
 ```
 
 **Pattern Matching:**
+
 - Uses Ruby regular expressions
 - Matches against the transaction name
 - Supports regex options like `Regexp::IGNORECASE`
@@ -302,11 +313,13 @@ SolarWindsAPM::Config[:transaction_settings] = [
 Append trace context to database queries as SQL comments for correlation between traces and database logs.
 
 **Enable SQL tagging:**
+
 ```bash
 export SW_APM_TAG_SQL=true
 ```
 
 **Example output:**
+
 ```sql
 -- Before (without tagging)
 SELECT * FROM users WHERE id = 1;
@@ -317,6 +330,7 @@ SELECT * FROM users WHERE id = 1;
 ```
 
 **Supported Operations:**
+
 - **MySQL2**: `query` operations
 - **PostgreSQL**: `exec`, `query`, and similar operations
 
@@ -351,6 +365,7 @@ Starting with version 7.0.0, the environment variable `SW_APM_PROXY` and configu
 For environments requiring HTTP proxies, configure using standard Ruby `Net::HTTP` proxy environment variables:
 
 **Basic proxy:**
+
 ```bash
 # proxy server with no authentication
 http_proxy=http://<proxyHost>:<proxyPort> ruby my.app
@@ -385,7 +400,7 @@ Environment Variable | Config File Key | Description | Default
 `SW_APM_DEBUG_LEVEL` | `:debug_level` | Set the library's logging level, valid values are -1 through 6 (least to most verbose). <br> Setting -1 disables logging from the library. | 3
 `SW_APM_ENABLED` | N/A | Enable/disable the library, setting `false` is an alternative to uninstalling `solarwinds_apm` since it will prevent the library from loading. | `true`
 `SW_APM_SERVICE_KEY` | `:service_key` | API token and service name in the form of `token:service_name`, **required**. | None
-`SW_APM_TAG_SQL` | `:tag_sql` | Enable/disable injecting trace context into supported SQL statements. Set to boolean true or (or string `true` in env var) to enable, see [Tag Query with Trace Context](#tag-query-with-trace-context) for details.| `false`
+`SW_APM_TAG_SQL` | `:tag_sql` | Enable/disable injecting trace context into supported SQL statements. Set to boolean true or (or string `true` in env var) to enable, see [Tag Query with Trace Context](#sql-query-tagging) for details.| `false`
 `SW_APM_TRIGGER_TRACING_MODE` | `:trigger_tracing_mode` | Enable/disable trigger tracing for the service.  Setting to `disabled` may impact DEM visibility into the service. | `enabled`
 `SW_APM_LAMBDA_PRELOAD_DEPS` | N/A | This option only takes effect in the AWS Lambda runtime. Set to `false` to disable the attempt to preload function dependencies and install instrumentations. | `true`
 `SW_APM_TRANSACTION_NAME` | N/A | Customize the transaction name for all traces, typically used to target specific instrumented lambda functions. _Precedence order_: custom SDK > `SW_APM_TRANSACTION_NAME` > automatic naming | None
@@ -411,6 +426,7 @@ N/A | `:transaction_settings` | Configure tracing mode per transaction, aka tran
 ### Log Analysis
 
 Enable debug logging and look for:
+
 - Service key validation
 - Collector connection status
 - Instrumentation loading
@@ -423,4 +439,4 @@ export SW_APM_DEBUG_LEVEL=5
 export OTEL_LOG_LEVEL=debug
 ```
 
-For additional help, see the [SolarWinds documentation](https://documentation.solarwinds.com/en/success_center/observability/content/configure/services/ruby/install.htm) or contact support.
+For additional help, see the [SolarWinds documentation](https://documentation.solarwinds.com/en/success_center/observability/content/configure/services/ruby/install.htm) or contact support.

CONTRIBUTING.md

@@ -45,11 +45,14 @@ The instructions below assume you are in the locally cloned project root directo
 
 1. **Fork the repository** on GitHub
 2. **Clone your fork** locally:
+
    ```bash
    git clone https://github.com/YOUR_USERNAME/apm-ruby.git
    cd apm-ruby
    ```
+
 3. **Add the upstream remote**:
+
    ```bash
    git remote add upstream https://github.com/solarwinds/apm-ruby.git
    ```
@@ -63,16 +66,19 @@ For development, you'll need a host environment capable of running Rake tasks to
 Choose the installation method that works best for your system:
 
 **macOS (using Homebrew):**
+
 ```bash
 brew install rbenv ruby-build
 ```
 
 **Linux (Ubuntu/Debian):**
+
 ```bash
 sudo apt install rbenv
 ```
 
 **Build from source:**
+
 ```bash
 git clone https://github.com/rbenv/rbenv.git ~/.rbenv
 echo 'eval "$(~/.rbenv/bin/rbenv init - bash)"' >> ~/.bashrc # for bash
@@ -152,6 +158,7 @@ bundle install
 #### Working in the Development Container
 
 The development container provides a complete environment for:
+
 - Building and testing the gem
 - Running linting tools
 - Debugging issues
@@ -179,6 +186,7 @@ SW_APM_SERVICE_KEY=<api-token:service-name> irb -r solarwinds_apm
 #### Making Changes
 
 1. **Create a feature branch**:
+
    ```bash
    git checkout -b feature/your-feature-name
    ```
@@ -198,18 +206,21 @@ SW_APM_SERVICE_KEY=<api-token:service-name> irb -r solarwinds_apm
 ### Running Tests
 
 **Full test suite:**
+
 ```bash
 APM_RUBY_TEST_KEY=your_service_key test/run_tests.sh
 ```
 
 **Single test file:**
+
 ```bash
 # Most tests require only the unit.gemfile dependencies
 bundle update
 bundle exec ruby -I test test/opentelemetry/solarwinds_propagator_test.rb
 ```
 
 **Single test case:**
+
 ```bash
 bundle exec ruby -I test test/opentelemetry/solarwinds_propagator_test.rb -n /trace_state_header/
 ```
@@ -231,6 +242,7 @@ Test logs are written to the `log/` directory and are available on the host mach
 ### Test Organization
 
 Tests are organized in the `test/` directory:
+
 - `test/api/` - API-related tests
 - `test/opentelemetry/` - OpenTelemetry integration tests
 - `test/patch/` - Instrumentation patch tests
@@ -254,7 +266,7 @@ This generates a `rubocop_result.txt` file. **All linting issues must be resolve
 - **Issues**: Check existing issues or create a new one
 - **Discussions**: Use GitHub Discussions for questions
 - **Documentation**: Refer to our [documentation website](https://documentation.solarwinds.com/en/success_center/observability/content/configure/services/ruby/install.htm)
-- **Email**: Contact technicalsupport@solarwinds.com for technical support
+- **Email**: Contact <technicalsupport@solarwinds.com> for technical support
 
 ## Additional Resources
 

README.md

@@ -3,6 +3,7 @@
 The `solarwinds_apm` gem starting from version 6.0.0 is an [OpenTelemetry Ruby](https://opentelemetry.io/docs/instrumentation/ruby/) distribution. It provides automatic instrumentation and custom SolarWinds Observability features for Ruby applications.
 
 ## Requirements
+>
 > [!NOTE]
 > Versions before 7.0.0 only support Linux and will go into no-op mode on other platforms.