Skip to content

Draft: WIP-2 Embedding Observability UI within GitLab

Daniele Rossetti requested to merge rossetd-test-observability-ui-iframe into master

What does this MR do and why?

WIP

gitlab-org/opstrace/opstrace-ui#10 (closed)

Screenshots or screen recordings

Demo

How to set up and validate locally

Because of Content Security Policies related to iframes, testing this MR locally is not straightforward. While we are working on enabling support for Reviews App, the quickest way of running this locally is to enable HTTPs on your local GDK, and change the hostname to be a subdomain of .gitlab.com e.g. local.gitlab.com

  1. Follow the steps detailed here and set your local GDK hostname to local.gitlab.com
  2. Follow the steps detailed here to enable HTTPs
  3. You should be able to access your local GDK by accessing https://local.gitlab.com:3443/
  4. Enable the feature flag 
    Feature.enable(:observability_group_tab)
  5. Access https://observe.gitlab.com/9970/?groupId=14485840 on a separate tab and login with your GitLab credentials ( this is only needed when testing it locally )
  6. Access https://local.gitlab.com:3443/ and login with your local dev credentials
  7. Go to a group page, e.g. https://local.gitlab.com:3443/gitlab-org
  8. Access the Observability tab from the left navbar

Note If instead of the Observability UI you are seeing a white page with a "Not found" or "Unauthorised" error try and hardcode the iframe URL to be https://observe.gitlab.com/9970/?groupId=14485840

@observability_iframe_src = "https://observe.gitlab.com/9970/?groupId=14485840"

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Daniele Rossetti

Merge request reports