Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix doc for sidekiq options #825

Merged
merged 8 commits into from
Feb 8, 2024
+76 −49
Merged

docs: Fix doc for sidekiq options #825

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
edcc00b
docs: ✏️ fix yard for sidekiq instrumentation options
kohbis Jan 18, 2024
c0dcfd3
Merge branch 'main' into fix-doc-for-sidekiq-options
arielvalentin Jan 22, 2024
9ea801a
docs: Refactor Sidekiq instrumentation and add configuration options
kohbis Jan 31, 2024
72b0ee3
Merge branch 'main' into fix-doc-for-sidekiq-options
kohbis Jan 31, 2024
8619fbb
Merge branch 'main' into fix-doc-for-sidekiq-options
kaylareopelle Feb 6, 2024
0f3539d
Update instrumentation/sidekiq/lib/opentelemetry/instrumentation/side…
kohbis Feb 7, 2024
7632fa1
Update instrumentation/sidekiq/lib/opentelemetry/instrumentation/side…
kohbis Feb 7, 2024
4d40a90
Merge branch 'main' into fix-doc-for-sidekiq-options
arielvalentin Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion instrumentation/sidekiq/lib/opentelemetry/instrumentation/sidekiq/instrumentation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base
# - `:queue` - the span names will be set to '<destination / queue name> <operation>'.
# - `:job_class` - the span names will be set to '<job class name> <operation>'.
option :span_naming, default: :queue, validate: %I[job_class queue]
# @!macro
# @!method $1
# @instrumentation_option_default `:$2`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why using :$2 here but in :propagation_style changed from :$2 to $2?
Should line 33 also need to change to $2 if that's the correct format?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somehow I thought it would be easier to see the symbols if they are code blocks.
But it's not my strong request, so it's ok that unified them one way or the other 🙏

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see, it's for yardoc; my bad. It looks good, thanks

Copy link
Contributor

@xuan-cao-swi xuan-cao-swi Jan 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have any other preference about illustration of boolean and nil value (i.e. could be string, code block or darken like **$2**); unless others suggest difference.

# @!scope class
# Controls how the job's execution is traced and related
# to the trace where the job was enqueued. Can be one of:
#
Expand All @@ -51,7 +55,7 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base
option :propagation_style, default: :link, validate: %i[link child none]
# @!macro
# @!method $1
# @instrumentation_option_default `:$2`
# @instrumentation_option_default $2
# @!scope class
# Allows tracing Sidekiq::Launcher#heartbeat.
option :trace_launcher_heartbeat, default: false, validate: :boolean
Expand Down
Loading