ActiveSupport :: सूचनाएं और इसकी आवश्यकता क्यों है?

ActiveSupport::Notifications रेल-आधारित अधिसूचना प्रणाली है। आप रेल में कुछ सूचनाओं की सदस्यता ले सकते हैं और जब वे भेजे जाते हैं तो अपना कोड कॉल कर सकते हैं। यह कुछ हद तक ActiveSupport::Callbacks समान है, लेकिन यह पूरे प्रोजेक्ट में काम करता है और घटनाओं को पहले से घोषित करने की आवश्यकता नहीं है।



उदाहरण के लिए, हम अधिसूचना 'render' सदस्यता ले सकते हैं:

 ActiveSupport::Notifications.subscribe("render") do |*args| #        render end 

आप अधिसूचना के नाम के रूप में नियमित अभिव्यक्ति का उपयोग कर सकते हैं, फिर आप अभिव्यक्ति से मेल खाते सभी सूचनाओं की सदस्यता लेते हैं। यदि आप सभी सूचनाओं की सदस्यता चाहते हैं, तो subscribe विधि के लिए कुछ भी पास न करें। subscribe विधि subscribe लिए एक लिंक लौटाती है, इसे अधिसूचना से सदस्यता समाप्त करने की आवश्यकता हो सकती है।

आप ActiveSupport::Notifications.publish विधि का उपयोग करके एक सूचना भेज सकते हैं:

 ActiveSupport::Notifications.publish('render', 'arg1', 'arg2') 

subscribe ब्लॉक में, 'render' , 'arg1' और 'arg2' पारित किया जाएगा।

मुझे उन रेलों में कोड नहीं मिला जो सीधे इन सुविधाओं का उपयोग करती हैं, शायद इस कार्य को अनुप्रयोग कार्यों के लिए रूपरेखा के उपयोगकर्ताओं द्वारा उपयोग किया जाना चाहिए। लेकिन ActiveSupport::Notifications में एक बहुत ही उपयोगी instrument विधि है। यह एक ब्लॉक प्राप्त करता है और इसके बाद यह ब्लॉक निष्पादन की शुरुआत और अंत के टाइमस्टैम्प के साथ एक अधिसूचना भेजता है, साथ ही अतिरिक्त डेटा के लिए एक हैश भी। रेल इस तंत्र का उपयोग करती है, और परोक्ष रूप से, विकास के वातावरण में विस्तृत लॉग बनाने के लिए subscribe और publish तरीके (उत्पादन में समान "मीटर" का उपयोग किया जाता है, लेकिन सब कुछ लॉग में नहीं लिखा जाता है)

उसी उद्देश्यों के लिए, इन "मीटर" का उपयोग आपके आवेदन में किया जा सकता है। आप उस कोड को लपेट सकते हैं जिसे आप इस विधि में जांचना चाहते हैं और लॉग में निष्पादन का परिणाम लिखते हैं। उदाहरण के लिए, हमारे पास निष्पादन की गति का एक तरीका है जिसे हम ट्रैक करना चाहते हैं।

 def do_something #    end 

बस इसे एक ActiveSupport::Notifications.instrument में ActiveSupport::Notifications.instrument block

 def do_something ActiveSupport::Notifications.instrument('benchmark.do_something', desc: 'Some description') do #    end end 

कुछ जगह, उदाहरण के लिए, config/initializers/benchmarking.rb लाइन 'benchmark.' साथ सभी सूचनाओं की सदस्यता लेते हैं 'benchmark.' ।

 logger = Logger.new(File.join(Rails.root, 'log', "benchmarks.log")) ActiveSupport::Notifications.subscribe(%r/benchmark\.*/) do |name, start, ending, transaction_id, payload| method = name.split(?.).last duration = (1000.0 * (ending - start)) message = if payload[:exception].present? payload[:exception].join(' ') else payload[:desc].to_s end logger.info("Benchmark:%s: %.0fms - %s" % method, duration, message) end 

निम्नलिखित चर को ब्लॉक में स्थानांतरित किया जाएगा: name, start, ending, transaction_id, payload ।

• name - पकड़े गए अधिसूचना का नाम
• start - ब्लॉक start समय
• ending - ब्लॉक निष्पादन अंत समय
• transaction_id - transaction_id - अद्वितीय आईडी, आमतौर पर एक ही धागे के भीतर अद्वितीय
• payload - अतिरिक्त डेटा "मीटर" को प्रेषित

अगला, बस लॉग करने के लिए निष्पादन का समय लिखें। यदि अपवाद होता है, तो payload[:exception] के नाम और त्रुटि संदेश के साथ एक सरणी रिकॉर्ड करेगा। इसे भी ध्यान में रखना होगा।

ActiveSupport::Notifications की भूमिका के बारे में अधिक जानकारी के लिए ActiveSupport::Notifications लॉग लॉग में ActiveSupport::Notifications , ActiveSupport::LogSubscriber , ActiveRecord::LogSubscriber , ActionController::LogSubscriber और ActionMailer::LogSubscriber ।

एक और विधि है जो अस्थायी रूप से सूचनाओं की सदस्यता लेती है, लेकिन केवल उसी समय जब इसे पारित किया जाता है।

 callback = lambda do|*args| #        #  "event.name" end ActiveSupport::Notifications.subscribed(callback, "event.name") do #        end 

किसी ईवेंट से सदस्यता समाप्त करने के लिए, सदस्यता unsubscribe विधि को कॉल करें और इसके लिए एक ग्राहक लिंक पास करें।

 ActiveSupport::Notifications.unsubscribe(subscriber) 

सूचना वितरण तंत्र स्वयं ActiveSupport::Notifications::Fanout में छिपा हुआ है ActiveSupport::Notifications::Fanout , यह ActiveSupport::Notifications::Instrumenter पर भी देखना दिलचस्प होगा ActiveSupport::Notifications::Instrumenter क्लास, जो instrument मेथड में ब्लॉक एक्जीक्यूशन टाइम मापने के लिए जिम्मेदार है

एक उदाहरण के रूप में, ActiveSupport::Notifications का उपयोग करके तरीकों के निष्पादन समय की वास्तविक समय की गणना के लिए एक मठवासी:

 class Module def benchmark_it *names options, names = benchmark_options_and_names(*names) names.each do |name| target, punctuation = name.to_s.sub(/([?!=])$/, ''), $1 define_method "#{target}_with_benchmark#{punctuation}" do |*args| ActiveSupport::Notifications.instrument("benchmark.#{self.name}.#{name}", options) do send("#{target}_without_benchmark#{punctuation}", *args) end end alias_method_chain name, :benchmark end end protected def benchmark_options_and_names *args options = args.last.is_a?(Hash) ? args.pop : {} [{desc: ''}.merge(options), args] end end ActiveSupport::Notifications.subscribe(%r/benchmark\.*/) do |name, start, ending, transaction_id, payload| _, classname, method = name.split(?.) duration = (1000.0 * (ending - start)) message = if payload[:exception].present? payload[:exception].join(' ') else payload[:desc].to_s end Rails.logger.info("Benchmark: %s.%s: %.0fms - %s" % classname, method, duration, message) end 

इस तरह इस्तेमाल किया:

 class MyClass def my_method #   - end #       benchmark_it :my_method, desc: '  ' end 

यह सब किस लिए है? एक ही रेल उदाहरण का उपयोग करके, यह देखा जा सकता है कि यदि आपके कोड में अलग-अलग शिथिल युग्मित घटक शामिल हैं, तो आप ऐसे सूचनाओं का उपयोग करके उनके साथ बातचीत स्थापित कर सकते हैं। तदनुसार, मैं अपने ORM या कुछ अन्य पुस्तकालय लिख सकता हूं, उदाहरण के लिए MyORM , और लॉगिंग कार्य को MyORM::LogSubscriber से ले ActiveSupport::LogSubscriber गया है जो MyORM::LogSubscriber से विरासत में मिला है। लॉग प्रदर्शित करने के लिए जिम्मेदार संदेश कोड अनुप्रयोग द्वारा स्मियर नहीं किया जाता है, बल्कि एक स्थान पर है। ठीक है, ज़ाहिर है, आपको पूरे पुस्तकालय में सेंसर की व्यवस्था करने की आवश्यकता है। वैसे, इन समान सेंसर का उपयोग लॉगिंग के अलावा किसी और चीज के लिए किया जा सकता है।

एक तरफ, मेरा कोड रेल से बंधा नहीं है, दूसरी तरफ, रेल को भी मेरे पुस्तकालय के बारे में कुछ भी नहीं पता है, लेकिन फिर भी, मेरा रत्न एक सामान्य लॉगिंग सिस्टम से जुड़ा हुआ है।

स्वाभाविक रूप से, लॉगिंग सूचनाओं के आवेदन का एकमात्र क्षेत्र नहीं है, लेकिन इस उदाहरण के साथ यह दिखाना आसान है कि उनकी आवश्यकता क्यों है।