Commit 9881a4f4 authored by Andy Hohenner's avatar Andy Hohenner
Browse files

Update references from GBPT to sitespeed-runway

parent ea9e56d3
Loading
Loading
Loading
Loading
+12 −12
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ flowchart LR
  subgraph PTK["Performance Testing Kit"]
    GPT[[GitLab Performance Tool]]
    CPT[["Component Performance Testing (alpha)"]]
    GBPT[[GitLab Browser Performance Tool]]
    SITESPEED[[Sitespeed Runway]]
  end

  START((Start))
@@ -27,7 +27,7 @@ flowchart LR
  ENV -- yes --> GPT
  ENV -- no --> UI

  UI -- yes --> GBPT
  UI -- yes --> SITESPEED
  UI -- no --> COMPONENT

  COMPONENT -- yes --> CPT
@@ -40,13 +40,13 @@ flowchart LR
  classDef kitStyle fill:#f0f8ff,stroke:#4a90e2,stroke-width:2px,color:#333;

  class UI,ENV,COMPONENT decision;
  class GBPT,CPT,GPT tool;
  class SITESPEED,CPT,GPT tool;
  class START start;
  class PTK kitStyle;

  %% Tool links
  click GPT "https://gitlab.com/gitlab-org/quality/performance/-/blob/main/docs/quick_start.md"
  click GBPT "https://gitlab.com/gitlab-org/quality/performance-sitespeed#running-tests"
  click SITESPEED "https://gitlab.com/gitlab-org/quality/sitespeed-runway/-/blob/main/docs/self-service.md"
  click CPT "https://gitlab.com/gitlab-org/quality/component-performance-testing"

  %% Decision node links
@@ -102,7 +102,7 @@ Use [Component Performance Testing Tool](https://gitlab.com/gitlab-org/quality/c

### Testing Page Load Performance

Use [GitLab Browser Performance Tool](https://gitlab.com/gitlab-org/quality/performance-sitespeed) to measure how fast your pages load for users, including metrics like Time to First Byte, Largest Contentful Paint, and other Core Web Vitals.
Use [Sitespeed Runway](https://gitlab.com/gitlab-org/quality/sitespeed-runway) to measure how fast your pages load for users, including metrics like Time to First Byte, Largest Contentful Paint, and other Core Web Vitals.

**When to use:**

@@ -186,7 +186,7 @@ Use lightweight profiling tools while actively developing to understand performa

**Example tools:**

- Code profilers for CPU and memory analysis
- Code profiler for CPU and memory analysis
- Database query analyzers
- Benchmarking utilities for comparing implementations

@@ -256,13 +256,13 @@ end

### Profiling Tools

We already use profiling tools (i.e. rubocop) in our pipelines to ensure that we meet coding guidelines and avoid common problematic patterns. Several performance focused ones that are in our codebase:
We already use profiling tools (i.e. RuboCop) in our pipelines to ensure that we meet coding guidelines and avoid common problematic patterns. Several performance focused ones that are in our codebase:

1. [ruby-prof](https://ruby-prof.github.io/): A comprehensive profiling solution that supports both flat and graph profiles. ruby-prof can measure CPU time, memory allocation, and object creation.
2. [stackprof](https://github.com/tmm1/stackprof): A sampling call-stack profiler. It's designed to be a faster and more memory-efficient alternative to ruby-prof for certain use cases.
3. [memory_profiler](https://github.com/SamSaffron/memory_profiler): A memory profiler that provides detailed information about memory usage, including object allocation and retention. [documentation](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/development/performance.md?ref_type=heads#using-memory-profiler) in our performance guidelines.
4. [rbspy](https://rbspy.github.io): A sampling profiler for Ruby, [documentation](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/administration/sidekiq/sidekiq_troubleshooting.md?ref_type=heads#ruby-profiling-with-rbspy) in our sidekiq troubleshooting docs
5. [derailed_benchmarks](https://github.com/zombocom/derailed_benchmarks): A set of benchmarks that measure various aspects of Rails application performance, including memory usage and load time. [documentation](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/development/performance.md?ref_type=heads#derailed-benchmarks) in our performance guidelines.
2. [Stackprof](https://github.com/tmm1/stackprof): A sampling call-stack profiler. It's designed to be a faster and more memory-efficient alternative to ruby-prof for certain use cases.
3. [memory profiler](https://github.com/SamSaffron/memory_profiler): A memory profiler that provides detailed information about memory usage, including object allocation and retention. [documentation](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/development/performance.md?ref_type=heads#using-memory-profiler) in our performance guidelines.
4. [rbspy](https://rbspy.github.io): A sampling profiler for Ruby, [documentation](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/administration/sidekiq/sidekiq_troubleshooting.md?ref_type=heads#ruby-profiling-with-rbspy) in our Sidekiq troubleshooting docs
5. [derailed benchmarks](https://github.com/zombocom/derailed_benchmarks): A set of benchmarks that measure various aspects of Rails application performance, including memory usage and load time. [documentation](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/development/performance.md?ref_type=heads#derailed-benchmarks) in our performance guidelines.
6. [benchmark-ips](https://github.com/evanphx/benchmark-ips): benchmarks a blocks iterations/second
7. [rspec_profiling](https://github.com/foraker/rspec_profiling): collects data on spec execution times, [documentation](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/development/performance.md?ref_type=heads#rspec-profiling) from our performance guidelines.

@@ -287,7 +287,7 @@ Some approaches to using these tools are detailed on the [profiling page](https:
| Project | Description |
| ---- | ----------- |
| [GPT](https://gitlab.com/gitlab-org/quality/performance) | The GitLab Performance Tool (GPT) provides load testing for GitLab instances |
| [GBPT](https://gitlab.com/gitlab-org/quality/performance-sitespeed) | SiteSpeed CI pipelines for browser performance testing |
| [Sitespeed Runway](https://gitlab.com/gitlab-org/quality/sitespeed-runway) | SiteSpeed CI pipelines for browser performance testing |
| [CPT (Alpha)](https://gitlab.com/gitlab-org/quality/component-performance-testing) | Component-level performance testing for individual services (currently in alpha trials) |
| [sitespeed-measurement-setup](https://gitlab.com/gitlab-org/frontend/sitespeed-measurement-setup) | Setup to measure performance on GitLab websites through sitespeed.io |