Solr Circuit Breaker

Wraz z publikacją wersji 8.7 Solr w nasze ręce dostaliśmy funkcjonalność circuit breaker. Ten wzorzec projektowy i funkcjonalność go implementująca pozwala na automatyczne odrzucenie dane żądania, kiedy spełnione są zdefiniowane kryteria. Na przykład, kiedy użycie pamięci jest większe, lub load jest zbyt wysoki. Spójrzmy zatem na to, co dostępne jest w Solr 8.7.

Nowa Funkcjonalność

Nowa funkcjonalność wprowadzona do Solr stara się dostarczyć możliwości przerwania wykonywania w chwili kiedy dana instancja Solr przekracza zdefiniowane limity. Na przykład, kiedy wykorzystanie pamięci JVM dochodzi do 75% możemy chcieć przestać akceptować kolejne żądania, aby zakończyć przetważanie obecnych.

W tym właśnie celu do Solr 8.7 została dodana funkcjonalność circuit breaker z następującymi implementacjami:

  • Wykorzystanie pamięci JVM
  • Użycie procesora

Czyli kiedy skorzystać z nowej funkcjonalności? Odpowiedź jest dość prosta – wtedy kiedy stawiamy stabilność instancji Solr ponad wydajność. Jeżeli chcemy większą stabilność – korzystamy z circuit breakerów, jak chcemy pełną wydajność – nie korzystamy z nich.

Konfiguracja

Konfiguracja circuit breaker powinna być umieszczona w sekcji circuitBreaker w pliku solrconfig.xml:

<circuitBreaker class="solr.CircuitBreakerManager" enabled="true">
...
</circuitBreaker>

Atrubut enabled kontroluje, czy funkcjonalność jest włączona, czy nie. W przypadku ustawienia jego wartości na true circuit breaker jest włączony, w przypadku ustawienia na false jest wyłączony.

W chwili pisania tego tekstu mogliśmy korzystać z następujących implementacji:

  • Circuit breakera opartego o wykorzystanie procesora
  • Circuit breakera opartego o wykorzystanie pamięci JVM

Zacznijmy od tego pierwszego. W przypadku zdefiniowania circuit breakera opartego o wykorzystanie procesora Solr sprawdza limit w oparciu o średnie wykorzystanie w ciągu ostatniej minuty. Jeżeli zdefiniowany limit zostanie przekroczony kolejne żądania nie będą przetwarzane. Aby zdefiniować taki circuit breaker do sekcji circuitBreaker w pliku solrconfig.xml dodajemy:

<str name="cpuEnabled">true</str>
<str name="cpuThreshold">75</str>

Powyższa konfiguracja mówi Solr, iż ma sprawdzać wykorzystanie procesora, a limit, który powinien powodować odrzucanie kolejnych żądań to 75% wykorzystania w trakcie ostatniej minuty.

Kolejna implementacja to ta oparta o średnie wykorzystanie pamięci JVM. W przypadku kiedy średnie zużycie będzie wyższe od zdefiniowanego limitu obliczanego na podstawie maksymalnej wielkości stosu kolejne żądania będą odrzucane. Aby zdefiniować taki circuit breaker do sekcji circuitBreaker w pliku solrconfig.xml dodajemy:

<str name="memEnabled">true</str>
<str name="memThreshold">80</str>

Powyższa konfiguracja mówi Solr, aby odrzucać kolejne żądania w chwili kiedy wykorzystanie JVM będzie równe lub większe od 80% maksymalnej wielkości stosu JVM. Czy w przypadku, kiedy Xmx dla procesu JVM ustawione byłoby na wartość 10G, a wykorzystanie wyniesie 8G lub więcej żądania będą odrzucane.

Warto pamiętać, że wartość memThreshold może przyjąć wartości pomiędzy 50, a 95.

Finalna konfiguracja zawierająca obie funkcjonalności wyglądałaby następująco:

<circuitBreaker class="solr.CircuitBreakerManager" enabled="true">
  <str name="memEnabled">true</str>
  <str name="memThreshold">80</str>
  <str name="cpuEnabled">true</str>
  <str name="cpuThreshold">75</str>
</circuitBreaker>

Działanie

Po stworzeniu kolekcji z naszą konfiguracją i w chwili kiedy jeden z limitów został przekroczony Solr odpowie następująco:

{
  "responseHeader":{
    "status":503,
    "QTime":0,
    "params":{
      "json":"{\n\t\"query\": \"*:*\",\n\t\"facet\": {\n\t  \"test\": {\n\t    \"terms\": {\n\t      \"field\": \"text\"\n\t    }\n\t  }\n\t}\n}"}},
  "status":"FAILURE",
  "error":{
    "metadata":[
      "error-class","org.apache.solr.common.SolrException",
      "root-error-class","org.apache.solr.common.SolrException"],
    "msg":"Circuit Breakers tripped Memory Circuit Breaker triggered as JVM heap usage values are greater than allocated threshold.Seen JVM heap memory usage 503369312 and allocated threshold 429496729\n",
    "code":503}}

Kod odpowiedzi w tym przypadku to 503 wraz z informacją dlaczego Solr odrzucił dane żądanie. Sugerowanym działaniem w takim wypadku jest odczekanie przed kolejną próbą tego samego żądania. Dodatkowo dobrym pomysłem jest zwiększanie czasu pomiędzy kolejnymi powtórzeniami, tak aby nie wysyłać zbyt dużej liczby żądań do Solr. Sama funkcjonalność circuit breaker nie wpływa znacząco na zasoby Solr, aczkolwiek wiele żądań, które będą wysłane w tym samym czasie może spowodować jeszcze większe wykorzystanie zasobów.

Minusy

Posiadanie konfiguracji circuit breaker w naszym pliku solrconfig.xml nie oznacza, że nasza instancja Solr jest całkowicie chroniona przed problemami takimi, jak OutOfMemory. Pokaże na to przykładzie wykorzystującym Solr 8.7 oraz circuit breaker działający na podstawie wykorzystania pamięci JVM. Cały przykład dostępny jest na Githubie.

Zaczynamy od domyślnej instancji Solr 8.7, działającym jako klaster SolrCloud i posiadająym następującą konfiguracje circuitBreaker:

<circuitBreaker class="solr.CircuitBreakerManager" enabled="true">
  <str name="memEnabled">true</str>
  <str name="memThreshold">80</str>
  <str name="cpuEnabled">true</str>
  <str name="cpuThreshold">75</str>
</circuitBreaker>

Następnie stworzyłem kolekcję circuit i zaindeksowałem milion dokumentów korzystając z prostego skryptu w języku Python. Struktura danych była bardzo prosta – składała się z dwóch pól:

<field name="id" type="string" indexed="true" stored="true" required="true" multiValued="false" docValues="true" />
<field name="text" type="text_ws" indexed="true" stored="true" multiValued="false" />

Sam skrypt stara się, aby w polu text było jak najwięcej unikalnych termów.

Następnie zadałem zapytanie, które wygląda jak to poniżej:

curl -XGET 'localhost:8983/solr/circuit/select?q=*:*&rows=0'

Odpowiedź od Solr była taka, jakiej byśmy się spodziewali:

{
  "responseHeader":{
    "zkConnected":true,
    "status":0,
    "QTime":60,
    "params":{
      "q":"*:*",
      "rows":"0"}},
  "response":{"numFound":1000000,"start":0,"numFoundExact":true,"docs":[]
  }}

Drugie zapytanie, które zadałem wyglądało następująco:

curl 'http://localhost:8983/solr/circuit/query' -d '{
  "query": "*:*",
  "limit": 0,
  "facet": {
    "test": {
      "terms": {
	"field": "text"
      }
    }
  }
}'

A odpowiedź Solr była już inna:

{
  "responseHeader":{
    "zkConnected":true,
    "status":500,
    "QTime":6893,
    "params":{
      "json":"{\n  \"query\": \"*:*\",\n  \"limit\": 0,\n  \"facet\": {\n    \"test\": {\n      \"terms\": {\n\t\"field\": \"text\"\n      }\n    }\n  }\n}"}},
  "response":{"numFound":1000000,"start":0,"numFoundExact":true,"docs":[]
  },
  "error":{
    "metadata":[
      "error-class","org.apache.solr.common.SolrException",
      "root-error-class","java.lang.OutOfMemoryError"],
    "msg":"Exception occured during uninverting text",
    "trace":"org.apache.solr.common.SolrException: Exception occured during uninverting text\n\tat org.apache.solr.search.facet.UnInvertedField.rethrowAsSolrException(UnInvertedField.java:681)\n\tat org.apache.solr.search.facet.UnInvertedField.getUnInvertedField(UnInvertedField.java:621)\n\tat org.apache.solr.search.facet.FacetFieldProcessorByArrayUIF.findStartAndEndOrds(FacetFieldProcessorByArrayUIF.java:43)\n\tat org.apache.solr.search.facet.FacetFieldProcessorByArray.calcFacets(FacetFieldProcessorByArray.java:116)\n\tat org.apache.solr.search.facet.FacetFieldProcessorByArray.process(FacetFieldProcessorByArray.java:94)\n\tat org.apache.solr.search.facet.FacetRequest.process(FacetRequest.java:454)\n\tat org.apache.solr.search.facet.FacetProcessor.processSubs(FacetProcessor.java:477)\n\tat org.apache.solr.search.facet.FacetProcessor.fillBucket(FacetProcessor.java:433)\n\tat org.apache.solr.search.facet.FacetQueryProcessor.process(FacetQuery.java:65)\n\tat org.apache.solr.search.facet.FacetRequest.process(FacetRequest.java:454)\n\tat org.apache.solr.search.facet.FacetModule.process(FacetModule.java:150)\n\tat org.apache.solr.handler.component.SearchHandler.handleRequestBody(SearchHandler.java:360)\n\tat org.apache.solr.handler.RequestHandlerBase.handleRequest(RequestHandlerBase.java:214)\n\tat org.apache.solr.core.SolrCore.execute(SolrCore.java:2627)\n\tat org.apache.solr.servlet.HttpSolrCall.execute(HttpSolrCall.java:795)\n\tat org.apache.solr.servlet.HttpSolrCall.call(HttpSolrCall.java:568)\n\tat org.apache.solr.servlet.SolrDispatchFilter.doFilter(SolrDispatchFilter.java:415)\n\tat org.apache.solr.servlet.SolrDispatchFilter.doFilter(SolrDispatchFilter.java:345)\n\tat org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1596)\n\tat org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:545)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:143)\n\tat org.eclipse.jetty.security.SecurityHandler.handle(SecurityHandler.java:590)\n\tat org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:127)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:235)\n\tat org.eclipse.jetty.server.session.SessionHandler.doHandle(SessionHandler.java:1610)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:233)\n\tat org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:1300)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:188)\n\tat org.eclipse.jetty.servlet.ServletHandler.doScope(ServletHandler.java:485)\n\tat org.eclipse.jetty.server.session.SessionHandler.doScope(SessionHandler.java:1580)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:186)\n\tat org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:1215)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:141)\n\tat org.eclipse.jetty.server.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:221)\n\tat org.eclipse.jetty.server.handler.InetAccessHandler.handle(InetAccessHandler.java:177)\n\tat org.eclipse.jetty.server.handler.HandlerCollection.handle(HandlerCollection.java:146)\n\tat org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:127)\n\tat org.eclipse.jetty.rewrite.handler.RewriteHandler.handle(RewriteHandler.java:322)\n\tat org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:127)\n\tat org.eclipse.jetty.server.Server.handle(Server.java:500)\n\tat org.eclipse.jetty.server.HttpChannel.lambda$handle$1(HttpChannel.java:383)\n\tat org.eclipse.jetty.server.HttpChannel.dispatch(HttpChannel.java:547)\n\tat org.eclipse.jetty.server.HttpChannel.handle(HttpChannel.java:375)\n\tat org.eclipse.jetty.server.HttpConnection.onFillable(HttpConnection.java:273)\n\tat org.eclipse.jetty.io.AbstractConnection$ReadCallback.succeeded(AbstractConnection.java:311)\n\tat org.eclipse.jetty.io.FillInterest.fillable(FillInterest.java:103)\n\tat org.eclipse.jetty.io.ChannelEndPoint$2.run(ChannelEndPoint.java:117)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.runTask(EatWhatYouKill.java:336)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.doProduce(EatWhatYouKill.java:313)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.tryProduce(EatWhatYouKill.java:171)\n\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.produce(EatWhatYouKill.java:135)\n\tat org.eclipse.jetty.util.thread.QueuedThreadPool.runJob(QueuedThreadPool.java:806)\n\tat org.eclipse.jetty.util.thread.QueuedThreadPool$Runner.run(QueuedThreadPool.java:938)\n\tat java.base/java.lang.Thread.run(Thread.java:832)\nCaused by: java.lang.OutOfMemoryError: Java heap space\n\tat org.apache.solr.search.facet.UnInvertedField.visitTerm(UnInvertedField.java:136)\n\tat org.apache.solr.uninverting.DocTermOrds.uninvert(DocTermOrds.java:350)\n\tat org.apache.solr.search.facet.UnInvertedField.<init>(UnInvertedField.java:205)\n\tat org.apache.solr.search.facet.UnInvertedField.lambda$getUnInvertedField$1(UnInvertedField.java:613)\n\tat org.apache.solr.search.facet.UnInvertedField$$Lambda$658/0x000000080116cc40.apply(Unknown Source)\n\tat org.apache.solr.util.ConcurrentLRUCache.lambda$computeIfAbsent$1(ConcurrentLRUCache.java:227)\n\tat org.apache.solr.util.ConcurrentLRUCache$$Lambda$659/0x000000080116c040.apply(Unknown Source)\n\tat java.base/java.util.concurrent.ConcurrentHashMap.computeIfAbsent(ConcurrentHashMap.java:1708)\n\tat org.apache.solr.util.ConcurrentLRUCache.computeIfAbsent(ConcurrentLRUCache.java:226)\n\tat org.apache.solr.search.FastLRUCache.computeIfAbsent(FastLRUCache.java:258)\n\tat org.apache.solr.search.facet.UnInvertedField.getUnInvertedField(UnInvertedField.java:610)\n\tat org.apache.solr.search.facet.FacetFieldProcessorByArrayUIF.findStartAndEndOrds(FacetFieldProcessorByArrayUIF.java:43)\n\tat org.apache.solr.search.facet.FacetFieldProcessorByArray.calcFacets(FacetFieldProcessorByArray.java:116)\n\tat org.apache.solr.search.facet.FacetFieldProcessorByArray.process(FacetFieldProcessorByArray.java:94)\n\tat org.apache.solr.search.facet.FacetRequest.process(FacetRequest.java:454)\n\tat org.apache.solr.search.facet.FacetProcessor.processSubs(FacetProcessor.java:477)\n\tat org.apache.solr.search.facet.FacetProcessor.fillBucket(FacetProcessor.java:433)\n\tat org.apache.solr.search.facet.FacetQueryProcessor.process(FacetQuery.java:65)\n\tat org.apache.solr.search.facet.FacetRequest.process(FacetRequest.java:454)\n\tat org.apache.solr.search.facet.FacetModule.process(FacetModule.java:150)\n\tat org.apache.solr.handler.component.SearchHandler.handleRequestBody(SearchHandler.java:360)\n\tat org.apache.solr.handler.RequestHandlerBase.handleRequest(RequestHandlerBase.java:214)\n\tat org.apache.solr.core.SolrCore.execute(SolrCore.java:2627)\n\tat org.apache.solr.servlet.HttpSolrCall.execute(HttpSolrCall.java:795)\n\tat org.apache.solr.servlet.HttpSolrCall.call(HttpSolrCall.java:568)\n\tat org.apache.solr.servlet.SolrDispatchFilter.doFilter(SolrDispatchFilter.java:415)\n\tat org.apache.solr.servlet.SolrDispatchFilter.doFilter(SolrDispatchFilter.java:345)\n\tat org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1596)\n\tat org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:545)\n\tat org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:143)\n\tat org.eclipse.jetty.security.SecurityHandler.handle(SecurityHandler.java:590)\n\tat org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:127)\n",
    "code":500}}

Jak widać powyżej Solr odpowiedział błędem 500, a powodem tego błędu był wyjątek java.lang.OutOfMemoryError. Oczywiście jest to przykład dość ekstremalny, ale należy pamiętać, iż tak może się zdarzyć. W chwili kiedy sprawdzane było wykorzystanie pamięci nie sięgało one 80% i wyglądało następująco:

I dlatego też Solr powzolił na wykonanie zapytania.

Podsumowanie

Pomimo tego, że nie wszystko jest idealne, a Solr nie dokonuje żadnych obliczeń i przewidywania wykorzystania pamięci przez dane żądanie uważam iż funkcjonalność circuit breaker to krok w dobrym kierunku. Mam także nadzieję, iż w niedalekiej przyszłości dostaniemy kolejne implementacje. Na przykład takie dedykowane tylko niektórym funkcjonalnościom – zapytanion, indeksowaniu, czy facetingowi. A jaka jest wasza opinia na ten temat?

Dodaj komentarz

Twój adres email nie zostanie opublikowany. Wymagane pola są oznaczone *

We use cookies to personalise content and ads, to provide social media features and to analyse our traffic. We also share information about your use of our site with our social media, advertising and analytics partners.
Cookies settings
Accept
Privacy & Cookie policy
Privacy & Cookies policy
Cookie name Active

Privacy Policy

What information do we collect?

We collect information from you when you register on our site or place an order. When ordering or registering on our site, as appropriate, you may be asked to enter your: name, e-mail address or mailing address.

What do we use your information for?

Any of the information we collect from you may be used in one of the following ways: To personalize your experience (your information helps us to better respond to your individual needs) To improve our website (we continually strive to improve our website offerings based on the information and feedback we receive from you) To improve customer service (your information helps us to more effectively respond to your customer service requests and support needs) To process transactions Your information, whether public or private, will not be sold, exchanged, transferred, or given to any other company for any reason whatsoever, without your consent, other than for the express purpose of delivering the purchased product or service requested. To administer a contest, promotion, survey or other site feature To send periodic emails The email address you provide for order processing, will only be used to send you information and updates pertaining to your order.

How do we protect your information?

We implement a variety of security measures to maintain the safety of your personal information when you place an order or enter, submit, or access your personal information. We offer the use of a secure server. All supplied sensitive/credit information is transmitted via Secure Socket Layer (SSL) technology and then encrypted into our Payment gateway providers database only to be accessible by those authorized with special access rights to such systems, and are required to?keep the information confidential. After a transaction, your private information (credit cards, social security numbers, financials, etc.) will not be kept on file for more than 60 days.

Do we use cookies?

Yes (Cookies are small files that a site or its service provider transfers to your computers hard drive through your Web browser (if you allow) that enables the sites or service providers systems to recognize your browser and capture and remember certain information We use cookies to help us remember and process the items in your shopping cart, understand and save your preferences for future visits, keep track of advertisements and compile aggregate data about site traffic and site interaction so that we can offer better site experiences and tools in the future. We may contract with third-party service providers to assist us in better understanding our site visitors. These service providers are not permitted to use the information collected on our behalf except to help us conduct and improve our business. If you prefer, you can choose to have your computer warn you each time a cookie is being sent, or you can choose to turn off all cookies via your browser settings. Like most websites, if you turn your cookies off, some of our services may not function properly. However, you can still place orders by contacting customer service. Google Analytics We use Google Analytics on our sites for anonymous reporting of site usage and for advertising on the site. If you would like to opt-out of Google Analytics monitoring your behaviour on our sites please use this link (https://tools.google.com/dlpage/gaoptout/)

Do we disclose any information to outside parties?

We do not sell, trade, or otherwise transfer to outside parties your personally identifiable information. This does not include trusted third parties who assist us in operating our website, conducting our business, or servicing you, so long as those parties agree to keep this information confidential. We may also release your information when we believe release is appropriate to comply with the law, enforce our site policies, or protect ours or others rights, property, or safety. However, non-personally identifiable visitor information may be provided to other parties for marketing, advertising, or other uses.

Registration

The minimum information we need to register you is your name, email address and a password. We will ask you more questions for different services, including sales promotions. Unless we say otherwise, you have to answer all the registration questions. We may also ask some other, voluntary questions during registration for certain services (for example, professional networks) so we can gain a clearer understanding of who you are. This also allows us to personalise services for you. To assist us in our marketing, in addition to the data that you provide to us if you register, we may also obtain data from trusted third parties to help us understand what you might be interested in. This ‘profiling’ information is produced from a variety of sources, including publicly available data (such as the electoral roll) or from sources such as surveys and polls where you have given your permission for your data to be shared. You can choose not to have such data shared with the Guardian from these sources by logging into your account and changing the settings in the privacy section. After you have registered, and with your permission, we may send you emails we think may interest you. Newsletters may be personalised based on what you have been reading on theguardian.com. At any time you can decide not to receive these emails and will be able to ‘unsubscribe’. Logging in using social networking credentials If you log-in to our sites using a Facebook log-in, you are granting permission to Facebook to share your user details with us. This will include your name, email address, date of birth and location which will then be used to form a Guardian identity. You can also use your picture from Facebook as part of your profile. This will also allow us and Facebook to share your, networks, user ID and any other information you choose to share according to your Facebook account settings. If you remove the Guardian app from your Facebook settings, we will no longer have access to this information. If you log-in to our sites using a Google log-in, you grant permission to Google to share your user details with us. This will include your name, email address, date of birth, sex and location which we will then use to form a Guardian identity. You may use your picture from Google as part of your profile. This also allows us to share your networks, user ID and any other information you choose to share according to your Google account settings. If you remove the Guardian from your Google settings, we will no longer have access to this information. If you log-in to our sites using a twitter log-in, we receive your avatar (the small picture that appears next to your tweets) and twitter username.

Children’s Online Privacy Protection Act Compliance

We are in compliance with the requirements of COPPA (Childrens Online Privacy Protection Act), we do not collect any information from anyone under 13 years of age. Our website, products and services are all directed to people who are at least 13 years old or older.

Updating your personal information

We offer a ‘My details’ page (also known as Dashboard), where you can update your personal information at any time, and change your marketing preferences. You can get to this page from most pages on the site – simply click on the ‘My details’ link at the top of the screen when you are signed in.

Online Privacy Policy Only

This online privacy policy applies only to information collected through our website and not to information collected offline.

Your Consent

By using our site, you consent to our privacy policy.

Changes to our Privacy Policy

If we decide to change our privacy policy, we will post those changes on this page.
Save settings
Cookies settings