diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md index 6664b9822e..18b7f35421 100644 --- a/docs/en/changes/changes.md +++ b/docs/en/changes/changes.md @@ -35,6 +35,7 @@ * UI-template: Fix metrics calculation in `general-service/mesh-service/faas-function` top-list dashboard. * Update MySQL dashboard to visualize collected slow SQLs. * Add virtual cache dashboard +* Remove `responseCode` fields of all OAL sources, as well as examples to avoid user's confusion. #### Documentation diff --git a/docs/en/concepts-and-designs/oal.md b/docs/en/concepts-and-designs/oal.md index 981c07325b..960f9b0c08 100644 --- a/docs/en/concepts-and-designs/oal.md +++ b/docs/en/concepts-and-designs/oal.md @@ -138,7 +138,7 @@ endpoint_percentile = from(Endpoint.latency).percentile(10) endpoint_success = from(Endpoint.*).filter(status == true).percent() // Calculate the sum of response code in [404, 500, 503], for each service. -endpoint_abnormal = from(Endpoint.*).filter(responseCode in [404, 500, 503]).count() +endpoint_abnormal = from(Endpoint.*).filter(httpResponseStatusCode in [404, 500, 503]).count() // Calculate the sum of request type in [RequestType.RPC, RequestType.gRPC], for each service. endpoint_rpc_calls_sum = from(Endpoint.*).filter(type in [RequestType.RPC, RequestType.gRPC]).count() diff --git a/docs/en/concepts-and-designs/scope-definitions.md b/docs/en/concepts-and-designs/scope-definitions.md index 540ed4bdfc..74561468f5 100644 --- a/docs/en/concepts-and-designs/scope-definitions.md +++ b/docs/en/concepts-and-designs/scope-definitions.md @@ -13,7 +13,6 @@ This calculates the metrics data from each request of the service. | endpointName | The name of the endpoint, such as a full path of HTTP URI. | | string | | latency | The time taken by each request. | | int | | status | Indicates the success or failure of the request. | | bool(true for success) | -| ~~responseCode~~ | Deprecated.The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int | | httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int | | rpcStatusCode | The string value of the rpc response code. | | string | | type | The type of each request. Such as: Database, HTTP, RPC, gRPC. | | enum | @@ -34,7 +33,6 @@ This calculates the metrics data from each request of the service instance. | endpointName | The name of the endpoint, such as a full path of the HTTP URI. | | string| | latency | The time taken by each request. | | int | | status | Indicates the success or failure of the request. | | bool(true for success) | -| ~~responseCode~~ | Deprecated.The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int | | httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int | | rpcStatusCode | The string value of the rpc response code. | | string | | type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum | @@ -126,7 +124,6 @@ This calculates the metrics data from each request of the endpoint in the servic | serviceInstanceName | The name of the service instance ID. | | string | | latency | The time taken by each request. | | int | | status | Indicates the success or failure of the request.| | bool(true for success) | -| ~~responseCode~~ | Deprecated.The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int | | httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int | | rpcStatusCode | The string value of the rpc response code. | | string | | type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum | @@ -152,7 +149,6 @@ This calculates the metrics data from each request between services. | componentId | The ID of component used in this call. | yes | string | | latency | The time taken by each request. | | int | | status | Indicates the success or failure of the request. | | bool(true for success) | -| ~~responseCode~~ | Deprecated.The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302 | | int | | httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302 | | int | | rpcStatusCode | The string value of the rpc response code. | | string | | type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum | @@ -178,7 +174,6 @@ This calculates the metrics data from each request between service instances. | componentId | The ID of the component used in this call. | yes | string | | latency | The time taken by each request. | | int | | status | Indicates the success or failure of the request. | | bool(true for success) | -| ~~responseCode~~ | Deprecated.The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302 | | int | | httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302 | | int | | rpcStatusCode | The string value of the rpc response code. | | string | | type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum | @@ -207,7 +202,6 @@ including auto instrument agents (like Java and .NET), OpenCensus SkyWalking exp | rpcLatency | The latency of the RPC between the parent endpoint and childEndpoint, excluding the latency caused by the parent endpoint itself. | componentId | The ID of the component used in this call. | yes | string | status | Indicates the success or failure of the request.| | bool(true for success) | -| ~~responseCode~~ | Deprecated.The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int | | httpResponseStatusCode | The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302| | int | | rpcStatusCode | The string value of the rpc response code. | | string | | type | The type of each request, such as Database, HTTP, RPC, or gRPC. | | enum |