aboutsummaryrefslogtreecommitdiffstats
path: root/yt/yt/client/hedging/hedging.h
blob: 3c515ce8b9d47dcdff5c5b075c4da6c794f5e07c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
#pragma once

#include "public.h"

#include "hedging_executor.h"
#include "penalty_provider.h"

#include <yt/yt/client/api/client.h>

// @brief   HedgingClient is a wrapper for several YT-clients with ability
//          to retry asynchronously the same request with different underlying-clients.
//          HedgingClient implements IClient interface and supports methods that do not change state of data on YT.
//          Currently supported methods: LookupRows, VersionedLookupRows, SelectRows, ExplainQuery,
//          CreateTableReader, GetNode, ListNode, NodeExists, CreateFileReader
//
//          For initial configuration every YT-client needs an InitialPenalty value.
//          This value is used to determine in which order YT-clients will be used.
//
//          MinInitialPenalty - minimal retry timeout value out of all YT-clients.
//          EffectivePenalty - is a delay value for starting a request with a corresponding YT-client.
//          For every client this value is calculated as: InitialPenalty - MinInitialPenalty.
//
//          If any of the clients responses with a success result: requests to other YT-clients are cancelled.
//
//          If any of the clients responses with an error: it's InitialPenalty is
//          increased by BanPenalty value for the next BanDuration time interval.
//          Both BanPenalty and BanDuration values are set in MultiClientCluster config.
namespace NYT::NClient::NHedging::NRpc {

////////////////////////////////////////////////////////////////////////////////

// from config.proto
class THedgingClientConfig;

// @brief Options for hedging client.
//        from hedging_executor.h
struct THedgingClientOptions;

////////////////////////////////////////////////////////////////////////////////

// @brief Method for creating HedgingClient with given options.
NApi::IClientPtr CreateHedgingClient(const THedgingClientOptions& options);

// @brief Method for creating HedgingClient with given options and ability to use penalty updater policy.
//        Currently for experimental usage.
NApi::IClientPtr CreateHedgingClient(const THedgingClientOptions& options, const IPenaltyProviderPtr& penaltyProvider);

// @brief Method for creating HedgingClient with given rpc clients config.
NApi::IClientPtr CreateHedgingClient(const THedgingClientConfig& config);

// @brief Method for creating HedgingClient with given rpc clients config and preinitialized clients.
NApi::IClientPtr CreateHedgingClient(const THedgingClientConfig& config, const IClientsCachePtr& clientsCache);

// @brief Method for creating HedgingClient with given rpc clients config, preinitialized clients and PenaltyProvider.
NApi::IClientPtr CreateHedgingClient(const THedgingClientConfig& config, const IClientsCachePtr& clientsCache, const IPenaltyProviderPtr& penaltyProvider);

// @brief Method for creating HedgingClient options from given config and preinitialized clients.
THedgingClientOptions GetHedgingClientOptions(const THedgingClientConfig& config, const IClientsCachePtr& clientsCache);

// @brief Method for creating HedgingClient options from given config.
THedgingClientOptions GetHedgingClientOptions(const THedgingClientConfig& config);

////////////////////////////////////////////////////////////////////////////////

} // namespace NYT::NClient::NHedging::NRpc