From 5d029f22026b3c90b91b2912d5e9b491f8030318 Mon Sep 17 00:00:00 2001 From: Abdellah Hariti Date: Thu, 17 Apr 2025 16:44:24 +0100 Subject: [PATCH] refactor: migrate ruby and related sdks to inline product options sytnax --- .../debug-symbols-apple/_default.mdx | 16 ++++++++++++---- .../getting-started-config/ruby.mdx | 6 +++++- .../getting-started-config/ruby.rack.mdx | 12 ++++++++++-- .../getting-started-config/ruby.rails.mdx | 6 +++++- .../getting-started-config/ruby.resque.mdx | 6 +++++- 5 files changed, 37 insertions(+), 9 deletions(-) diff --git a/platform-includes/debug-symbols-apple/_default.mdx b/platform-includes/debug-symbols-apple/_default.mdx index 0cf7a319aa965c..90fb532435b14c 100644 --- a/platform-includes/debug-symbols-apple/_default.mdx +++ b/platform-includes/debug-symbols-apple/_default.mdx @@ -56,21 +56,25 @@ Sentry can display snippets of your code next to event stack traces. This featur -```ruby {tabTitle:Current Fastlane plugin} {"onboardingOptions": {"source-context": "5"}} +```ruby {tabTitle:Current Fastlane plugin} sentry_debug_files_upload( auth_token: '___ORG_AUTH_TOKEN___', org_slug: '___ORG_SLUG___', project_slug: '___PROJECT_SLUG___', + # ___PRODUCT_OPTION_START___ source-context include_sources: true, # Optional. For source context. + # ___PRODUCT_OPTION_END___ source-context ) ``` -```ruby {tabTitle:Fastlane plugin before 1.20.0} {"onboardingOptions": {"source-context": "5"}} +```ruby {tabTitle:Fastlane plugin before 1.20.0} sentry_upload_dif( auth_token: '___ORG_AUTH_TOKEN___', org_slug: '___ORG_SLUG___', project_slug: '___PROJECT_SLUG___', + # ___PRODUCT_OPTION_START___ source-context include_sources: true, # Optional. For source context. + # ___PRODUCT_OPTION_END___ source-context ) ``` @@ -106,7 +110,7 @@ Another option is to use warnings, and then set `GCC_TREAT_WARNINGS_AS_ERRORS` t -```bash {tabTitle:Warn on failures - nonblocking} {"onboardingOptions": {"source-context": "10"}} +```bash {tabTitle:Warn on failures - nonblocking} if [[ "$(uname -m)" == arm64 ]]; then export PATH="/opt/homebrew/bin:$PATH" fi @@ -116,7 +120,9 @@ export SENTRY_ORG=___ORG_SLUG___ export SENTRY_PROJECT=___PROJECT_SLUG___ export SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ ERROR=$(sentry-cli debug-files upload \ +# ___PRODUCT_OPTION_START___ source-context --include-sources \ +# ___PRODUCT_OPTION_END___ source-context "$DWARF_DSYM_FOLDER_PATH" 2>&1 >/dev/null) if [ ! $? -eq 0 ]; then echo "warning: sentry-cli - $ERROR" @@ -126,7 +132,7 @@ echo "warning: sentry-cli not installed, download from https://github.com/getsen fi ``` -```bash {tabTitle:Error on failures - blocking} {"onboardingOptions": {"source-context": "10"}} +```bash {tabTitle:Error on failures - blocking} if [[ "$(uname -m)" == arm64 ]]; then export PATH="/opt/homebrew/bin:$PATH" fi @@ -136,7 +142,9 @@ export SENTRY_ORG=___ORG_SLUG___ export SENTRY_PROJECT=___PROJECT_SLUG___ export SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ ERROR=$(sentry-cli debug-files upload \ +# ___PRODUCT_OPTION_START___ source-context --include-sources \ +# ___PRODUCT_OPTION_END___ source-context "$DWARF_DSYM_FOLDER_PATH" --force-foreground 2>&1 >/dev/null) if [ ! $? -eq 0 ]; then echo "error: sentry-cli - $ERROR" diff --git a/platform-includes/getting-started-config/ruby.mdx b/platform-includes/getting-started-config/ruby.mdx index b96395f64a22d8..068db3d5fa1ebf 100644 --- a/platform-includes/getting-started-config/ruby.mdx +++ b/platform-includes/getting-started-config/ruby.mdx @@ -1,4 +1,4 @@ -```ruby {"onboardingOptions": {"performance": "12-15", "profiling": "16-19"}} +```ruby require 'sentry-ruby' Sentry.init do |config| @@ -10,13 +10,17 @@ Sentry.init do |config| # Add data like request headers and IP for users, if applicable; # see https://docs.sentry.io/platforms/ruby/data-management/data-collected/ for more info config.send_default_pii = true + # ___PRODUCT_OPTION_START___ performance # enable tracing # we recommend adjusting this value in production config.traces_sample_rate = 1.0 + # ___PRODUCT_OPTION_END___ performance + # ___PRODUCT_OPTION_START___ profiling # enable profiling # this is relative to traces_sample_rate config.profiles_sample_rate = 1.0 + # ___PRODUCT_OPTION_END___ profiling end ``` diff --git a/platform-includes/getting-started-config/ruby.rack.mdx b/platform-includes/getting-started-config/ruby.rack.mdx index f6df8b1b60e3df..f5e65257d553b4 100644 --- a/platform-includes/getting-started-config/ruby.rack.mdx +++ b/platform-includes/getting-started-config/ruby.rack.mdx @@ -3,7 +3,7 @@ Add `use Sentry::Rack::CaptureExceptions` to your `config.ru` or other rackup file: -```ruby {filename:config.ru} {"onboardingOptions": {"performance": "12-15", "profiling": "16-19"}} +```ruby {filename:config.ru} require 'sentry-ruby' Sentry.init do |config| @@ -15,14 +15,18 @@ Sentry.init do |config| # Add data like request headers and IP for users, if applicable; # see https://docs.sentry.io/platforms/ruby/data-management/data-collected/ for more info config.send_default_pii = true + # ___PRODUCT_OPTION_START___ performance # enable tracing # we recommend adjusting this value in production config.traces_sample_rate = 1.0 + # ___PRODUCT_OPTION_END___ performance + # ___PRODUCT_OPTION_START___ profiling # enable profiling # this is relative to traces_sample_rate config.profiles_sample_rate = 1.0 + # ___PRODUCT_OPTION_END___ profiling end use Sentry::Rack::CaptureExceptions @@ -37,7 +41,7 @@ be placed before your code requires Sinatra: -```ruby {filename:app.rb} {"onboardingOptions": {"performance": "12-15", "profiling": "16-19"}} +```ruby {filename:app.rb} require 'sentry-ruby' Sentry.init do |config| @@ -49,14 +53,18 @@ Sentry.init do |config| # Add data like request headers and IP for users, if applicable; # see https://docs.sentry.io/platforms/ruby/data-management/data-collected/ for more info config.send_default_pii = true + # ___PRODUCT_OPTION_START___ performance # enable tracing # we recommend adjusting this value in production config.traces_sample_rate = 1.0 + # ___PRODUCT_OPTION_END___ performance + # ___PRODUCT_OPTION_START___ profiling # enable profiling # this is relative to traces_sample_rate config.profiles_sample_rate = 1.0 + # ___PRODUCT_OPTION_END___ profiling end # in a non-rackup environment you must initialize the Sentry SDK before requiring sinatra diff --git a/platform-includes/getting-started-config/ruby.rails.mdx b/platform-includes/getting-started-config/ruby.rails.mdx index 86fa4258768540..1e0c3273bca874 100644 --- a/platform-includes/getting-started-config/ruby.rails.mdx +++ b/platform-includes/getting-started-config/ruby.rails.mdx @@ -1,7 +1,7 @@ Initialize the SDK within your `config/initializers/sentry.rb`: -```ruby {filename:config/initializers/sentry.rb} {"onboardingOptions": {"performance": "10-13", "profiling": "14-17"}} +```ruby {filename:config/initializers/sentry.rb} Sentry.init do |config| config.dsn = '___PUBLIC_DSN___' @@ -11,13 +11,17 @@ Sentry.init do |config| # Add data like request headers and IP for users, if applicable; # see https://docs.sentry.io/platforms/ruby/data-management/data-collected/ for more info config.send_default_pii = true + # ___PRODUCT_OPTION_START___ performance # enable tracing # we recommend adjusting this value in production config.traces_sample_rate = 1.0 + # ___PRODUCT_OPTION_END___ performance + # ___PRODUCT_OPTION_START___ profiling # enable profiling # this is relative to traces_sample_rate config.profiles_sample_rate = 1.0 + # ___PRODUCT_OPTION_END___ profiling end ``` diff --git a/platform-includes/getting-started-config/ruby.resque.mdx b/platform-includes/getting-started-config/ruby.resque.mdx index 07e544a88cb949..11435a1a016420 100644 --- a/platform-includes/getting-started-config/ruby.resque.mdx +++ b/platform-includes/getting-started-config/ruby.resque.mdx @@ -1,4 +1,4 @@ -```ruby {"onboardingOptions": {"performance": "12-15", "profiling": "16-19"}} +```ruby require 'sentry-ruby' Sentry.init do |config| @@ -10,14 +10,18 @@ Sentry.init do |config| # Add data like request headers and IP for users, if applicable; # see https://docs.sentry.io/platforms/ruby/data-management/data-collected/ for more info config.send_default_pii = true + # ___PRODUCT_OPTION_START___ performance # enable tracing # we recommend adjusting this value in production config.traces_sample_rate = 1.0 + # ___PRODUCT_OPTION_END___ performance + # ___PRODUCT_OPTION_START___ profiling # enable profiling # this is relative to traces_sample_rate config.profiles_sample_rate = 1.0 + # ___PRODUCT_OPTION_END___ profiling end ```