You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 8, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+13-6Lines changed: 13 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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
+
1
8
# Splunk Distribution of OpenTelemetry Ruby
2
9
3
10
<palign="left">
@@ -24,26 +31,26 @@ This distribution comes with the following defaults:
24
31
- Unlimited default limits for [configuration options](#trace-configuration) to
25
32
support full-fidelity traces.
26
33
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.
28
35
29
36
## Requirements
30
37
31
38
This distribution requires Ruby version 3.0 or higher.
32
39
33
40
## Get started
34
41
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.
36
43
37
44
## Advanced configuration
38
45
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.
40
47
41
48
## Correlate traces and logs
42
49
43
50
You can add trace metadata to logs using the OpenTelemetry trace API. Trace
44
51
metadata lets you explore logs in Splunk Observability Cloud.
45
52
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.
47
54
48
55
## Library instrumentation
49
56
@@ -56,7 +63,7 @@ on [rubygems.org](https://rubygems.org).
56
63
57
64
## Manual instrumentation
58
65
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.
60
67
61
68
## Configure for use with Smart Agent
62
69
@@ -68,7 +75,7 @@ If the `SPLUNK_REALM` or the `OTEL_EXPORTER_JAEGER_ENDPOINT` environmental varia
68
75
69
76
## Troubleshooting
70
77
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.
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).
Copy file name to clipboardExpand all lines: docs/advanced-config.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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).
2
2
>
3
3
> For instructions on how to contribute to the docs, see [CONTRIBUTING.md](../CONTRIBUTING.md#documentation).
0 commit comments