The project is in a healthy, maintained state
The 'APM' (Application Performance Monitoring) Ruby gem provides developers with comprehensive insights into their software applications' performance and behavior. By monitoring end-user experiences, profiling code execution, tracing transaction flows, and tracking resource utilization, the gem assists in identifying bottlenecks, errors, and areas for optimization. Real-time alerts, error analysis, and trend tracking contribute to maintaining a smooth user experience, enhancing application scalability, and ensuring efficient resource utilization.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Project Readme

Middleware::RubyGem


Installation Steps

Build and Install Native Gem

  • Clone the repository and navigate to the root directory of repository

  • Install all the required gems

    bundle install
  • Build the native gem

    gem build
  • Install native gem

    gem install middleware_apm_*.gem 

Usage gem in ruby application

  • Add the gem to Gemfile

    # If the application is running in Linux environment
    gem "middleware_apm_linux"
    
    # If the application is running in Windows environment
    gem "middleware_apm_windows"
  • Add below code at initialization of your application

    # If the application is running in Linux environment
    require 'middleware/ruby_gem_linux'
    
    # If the application is running in Windows environment
    require 'middleware/ruby_gem_windows'
    
    Middleware::RubyGem.init
  • Set below listed environment variables

    Environment Variable Name Sample Value Is required Description
    OTEL_EXPORTER_OTLP_ENDPOINT http://localhost:9320 Yes Endpoint to send the collected data.
    OTEL_SERVICE_NAME Demo Service Name No Your Service Name.
    OTEL_RESOURCE_ATTRIBUTES project.name="Demo Project Name" No Your Project Name.
    MW_API_KEY {Your API Key} If Linux then Yes / If windows then No It is used for profiling.
  • Run your application

    • Example: If its a ruby-on-rails application
      rails server

Note: Profiling is not supported for windows application.