add profiling.md to https://ray-project.github.io/kuberay/

Signed-off-by: Yicheng-Lu-llll <[email protected]>
ray-project · Aug 15, 2023 · d93af34 · d93af34
1 parent 89e6777
commit d93af34
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/docs/guidance/observability.md b/docs/guidance/observability.md
@@ -52,4 +52,8 @@ curl --request GET '<baseUrl>/apis/v1alpha2/namespaces/<namespace>/clusters/<ray
 
 ## Ray Cluster: Monitoring with Prometheus & Grafana
 
-See [prometheus-grafana.md](./prometheus-grafana.md) for more details.
+See [prometheus-grafana.md](./prometheus-grafana.md) for more details.
+
+## Profiling with KubeRay
+
+See [profiling.md](./profiling.md) for more details.
diff --git a/docs/guidance/profiling.md b/docs/guidance/profiling.md
@@ -53,9 +53,9 @@ securityContext:
 6. **Profile using Ray Dashboard**:
     - Visit http://localhost:8265/#/cluster.
     - Click `Stack Trace` for `ray::long_running_task`.
-      <img width="1728" alt="StackTrace" src="../images/stack_trace.png">
+      ![StackTrace](../images/stack_trace.png)
     - Click `CPU Flame Graph` for `ray::long_running_task`.
-      <img width="1728" alt="FlameGraph" src="../images/cpu_flame_graph.png">
+      ![FlameGraph](../images/cpu_flame_graph.png)
     - For additional details on using the profiler, refer the [Ray Observability Guide](https://docs.ray.io/en/latest/ray-observability/user-guides/debug-apps/optimize-performance.html#python-cpu-profiling-in-the-dashboard).
 
 7. **Clean up the RayCluster**: 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -41,6 +41,7 @@ nav:
     - Monitoring and Observability:
       - Observability: guidance/observability.md
       - Prometheus and Grafana: guidance/prometheus-grafana.md
+      - Profiling: guidance/profiling.md
     - Security:
       - IAM Roles (AWS EKS): guidance/aws-eks-iam.md
       - Pod Security: guidance/pod-security.md