IMetricCollector

public interface IMetricCollector
implements IDisableable, ILogSaverListener

com.android.tradefed.device.metric.IMetricCollector

अप्रत्यक्ष तौर पर जुड़ी जानी-पहचानी सबक्लास AtraceCollector, AtraceRunMetricCollector, BaseDeviceMetricCollector, BluetoothConnectionLatencyCollector, BluetoothConnectionStateCollector, BluetoothHciSnoopLogCollector, BugreportzOnFailureCollector, BugreportzOnTestCaseFailureCollector, ClangCodeCoverageCollector, CodeCoverageCollector, CountTestCasesCollector, DebugHostLogOnFailureCollector, DeviceTraceCollector, FilePullerDeviceMetricCollector, FilePullerLogCollector, और 14 अन्य. AtraceCollector IMetricCollector, टेस्ट के दौरान ट्रेस करता है. साथ ही, नतीजे इकट्ठा करता है और उन्हें इनवोकेशन में लॉग करता है.  AtraceRunMetricCollector यह फ़ंक्शन, टेस्ट डिवाइस से दी गई डायरेक्ट्री के तहत सभी टेस्ट डायरेक्ट्री से ट्रेस इकट्ठा करता है. साथ ही, टेस्ट डायरेक्ट्री को लॉग करता है और टेस्ट डायरेक्ट्री के तहत ट्रेस फ़ाइलों को प्रोसेस करता है. इसके अलावा, यह मेट्रिक को एग्रीगेट करता है.  BaseDeviceMetricCollector IMetricCollector को लागू करने का बुनियादी तरीका. इससे onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) और ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map)) पर डेटा इकट्ठा करने की प्रोसेस शुरू और बंद की जा सकती है.  BluetoothConnectionLatencyCollector कलेक्टर, डिवाइसों पर पहले से तय की गई statsd अवधि की मेट्रिक कॉन्फ़िगरेशन को पुश करेगा. साथ ही, हर प्रोफ़ाइल के लिए ब्लूटूथ कनेक्शन की अवधि इकट्ठा करेगा.  BluetoothConnectionStateCollector यह कलेक्टर, BluetoothConnectionStateChanged मेट्रिक इकट्ठा करेगा. साथ ही, हर प्रोफ़ाइल के लिए कनेक्शन की स्थिति का नंबर रिकॉर्ड करेगा.  BluetoothHciSnoopLogCollector कलेक्टर, DUT पर ब्लूटूथ HCI स्नूप लॉग इन करने की सुविधा चालू करता है. साथ ही, हर टेस्ट के लिए लॉग इकट्ठा करता है.  BugreportzOnFailureCollector टेस्ट केस फ़ेल होने पर, bugreportz इकट्ठा करता है.  BugreportzOnTestCaseFailureCollector रन में मौजूद किसी टेस्ट केस के फ़ेल होने पर, bugreportz इकट्ठा करता है.  ClangCodeCoverageCollector एक BaseDeviceMetricCollector जो डिवाइस से Clang कवरेज मेज़रमेंट को पुल करेगा और उन्हें टेस्ट आर्टफ़ैक्ट के तौर पर लॉग करेगा.  CodeCoverageCollector एक BaseDeviceMetricCollector, जो डिवाइस से Java और नेटिव कवरेज मेज़रमेंट को पुल करेगा और उन्हें टेस्ट आर्टफ़ैक्ट के तौर पर लॉग करेगा.  CountTestCasesCollector किसी दिए गए IRemoteTest के लिए, टेस्ट केस की संख्या गिनें और उसकी रिपोर्ट बनाएं.  DebugHostLogOnFailureCollector यह कलेक्टर, टेस्ट केस फ़ेल होने पर होस्ट-साइड के लॉग इकट्ठा करेगा और उन्हें लॉग करेगा.  DeviceTraceCollector यह कलेक्टर, टेस्ट रन शुरू होने पर perfetto ट्रेस शुरू करेगा और आखिर में ट्रेस फ़ाइल को लॉग करेगा.  FilePullerDeviceMetricCollector एक BaseDeviceMetricCollector जो डिवाइस से आने वाली मेट्रिक की कुंजी को सुनता है और उन्हें डिवाइस से फ़ाइल के तौर पर खींचता है.  FilePullerLogCollector डिवाइस-साइड से रिपोर्ट की गई फ़ाइल का लॉगर.  GcovCodeCoverageCollector एक BaseDeviceMetricCollector जो डिवाइस से gcov कवरेज मेज़रमेंट को खींच लेगा और उन्हें टेस्ट आर्टफ़ैक्ट के तौर पर लॉग कर देगा.  GcovKernelCodeCoverageCollector एक BaseDeviceMetricCollector, जो debugfs से gcov कर्नल कवरेज मेज़रमेंट को डिवाइस से बाहर निकालता है. इसके बाद, उन्हें टेस्ट आर्टफ़ैक्ट के तौर पर लॉग करता है.  HostStatsdMetricCollector यह IMetricCollector, statsd यूटिलिटी कमांड का इस्तेमाल करके होस्ट साइड से statsd मेट्रिक इकट्ठा करता है.  JavaCodeCoverageCollector एक BaseDeviceMetricCollector, जो डिवाइस से Java कवरेज मेज़रमेंट को पुल करेगा और उन्हें टेस्ट आर्टफ़ैक्ट के तौर पर लॉग करेगा.  LogcatOnFailureCollector यह कलेक्टर, टेस्ट केस के फ़ेल होने पर logcat को कैप्चर और लॉग करेगा.  LogcatTimingMetricCollector यह एक मेट्रिक कलेक्टर है. यह logcat से समय की जानकारी इकट्ठा करता है. जैसे, उपयोगकर्ता के स्विच करने का समय. यह जानकारी, एक या एक से ज़्यादा बार दोहराए गए टेस्ट के दौरान इकट्ठा की जाती है. इसके लिए, दिए गए रेगुलर एक्सप्रेशन पैटर्न का इस्तेमाल किया जाता है, ताकि logcat लाइनों से किसी इवेंट के शुरू और खत्म होने के सिग्नल को पार्स किया जा सके.  ModuleLogcatCollector यह logcat collector का वर्शन है, लेकिन यह मॉड्यूल के लिए है.  PerfettoFilePullerCollector यह एक ऐसा कलेक्टर है जो डिवाइस से Perfect Trace फ़ाइलें इकट्ठा करता है. इसके पास फ़ाइलों को कंप्रेस करने का विकल्प होता है. साथ ही, यह फ़ाइलों को टेस्ट लॉग में जोड़ता है.  PerfettoPullerMetricCollector इस क्लास का इस्तेमाल बंद कर दिया गया है. इसके बजाय, PerfettoFilePullerCollector और ERROR(/PerfettoTracePostProcessor) का इस्तेमाल करें.  RebootReasonCollector यह कलेक्टर, टेस्ट रन के दौरान डिवाइस के रीबूट होने की जानकारी इकट्ठा करता है. साथ ही, इसकी वजह और संख्या के हिसाब से रिपोर्ट करता है.  RuntimeRestartCollector यह कलेक्टर, टेस्ट रन के दौरान रनटाइम रीस्टार्ट (सिस्टम सर्वर क्रैश) के टाइमस्टैंप इकट्ठा करता है.  ScreenshotOnFailureCollector यह एक ऐसा कलेक्टर है जो टेस्ट केस के फ़ेल होने पर, स्क्रीनशॉट कैप्चर और लॉग करेगा.  ShowmapPullerMetricCollector FilePullerDeviceMetricCollector का बुनियादी तौर पर लागू किया गया वर्शन. इससे डिवाइस से showmap फ़ाइलें पुल की जा सकती हैं और उनसे मेट्रिक इकट्ठा की जा सकती हैं.  TraceCmdCollector एक IMetricCollector जो trace-cmd का इस्तेमाल करके, टेस्ट के दौरान ट्रेस इकट्ठा करता है और उन्हें इनवोकेशन में लॉग करता है.

---

इस इंटरफ़ेस को डेकोरेटर के तौर पर तब जोड़ा जाएगा, जब टेस्ट के नतीजे रिपोर्ट किए जा रहे हों. ऐसा इसलिए किया जाएगा, ताकि मिलती-जुलती मेट्रिक इकट्ठा की जा सकें.

इस इंटरफ़ेस का इस्तेमाल के तौर पर नहीं किया जा सकता, भले ही यह ITestInvocationListener को बढ़ाता हो. कॉन्फ़िगरेशन की जांच करने वाली सुविधा, इसे अस्वीकार कर देगी. इसका इस्तेमाल "metrics_collector" के तौर पर किया जाना चाहिए.

कलेक्टर से यह उम्मीद नहीं की जाती कि वे इंटरनल स्टेट को बनाए रखें, क्योंकि उन्हें कई जगहों पर फिर से इस्तेमाल किया जा सकता है. अगर इंटरनल स्टेट का इस्तेमाल करना ज़रूरी है, तो init(com.android.tradefed.invoker.IInvocationContext, com.android.tradefed.result.ITestInvocationListener) पर इसे साफ़ कर देना चाहिए.

खास जानकारी

सार्वजनिक तरीके
default boolean	captureModuleLevel() यह तय करता है कि कलेक्टर, मॉड्यूल लेवल पर कैप्चर करने के लिए लागू होता है या नहीं. साथ ही, यह भी तय करता है कि इसे शुरू किया जाना चाहिए या नहीं.
abstract	getBuildInfos() यह फ़ंक्शन, इनवोकेशन में उपलब्ध बिल्ड की जानकारी की सूची दिखाता है.
abstract	getDevices() इस फ़ंक्शन से, इनवॉकेशन में उपलब्ध डिवाइसों की सूची मिलती है.
abstract ITestInvocationListener	getInvocationListener() यह कुकी, उस ओरिजनल ITestInvocationListener को वापस भेजती है जहां हम नतीजे फ़ॉरवर्ड कर रहे हैं.
abstract ITestInvocationListener	init(IInvocationContext context, ITestInvocationListener listener) मौजूदा कॉन्टेक्स्ट के साथ कलेक्टर को शुरू करना और नतीजों को कहां फ़ॉरवर्ड करना है.
abstract void	onTestAssumptionFailure(DeviceMetricData testData, TestDescription test) जब कोई टेस्ट केस, अनुमान के सही न होने की वजह से पूरा नहीं हो पाता, तब कॉलबैक किया जाता है.
abstract void	onTestEnd(DeviceMetricData testData, currentTestCaseMetrics, TestDescription test) टेस्ट केस खत्म होने पर कॉलबैक.
abstract void	onTestEnd(DeviceMetricData testData, currentTestCaseMetrics) टेस्ट केस खत्म होने पर कॉलबैक.
abstract void	onTestFail(DeviceMetricData testData, TestDescription test) टेस्ट केस फ़ेल होने पर कॉलबैक.
default void	onTestModuleEnded() इस कुकी का इस्तेमाल, मॉड्यूल खत्म होने से जुड़े इवेंट को कैप्चर करने के लिए किया जाता है.
default void	onTestModuleStarted() इस कुकी की मदद से, मॉड्यूल शुरू होने वाले इवेंट को कैप्चर किया जा सकता है.
abstract void	onTestRunEnd(DeviceMetricData runData, currentRunMetrics) टेस्ट रन खत्म होने पर कॉलबैक.
abstract void	onTestRunStart(DeviceMetricData runData) टेस्ट रन शुरू होने पर कॉलबैक.
default void	onTestRunStart(DeviceMetricData runData, int testCount) टेस्ट रन शुरू होने पर कॉलबैक.
abstract void	onTestStart(DeviceMetricData testData) टेस्ट केस शुरू होने पर कॉलबैक.

सार्वजनिक तरीके

captureModuleLevel

public boolean captureModuleLevel ()

यह तय करता है कि कलेक्टर, मॉड्यूल लेवल पर कैप्चर करने के लिए लागू होता है या नहीं. साथ ही, यह भी तय करता है कि इसे शुरू किया जाना चाहिए या नहीं.

रिटर्न
boolean

getBuildInfos

public abstract  getBuildInfos ()

यह फ़ंक्शन, इनवोकेशन में उपलब्ध बिल्ड की जानकारी की सूची दिखाता है.

रिटर्न

getDevices

public abstract  getDevices ()

इस फ़ंक्शन से, इनवॉकेशन में उपलब्ध डिवाइसों की सूची मिलती है.

रिटर्न

getInvocationListener

public abstract ITestInvocationListener getInvocationListener ()

यह कुकी, उस ओरिजनल ITestInvocationListener को वापस भेजती है जहां हम नतीजे फ़ॉरवर्ड कर रहे हैं.

रिटर्न
ITestInvocationListener

init

public abstract ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

मौजूदा कॉन्टेक्स्ट के साथ कलेक्टर को शुरू करना और नतीजों को कहां फ़ॉरवर्ड करना है. इसे हर इंस्टेंस के लिए सिर्फ़ एक बार कॉल किया जाएगा. साथ ही, कलेक्टर को अपने इंटरनल कॉन्टेक्स्ट और लिसनर को अपडेट करना होगा. टेस्ट रन के दौरान, Init को कभी भी कॉल नहीं किया जाएगा.

जब तक आपको यह न पता हो कि क्या करना है, तब तक इस विकल्प को न चुनें.

पैरामीटर
context	IInvocationContext: चालू इनवोकेशन के लिए IInvocationContext.
listener	ITestInvocationListener: ITestInvocationListener जहां नतीजे दिखाने हैं.

रिटर्न
ITestInvocationListener	नए लिसनर को ओरिजनल लिसनर के साथ रैप किया गया है.

थ्रो
DeviceNotAvailableException

onTestAssumptionFailure

public abstract void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

जब कोई टेस्ट केस, अनुमान के सही न होने की वजह से पूरा नहीं हो पाता, तब कॉलबैक किया जाता है.

पैरामीटर
testData	DeviceMetricData: DeviceMetricData, जिसमें टेस्ट केस का डेटा मौजूद है.
test	TestDescription: इससे, टेस्ट केस की TestDescription का पता चलता है.

थ्रो
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics, 
                TestDescription test)

टेस्ट केस खत्म होने पर कॉलबैक. यह समय, डेटा को साफ़ करने का होना चाहिए.

पैरामीटर
testData	DeviceMetricData: DeviceMetricData, जिसमें टेस्ट केस का डेटा मौजूद है. यह onTestStart(com.android.tradefed.device.metric.DeviceMetricData) के दौरान इस्तेमाल किए गए ऑब्जेक्ट जैसा ही होगा.
currentTestCaseMetrics	: ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) को पास की गई मेट्रिक का मौजूदा मैप.
test	TestDescription: यह टेस्ट केस की TestDescription है.

थ्रो
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

टेस्ट केस खत्म होने पर कॉलबैक. यह समय, डेटा को साफ़ करने का होना चाहिए.

पैरामीटर
testData	DeviceMetricData: DeviceMetricData, जिसमें टेस्ट केस का डेटा मौजूद है. यह onTestStart(com.android.tradefed.device.metric.DeviceMetricData) के दौरान इस्तेमाल किए गए ऑब्जेक्ट जैसा ही होगा.
currentTestCaseMetrics	: ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) को पास की गई मेट्रिक का मौजूदा मैप.

थ्रो
DeviceNotAvailableException

onTestFail

public abstract void onTestFail (DeviceMetricData testData, 
                TestDescription test)

टेस्ट केस फ़ेल होने पर कॉलबैक.

पैरामीटर
testData	DeviceMetricData: DeviceMetricData, जिसमें टेस्ट केस का डेटा मौजूद है.
test	TestDescription: इससे, टेस्ट केस की TestDescription का पता चलता है.

थ्रो
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

इस कुकी का इस्तेमाल, मॉड्यूल के खत्म होने से जुड़े इवेंट को कैप्चर करने के लिए किया जाता है.

थ्रो
	com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

इस कुकी की मदद से, मॉड्यूल शुरू होने वाले इवेंट को कैप्चर किया जा सकता है.

थ्रो
	com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestRunEnd

public abstract void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

टेस्ट रन खत्म होने पर कॉलबैक. यह समय, डेटा को साफ़ करने का होना चाहिए.

पैरामीटर
runData	DeviceMetricData: वह DeviceMetricData जिसमें रन का डेटा मौजूद है. यह onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) के दौरान इस्तेमाल किए गए ऑब्जेक्ट जैसा ही होगा.
currentRunMetrics	: ERROR(/#testRunEnded(long,Map)) को पास की गई मेट्रिक का मौजूदा मैप.

थ्रो
DeviceNotAvailableException

onTestRunStart

public abstract void onTestRunStart (DeviceMetricData runData)

टेस्ट रन शुरू होने पर कॉलबैक.

पैरामीटर
runData	DeviceMetricData: वह DeviceMetricData जिसमें रन का डेटा मौजूद है.

थ्रो
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData, 
                int testCount)

टेस्ट रन शुरू होने पर कॉलबैक.

पैरामीटर
runData	DeviceMetricData: वह DeviceMetricData जिसमें रन का डेटा मौजूद है.
testCount	int: इस टेस्ट रन में टेस्ट केस की संख्या.

थ्रो
DeviceNotAvailableException

onTestStart

public abstract void onTestStart (DeviceMetricData testData)

टेस्ट केस शुरू होने पर कॉलबैक.

पैरामीटर
testData	DeviceMetricData: DeviceMetricData, जिसमें टेस्ट केस का डेटा मौजूद है.

थ्रो
DeviceNotAvailableException