1nbdkit-retry-request-filter(1)      NBDKIT      nbdkit-retry-request-filter(1)
2
3
4

NAME

6       nbdkit-retry-request-filter - retry single requests on error
7

SYNOPSIS

9        nbdkit --filter=retry-request PLUGIN
10                          [retry-request-retries=N] [retry-request-delay=N]
11                          [retry-request-open=false]
12

DESCRIPTION

14       "nbdkit-retry-request-filter" is a filter for nbdkit that transparently
15       retries single requests if they fail.  This is useful for plugins that
16       are not completely reliable or have random behaviour.  For example
17       nbdkit-curl-plugin(1) might behave this way if pointed at a load
18       balancer which sometimes redirects to a web server that is not
19       responsive.
20
21       An alternative filter with different trade-offs is
22       nbdkit-retry-filter(1).  That filter is more heavyweight because it
23       always reopens the whole plugin connection on failure.
24

PARAMETERS

26       retry-request-retries=N
27           The number of times any single request will be retried before we
28           give up and fail the operation.  The default is 2.
29
30       retry-request-delay=N
31           The number of seconds to wait before retrying.  The default is 2
32           seconds.
33
34       retry-request-open=false
35           If set to false, do not retry opening the plugin.  The default is
36           to treat plugin open in the same way as other requests.
37

FILES

39       $filterdir/nbdkit-retry-request-filter.so
40           The filter.
41
42           Use "nbdkit --dump-config" to find the location of $filterdir.
43

VERSION

45       "nbdkit-retry-filter" first appeared in nbdkit 1.30.
46

SEE ALSO

48       nbdkit(1), nbdkit-filter(3), nbdkit-readahead-filter(1),
49       nbdkit-retry-filter(1).
50

AUTHORS

52       Richard W.M. Jones
53

55       Copyright (C) 2019-2021 Red Hat Inc.
56

LICENSE

58       Redistribution and use in source and binary forms, with or without
59       modification, are permitted provided that the following conditions are
60       met:
61
62       •   Redistributions of source code must retain the above copyright
63           notice, this list of conditions and the following disclaimer.
64
65       •   Redistributions in binary form must reproduce the above copyright
66           notice, this list of conditions and the following disclaimer in the
67           documentation and/or other materials provided with the
68           distribution.
69
70       •   Neither the name of Red Hat nor the names of its contributors may
71           be used to endorse or promote products derived from this software
72           without specific prior written permission.
73
74       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
75       EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
76       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
77       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
78       LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
79       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
80       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
81       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
82       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
83       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
84       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
85
86
87
88nbdkit-1.32.5                     2023-01-03    nbdkit-retry-request-filter(1)
Impressum