Browse Source

Merge pull request #23278 from abpframework/studio-doc-update

Updated studio solution runner documentation
pull/23345/head
Berkan Sasmaz 7 months ago
committed by GitHub
parent
commit
61ae801aaa
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. BIN
      docs/en/get-started/images/abp-studio-microservice-solution-runner-applications.png
  2. BIN
      docs/en/get-started/images/abp-studio-microservice-solution-runner.png
  3. 4
      docs/en/get-started/microservice.md
  4. BIN
      docs/en/studio/images/monitoring-applications/monitoring-window-hint.png
  5. BIN
      docs/en/studio/images/monitoring-applications/monitoring.png
  6. BIN
      docs/en/studio/images/monitoring-applications/tools-create.png
  7. BIN
      docs/en/studio/images/monitoring-applications/tools-overview.png
  8. 19
      docs/en/studio/monitoring-applications.md

BIN
docs/en/get-started/images/abp-studio-microservice-solution-runner-applications.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/en/get-started/images/abp-studio-microservice-solution-runner.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 123 KiB

After

Width:  |  Height:  |  Size: 115 KiB

4
docs/en/get-started/microservice.md

@ -152,9 +152,9 @@ In the *Solution Runner* section (on the left side) you can see all the runnable
![abp-studio-microservice-solution-runner-applications](images/abp-studio-microservice-solution-runner-applications.png)
> A leaf item in the *Solution Runner* is called as an *Application* as it is an executable application.
> A leaf item in the *Solution Runner* is called as an *Application* as it is an executable application, excluding items under `Containers`.
As shown in the figure above, the executable applications are grouped into folders like `apps`, `gateways`, `infrastructure`, and `services`. You can start/stop them all, a group (folder) of them, or one by one.
As shown in the figure above, the executable applications are grouped into folders like `apps`, `gateways`, and `services`. You can start/stop them all, a group (folder) of them, or one by one. The `Containers` branch contains the needed docker containers for the applications.
Before running the applications, you can run the all application by right-clicking the root item in the *Solution Runner* and select *Build* -> *Build All* action. However, you don't need to do that, because ABP Studio builds the applications before running them by default.

BIN
docs/en/studio/images/monitoring-applications/monitoring-window-hint.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

BIN
docs/en/studio/images/monitoring-applications/monitoring.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/en/studio/images/monitoring-applications/tools-create.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

BIN
docs/en/studio/images/monitoring-applications/tools-overview.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 174 KiB

19
docs/en/studio/monitoring-applications.md

@ -10,10 +10,14 @@
}
````
ABP Studio offers a comprehensive centralized monitoring solution, enabling you to oversee all applications from a single interface. To see the monitoring tabs you can select the [Solution Runner](./running-applications.md) or *Kubernetes* from the left menu, monitoring tabs are automatically opened in the center. You can start the applications for monitoring. Various monitoring options are available, including [Overall](#overall), [Browse](#browse), [HTTP Requests](#http-requests), [Events](#events), [Exceptions](#exceptions), [Logs](#logs).
ABP Studio offers a comprehensive centralized monitoring solution, enabling you to oversee all applications from a single interface. To see the monitoring tabs you can select the [Solution Runner](./running-applications.md) or *Kubernetes* from the left menu, monitoring tabs are automatically opened in the center. You can start the applications for monitoring. Various monitoring options are available, including [Overall](#overall), [Browse](#browse), [HTTP Requests](#http-requests), [Events](#events), [Exceptions](#exceptions), [Logs](#logs), [Tools](#tools).
![monitoring](./images/monitoring-applications/monitoring.png)
If you want to open any of these tabs in separate window, just drag it from the header a little bit and it will pop-up in a new window. In this way you can monitor multiple tabs at once:
![monitoring-window-hint](./images/monitoring-applications/monitoring-window-hint.png)
## Collecting Telemetry Information
There are two application [types](./running-applications.md#abp-studio-running-applications): C# and CLI. Only C# applications can establish a connection with ABP Studio and transmit telemetry information via the `Volo.Abp.Studio.Client.AspNetCore` package. However, we can view the *Logs* and *Browse* (if there is a *Launch URL*) for both CLI and C# application types. Upon starting C# applications, they attempt to establish a connection with ABP Studio. When connection successful, you should see a chain icon next to the application name in [Solution Runner](./running-applications.md#run-1). Applications can connect the ABP Studio with *Solution Runner* -> *C# Application* -> *Run* -> *Start* or from an outside environment such as debugging with Visual Studio. Additionally, they can establish a connection from a Kubernetes Cluster through the ABP Studio [Kubernetes Integration: Connecting to the Cluster](../get-started/microservice.md#kubernetes-integration-connecting-to-the-cluster).
@ -130,3 +134,16 @@ Click on a row to inspect the details of each exception; `Application`, `Excepti
The *Logs* tab allows you to view all logs for both CLI and C# applications. To access logs, simply select an application. You can also apply filters using the search textbox by log text or by selecting a specific *Log Level*. When you select a *Log Level* it shows selected log level and higher log levels. For example, if you select *Warning* it shows *Warning*, *Error* and *Critical* logs. To clear selected application logs, use the *Clear Logs* button. If *Auto Scroll* is checked, the display automatically scrolls when new logs are received.
![logs](./images/monitoring-applications/logs.png)
## Tools
The *Tools* tab allows you to easily access to the user interfaces of the tools you are using. A *tool* may be related with a docker container, or independent. If it is related with a container (ex: *grafana*), the tool is opened when the container is up. If the tool is independent, it will be always opened.
![tools](./images/monitoring-applications/tools-overview.png)
The microservice template comes with pre-defined tools to display related container user interfaces. You can edit existing tools, add new tools or delete existing tools.
In the example below, a new tool named `My Application Status` will be added to the tools and it will display the URL in the input:
![tools-create](./images/monitoring-applications/tools-create.png)

Loading…
Cancel
Save