Obsrv Error Codes and Resolution

Introduction

This document provides a comprehensive guide to the error codes used in the Obsrv. Each error code is associated with a specific error scenario, a descriptive message, and recommended resolutions.

ERR_EXT_1001 - NO_EXTRACTION_DATA_FOUND

  1. Message: Unable to extract the data from the extraction key.

  2. Overview: The ERR_EXT_1001 error occurs when the system fails to extract data using the specified extraction key.

  • Troubleshooting Steps:

    1. Dataset Extraction Key Configuration

      • Issue: The extraction key is not configured during dataset creation.

      • Solution: Ensure proper configuration of the extraction key when creating the dataset.

    2. Invalid Extraction Key in Ingested Event

      • Issue: An invalid extraction key is provided in the ingested event.

      • Solution: Validate and correct the extraction key in the ingested event.

    Examples:

    1. For the batch event, the extraction key is the events, and all events must be in a list format. Using this, we can send a batch of events.

       {
        "data": {
          "id": "UUID",
          "events": []
        }
      } 
    2. For the non batch event, The extraction key is the event, and one event at a time we can ingest

      {
        "data": {
          "id": "UUID",
          "event": {}
        }
      }

ERR_EXT_1002 - EXTRACTED_DATA_NOT_A_LIST

  1. Message: The extracted data is not a list.

  2. Overview: The ERR_EXT_1002 error arises when the system encounters difficulties extracting batch data using the specified extraction key, and the data does not adhere to the expected list format.

  • Troubleshooting Steps:

    1. Invalid Batch Data Format in Ingested Event

      • Issue: Ingested data contains an invalid batch structure.

      • Solution: Ensure that if batch mode is configured with an extraction key, all events should be in a list format.

      • Example:


ERR_EXT_1003 - EVENT_SIZE_EXCEEDED

  1. Message: The event size exceeds the maximum configured limit.

  2. Overview: The ERR_EXT_1003 error is triggered when the size of the ingested event surpasses the defined batch size.

  • Troubleshooting Steps:

    1. System Configuration

      • Issue: Batch size limit exceeded.

      • Solution: The maximum supported batch size is 1048576 bytes (~1MB), and it is recommended not to ingest data exceeding the configured batch size.


ERR_EXT_1004 - MISSING_DATASET_ID

  1. Message: The Dataset ID is not provided in the event.

  2. Overview: The ERR_EXT_1004 error arises when the required Dataset ID is not included in the event being processed. This omission hampers the normal processing of the event.

  • Troubleshooting Steps:

    1. Connectors Validation:

      • Issue: The Dataset ID is not stamped in the event.

      • Solution: The processing system anticipates the presence of the dataset within the ingested event. Connectors such as API, Kafka, Database, Object store, etc., must ensure that the dataset ID is stamped at the root level of the event.

      • Example:

      Ensure that the dataset field is included and properly defined within the event structure to resolve the ERR_EXT_1004 error.


ERR_EXT_1005 - MISSING_DATASET_CONFIGURATION

  1. Message: Dataset configuration is missing.

  2. Overview: The ERR_EXT_1005 error occurs when the system processes an event lacking the necessary dataset configuration.

  • Troubleshooting Steps:

    1. Dataset Validation:

      • Issue: Absence of dataset configuration in the table.

      • Solution: Prior to ingesting the event, ensure the dataset is created, thoroughly reviewed, and published to a live status. This ensures that the necessary configuration is in place.

    2. Event Validation:

      • Issue: The event contains an invalid dataset name.

      • Solution: When ingesting events, ensure that the dataset id is accurately defined within the API or connectors. This step is crucial for preventing discrepancies and ensuring the integrity of the dataset information in the event.

      By adhering to these measures, you can prevent the ERR_EXT_1005 error and ensure a seamless event processing experience.


ERR_EXT_1006 - EVENT_MISSING

Message: The ERR_EXT_1006 error occurs when the system processes a non-batch event lacking the necessary "event" property.

Overview: This error is triggered when the system encounters a non-batch event without the required "event" property in the dataset configuration.

  • Troubleshooting Steps:

    1. Event Validation:

      • Issue: The "event" property is not defined for non-batch events.

      • Solution: Ensure that all non-batch events are encapsulated within the "event" property. For example, in the below structure, make sure to define an "event" as a property name when ingesting data:

    This correction ensures that the non-batch event structure adheres to the expected format, resolving the ERR_EXT_1006 error.


ERR_DEDUP_1007 - NO_DEDUP_KEY_FOUND

  1. Message: The ERR_DEDUP_1007 error occurs when no dedup key is found, leading to potential data discrepancies.

  2. Overview: This error happens when a dataset is configured with deduplication, but the dedup key is either missing or lacks data.

  • Troubleshooting Steps:

    1. Dataset Dedup Configuration:

      • Issue: Absence of the deduplication key in the dataset configuration.

      • Solution: Ensure that if the dataset is configured with deduplication events filtration, the deduplication key is properly defined in the deduplication config object. If it is not, update the dataset configurations accordingly.

    2. Event Dedupe Property:

      • Issue: Lack of dedupe property in the event.

      • Solution: When encountering this issue, make sure to include the dedupe property within the event. Alternatively, if the dedupe property is expected to be present, mark it as a required property in the event schema while creating the dataset. This helps in maintaining consistency and resolving the ERR_DEDUP_1007 error.


ERR_DEDUP_1008 - DEDUP_KEY_NOT_A_STRING_OR_NUMBER

  1. Message: The ERR_DEDUP_1008 error occurs when the event dedup property contains a value other than a string or number.

  2. Overview: This error manifests when the dedup key value in the event is not a valid string or number.

  • Troubleshooting Steps:

    1. Event Dedup Property:

      • Issue: Invalid property value type of dedupe key

      • Solution: Ensure passing the right value type in the event dedup property and update the dataset schema of the dedup property to have the correct arrival format and data type format.


ERR_EXT_1009 - DUPLICATE_BATCH_EVENT_FOUND

  1. Message: The ERR_EXT_1009 error indicates the discovery of a duplicate batch event.

  2. Overview: When the source produces a duplicate batch event, the system identifies and filters out these occurrences.

  • Troubleshooting Steps:

    1. Batch Event Dedup Key:

      • Issue: Batch event dedupe property is not unique

      • Solution: Ensure generating a unique value for the dedup property or update the dataset configuration to choose the right dedup property with unique values. For example, the id can be a dedup property, and its value should always be unique.


ERR_PP_1010 - DUPLICATE_EVENT_FOUND

  1. Message: The ERR_PP_1010 error indicates the identification of a duplicate event.

  2. Overview: When the source produces a duplicate event, the system identifies and filters out such occurrences.

  • Troubleshooting Steps:

    1. Event Dedup Key:

      • Issue: Event dedup property is not unique

      • Solution: Ensure generating a unique value for the dedup property or update the dataset configuration to choose the right dedup property with a unique value.


ERR_PP_1011 - JSON_SCHEMA_NOT_FOUND

  1. Message: The ERR_PP_1011 error signals that the JSON schema is not found for the dataset.

  2. Overview: This issue occurs when a dataset is created without any schema.

  • Troubleshooting Steps:

    1. Dataset Configuration:

      • Issue: When the schema is not defined in the table of the dataset

      • Solution: Update the dataset configuration with a schema object using the dataset update API (/obsrv/v1/datasets/update). Ensure not providing any delete property access to the database since Obsrv ensures always having a schema of the dataset. If any users delete the property value in the table, then this issue might occur.


ERR_PP_1012 - INVALID_JSON_SCHEMA

  1. Message: The ERR_PP_1012 error indicates an invalid JSON schema.

  2. Overview: This issue generally occurs when an invalid schema is manually crafted or created for a dataset, or if the API has generated an invalid schema.

  • Troubleshooting Steps:

    1. Dataset Configurations:

      • Issue: When the dataset is created with an invalid schema structure

      • Solution: Generate the correct schema and create the dataset. If the dataset is already created, update the schema of the dataset using the obsrv/v1/datasets/update API.


ERR_PP_1013 - SCHEMA_VALIDATION_FAILED

  1. Message: The ERR_PP_1013 error indicates that the event has failed schema validation.

  2. Overview: This error occurs when events do not conform to the correct structure as defined in the configured schema.

  • Troubleshooting Steps:

    1. Event Correction:

      • Issue: Invalid event structure

      • Solution: Thoroughly examine and rectify the event generated by the source to ensure it generates the correct structure in alignment with the expected schema.

    2. Dataset Schema Configuration:

      • Issue: Incorrect schema

      • Solution: To address this issue, carefully review the schema's required fields, data types, and other properties. If any property of the schema requires an update, perform the necessary changes using the obsrv/v1/datasets/update endpoint

    . Ensure that the schema is configured accurately to prevent future occurrences of schema validation failures.

    Implementing these troubleshooting steps with precision is essential to maintain data integrity and resolve the schema validation issue effectively.


ERR_DENORM_1014 - DENORM_KEY_MISSING

  1. Message: The ERR_DENORM_1014 error signifies the absence of a denorm key or missing data for the specified key.

  2. Overview: This error occurs (ERR_DENORM_1014) when a dataset is configured with denorm but lacks a denorm key.

  • Troubleshooting Steps:

    1. Event Correction:

      • Issue: When the event doesn't contain the denorm key

      • Solution: Ensure the source consistently generates the denorm key and update the dataset property schema to consider the denorm key as a required property.

    2. Dataset Denorm Configuration:

      • Issue: Empty denorm key value in the dataset denorm configurations

      • Solution: Update the dataset denorm configuration to include the correct denorm key value. This can be done by utilizing the obsrv/v1/datasets/update API to ensure accurate configurations.


ERR_DENORM_1015 - DENORM_KEY_NOT_A_STRING_OR_NUMBER

  1. Message: The ERR_DENORM_1015 error occurs when the denorm key value is not a String or Number.

  2. Overview: This error (ERR_DENORM_1015) manifests when the denorm key value is not a valid string or number.

  • Troubleshooting Steps:

    1. Event Correction:

      • Issue: The ingested event's denorm key value might have a type other than string or number.

      • Solution: Ensure the source produces an event with a denorm key value of the correct data type.

    2. Dataset Schema Update:

      • Issue: Invalid data type or format of the event's denorm key value

      • Solution: Update the schema of the denorm property to string or number type to process only valid events.

    3. Dataset Denorm Configuration:

      • Issue: Invalid denorm key has been configured

      • Solution: Update the dataset denorm configuration using an API or edit through the Obsrv console to choose the correct property required to join with another dataset.


ERR_DENORM_1016 - DENORM_DATA_NOT_FOUND

  1. Message: The ERR_DENORM_1016 error occurs when denorm data is not found for the given key.

  2. Overview: This error happens when denorm data for the specified key is not found in the master dataset.

  • Troubleshooting Steps:

    1. Review Master Dataset:

      • Issue: The master dataset might not have denorm value for the given denorm key value.

      • Solution: Re-populate the master dataset using the master dataset indexer job or reindex the data using the data/in API.

    2. Review the Dataset Denorm Configuration:

      • Issue: An invalid denorm key might have been chosen.

      • Solution: Review the denorm key that can correctly join with the master dataset. If the denorm key is invalid, update the configurations using the update API.


ERR_EXT_1018 - ERR_INVALID_EVENT

  1. Message: The ERR_EXT_1018 error signals an invalid JSON event, indicating an error while deserializing the event.

  2. Overview: This issue occurs when an unparsable event is found.

  • Troubleshooting Steps:

    1. Review the Source Event Producer:

      • Issue: Unparsable event produced by the source

      • Solution: Correct the source to produce parsable events.


ERR_ROUTER_1019 - INDEX_KEY_MISSING_OR_BLANK

  1. Message: The ERR_ROUTER_1019 error states an inability to index data as the timestamp key is missing, blank, or not a date-time value.

  2. Overview: This issue occurs when an invalid timestamp is configured.

  • Troubleshooting Steps:

    1. Update the Dataset Index Key Configuration:

      • Issue: Index key value might be invalid

      • Solution: Update the dataset configuration to use the right timestamp key or default to the event arrival time.

    2. Update the Schema Configuration:

      • Issue: Schema configuration could be invalid

      • Solution: Mark the index key (timestamp) property as a required property and choose the right arrival and data type format.

    3. Source Correction:

      • Issue: Source might be producing an invalid structure of the timestamp key

      • Solution: Correct the source to produce the right value for the index property or timestamp key.


ERR_TRANSFORM_1020 - INVALID_EXPR_FUNCTION

  1. Message: The error (ERR_TRANSFORM_1020) indicates that the transformation expression function provided is not valid.

  2. Overview: This functional error typically occurs when an invalid transformation expression is supplied.

  • Troubleshooting Steps:

    1. Validate the Expression:

      • Issue: Execution of an invalid expression

      • Solution: Utilize the jsonat tool or the Obsrv console's expression tryout feature to thoroughly validate and correct the expression. Once validated, update the dataset transformation configuration using the obsrv/v1/datasets/update API. This ensures the correction is applied across the dataset.


ERR_TRANSFORM_1021 - ERR_EVAL_EXPR_FUNCTION

  1. Message: The error (ERR_TRANSFORM_1021) signifies an inability to evaluate the transformation expression function.

  2. Overview: This functional error occurs when the expression is deemed correct, but the values within it might be incorrect, leading to the failure of the expression evaluation.

  • Troubleshooting Steps:

    1. Validate the Expression Values and Source Correction:

      • Issue: Invalid attributes in the expression

      • Solution: Verify that the system generates accurate values for the properties used in the expression. Validate the sample event against the expression using the jsonat tool or the Obsrv expression tryout tool. This meticulous validation ensures the correctness of both the expression and the underlying data.


ERR_TRANSFORM_1022 - ERR_UNKNOWN_TRANSFORM_EXCEPTION

  1. Message: The error (ERR_TRANSFORM_1022) indicates an inability to evaluate the transformation expression function during execution.

  2. Overview: This functional error occurs during the execution of the expression.

  • Troubleshooting Steps:

    1. Validate the Expression:

      • Issue: Execution of an invalid expression

      • Solution: Employ the jsonat tool or the Obsrv console's tryout option to validate and correct the expression thoroughly. Post-validation, update the dataset transformation configuration using the obsrv/v1/datasets/update API. This comprehensive approach ensures a robust resolution to the expression-related issues during execution.


ERR_TRANSFORM_1023 - ERR_TRANSFORMATION_FAILED

  1. Message: The error (ERR_TRANSFORM_1023) occurs when at least one mandatory transformation has failed.

  2. Overview: This issue arises when the system encounters difficulties in applying the transformation.

  • Troubleshooting Steps:

    1. Validate the Expression and Event:

      • Issue: Failure to apply the expression on the event

      • Solution: This issue often surfaces when encountering related errors such as ERR_EVAL_EXPR_FUNCTION, ERR_UNKNOWN_TRANSFORM_EXCEPTION, or TRANSFORMATION_FIELD_MISSING. Addressing these underlying error codes is crucial for resolving the core issue. A meticulous validation of the expression and the associated event is paramount for a successful resolution.


ERR_TRANSFORM_1024 - TRANSFORMATION_FIELD_MISSING

  1. Message: The error (ERR_TRANSFORM_1024) highlights that a transformation field is either missing or blank.

  2. Overview: This functional error is triggered when the transformation field is not defined or lacks necessary information.

  • Troubleshooting Steps:

    1. Validate the Expression Values and Source Correction:

      • Issue: Attributes of the expression are not defined

      • Solution: Ensure that the system produces the required properties with accurate values for the expression. Validate the sample event against the expression using the jsonat tool or the Obsrv expression tryout tool. This meticulous validation process ensures that the expression has the necessary data inputs, addressing the missing or undefined attributes, and contributes to a reliable data processing framework.

Last updated