The Need for Regexp Queries in SLO APIs

Oct 13, 2025 by wbrum.org 72 views

Problem: The Current Limitations of SLO APIs

As part of supporting our products, Kibana has an Service Level Objective (SLO) that triggers alerts when a threshold for CDN bad responses is reached. Ideally, the Service Level Indicator (SLI) should account for projects created through Pull Requests (PRs) and support a query such as:

{
  "regexp": {
    "httpRequest.referer": {
      "case_insensitive": false,
      "flags": "ALL",
      "value": ".*-pr[\\d]+-.*qa\\.elastic\\.cloud\\/"
    }
  }
}

However, the current provider only supports a kql_custom_indicator for SLOs, which only accepts a KQL string. This limitation restricts the ability to create more complex indicators built from queries in the SLO API, resulting in lower accuracy.

The Need for Regexp Queries in SLO APIs

Supporting regexp queries in SLO APIs would enable higher accuracy and more precise monitoring of CDN bad responses. This is particularly important for projects created through PRs, where the referer URL may contain specific patterns that need to be matched.

Ideal Solution: Supporting All Formats of SLIs

The terraform provider supports all formats in which SLIs can be defined using Kibana. By leveraging this capability, we can support regexp queries in SLO APIs and provide more accurate monitoring of CDN bad responses.

Alternative Solution: Don't Filter Based on Projects Created through PRs

Another possible solution is to not filter based on projects created through PRs. However, this approach may not be desirable, as it may lead to false positives and decreased accuracy.

Additional Context: Relates to https://github.com/elastic/kibana-team/issues/1399

This feature request is related to the issue #1399 on the Kibana team's GitHub repository. The issue highlights the need for more complex indicators built from queries in the SLO API.

Benefits of Supporting Regexp Queries in SLO APIs

Supporting regexp queries in SLO APIs offers several benefits, including:

Improved accuracy: By supporting regexp queries, we can create more complex indicators that accurately monitor CDN bad responses.
Increased flexibility: Regexp queries provide a flexible way to match specific patterns in the referer URL, making it easier to monitor projects created through PRs.
Enhanced monitoring capabilities: By supporting regexp queries, we can provide more precise monitoring of CDN bad responses, enabling better decision-making and improved customer satisfaction.

Implementation Plan

To implement this feature, we will:

Review the terraform provider's documentation: We will review the terraform provider's documentation to understand the current limitations and capabilities of the provider.
Develop a new provider: We will develop a new provider that supports regexp queries in SLO APIs.
Test the new provider: We will test the new provider to ensure that it works as expected and provides accurate monitoring of CDN bad responses.
Deploy the new provider: We will deploy the new provider to production, making it available for use by customers.

Conclusion

Q: What is the current limitation of SLO APIs?

A: The current provider only supports a kql_custom_indicator for SLOs, which only accepts a KQL string. This limitation restricts the ability to create more complex indicators built from queries in the SLO API.

Q: Why is supporting regexp queries in SLO APIs important?

A: Supporting regexp queries in SLO APIs is important because it enables higher accuracy and more precise monitoring of CDN bad responses. This is particularly important for projects created through PRs, where the referer URL may contain specific patterns that need to be matched.

Q: What are the benefits of supporting regexp queries in SLO APIs?

A: The benefits of supporting regexp queries in SLO APIs include:

Improved accuracy: By supporting regexp queries, we can create more complex indicators that accurately monitor CDN bad responses.
Increased flexibility: Regexp queries provide a flexible way to match specific patterns in the referer URL, making it easier to monitor projects created through PRs.
Enhanced monitoring capabilities: By supporting regexp queries, we can provide more precise monitoring of CDN bad responses, enabling better decision-making and improved customer satisfaction.

Q: How will supporting regexp queries in SLO APIs be implemented?

A: To implement this feature, we will:

Review the terraform provider's documentation: We will review the terraform provider's documentation to understand the current limitations and capabilities of the provider.
Develop a new provider: We will develop a new provider that supports regexp queries in SLO APIs.
Test the new provider: We will test the new provider to ensure that it works as expected and provides accurate monitoring of CDN bad responses.
Deploy the new provider: We will deploy the new provider to production, making it available for use by customers.

Q: What is the timeline for implementing this feature?

A: We anticipate that the implementation of this feature will take several weeks to complete. We will provide regular updates on the status of the implementation and will notify customers when the new provider is available for use.

Q: How will customers be notified when the new provider is available?

A: We will notify customers through email and will provide instructions on how to use the new provider. We will also provide documentation and support to ensure that customers can successfully use the new provider.

Q: What if I have questions or need further assistance?

A: If you have questions or need further assistance, please don't hesitate to contact us. We are committed to providing excellent support and will do our best to assist you.

Q: Is this feature related to any other issues or features?

A: Yes, this feature is related to the issue #1399 on the Kibana team's GitHub repository. The issue highlights the need for more complex indicators built from queries in the SLO API.

Q: Can I provide feedback or suggestions on this feature?

A: Yes, we would love to hear your feedback and suggestions on this feature. Please don't hesitate to contact us with any comments or ideas you may have.