mirror of https://github.com/dapr/docs.git
create new errors topic
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
This commit is contained in:
parent
780c0185c9
commit
263db693ec
|
@ -2,6 +2,6 @@
|
||||||
type: docs
|
type: docs
|
||||||
title: "Debugging Dapr applications and the Dapr control plane"
|
title: "Debugging Dapr applications and the Dapr control plane"
|
||||||
linkTitle: "Debugging"
|
linkTitle: "Debugging"
|
||||||
weight: 50
|
weight: 60
|
||||||
description: "Guides on how to debug Dapr applications and the Dapr control plane"
|
description: "Guides on how to debug Dapr applications and the Dapr control plane"
|
||||||
---
|
---
|
|
@ -2,6 +2,6 @@
|
||||||
type: docs
|
type: docs
|
||||||
title: "Components"
|
title: "Components"
|
||||||
linkTitle: "Components"
|
linkTitle: "Components"
|
||||||
weight: 30
|
weight: 40
|
||||||
description: "Learn more about developing Dapr's pluggable and middleware components"
|
description: "Learn more about developing Dapr's pluggable and middleware components"
|
||||||
---
|
---
|
||||||
|
|
|
@ -0,0 +1,8 @@
|
||||||
|
---
|
||||||
|
type: docs
|
||||||
|
title: "Error codes"
|
||||||
|
linkTitle: "Error codes"
|
||||||
|
weight: 20
|
||||||
|
description: "Error codes and messages you may encounter while using Dapr"
|
||||||
|
---
|
||||||
|
|
|
@ -1,20 +1,11 @@
|
||||||
---
|
---
|
||||||
type: docs
|
type: docs
|
||||||
title: "Error codes returned by APIs"
|
title: "Error codes reference guide"
|
||||||
linkTitle: "Error codes"
|
linkTitle: "Reference"
|
||||||
description: "Detailed reference of the Dapr API error codes"
|
description: "List of gRPC and HTTP error codes in Dapr and their descriptions"
|
||||||
weight: 1400
|
weight: 20
|
||||||
---
|
---
|
||||||
|
|
||||||
For http calls made to Dapr runtime, when an error is encountered, an error json is returned in http response body. The json contains an error code and an descriptive error message, e.g.
|
|
||||||
|
|
||||||
```
|
|
||||||
{
|
|
||||||
"errorCode": "ERR_STATE_GET",
|
|
||||||
"message": "Requested state key does not exist in state store."
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The following tables list the error codes returned by Dapr runtime:
|
The following tables list the error codes returned by Dapr runtime:
|
||||||
|
|
||||||
### Actors API
|
### Actors API
|
||||||
|
@ -154,3 +145,8 @@ The following tables list the error codes returned by Dapr runtime:
|
||||||
| ERR_MALFORMED_REQUEST | Error with a malformed request. |
|
| ERR_MALFORMED_REQUEST | Error with a malformed request. |
|
||||||
| ERR_MALFORMED_REQUEST_DATA | Error request data is malformed. |
|
| ERR_MALFORMED_REQUEST_DATA | Error request data is malformed. |
|
||||||
| ERR_MALFORMED_RESPONSE | Error response data is malformed. |
|
| ERR_MALFORMED_RESPONSE | Error response data is malformed. |
|
||||||
|
|
||||||
|
## Next steps
|
||||||
|
|
||||||
|
- [Handling HTTP error codes]({{< ref http-error-codes.md >}})
|
||||||
|
- [Handling gRPC error codes]({{< ref grpc-error-codes.md >}})
|
|
@ -0,0 +1,13 @@
|
||||||
|
---
|
||||||
|
type: docs
|
||||||
|
title: "Errors overview"
|
||||||
|
linkTitle: "Overview"
|
||||||
|
weight: 10
|
||||||
|
description: "Overview of Dapr errors"
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Next step
|
||||||
|
|
||||||
|
{{< button text="Error code reference" page="error-codes-reference" >}}
|
|
@ -1,20 +1,18 @@
|
||||||
---
|
---
|
||||||
type: docs
|
type: docs
|
||||||
title: Dapr errors
|
title: Handling gRPC error codes
|
||||||
linkTitle: "Dapr errors"
|
linkTitle: "gRPC"
|
||||||
weight: 700
|
weight: 40
|
||||||
description: "Information on Dapr errors and how to handle them"
|
description: "Information on Dapr gRPC errors and how to handle them"
|
||||||
---
|
---
|
||||||
|
|
||||||
## Error handling: Understanding errors model and reporting
|
|
||||||
|
|
||||||
Initially, errors followed the [Standard gRPC error model](https://grpc.io/docs/guides/error/#standard-error-model). However, to provide more detailed and informative error messages, an enhanced error model has been defined which aligns with the gRPC [Richer error model](https://grpc.io/docs/guides/error/#richer-error-model).
|
Initially, errors followed the [Standard gRPC error model](https://grpc.io/docs/guides/error/#standard-error-model). However, to provide more detailed and informative error messages, an enhanced error model has been defined which aligns with the gRPC [Richer error model](https://grpc.io/docs/guides/error/#richer-error-model).
|
||||||
|
|
||||||
{{% alert title="Note" color="primary" %}}
|
{{% alert title="Note" color="primary" %}}
|
||||||
Not all Dapr errors have been converted to the richer gRPC error model.
|
Not all Dapr errors have been converted to the richer gRPC error model.
|
||||||
{{% /alert %}}
|
{{% /alert %}}
|
||||||
|
|
||||||
### Standard gRPC Error Model
|
## Standard gRPC Error Model
|
||||||
|
|
||||||
The [Standard gRPC error model](https://grpc.io/docs/guides/error/#standard-error-model) is an approach to error reporting in gRPC. Each error response includes an error code and an error message. The error codes are standardized and reflect common error conditions.
|
The [Standard gRPC error model](https://grpc.io/docs/guides/error/#standard-error-model) is an approach to error reporting in gRPC. Each error response includes an error code and an error message. The error codes are standardized and reflect common error conditions.
|
||||||
|
|
||||||
|
@ -25,7 +23,7 @@ ERROR:
|
||||||
Message: input key/keyPrefix 'bad||keyname' can't contain '||'
|
Message: input key/keyPrefix 'bad||keyname' can't contain '||'
|
||||||
```
|
```
|
||||||
|
|
||||||
### Richer gRPC Error Model
|
## Richer gRPC Error Model
|
||||||
|
|
||||||
The [Richer gRPC error model](https://grpc.io/docs/guides/error/#richer-error-model) extends the standard error model by providing additional context and details about the error. This model includes the standard error `code` and `message`, along with a `details` section that can contain various types of information, such as `ErrorInfo`, `ResourceInfo`, and `BadRequest` details.
|
The [Richer gRPC error model](https://grpc.io/docs/guides/error/#richer-error-model) extends the standard error model by providing additional context and details about the error. This model includes the standard error `code` and `message`, along with a `details` section that can contain various types of information, such as `ErrorInfo`, `ResourceInfo`, and `BadRequest` details.
|
||||||
|
|
|
@ -0,0 +1,21 @@
|
||||||
|
---
|
||||||
|
type: docs
|
||||||
|
title: "Handling HTTP error codes"
|
||||||
|
linkTitle: "HTTP"
|
||||||
|
description: "Detailed reference of the Dapr HTTP error codes and how to handle them"
|
||||||
|
weight: 30
|
||||||
|
---
|
||||||
|
|
||||||
|
For http calls made to Dapr runtime, when an error is encountered, an error json is returned in http response body. The json contains an error code and an descriptive error message, e.g.
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"errorCode": "ERR_STATE_GET",
|
||||||
|
"message": "Requested state key does not exist in state store."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Related
|
||||||
|
|
||||||
|
- [Error code reference list]({{< ref error-codes-reference.md >}})
|
||||||
|
- [Handling gRPC error codes]({{< ref grpc-error-codes.md >}})
|
|
@ -2,6 +2,6 @@
|
||||||
type: docs
|
type: docs
|
||||||
title: "Integrations"
|
title: "Integrations"
|
||||||
linkTitle: "Integrations"
|
linkTitle: "Integrations"
|
||||||
weight: 60
|
weight: 70
|
||||||
description: "Dapr integrations with other technologies"
|
description: "Dapr integrations with other technologies"
|
||||||
---
|
---
|
|
@ -2,6 +2,6 @@
|
||||||
type: docs
|
type: docs
|
||||||
title: "Local development"
|
title: "Local development"
|
||||||
linkTitle: "Local development"
|
linkTitle: "Local development"
|
||||||
weight: 40
|
weight: 50
|
||||||
description: "Capabilities for developing Dapr applications locally"
|
description: "Capabilities for developing Dapr applications locally"
|
||||||
---
|
---
|
|
@ -2,7 +2,7 @@
|
||||||
type: docs
|
type: docs
|
||||||
title: "Dapr Software Development Kits (SDKs)"
|
title: "Dapr Software Development Kits (SDKs)"
|
||||||
linkTitle: "SDKs"
|
linkTitle: "SDKs"
|
||||||
weight: 20
|
weight: 30
|
||||||
description: "Use your favorite languages with Dapr"
|
description: "Use your favorite languages with Dapr"
|
||||||
no_list: true
|
no_list: true
|
||||||
---
|
---
|
||||||
|
|
Loading…
Reference in New Issue