📭 👆🏽 🚔 SOAP सेवाओं के लिए चयनात्मक यातायात लॉगिंग 👩🏿‍⚖️ 😴 🍢

लगभग हमारी किसी भी परियोजना में जो ग्राहक सेवाओं के साथ एकीकृत होती है, SOAP सेवाओं का उपयोग किया जाता है। और इस तरह के हर प्रोजेक्ट में जानकारी लॉग करने का काम होता है। हम विशेष रूप से लॉगिंग अनुरोधों में रुचि रखते हैं जो समाधान के व्यावसायिक संचालन से संबंधित हैं। उदाहरण के लिए, एक कर्मचारी ने गलत डेटा दर्ज किया और सेवा ने एक त्रुटि लौटा दी। हम इस त्रुटि का विवरण जानना चाहते हैं और इसे जल्द से जल्द सही करना चाहते हैं या ग्राहक के साथ चर्चा के लिए प्रस्तुत करना चाहते हैं।

हम अपने ग्राहक के अनुरोधों और सेवा के उत्तरों को अपरिवर्तित देखना चाहेंगे, क्योंकि इससे आने वाली समस्याओं को हल करने में मदद मिलती है।

इस लेख में, हम दिखाते हैं कि हम SOAP सेवाओं के लिए चयनात्मक यातायात लॉगिंग कैसे सेट करते हैं।

समस्या

आरंभ करने के लिए, स्प्रिंग ने अंतर्निहित अनुरोध और प्रतिक्रिया लॉगिंग है जो कॉन्फ़िगरेशन के माध्यम से सक्षम है

logging.level.org.springframework.ws.client.MessageTracing.sent=TRACE logging.level.org.springframework.ws.client.MessageTracing.received=TRACE

समस्या यह है कि इन सेटिंग्स में सभी SOAP ट्रैफ़िक लॉग करना शामिल है। हमें केवल कुछ तरीकों की आवश्यकता है, और फिर पूरी तरह से नहीं। उदाहरण के लिए, हम लॉग में फ़ाइलों को डाउनलोड करने के लिए अनुरोध नहीं देखना चाहते हैं, क्योंकि यह बड़ी मात्रा में डेटा है।

स्प्रिंग फ्रेमवर्क में, एक साबुन क्लाइंट बनाने के लिए वास्तविक मानक WebServiceGatewaySupport का उपयोग करना है, जिसमें आप ClientInterceptor के माध्यम से अनुरोध और प्रतिक्रिया प्रसंस्करण भी जोड़ सकते हैं। लेकिन उनके तरीकों में यह समझना मुश्किल है कि हमारे क्लाइंट ने किस तरीके से कॉल की शुरुआत की। और यह स्पष्ट नहीं है कि क्या केवल एक अनुरोध, एक उत्तर या एक ही बार में लॉग इन करना आवश्यक है।

निर्णय

हम मानक ClientInterceptor का उपयोग करेंगे, लेकिन विधि हस्ताक्षर और "इनपुट", "आउटपुट" झंडे के बारे में लापता जानकारी के साथ इसकी आपूर्ति करते हैं, जिसके द्वारा आप यह निर्धारित कर सकते हैं कि क्या अनुरोध और प्रतिक्रिया लॉग की जानी चाहिए।

हम तुरंत एक आरक्षण करते हैं कि इस तरह का समाधान धारावाहिकीकरण / डीरियलाइज़ेशन स्ट्रीमिंग के साथ काम नहीं करेगा। लेकिन हम Axiom का उपयोग करते हैं, जिसमें डिफ़ॉल्ट रूप से "पेलोड कैशिंग" विकल्प सक्षम है और यह समाधान काम करता है।

जानकारी संग्रहीत करने के लिए संरचना:

 import lombok.Data; @Data public class SoapLoggingInfo { private String method; private boolean input = false; private boolean output = false; }

जानकारी संग्रहीत करने के लिए संदर्भ:

 public class SoapLoggingContext { private static final ThreadLocal<SoapLoggingInfo> holder = new ThreadLocal<>(); public static void set(SoapLoggingInfo value) { holder.set(value); } public static SoapLoggingInfo get() { return holder.get(); } }

एक संदर्भ में जानकारी रखने के लिए, हम एओपी दृष्टिकोण का उपयोग "स्लाइस" के साथ एनोटेट विधियों और "युक्तियों" के एक जोड़े का उपयोग करेंगे: विधि के पहले और बाद में कहा जाता है।

विधि के लिए व्याख्या:

 @Target({ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Component public @interface SoapLoggable { boolean value() default true; boolean input() default true; boolean output() default true; }

पहलू को ही बिल्ली के नीचे रखा गया था।

पहलू

 @Aspect @Component @Slf4j public class SoapLoggingAspect { @Value("${logging.soap.request.enabled:false}") private Boolean enabled; @Pointcut("execution(@ru.trueengineering.agentapi.logging.SoapLoggable * *(..))") public void soapLoggableMethod() {} @Before("soapLoggableMethod()") public void beforeSoapLoggable(JoinPoint joinPoint) { if (!enabled) { return; } SoapLoggable soapRequestLogger = getAnnotation(joinPoint); if (soapRequestLogger.value()) { SoapLoggingInfo loggingInfo = new SoapLoggingInfo(); loggingInfo.setInput(soapRequestLogger.input()); loggingInfo.setOutput(soapRequestLogger.output()); final Class<?> aClass = joinPoint.getTarget().getClass(); final Signature signature = joinPoint.getSignature(); final String name = signature.getName(); loggingInfo.setMethod(aClass.getSimpleName() + "." + name); SoapLoggingContext.set(loggingInfo); } } @After("soapLoggableMethod()") public void afterSoapLoggable(JoinPoint joinPoint) { SoapLoggingContext.set(null); } private SoapLoggable getAnnotation(JoinPoint joinPoint) { MethodSignature signature = (MethodSignature) joinPoint.getSignature(); Method method = signature.getMethod(); return method.getAnnotation(SoapLoggable.class); } }

चलिए अलग करते हैं

एक स्लाइस एक अभिव्यक्ति है जिसका अर्थ है "सभी तरीके जिन्हें सोप एलोगेबल द्वारा एनोटेट किया गया है।" हम AspectJ की क्षमताओं का उपयोग करते हैं:

 @Pointcut("execution(@ru.trueengineering.agentapi.logging.SoapLoggable * *(..))") public void soapLoggableMethod() {}

सलाह है कि स्लाइस के तहत एक विधि से पहले बुलाया जाता है:

 @Before("soapLoggableMethod()") public void beforeSoapLoggable(JoinPoint joinPoint) {}

इस पद्धति में, हम एनोटेशन लेते हैं, एनोटेशन से विधि हस्ताक्षर और मेटा-जानकारी निकालते हैं, क्लाइंटइन्टरसेप्टर के लिए ऑब्जेक्ट बनाते हैं और इसे संदर्भ में डालते हैं।

एक विधि है जो एक स्लाइस के तहत गिर गया है कॉल करने के बाद एक टिप है:

 @After("soapLoggableMethod()") public void afterSoapLoggable(JoinPoint joinPoint) {}

यह सिर्फ संदर्भ को साफ करता है। दरअसल, बिल्ली के नीचे प्रवेश करना:

लॉगिंग

 @Component @Slf4j public class SoapLoggingInterceptor extends ClientInterceptorAdapter { @Override public boolean handleRequest(MessageContext messageContext) throws WebServiceClientException { SoapLoggingInfo info = SoapLoggingContext.get(); if (info != null && info.isInput()) { ByteArrayOutputStream xml = new ByteArrayOutputStream(); try { messageContext.getRequest().writeTo(xml); log.debug(": " + info.getMethod() + ", :" + xml.toString(StandardCharsets.UTF_8)); } catch (IOException e) { log.error("  SOAP request", e); } } return true; } @Override public boolean handleResponse(MessageContext messageContext) throws WebServiceClientException { return handleResponseOrFault(messageContext); } @Override public boolean handleFault(MessageContext messageContext) throws WebServiceClientException { return handleResponseOrFault(messageContext); } private boolean handleResponseOrFault(MessageContext messageContext) { SoapLoggingInfo info = SoapLoggingContext.get(); if (info != null && info.isOutput()) { ByteArrayOutputStream xml = new ByteArrayOutputStream(); try { messageContext.getResponse().writeTo(xml); log.debug(": " + info.getMethod() + ", :" + xml.toString(StandardCharsets.UTF_8)); } catch (IOException e) { log.error("  SOAP response", e); } } return true; } }

हम "अवरोधन" और एसओएपी अनुरोधों को संसाधित करने के मानक तरीके का उपयोग करते हैं, लेकिन हम संदर्भ से जानकारी का उपयोग केवल चुनिंदा तरीकों से लॉग इन करने के लिए करते हैं।

लाभ!

इस दृष्टिकोण का उपयोग करना बहुत सरल है।

संलग्न फ़ाइल के साथ अनुरोध नहीं देखना चाहते हैं? ठीक है!

 @SoapLoggable(input = false) public Optional<Osago2Response<ArrayOfKeyValuePairOfstringstring>> attachFile( final AttachFileRequest attachFileRequest) { return send(new WsAttachFileRequest(attachFileRequest)); }

सब कुछ देखना चाहते हैं? यह और भी आसान है।

 @SoapLoggable public Optional<Osago2Response<CalcResult>> calculate(final CalcRequest calcRequest) { }

निष्कर्ष

इस लेख ने SOAP सेवाओं के लिए चयनात्मक यातायात लॉगिंग को कॉन्फ़िगर करने के तरीके पर अपने अनुभव साझा किए। इसके लिए धन्यवाद, हम समस्याओं के विश्लेषण के लिए व्यावसायिक कार्यों की निगरानी करते हैं और किसी भी समय लॉग का उपयोग करते हैं। इसके अलावा, हम SOAP अनुरोध को निष्पादित करने और त्रुटि के कारण को तुरंत स्थानीयकृत करने के लिए खर्च किए गए समय का ट्रैक रखने के लिए एक ही तंत्र का उपयोग कर सकते हैं।

हम इस विषय पर एक उपयोगी लिंक भी साझा करते हैं: एस्पेक्टेज पर स्लाइस और युक्तियों का उपयोग करने के उदाहरणों का एक संक्षिप्त सेट ।

SOAP सेवाओं के लिए चयनात्मक यातायात लॉगिंग

समस्या

निर्णय

चलिए अलग करते हैं

लाभ!

निष्कर्ष

More articles: