Add docs about Services and metrics

JetBrains · Dec 30, 2023 · 375e415 · 375e415
1 parent 1214395
commit 375e415
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 1 deletion.
diff --git a/docs/aspire.tree b/docs/aspire.tree
@@ -8,5 +8,7 @@
 
     <toc-element topic="starter-topic.md"/>
     <toc-element topic="run-configuration.md"/>
+    <toc-element topic="dashboard.md"/>
+    <toc-element topic="metrics.md"/>
     <toc-element topic="troubleshooting.md"/>
 </instance-profile>
diff --git a/docs/images/metrics.jpg b/docs/images/metrics.jpg
diff --git a/docs/images/metrics_dark.jpg b/docs/images/metrics_dark.jpg
diff --git a/docs/images/services.jpg b/docs/images/services.jpg
diff --git a/docs/images/services_dark.jpg b/docs/images/services_dark.jpg
diff --git a/docs/topics/dashboard.md b/docs/topics/dashboard.md
@@ -0,0 +1,6 @@
+# Dashboard
+
+The plugin can display a basic dashboard for your dotnet projects. 
+To enable it, go to **Settings | Tools | Aspire** and enable **Show projects in the Services tool window** option.
+
+![Aspire Services tool window](services.jpg){ width="700" }
diff --git a/docs/topics/metrics.md b/docs/topics/metrics.md
@@ -0,0 +1,7 @@
+# Metrics
+
+The plugin can display a metrics table and chart for your dotnet projects.
+To enable it, go to **Settings | Tools | Aspire** and enable **Show projects in the Services tool window** and
+**Collect OpenTelemetry data** options.
+
+![Aspire metrics chart](metrics.jpg){ width="750" }
diff --git a/docs/topics/troubleshooting.md b/docs/topics/troubleshooting.md
@@ -23,7 +23,8 @@ host. To do this, go to
 the [plugin directory](https://www.jetbrains.com/help/rider/Directories_Used_by_the_IDE_to_Store_Settings_Caches_Plugins_and_Logs.html#plugins-directory).
 Then open the `aspire-plugin/aspire-session-host/appsettings.json` file. This is a default
 aspnetcore [configuration file](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-8.0#configure-logging).
-Then change the level of the **Default** and **AspireSessionHost** categories. 
+Then change the level of the **Default** and **AspireSessionHost** categories. The updated logs will be reported to the
+IDE logs.
 
 ```json
 {