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

feat: allow customers to have codeless instrumentation #102

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: allow customers to have codeless instrumentation #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a2a20e4
dont ignore `handler.rb` in `.dockerignore`
duncanista Jan 9, 2025
7429ef6
copy the `handler.rb` into `opt`
duncanista Jan 9, 2025
d8a6bfb
add `handler.rb`
duncanista Jan 9, 2025
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
3 changes: 2 additions & 1 deletion .dockerignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
!datadog-lambda.gemspec
!.rubocop.yml
!Gemfile
!Rakefile
!Rakefile
!handler.rb
7 changes: 5 additions & 2 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ ARG image
FROM $image AS builder
ARG runtime
# Install dev dependencies
COPY . /var/task/datadog-lambda-rb
WORKDIR /var/task/datadog-lambda-rb
COPY . /ruby
WORKDIR /ruby
RUN apt-get update
RUN apt-get install -y gcc zip binutils

Expand All @@ -14,6 +14,9 @@ RUN gem build datadog-lambda
RUN gem install datadog-lambda --install-dir "/opt/ruby/gems/$runtime"
RUN gem install datadog -v 2.0 --install-dir "/opt/ruby/gems/$runtime"

# Copy handler
COPY handler.rb /opt

WORKDIR /opt
# Remove native extension debase-ruby_core_source (25MB) runtimes below Ruby 2.6
RUN rm -rf ./ruby/gems/$runtime/gems/debase-ruby_core_source*/
Expand Down
41 changes: 41 additions & 0 deletions handler.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# frozen_string_literal: true

# Customer code lives here
LAMBDA_TASK_ROOT = ENV['LAMBDA_TASK_ROOT']

# Get the handler file and method from the environment
# file.method
LAMBDA_HANDLER = ENV['DD_LAMBDA_HANDLER']
handler_file, HANDLER_METHOD = LAMBDA_HANDLER.split('.')

# Add extension to the handler file
handler_file += '.rb'
Copy link

Choose a reason for hiding this comment

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

⚪ Code Quality Violation

Suggested change
handler_file += '.rb'
handler_file << '.rb'
Avoid appending to string using += (...read more)

The rule to avoid slow string concatenation in Ruby is essential for writing efficient and fast-performing code. String concatenation using the += operator is slower because it creates a new string object every time it's used. This can lead to performance issues, especially in loops or large programs where numerous string concatenations might be happening.

Instead, the << operator, also known as the append operator, should be used for string concatenation in Ruby. The << operator modifies the original string, avoiding the creation of multiple unnecessary string objects. This results in faster execution time and lower memory usage, which is especially beneficial in larger applications or systems with limited resources.

Therefore, good coding practice in Ruby suggests using << for string concatenation instead of +=. For instance, output << "<p>#{text}</p>" is more efficient than output += "<p>#{text}</p>". Following this rule will help you write cleaner, faster, and more resource-efficient Ruby code.

View in Datadog  Leave us feedback  Documentation


begin
handler_path = File.join(LAMBDA_TASK_ROOT, handler_file)

raise LoadError, "Handler file not found at: #{handler_path}" unless File.exist?(handler_path)

load(handler_path)
rescue LoadError => e
puts "Failed to load handler file: #{e.message}"
exit(1)
rescue SyntaxError => e
puts "Syntax error in handler file: #{e.message}"
exit(1)
rescue StandardError => e
puts "Unexpected error while loading handler: #{e.class} - #{e.message}"
exit(1)
end

require 'datadog/lambda'

Datadog::Lambda.configure_apm do |c|
# Enable the instrumentation
end

def handler(event:, context:)
Copy link

Choose a reason for hiding this comment

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

🔵 Code Quality Violation

Avoid top-level methods definition. Organize methods in modules/classes. (...read more)

This rule emphasizes the importance of organizing methods within modules or classes in Ruby. In Ruby, it's considered a best practice to wrap methods within classes or modules. This is because it helps in grouping related methods together, which in turn makes the code easier to understand, maintain, and reuse.

Not adhering to this rule can lead to a disorganized codebase, making it hard for other developers to understand and maintain the code. It can also lead to potential name clashes if a method is defined in the global scope.

To avoid violating this rule, always define your methods within a class or a module. For example, instead of writing def some_method; end, you should write class SomeClass def some_method; end end. This not only adheres to the rule but also improves the readability and maintainability of your code.

View in Datadog  Leave us feedback  Documentation

Datadog::Lambda.wrap(event, context) do
Kernel.send(HANDLER_METHOD, event:, context:)
end
end
Loading