Wednesday, May 29, 2024
HomeBig DataUtilizing Question Logs in Rockset

Utilizing Question Logs in Rockset

At Rockset, we frequently search for methods to offer our prospects higher visibility into the product. Towards this purpose, we lately determined to enhance our customer-facing question logging. Our earlier iteration of question logs was primarily based in one in every of our shared providers known as apiserver. As a part of the work that apiserver would do when finishing a question execution request, it will create a log that might ultimately be ingested into the _events assortment. Nevertheless, there have been points that made us rethink this implementation of question logs:

  1. No isolation: as a result of the question logs in _events relied on shared providers, heavy site visitors from one org might have an effect on question logging in different orgs.
  2. Incomplete logs: due to the problems brought about through the use of shared providers, we solely logged question errors – profitable queries wouldn’t be logged. Moreover, it was not potential for us to log information about async queries.
  3. No capability to debug question efficiency – the question logs in _events solely contained primary details about every question. There was no means for the consumer to get details about why a given question might have run slowly or exhausted compaute sources for the reason that logs contained no details about the question plan.

Improved Question Logging

The brand new question logs function addresses all of those points. The mechanisms that deal with question logs are contained fully inside your Digital Occasion versus being inside one in every of Rockset’s shared providers. This provides question logs the benefit of isolation. Moreover, each question you submit can be robotically logged if in case you have already created a group with a question logs supply (supplied you don’t hit a charge restrict).

How Question Logs Work

Question logging begins on the finish of question execution. As a part of the steps which can be run within the closing aggregator when a question has accomplished, a file containing metadata related together with your question is created. At this level, we can also have to gather data from different aggregators that have been concerned within the question. After that is performed, the file is quickly saved in an in-memory buffer. The contents of this buffer are flushed to S3 each few seconds. As soon as question logs have been dumped to S3, they are going to be ingested into any of your question log collections which have been created.



Once we first designed this venture, we had at all times meant for it to work with the question profiler within the console. This may enable our prospects to debug question bottlenecks with these logs. Nevertheless, the question profiler requires fairly a bit of information, which means it will be inconceivable for each question log to comprise all the data crucial for the profiler. To unravel this downside, we opted to create two tiers of question logs – INFO and DEBUG logs.

INFO logs are robotically created for each question issued by your org. They comprise some primary metadata related together with your question however can’t be used with the question profiler. When you understand that you could be need to have the flexibility to debug a sure question with the profiler, you may specify a DEBUG log threshold together with your question request. If the question execution time is bigger than the required threshold, Rockset will create each an INFO and a DEBUG log. There are two methods of specifying a threshold:

  1. Use the debug_log_threshold_ms question trace

    SELECT * FROM _events HINT(debug_log_threshold_ms=1000)

  2. Use the debug_threshold_ms parameter in API requests. That is obtainable for each question and question lambda execution requests.

Observe that since DEBUG logs are a lot bigger than INFO logs, the speed restrict for DEBUG logs is way decrease. Because of this, it is strongly recommended that you just solely present a DEBUG log threshold when you understand that this data may very well be helpful. In any other case, you run the danger of hitting the speed restrict once you most want a DEBUG log.

System Sources

As a part of this venture, we determined to introduce a brand new idea known as system sources. These are sources which ingest information originating from Rockset. Nevertheless, not like the _events assortment, collections with system sources are managed fully by your group. This lets you configure the entire settings of those collections. We can be introducing extra system supply varieties as time goes on.

Getting Began with Question Logging

To be able to begin logging your queries, all it’s good to do is create a group with a question logs supply. This may be performed by way of the console.


Rockset will start ingesting question logs into this assortment as you submit queries. Logs for the final 24 hours of queries can even be ingested into this assortment. Please observe that it could possibly take a couple of minutes after a question has accomplished earlier than the related log will present up in your assortment.

To be able to use the question profiler with these logs, open the Rockset Console’s question editor and problem a question that targets one in every of your question logs collections. The question editor will detect that you’re trying to question a group with a question logs supply and a column known as ‘Profiler’ can be added to the question outcomes desk. Any paperwork which have a populated stats discipline could have a hyperlink on this column. Clicking on this hyperlink will open the question profile in a brand new tab.



Observe that customized ingest transformations or question aliases can intervene with this performance so it is strongly recommended that you don’t rename any columns.

For an intensive dive into utilizing Rockset’s Question Profiler, please seek advice from the video obtainable right here.


Hopefully, this has given you a fast look into the performance that question logs can provide. Whether or not it’s good to debug question efficiency or examine why beforehand accomplished queries have failed, your expertise with Rockset can be improved by making use of question logs.



Please enter your comment!
Please enter your name here

Most Popular

Recent Comments