Skip to content

Remove newlines when generating prometheus_endpoint_path

Reuben Pereira requested to merge 220338-remove-newlines-in-prom-queries into master

What does this MR do?

Large Prometheus queries are more readable if they are multiline, but we currently do not support multiline Prometheus queries in metrics dashboard yaml files.

The Prometheus query in a metrics dashboard yaml file is passed to the Prometheus server as a GET API query parameter. However, our UrlBlocker does not allow multiline URLs. This prevents us from using multiline Prometheus queries in metrics dashboard.

This MR removes newlines from the Prometheus query before adding it to the API request, thus allowing multiline queries in metrics dashboard yaml files.

Issue: #220338 (closed)

Screenshots

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Reuben Pereira

Merge request reports