Ruby Library release notes
These release notes describe the new features, improvements, and fixed issues in the SolarWinds Observability Ruby Library.
Learn more
- For release notes for all SolarWinds agents, libraries, and collectors, see SolarWinds Observability summary release notes.
- For currently known issues, see Known issues.
- For information about requirements, see SolarWinds Observability System Requirements.
2024 updates
6.0.0 - April 11, 2024
Upstream OpenTelemetry versions
Breaking changes
-
This is a completely new version of the instrumentation library built upon OpenTelemetry. Please see the 6.0.0 prerelease notes for a description of the changes.
New features and improvements
- Improved logging when a service key is invalid.
- Better no-op support when the library is disabled.
6.0.0 prerelease - January 31, 2024
Upstream OTel dependencies
New features and improvements
-
Initial SolarWinds Observability Ruby Library alpha release: This release introduces the alpha version of the SolarWinds Observability Ruby Library, leveraging OpenTelemetry Instrumentation for automatic instrumentation of common Ruby frameworks.
-
OpenTelemetry Ruby API/SDK integration: Integration with OpenTelemetry Ruby API/SDK for trace generation.
-
Supported Ruby version: OpenTelemetry Ruby supports only current versions of the runtime. The SolarWinds Observibility Ruby Library prerelease can still be installed on Ruby 2.7 which is EOL, but it will lack major features and this support will be removed soon. We highly encourage upgrading to a current version of Ruby.
-
Customizable configuration: Users can customize the standard opentelemetry-ruby configuration through the SolarWindsAPM configurator. For more information, see the Configuration documentation.
-
Enhanced trace/span metadata: Users can adjust trace/span metadata using the standard opentelemetry-ruby API. For more information, see the OpenTelemetry SDK documentation.
-
Environment variable configuration: Users can configure propagators, exporters, and instrumentation using OpenTelemetry Ruby environment variables. For more information, see Environmental Variables and OpenTelemetry Configuration documentation.
-
Unified metrics format support: Support for a new unified metrics format. For more information about the unified metrics, see the October 2022 Release Notes.
-
-
SolarWindsAPM Ruby API updates:
- Code adjustment for ugrade to 6.x: Updated the new SolarWindsAPM Ruby API. For more information, see the API documentation.
- Custom transaction name setting: Set a custom transaction name using
SolarWindsAPM::API.set_transaction_name('custom_name')
. - Readiness check: Check if SolarWindsAPM is ready using
SolarWindsAPM::API.solarwinds_ready(wait_milliseconds=3000)
. - Trace context information retrieval: Get current trace context information using
SolarWindsAPM::API.current_trace_info
. - Convenience method for OpenTelemetry Ruby
in_span
: Use a convenience method for OpenTelemetry Ruby'sin_span
usingSolarWindsAPM::API.in_span('custom_span') do |span| end
.
- Custom transaction name setting: Set a custom transaction name using
- Code adjustment for ugrade to 6.x: Updated the new SolarWindsAPM Ruby API. For more information, see the API documentation.
Common APM library updates: update to liboboe 14.0.1
- Dropped support of alpine 3.12.
-
Fixed the default log sink (
stdout
) fromBoost.log
of liboboe - Added dependency review Github action.
2023 updates
5.1.8 - May 23, 2023
Common APM library updates: update to liboboe 12.2.0
- AWS and Azure VM metadata is reported for Service and Host correlation.
5.1.7 - April 3, 2023
Improvements:
- liboboe is upgraded to version 12.1.0. liboboe 12.1.0 adds the ability to retrieve AWS EC2 and Azure VM metadata, fixes a threading locking issue, and allows messages to be ingested without an HTTP status code tag applied.
5.1.6 - March 17, 2023
Improvements
-
RemoteHost
is sanitized in the library code.
Support changes
- Updated liboboe to version 12.0.0. liboboe 12.0.0 restores support of alpine 3.12, upgrades gRPC to v1.51.1, upgrades boost to 1.80.0, and removes support for CentOS, Redhat 7, and ubuntu 16.04.
- AmazonLinux is an alternative for the RHEL distro.
2022 updates
5.1.3 - November 7, 2022
- Updated to liboboe 11.0.0 to support using the AppOptics endpoint with default certificates.
5.1.2 - October 13, 2022
- Support for a new unified metrics format with an update to liboboe 10.6.1. See SolarWinds Observability October 2022 release notes for details of the unified metrics, why you should upgrade your library, and follow up actions that may be necessary after upgrading your library.
- Disabled profiling
Legal notices
© 2024 SolarWinds Worldwide, LLC. All rights reserved.
This document may not be reproduced by any means nor modified, decompiled, disassembled, published or distributed, in whole or in part, or translated to any electronic medium or other means without the prior written consent of SolarWinds. All right, title, and interest in and to the software, services, and documentation are and shall remain the exclusive property of SolarWinds, its affiliates, and/or its respective licensors.
SOLARWINDS DISCLAIMS ALL WARRANTIES, CONDITIONS, OR OTHER TERMS, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, ON THE DOCUMENTATION, INCLUDING WITHOUT LIMITATION NONINFRINGEMENT, ACCURACY, COMPLETENESS, OR USEFULNESS OF ANY INFORMATION CONTAINED HEREIN. IN NO EVENT SHALL SOLARWINDS, ITS SUPPLIERS, NOR ITS LICENSORS BE LIABLE FOR ANY DAMAGES, WHETHER ARISING IN TORT, CONTRACT OR ANY OTHER LEGAL THEORY, EVEN IF SOLARWINDS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
The SolarWinds, SolarWinds & Design, Orion, and THWACK trademarks are the exclusive property of SolarWinds Worldwide, LLC or its affiliates, are registered with the U.S. Patent and Trademark Office, and may be registered or pending registration in other countries. All other SolarWinds trademarks, service marks, and logos may be common law marks or are registered or pending registration. All other trademarks mentioned herein are used for identification purposes only and are trademarks of (and may be registered trademarks) of their respective companies.