diff --git a/docs/content/user-guide/en/monitoring/dashboard.md b/docs/content/user-guide/en/monitoring/dashboard.md index 6535008..cf6c9f0 100644 --- a/docs/content/user-guide/en/monitoring/dashboard.md +++ b/docs/content/user-guide/en/monitoring/dashboard.md @@ -1,10 +1,10 @@ # Dashboard -CAP 原生提供了 Dashboard 供查看消息，利用 Dashboard 提供的功能可以很方便的查看和管理消息。 +The CAP provides a Dashboard for viewing messages, and the features provided by Dashboard make it easy to view and manage messages. -## 启用 Dashboard +## Enable Dashboard -默认情况下，不会启动Dashboard中间件，要开启Dashboard功能你需要在配置中添加如下代码： +By default, Dashboard middleware will not be launched. To enable Dashboard functionality you need to add the following code to your configuration: ```C# services.AddCap(x => @@ -16,31 +16,31 @@ services.AddCap(x => }); ``` -默认情况下，你可以访问 `http://localhost:xxx/cap` 这个地址打开Dashboard。 +By default, you can open the Dashboard by visiting the url `http://localhost:xxx/cap`. -### Dashboard 配置项 +### Dashboard Configuration * PathMatch -默认值：'/cap' +> Default ：'/cap' -你可以通过修改此配置项来更改Dashboard的访问路径。 +You can change the path of the Dashboard by modifying this configuration item. * StatsPollingInterval -默认值：2000 毫秒 +> Default: 2000ms -此配置项用来配置Dashboard 前端 获取状态接口(/stats)的轮询时间 +This configuration item is used to configure the Dashboard front end to get the polling time of the status interface (/stats). * Authorization -此配置项用来配置访问 Dashboard 时的授权过滤器，默认过滤器允许局域网访问，当你的应用想提供外网访问时候，可以通过设置此配置来自定义认证规则。详细参看下一节 +This configuration item is used to configure the authorization filter when accessing the Dashboard. The default filter allows LAN access. When your application wants to provide external network access, you can customize the authentication rules by setting this configuration. See the next section for details. -### 自定义认证 +### Custom authentication -通过实现 `IDashboardAuthorizationFilter` 接口可以自定义Dashboard认证。 +Dashboard authentication can be customized by implementing the `IDashboardAuthorizationFilter` interface. -以下是一个示例代码，通过从url请求参数中读取 accesskey 判断是否允许访问。 +The following is a sample code that determines if access is allowed by reading the accesskey from the url request parameter. ```C# public class TestAuthorizationFilter : IDashboardAuthorizationFilter @@ -55,7 +55,7 @@ public class TestAuthorizationFilter : IDashboardAuthorizationFilter } ``` -然后在修改注册 Dashboard 时候配置此过滤对象。 +Then configure this filter when registration Dashboard. ```C# services.AddCap(x => diff --git a/docs/content/user-guide/en/monitoring/diagnostics.md b/docs/content/user-guide/en/monitoring/diagnostics.md index 3dc3af1..eb7c57d 100644 --- a/docs/content/user-guide/en/monitoring/diagnostics.md +++ b/docs/content/user-guide/en/monitoring/diagnostics.md @@ -1,24 +1,23 @@ # Diagnostics -Diagnostics 提供一组功能使我们能够很方便的可以记录在应用程序运行期间发生的关键性操作以及他们的执行时间等，使管理员可以查找特别是生产环境中出现问题所在的根本原因。 +Diagnostics provides a set of features that make it easy for us to document the critical operations that occur during the application's operation, their execution time, etc., allowing administrators to find the root cause of problems, especially in production environments. +## Diagnostics events -## CAP 中的 Diagnostics +The CAP provides support for `DiagnosticSource` with a listener name of `CapDiagnosticListener`. -在 CAP 中，对 `DiagnosticSource` 提供了支持，监听器名称为 `CapDiagnosticListener`。 +Diagnostics provides external event information as follows: -Diagnostics 提供对外提供的事件信息有： +* Before the message is persisted +* After the message is persisted +* Message persistence exception +* Before the message is sent to MQ +* After the message is sent to MQ +* The message sends an exception to MQ. +* Messages saved from MQ consumption before saving +* After the message is saved from MQ consumption +* Before the subscriber method is executed +* After the subscriber method is executed +* Subscriber method execution exception -* 消息持久化之前 -* 消息持久化之后 -* 消息持久化异常 -* 消息向MQ发送之前 -* 消息向MQ发送之后 -* 消息向MQ发送异常 -* 消息从MQ消费保存之前 -* 消息从MQ消费保存之后 -* 订阅者方法执行之前 -* 订阅者方法执行之后 -* 订阅者方法执行异常 - -相关涉及到的对象，你可以在 `DotNetCore.CAP.Diagnostics` 命名空间下看到。 \ No newline at end of file +Related objects, you can find at the `DotNetCore.CAP.Diagnostics` namespace. \ No newline at end of file diff --git a/docs/content/user-guide/en/monitoring/health-checks.md b/docs/content/user-guide/en/monitoring/health-checks.md index 4f3601d..29f5938 100644 --- a/docs/content/user-guide/en/monitoring/health-checks.md +++ b/docs/content/user-guide/en/monitoring/health-checks.md @@ -1,3 +1,3 @@ -# 健康检查 +# Health Checks TODO \ No newline at end of file diff --git a/docs/content/user-guide/en/persistent/in-memory-storage.md b/docs/content/user-guide/en/persistent/in-memory-storage.md index 996be88..e5b2982 100644 --- a/docs/content/user-guide/en/persistent/in-memory-storage.md +++ b/docs/content/user-guide/en/persistent/in-memory-storage.md @@ -6,8 +6,8 @@ Persistent storage of memory messages is often used in development and test envi To use in-memory storage, you need to install the following extensions from NuGet: -```ps -Install-Package DotNetCore.CAP.InMemoryStorage +```powershell +PM> Install-Package DotNetCore.CAP.InMemoryStorage ``` Next, add configuration items to the `ConfigureServices` method of `Startup.cs`. diff --git a/docs/content/user-guide/en/persistent/mongodb.md b/docs/content/user-guide/en/persistent/mongodb.md index d4d99d3..8f3ca46 100644 --- a/docs/content/user-guide/en/persistent/mongodb.md +++ b/docs/content/user-guide/en/persistent/mongodb.md @@ -12,9 +12,8 @@ For a quick development of the MongoDB 4.0+ cluster for the development environm To use MongoDB storage, you need to install the following extensions from NuGet: -```ps - -Install-Package DotNetCore.CAP.MongoDB +```powershell +PM> Install-Package DotNetCore.CAP.MongoDB ``` diff --git a/docs/content/user-guide/en/persistent/mysql.md b/docs/content/user-guide/en/persistent/mysql.md index d369527..794fd3e 100644 --- a/docs/content/user-guide/en/persistent/mysql.md +++ b/docs/content/user-guide/en/persistent/mysql.md @@ -6,9 +6,8 @@ MySQL is an open-source relational database management system. CAP has supported To use MySQL storage, you need to install the following extensions from NuGet: -```ps - -Install-Package DotNetCore.CAP.MySql +```powershell +PM> Install-Package DotNetCore.CAP.MySql ``` diff --git a/docs/content/user-guide/en/persistent/postgresql.md b/docs/content/user-guide/en/persistent/postgresql.md index 459c00a..eeca893 100644 --- a/docs/content/user-guide/en/persistent/postgresql.md +++ b/docs/content/user-guide/en/persistent/postgresql.md @@ -6,9 +6,8 @@ PostgreSQL is an open-source relational database management system. CAP has supp To use PostgreSQL storage, you need to install the following extensions from NuGet: -```shell - -Install-Package DotNetCore.CAP.PostgreSql +```powershell +PM> Install-Package DotNetCore.CAP.PostgreSql ``` diff --git a/docs/content/user-guide/en/persistent/sqlserver.md b/docs/content/user-guide/en/persistent/sqlserver.md index 38fce7e..124f8f1 100644 --- a/docs/content/user-guide/en/persistent/sqlserver.md +++ b/docs/content/user-guide/en/persistent/sqlserver.md @@ -6,9 +6,8 @@ SQL Server is a relational database management system developed by Microsoft. CA To use SQL Server storage, you need to install the following extensions from NuGet: -```shell - -Install-Package DotNetCore.CAP.SqlServer +```powershell +PM> Install-Package DotNetCore.CAP.SqlServer ``` diff --git a/docs/content/user-guide/en/transports/azure-service-bus.md b/docs/content/user-guide/en/transports/azure-service-bus.md index c3e45a4..f027de0 100644 --- a/docs/content/user-guide/en/transports/azure-service-bus.md +++ b/docs/content/user-guide/en/transports/azure-service-bus.md @@ -6,18 +6,17 @@ CAP supports Azure Service Bus as a message transporter. ## Configuration -!!! warning "必要条件" - 针对 Service Bus 定价层, CAP 要求使用 “标准” 或者 “高级” 以支持 Topic 功能。 +!!! warning "Requirement" + For the Service Bus pricing layer, CAP requires "standard" or "advanced" to support Topic functionality. -要使用 Azure Service Bus 作为消息传输器，你需要从 NuGet 安装以下扩展包： - -```shell - -Install-Package DotNetCore.CAP.AzureServiceBus +To use Azure Service Bus as a message transport, you need to install the following extensions from NuGet: +```powershell +PM> Install-Package DotNetCore.CAP.AzureServiceBus ``` -然后，你可以在 `Startup.cs` 的 `ConfigureServices` 方法中添加基于内存的配置项。 +Then you can add memory-based configuration items to the `ConfigureServices` method of `Startup.cs`. + ```csharp @@ -39,10 +38,10 @@ public void ConfigureServices(IServiceCollection services) #### AzureServiceBus Options -CAP 直接对外提供的 Kafka 配置参数如下： +The AzureServiceBus configuration options provided directly by the CAP are as follows: NAME | DESCRIPTION | TYPE | DEFAULT :---|:---|---|:--- -ConnectionString | Endpoint 地址 | string | +ConnectionString | Endpoint address | string | TopicPath | Topic entity path | string | cap -ManagementTokenProvider | Token提供 | ITokenProvider | null \ No newline at end of file +ManagementTokenProvider | Token provider | ITokenProvider | null \ No newline at end of file diff --git a/docs/content/user-guide/en/transports/in-memory-queue.md b/docs/content/user-guide/en/transports/in-memory-queue.md index 532a479..cc99972 100644 --- a/docs/content/user-guide/en/transports/in-memory-queue.md +++ b/docs/content/user-guide/en/transports/in-memory-queue.md @@ -6,9 +6,8 @@ In Memory Queue is a memory-based message queue provided by [Community](https:// To use In Memory Queue as a message transporter, you need to install the following extensions from NuGet: -```shell - -Install-Package Savorboard.CAP.InMemoryMessageQueue +```powershell +PM> Install-Package Savorboard.CAP.InMemoryMessageQueue ``` Then you can add memory-based configuration items to the `ConfigureServices` method of `Startup.cs`. diff --git a/docs/content/user-guide/en/transports/kafka.md b/docs/content/user-guide/en/transports/kafka.md index 21a68b4..5f1bc09 100644 --- a/docs/content/user-guide/en/transports/kafka.md +++ b/docs/content/user-guide/en/transports/kafka.md @@ -8,9 +8,8 @@ CAP has supported Kafka® as message transporter. To use Kafka transporter, you need to install the following extensions from NuGet: -```shell - -Install-Package DotNetCore.CAP.Kafka +```powershell +PM> Install-Package DotNetCore.CAP.Kafka ``` diff --git a/docs/content/user-guide/en/transports/rabbitmq.md b/docs/content/user-guide/en/transports/rabbitmq.md index 415e9cc..5d79991 100644 --- a/docs/content/user-guide/en/transports/rabbitmq.md +++ b/docs/content/user-guide/en/transports/rabbitmq.md @@ -8,9 +8,8 @@ CAP has supported RabbitMQ as message transporter. To use RabbitMQ transporter, you need to install the following extensions from NuGet: -```shell - -Install-Package DotNetCore.CAP.RabbitMQ +```powershell +PM> Install-Package DotNetCore.CAP.RabbitMQ ```