Skip to content

Commit

Permalink
Docs for GRPC Error codes (#775)
Browse files Browse the repository at this point in the history
Docs for GRPC Error codes in Case of Streaming.
  • Loading branch information
indrajit96 committed Aug 16, 2024
1 parent 83e3066 commit d88685d
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,28 @@ server side.
If writing your own gRPC clients in the language of choice consult
gRPC guide on [cancellation](https://grpc.io/docs/guides/cancellation/#cancelling-an-rpc-call-on-the-client-side).

### GRPC Status Codes

Starting from release 24.08, Triton server introduces support for gRPC error
codes in streaming mode for all clients enhancing error reporting capabilities. When
this feature is enabled, the Triton server will return standard gRPC error codes
and subsequently close the stream after delivering the error. This feature is
optional can be enabled by adding header with `triton_grpc_error` key and `true` as
value. See [grpc error
codes](https://github.com/triton-inference-server/server/tree/main#GRPC-Status-Codes) in the server to learn about how this is handled on the server side. See gRPC
guide on [status-codes](https://grpc.io/docs/guides/status-codes/) for more details.
Below is a Python snippet to enable the feature. Without this header Triton server
will continue streaming in default mode returning error message and status inside
`InferenceServerException` object within the callback provided.

```python
triton_client = grpcclient.InferenceServerClient(triton_server_url)
# New added header key value
metadata = {"triton_grpc_error": "true"}
triton_client.start_stream(
callback=partial(callback, user_data), headers=metadata
)
```
## Simple Example Applications

This section describes several of the simple example applications and
Expand Down

0 comments on commit d88685d

Please sign in to comment.