Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation for timeout at the server side #4595

Closed
ikhoon opened this issue Dec 29, 2022 · 2 comments · Fixed by #4860
Closed

Add documentation for timeout at the server side #4595

ikhoon opened this issue Dec 29, 2022 · 2 comments · Fixed by #4860
Labels
documentation

Comments

@ikhoon
Copy link
Contributor

ikhoon commented Dec 29, 2022

There is documentation for the client-side timeout configuration. https://armeria.dev/docs/client-timeouts But we don't provide documentation for the server-side.

We may list how to override the server-side request timeout with:

  • Globally configuring the default timeout with system properties or a custom FlagsProvider
  • Set a custom timeout using
    • ServerBuilder
    • VirtualHostBuilder
    • ServiceBuilder
    • ...
  • Override a request timeout using ServiceRequestContext.setRequestTimeout()
  • Use the brand new @RequestTimeout annotation for annotated services and gRPC services.
@tomatophobia
Copy link
Contributor

May I work on this issue? @ikhoon

@ikhoon
Copy link
Contributor Author

ikhoon commented May 5, 2023

I'd be glad if you could contribute to this. ❤️

@tomatophobia tomatophobia mentioned this issue May 5, 2023
Merged
trustin pushed a commit that referenced this issue May 30, 2023
@tomatophobia
Add documentation for timeout at the server side (#4860)
c36574d 
Motivation:

- Related issue: #4595
- Documentation exists for [configuring timeouts on the
client-side](https://armeria.dev/docs/client-timeouts) of an
application, but there is no documentation available for configuring
timeouts on the server-side.

Modifications:

- Create a documentation of several ways to override request timeouts on
a server.

Result:

- Closes #4595
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation for timeout at the server side tomatophobia/armeria
2 participants
@ikhoon @tomatophobia