Docs > Data Ingestion and Processing > ContextStreams > Debugging ContextStreams
In vuSmartMaps, the Preview Data option for I/O Streams offers a debugging of the selected stream, by showing the data preview.
The Preview option serves as a quick debugging tool for I/O Streams, enabling users to verify if the data is being streamed as expected.
Click on the Preview Data button (available under the Actions column on the I/O Streams page) to preview the data in the particular I/O stream.
The Preview Data option allows users for the following options:
These options capacitate users to interact with, analyze, and debug data within their selected I/O streams effectively. The preview features enable users to ensure that data is correctly streaming, providing valuable insights for debugging purposes.
These debugging methods empower users to perform end-to-end checks of the data flow within the vuSmartMaps platform. Starting from the I/O stream, users can follow the entire data journey through the Data Pipeline to the DataStore Connector and verify whether data is being correctly written into the database. This robust feature serves as a powerful tool for end-users, facilitating comprehensive debugging of the entire ContextStream configuration.
Within the ‘Capture’ tab, users can configure preview settings using the left pane:
Filter (Optional): Define patterns to filter and display records based on specific criteria. Filters can be applied using string, regex, and key-value patterns to match the desired records. Below are the supported filtering options:
String Filter: Matches records containing an exact string.
error
Regex Filter: Matches records based on a regular expression.
UPI[0-9]+[a-z]
String Filter with Escaped Comma: Matches records that contain the exact appearance of a string, including escaped commas. This ensures the search string is treated as a single literal string.
message\, error
will match records with the exact text "message, error"
.String Filter with Comma-Separated Values: Matches records that contain any one of the comma-separated values. The filter acts as an OR condition.
message, error
will match records containing either "message"
or "error"
.String and Regex Filter: Matches records that satisfy either a string or a regex condition, separated by commas. The comma acts as an OR operator.
message, Er[a-zA-Z]
will match records containing "message"
or any text matching the regex Er[a-zA-Z]
.Key-Value Pair Filter: Matches records where a specific key has a specific value.
code:01
will match records where the key code
has the value 01
.Regex Filter in Key-Value Pair: Matches key-value pairs where the value matches a regular expression.
message:[Ee]rror
will match records where the key message
has a value that matches the regex [Ee]rror
.Regex Filter with Comma-Separated Values: Matches records based on multiple regular expressions separated by commas. The filter acts as an OR condition.
UPI[0-9]+[a-z], Er[a-zA-Z]
will match records containing text that satisfies either UPI[0-9]+[a-z]
or Er[a-zA-Z]
.Upon clicking the Capture button, the Data Preview appears on the right side of the screen. With this, the user can debug if data in the I/O streams is getting streamed as expected or not. Users have the option to download this data using the Download Preview Data button.
In the ‘Upload’ tab, users can upload data via a JSON file. After clicking the Upload button, the data preview appears on the right side of the screen. As with the Capture tab, users can download this data using the Download Preview Data button.
With this option, users can analyze the data, if it is getting streamed as expected.
💡Note: Only valid minified JSON separated by newlines is accepted via a file. You can use the minify option of JSON Beautifier or similar tools. An example below:
{"services":[{"name":"longhorn","count":"1","cpu_core":"0.01","memory":"2GB","disk":"3GB"},{"name":"minio-operator","count":"1","cpu_core":"0.01","memory":"2GB","disk":"1GB"}]} {"services":[{"name":"longhorn","count":"1","cpu_core":"0.01","memory":"2GB","disk":"3GB"},{"name":"minio-operator","count":"1","cpu_core":"0.01","memory":"2GB","disk":"1GB"}]} {"services":[{"name":"longhorn","count":"1","cpu_core":"0.01","memory":"2GB","disk":"3GB"},{"name":"minio-operator","count":"1","cpu_core":"0.01","memory":"2GB","disk":"1GB"}]}
In the vuSmartMaps UI, the Debug option plays a pivotal role in analyzing and diagnosing the functionality of the data pipelines. There are three distinct debugging options available, each serving a unique purpose:
In summary, these three debugging options offer comprehensive diagnostic capabilities throughout the data pipeline lifecycle.
To debug an individual block within a pipeline using the Block Editor, follow these steps:
Filter (Optional): Define patterns to filter and display records based on specific criteria. Filters can be applied using string, regex, and key-value patterns to match the desired records. Below are the supported filtering options:
String Filter: Matches records containing an exact string.
error
Regex Filter: Matches records based on a regular expression.
UPI[0-9]+[a-z]
String Filter with Escaped Comma: Matches records that contain the exact appearance of a string, including escaped commas. This ensures the search string is treated as a single literal string.
message\, error
will match records with the exact text "message, error"
.String Filter with Comma-Separated Values: Matches records that contain any one of the comma-separated values. The filter acts as an OR condition.
message, error
will match records containing either "message"
or "error"
.String and Regex Filter: Matches records that satisfy either a string or a regex condition, separated by commas. The comma acts as an OR operator.
message, Er[a-zA-Z]
will match records containing "message"
or any text matching the regex Er[a-zA-Z]
.Key-Value Pair Filter: Matches records where a specific key has a specific value.
code:01
will match records where the key code
has the value 01
.Regex Filter in Key-Value Pair: Matches key-value pairs where the value matches a regular expression.
message:[Ee]rror
will match records where the key message
has a value that matches the regex [Ee]rror
.Regex Filter with Comma-Separated Values: Matches records based on multiple regular expressions separated by commas. The filter acts as an OR condition.
UPI[0-9]+[a-z], Er[a-zA-Z]
will match records containing text that satisfies either UPI[0-9]+[a-z]
or Er[a-zA-Z]
.This debugging feature within the Block Editor provides users with insights into the behavior of individual blocks, allowing for precise adjustments and optimization in the data contextualization process.
To debug a pipeline in Draft mode directly from the Pipeline Editor, follow these steps:
Filter (Optional): Define patterns to filter and display records based on specific criteria. Filters can be applied using string, regex, and key-value patterns to match the desired records. Below are the supported filtering options:
String Filter: Matches records containing an exact string.
error
Regex Filter: Matches records based on a regular expression.
UPI[0-9]+[a-z]
String Filter with Escaped Comma: Matches records that contain the exact appearance of a string, including escaped commas. This ensures the search string is treated as a single literal string.
message\, error
will match records with the exact text "message, error"
.String Filter with Comma-Separated Values: Matches records that contain any one of the comma-separated values. The filter acts as an OR condition.
message, error
will match records containing either "message"
or "error"
.String and Regex Filter: Matches records that satisfy either a string or a regex condition, separated by commas. The comma acts as an OR operator.
message, Er[a-zA-Z]
will match records containing "message"
or any text matching the regex Er[a-zA-Z]
.Key-Value Pair Filter: Matches records where a specific key has a specific value.
code:01
will match records where the key code
has the value 01
.Regex Filter in Key-Value Pair: Matches key-value pairs where the value matches a regular expression.
message:[Ee]rror
will match records where the key message
has a value that matches the regex [Ee]rror
.Regex Filter with Comma-Separated Values: Matches records based on multiple regular expressions separated by commas. The filter acts as an OR condition.
UPI[0-9]+[a-z], Er[a-zA-Z]
will match records containing text that satisfies either UPI[0-9]+[a-z]
or Er[a-zA-Z]
.This debugging feature within the Pipeline Editor allows users to iteratively test and refine their draft pipelines, ensuring accurate and efficient data contextualization.
To debug a pipeline in Published mode directly from the Data Pipeline page, follow these steps:
Filter (Optional): Define patterns to filter and display records based on specific criteria. Filters can be applied using string, regex, and key-value patterns to match the desired records. Below are the supported filtering options:
String Filter: Matches records containing an exact string.
error
Regex Filter: Matches records based on a regular expression.
UPI[0-9]+[a-z]
String Filter with Escaped Comma: Matches records that contain the exact appearance of a string, including escaped commas. This ensures the search string is treated as a single literal string.
message\, error
will match records with the exact text "message, error"
.String Filter with Comma-Separated Values: Matches records that contain any one of the comma-separated values. The filter acts as an OR condition.
message, error
will match records containing either "message"
or "error"
.String and Regex Filter: Matches records that satisfy either a string or a regex condition, separated by commas. The comma acts as an OR operator.
message, Er[a-zA-Z]
will match records containing "message"
or any text matching the regex Er[a-zA-Z]
.Key-Value Pair Filter: Matches records where a specific key has a specific value.
code:01
will match records where the key code
has the value 01
.Regex Filter in Key-Value Pair: Matches key-value pairs where the value matches a regular expression.
message:[Ee]rror
will match records where the key message
has a value that matches the regex [Ee]rror
.Regex Filter with Comma-Separated Values: Matches records based on multiple regular expressions separated by commas. The filter acts as an OR condition.
UPI[0-9]+[a-z], Er[a-zA-Z]
will match records containing text that satisfies either UPI[0-9]+[a-z]
or Er[a-zA-Z]
.This debugging feature provides insights into the processing steps and allows users to identify and rectify any issues, ensuring smooth and accurate data contextualization within the pipeline.
Browse through our resources to learn how you can accelerate digital transformation within your organisation.
VuNet’s Business-Centric Observability platform, vuSmartMaps™ seamlessly links IT performance to business metrics and business journey performance. It empowers SRE and IT Ops teams to improve service success rates and transaction response times, while simultaneously providing business teams with critical, real-time insights. This enables faster incident detection and response.