Skip to main content

Query checker

Reading time: 0 minute(s) (0 words)

The Query checker feature allows Nobl9 users to validate whether their newly created SLOs will work correctly. If an SLO passes validation, it will start collecting SLI data immediately. Otherwise, the Query checker notifies about an error, so you can fix issues with connection or query, and get your SLOs going.

Prerequisites

note

The Query checker feature works only for the Direct connection method with the following data sources:

Assumptions and limitations

Assumptions for verifying connection

Nobl9 tests the connection by calling the data source's API and verifying the connection status, usually through the HTTP response codes received from the data sources.

Limitations of verifying query

This feature aims to verify the data source's response rather than validate the underlying syntax of the query. Nobl9 tests the query by calling the underlying data source API and verifying the result.

There are two possible outcomes of the verification:

  1. A query is marked as valid, meaning the request has succeeded.

    caution

    The query will be marked as valid even when the response is empty.

  2. A query is marked as invalid - meaning that the data source's connection can't be established or the call to API results in error (usually with the HTTP status code different from 200).

When does the verification occur?

Nobl9 triggers the Verifying connection and query process in the following three instances:

  1. When you add a new SLO with a new query.
  2. When you update the query in an existing SLO.
    Query update creates a new indicator entry in our database, which triggers the validation process.
  3. When you update the data source’s Direct connection credentials.
    Only queries (indicators) marked as invalid will be re-validated.

User experience

Depending on the selected metric type, there are slight differences in how the Query checker works.

After you create an SLO with a Threshold metric, Nobl9 will automatically begin the check process. For both, Threshold and Ratio metrics, you'll see the following statuses in the SLO details view:

step 1 slo details
Image 1: Step 1 of the verification process - SLO details

And, in the grid view:

Step 1 grid view
Image 2: Step 1 of the verification process - grid view

Threshold metrics

Successful check

Once the checks are successful, Nobl9 will automatically proceed to the importing data and calculating statuses in the SLO details:

Successful check
Image 3: Successful checks for the Threshold metrics

Unsuccessful check

When the verification returns an unsuccessful result for your Threshold metric SLO, Nobl9 will display the following errors in the SLO details tab:

Threshold errors
Image 4: Error statuses for the Threshold metric check

When you click the View error log link, Nobl9 will display a modal containing the query and error message returned by the data source:

Threshold errors
Image 5: Error modal for the Threshold metric troubleshooting

Expand this section to see the next steps.

Now, you can fix your SLO by:

  • Clicking on the Edit Data Source button that will take you to the Data source wizard, where you can adjust your data source settings.
  • Clicking on the Edit SLO Query button that will take you to step 2 of the SLO wizard, where you can adjust your query and ensure your SLO is up and running.
  • Ratio metrics

    Successful check

    Once the checks are successful, Nobl9 will automatically proceed to the importing data and calculating statuses in the SLO details:

    SWAP
    Image 6: Successful checks for the Ratio metric

    Unsuccessful check

    For the Ratio metrics SLOs, there are four possible scenarios in which Nobl9 may return:

    1. Errors for both, good and total queries.
    2. An error for the good query only.
    3. An error for the total query only.
    4. An error for one broken objective.
    Errors for good and total queries

    When the verification returns an unsuccessful result for both, Good and Total queries:

    Unsuccessful check - good + total
    Image 7: Unsuccessful check - error statuses for the Ratio metric

    When you click the Good query or the Total query link, Nobl9 will display a modal containing the query and error message returned by the data source:

    Unsuccessful check - ratio good + total
    Image 8: Error modal for the good query
    Unsuccessful check - ratio good + total
    Image 9: Error modal for the total query

    Expand this section to see the next steps.

    Now, you can fix your SLO by:

  • Clicking on the Edit Data Source button that will take you to the Data source wizard, where you can adjust your data source settings.
  • Clicking on the Edit SLO Query button that will take you to step 2 of the SLO wizard, where you can adjust your query and ensure your SLO is up and running.
  • Errors for the good query only

    When the verification returns an unsuccessful result for the Good query only:

    Unsuccessful check - ratio good + total
    Image 10: Error statuses for the good query only

    When you click the Good query, Nobl9 will display a modal containing the query and error message returned by the data source:

    Unsuccessful check - ratio good
    Image 11: Error modal for the good query

    Expand this section to see the next steps.

    Now, you can fix your SLO by:

  • Clicking on the Edit Data Source button that will take you to the Data source wizard, where you can adjust your data source settings.
  • Clicking on the Edit SLO Query button that will take you to step 2 of the SLO wizard, where you can adjust your query and ensure your SLO is up and running.
  • Errors for the total query only

    When the verification returns an unsuccessful result for the Total query only:

    Unsuccessful check - total
    Image 12: Error statuses for the good query only

    When you click the Total query, Nobl9 will display a modal containing the query and error message returned by the data source:

    Unsuccessful check - total
    Image 13: Error modal for the total query

    Expand this section to see the next steps.

    Now, you can fix your SLO by:

  • Clicking on the Edit Data Source button that will take you to the Data source wizard, where you can adjust your data source settings.
  • Clicking on the Edit SLO Query button that will take you to step 2 of the SLO wizard, where you can adjust your query and ensure your SLO is up and running.
  • Errors for one broken SLO objective

    When the verification returns an unsuccessful result for one SLO objective:

    Unsuccessful check - ratio good + total
    Image 14: Error statuses for one broken objective

    When you click the Good query or the Total query link, Nobl9 will display a modal containing the query and error message returned by the data source:

    Unsuccessful check - ratio good + total
    Image 15: Error modal for the good query
    Unsuccessful check - ratio good + total
    Image 16: Error modal for the total query

    Expand this section to see the next steps.

    Now, you can fix your SLO by:

  • Clicking on the Edit Data Source button that will take you to the Data source wizard, where you can adjust your data source settings.
  • Clicking on the Edit SLO Query button that will take you to step 2 of the SLO wizard, where you can adjust your query and ensure your SLO is up and running.
  • Overview of error statuses in the SLI grid

    Threshold metric errors

    Unsuccessful check - threshold grid
    Image 17: Error status for the Threshold metric on the SLO grid

    Ratio metric errors

    Good and total queries
    Unsuccessful check - ratio good + total grid
    Image 18: Error status for the Ratio metric on the SLO grid (good and total query errors)
    Good query
    Unsuccessful check - grid good
    Image 19: Error status for the Ratio metric on the SLO grid (good query error)
    Total query
    Unsuccessful check - grid total
    Image 20: Error status for the Ratio metric on the SLO grid (total query error)
    One broken objective
    Unsuccessful check - grid objective
    Image 21: Error status for the Ratio metric on the SLO grid (one broken objective)