docs/en/studio/overview.md
//[doc-seo]
{
"Description": "Explore ABP Studio's key features like Solution Explorer, Kubernetes Integration, and AI Assistant to optimize your ABP application development and management."
}
//[doc-nav]
{
"Next": {
"Name": "Solution Explorer",
"Path": "studio/solution-explorer"
}
}
ABP Studio, a comprehensive desktop application, offers a wide range of features and functionalities tailored to streamline the development and management of ABP-based applications. This article provides an overview of the key components of ABP Studio, including the Solution Explorer, Solution Runner, Kubernetes Integration, AI Assistant, Application Monitoring Area, Background Tasks, Notifications and Logs. Understanding these components is essential for efficiently utilizing ABP Studio to its full potential.
The top menu is the main menu bar in ABP Studio. It offers access to various functionalities such as File, ABP Suite, Tools, and Help. In this section we will examine these functions.
ABP Suite is a complementary tool to the ABP Platform, designed to enable the rapid construction of web pages in just a few minutes. With the ABP Suite button in the Top Menu, you can access the Suite from the browser embedded in ABP Studio.
The Welcome Screen is the initial user interface users encounter upon starting ABP Studio.
Located on the left side of the interface, the Left Area is a panel that provides quick access to various functionalities like Solution Explorer, Solution Runner, Kubernetes Integration, and AI Assistant. Now let's examine each item.
The Solution Explorer is a feature for managing your project's structure, allowing operations such as add package reference, add new package, new module creation, and etc. within ABP Studio.
Solution Runner is a tool within ABP Studio that enables users to build, run, and monitor their applications directly from the user interface.
Kubernetes integration in ABP Studio enables users to deploy solutions directly to Kubernetes clusters and provides tools for displaying and managing Kubernetes services. This integration features two main panes:
This pane is dedicated to managing Helm charts, which are packages used in Kubernetes deployments. It simplifies the process of building images and installing charts.
This pane is dedicated to managing Kubernetes services. It simplifies the process of redeploying and intercepting application service.
The AI Assistant is an integrated chat interface within ABP Studio that provides intelligent assistance for ABP-related questions. You can access it from the left sidebar by clicking the AI icon.
For external AI tool integrations through MCP, see the Model Context Protocol (MCP) documentation.
Key features of the AI Assistant include:
Note: Review the Privacy Notice available in the AI Assistant panel to understand how your data is handled.
The Application Monitoring Area is a functional component within ABP Studio that displays real-time operational status and metrics for applications. It indicates the active state of applications, the count of running instances, and so on. The user interface is organized into several tabs: Overall, Browse, HTTP Requests, Events, Exceptions, and Logs. Now let's examine the Overall tab.
The summary section gives a quick overview of the system's status, displaying metrics such as the number of apps running, total requests, events, and exceptions. This high-level view helps to quickly determine the health of the system.
Now let's examine the Browse tab.
Providing a built-in browser to open and interact with running applications or websites directly within ABP Studio. Now let's continue with the HTTP Requests tab.
This tab provides a log of all HTTP requests across applications, complete with timestamps, paths, methods, and status codes. It enables developers to trace each request's journey and identify any potential bottlenecks or errors. Now let's examine the next tab, the Events tab.
The Events tab is a centralized stream where all the distributed events across applications are recorded. It allows filtering by name, application, direction, and source, providing a transparent view of the inter-service communication. So far, so good. Now let's move on to the next tab.
The Exceptions tab is dedicated to capturing and listing all exceptions thrown by connected applications. It is essential for debugging, offering the ability to filter by content, application, and severity level. Finally, let's continue with the Logs tab.
The Logs tab in ABP Studio displays a real-time feed of log entries from applications, allowing for filtering by content, application, and severity level for targeted troubleshooting.
The Background Tasks section of ABP Studio provides a user interface for observing and managing asynchronous operations that occur within the studio environment. This area displays a list of tasks with their respective details:
Queued, Executing, Completed, Failed, or Canceled.Queued state, tasks can be canceled by the user.Failed to understand and address the causes of failure.System behavior includes:
ABP Studio is designed to inform users of various system events through a dedicated Notifications section in bottom area. This UI provides real-time alerts in the form of informational messages, warnings, success confirmations, and error notifications, each differentiated by distinct visual cues for immediate recognition.
Notifications are displayed transiently on the user interface for a brief period, typically five seconds, ensuring the user is promptly informed without causing prolonged distraction.
Users can manually dismiss notifications or interact with them if additional actions are associated with the alert.
Notifications are consolidated in a list that can be accessed through the notifications user interface, allowing users to review past alerts and perform relevant actions.
The Logs UI in ABP Studio is designed to capture and display a stream of log entries generated by the application.
The Logs user interface include:
Information level and above.