From 00709acd51e60bcf73b9aba4613f2421554a62b2 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Thu, 31 Mar 2022 20:49:53 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Updates=20contents=20of=20widget?= =?UTF-8?q?=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/widgets.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/widgets.md b/docs/widgets.md index 3c005c49..0919e8f0 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -69,6 +69,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a - [Widget Usage Guide](#widget-usage-guide) - [Continuous Updates](#continuous-updates) - [Proxying Requests](#proxying-requests) + - [Setting Timeout](#setting-timeout) - [Custom CSS Styling](#widget-styling) - [Customizing Charts](#customizing-charts) - [Language Translations](#language-translations) @@ -1729,7 +1730,16 @@ Vary: Origin ### Setting Timeout -Default timeout is ½ a second. This can be overridden with the `timeout` attribute on a widget, specified as an integer in milliseconds. +If the endpoint you are requesting data from is slow to respond, you may see a timeout error in the console. This can easily be fixed by specifying the `timeout` property on the offending widget. This should be an integer value, in milliseconds. By default timeout is `2500` ms (2½ seconds). + +For example: + +```yaml +- type: gl-current-cpu + timeout: 8000 + options: + hostname: https://glances.dns-device.local +``` ---