Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Commit 55b0a43

Browse files
authored
doc: add deprecation notice (#223)
* doc: add deprecation notice and fix documentation links * update icon * spacing * more broken links * more broken links
1 parent 6385f22 commit 55b0a43

File tree

3 files changed

+15
-8
lines changed

3 files changed

+15
-8
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
> ⚠️ Deprecation Notice
2+
3+
> The Splunk Distribution of OpenTelemetry Ruby is deprecated as of March 15, 2024 and will reach end of Support on March 15, 2025.
4+
> Until then, only critical security fixes and bug fixes will be provided. After the date, this repository will be archived and no longer maintained.
5+
> New customers instrumenting Ruby applications should use the [OpenTelemetry Distribution of Ruby](https://github.com/open-telemetry/opentelemetry-ruby).
6+
> Existing customers should consider migrating to [OpenTelemetry Distribution of Ruby](https://github.com/open-telemetry/opentelemetry-ruby) which offers similar capabilities. To learn how to instrument Ruby code see the [Splunk documentation](https://docs.splunk.com/observability/en/gdi/get-data-in/application/ruby/get-started-ruby.html).
7+
18
# Splunk Distribution of OpenTelemetry Ruby
29

310
<p align="left">
@@ -24,26 +31,26 @@ This distribution comes with the following defaults:
2431
- Unlimited default limits for [configuration options](#trace-configuration) to
2532
support full-fidelity traces.
2633

27-
If you're using the SignalFx Tracing Library for Ruby and want to migrate to the Splunk Distribution of OpenTelemetry Ruby, see [Migrate from the SignalFx Tracing Library for Ruby](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.migrate) in the official documentation.
34+
If you're using the SignalFx Tracing Library for Ruby and want to migrate to the Splunk Distribution of OpenTelemetry Ruby, see [Migrate from the SignalFx Tracing Library for Ruby](https://docs.splunk.com/observability/en/gdi/get-data-in/application/ruby/distro/troubleshooting/migrate-signalfx-ruby-agent-to-otel.html) in the official documentation.
2835

2936
## Requirements
3037

3138
This distribution requires Ruby version 3.0 or higher.
3239

3340
## Get started
3441

35-
For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry Ruby, see [Instrument a Ruby application for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.application) in the official documentation.
42+
For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry Ruby, see [Instrument a Ruby application for Splunk Observability Cloud](https://docs.splunk.com/observability/en/gdi/get-data-in/application/ruby/distro/instrumentation/instrument-ruby-application.html) in the official documentation.
3643

3744
## Advanced configuration
3845

39-
See [Configure the Ruby agent for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.configuration) in the official documentation.
46+
See [Configure the Ruby agent for Splunk Observability Cloud](https://docs.splunk.com/observability/en/gdi/get-data-in/application/ruby/distro/configuration/advanced-ruby-otel-configuration.html) in the official documentation.
4047

4148
## Correlate traces and logs
4249

4350
You can add trace metadata to logs using the OpenTelemetry trace API. Trace
4451
metadata lets you explore logs in Splunk Observability Cloud.
4552

46-
See [Connect Ruby trace data with logs for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.trace.logs) in the official documentation.
53+
See [Connect Ruby trace data with logs for Splunk Observability Cloud](https://docs.splunk.com/observability/en/gdi/get-data-in/application/ruby/distro/instrumentation/connect-traces-logs.html) in the official documentation.
4754

4855
## Library instrumentation
4956

@@ -56,7 +63,7 @@ on [rubygems.org](https://rubygems.org).
5663

5764
## Manual instrumentation
5865

59-
See [Manually instrument Ruby applications for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.manual.instrumentation) for instructions on how to manually instrument Ruby applications.
66+
See [Manually instrument Ruby applications for Splunk Observability Cloud](https://docs.splunk.com/observability/en/gdi/get-data-in/application/ruby/distro/instrumentation/ruby-manual-instrumentation.html) for instructions on how to manually instrument Ruby applications.
6067

6168
## Configure for use with Smart Agent
6269

@@ -68,7 +75,7 @@ If the `SPLUNK_REALM` or the `OTEL_EXPORTER_JAEGER_ENDPOINT` environmental varia
6875

6976
## Troubleshooting
7077

71-
For troubleshooting information, see the [Troubleshoot Ruby instrumentation for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.troubleshooting) in the official documentation.
78+
For troubleshooting information, see the [Troubleshoot Ruby instrumentation for Splunk Observability Cloud](https://docs.splunk.com/observability/en/gdi/get-data-in/application/ruby/distro/troubleshooting/common-ruby-troubleshooting.html) in the official documentation.
7279

7380
# License
7481

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
The documentation for this distribution can be found in the [Splunk Observability Cloud official documentation](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.application).
1+
The documentation for this distribution can be found in the [Splunk Observability Cloud official documentation](https://docs.splunk.com/observability/en/gdi/get-data-in/application/ruby/distro/get-started.html).

docs/advanced-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
> The official Splunk documentation for this page is [Configure the Splunk Distribution of OTel Ruby](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=ruby.configuration).
1+
> The official Splunk documentation for this page is [Configure the Splunk Distribution of OTel Ruby](https://docs.splunk.com/observability/en/gdi/get-data-in/application/ruby/distro/configuration/advanced-ruby-otel-configuration.html).
22
>
33
> For instructions on how to contribute to the docs, see [CONTRIBUTING.md](../CONTRIBUTING.md#documentation).
44

0 commit comments

Comments
 (0)