···112 http://tools.ietf.org/html/rfc4366#section-3.1
113 '';
114 };
115- remote_timeout = mkDefOpt types.str "30s" ''
116- Timeout for requests to the remote write endpoint.
117- '';
118- relabel_configs = mkOpt (types.listOf promTypes.relabel_config) ''
119- List of remote write relabel configurations.
120- List of relabel configurations.
121- '';
122 name = mkOpt types.string ''
123- Name of the remote write config, which if specified must be unique among remote write configs.
124 The name will be used in metrics and logging in place of a generated value to help users distinguish between
125- remote write configs.
00000000000126 '';
127 basic_auth = mkOpt (types.submodule {
128 options = {
···136 password_file = mkOpt types.str "HTTP password file";
137 };
138 }) ''
139- Sets the `Authorization` header on every remote write request with the
140 configured username and password.
141 password and password_file are mutually exclusive.
142 '';
143 bearer_token = mkOpt types.str ''
144- Sets the `Authorization` header on every remote write request with
145 the configured bearer token. It is mutually exclusive with `bearer_token_file`.
146 '';
147 bearer_token_file = mkOpt types.str ''
148- Sets the `Authorization` header on every remote write request with the bearer token
149 read from the configured file. It is mutually exclusive with `bearer_token`.
150 '';
151 tls_config = mkOpt promTypes.tls_config ''
152- Configures the remote write request's TLS settings.
153 '';
154 proxy_url = mkOpt types.str "Optional Proxy URL.";
155- metadata_config = {
156- send = mkDefOpt types.bool "true" ''
157- Whether metric metadata is sent to remote storage or not.
158- '';
159- send_interval = mkDefOpt types.str "1m" ''
160- How frequently metric metadata is sent to remote storage.
161- '';
162- };
163 };
164 };
165···172 http://tools.ietf.org/html/rfc4366#section-3.1
173 '';
174 };
175- remote_timeout = mkDefOpt types.str "30s" ''
176 Timeout for requests to the remote write endpoint.
177 '';
178- relabel_configs = mkOpt (types.listOf promTypes.relabel_config) ''
179- List of remote write relabel configurations.
180- List of relabel configurations.
181- '';
182 name = mkOpt types.string ''
183 Name of the remote write config, which if specified must be unique among remote write configs.
184 The name will be used in metrics and logging in place of a generated value to help users distinguish between
···212 Configures the remote write request's TLS settings.
213 '';
214 proxy_url = mkOpt types.str "Optional Proxy URL.";
215- metadata_config = {
216- send = mkDefOpt types.bool "true" ''
217- Whether metric metadata is sent to remote storage or not.
218- '';
219- send_interval = mkDefOpt types.str "1m" ''
220- How frequently metric metadata is sent to remote storage.
221- '';
222- };
000000000000000000000000000000000000223 };
224 };
225
···112 http://tools.ietf.org/html/rfc4366#section-3.1
113 '';
114 };
0000000115 name = mkOpt types.string ''
116+ Name of the remote read config, which if specified must be unique among remote read configs.
117 The name will be used in metrics and logging in place of a generated value to help users distinguish between
118+ remote read configs.
119+ '';
120+ required_matchers = mkOpt (types.attrsOf types.str) ''
121+ An optional list of equality matchers which have to be
122+ present in a selector to query the remote read endpoint.
123+ '';
124+ remote_timeout = mkOpt types.str ''
125+ Timeout for requests to the remote read endpoint.
126+ '';
127+ read_recent = mkOpt types.bool ''
128+ Whether reads should be made for queries for time ranges that
129+ the local storage should have complete data for.
130 '';
131 basic_auth = mkOpt (types.submodule {
132 options = {
···140 password_file = mkOpt types.str "HTTP password file";
141 };
142 }) ''
143+ Sets the `Authorization` header on every remote read request with the
144 configured username and password.
145 password and password_file are mutually exclusive.
146 '';
147 bearer_token = mkOpt types.str ''
148+ Sets the `Authorization` header on every remote read request with
149 the configured bearer token. It is mutually exclusive with `bearer_token_file`.
150 '';
151 bearer_token_file = mkOpt types.str ''
152+ Sets the `Authorization` header on every remote read request with the bearer token
153 read from the configured file. It is mutually exclusive with `bearer_token`.
154 '';
155 tls_config = mkOpt promTypes.tls_config ''
156+ Configures the remote read request's TLS settings.
157 '';
158 proxy_url = mkOpt types.str "Optional Proxy URL.";
00000000159 };
160 };
161···168 http://tools.ietf.org/html/rfc4366#section-3.1
169 '';
170 };
171+ remote_timeout = mkOpt types.str ''
172 Timeout for requests to the remote write endpoint.
173 '';
174+ write_relabel_configs = mkOpt (types.listOf promTypes.relabel_config) ''
175+ List of remote write relabel configurations.
176+ '';
0177 name = mkOpt types.string ''
178 Name of the remote write config, which if specified must be unique among remote write configs.
179 The name will be used in metrics and logging in place of a generated value to help users distinguish between
···207 Configures the remote write request's TLS settings.
208 '';
209 proxy_url = mkOpt types.str "Optional Proxy URL.";
210+ queue_config = mkOpt (types.submodule {
211+ options = {
212+ capacity = mkOpt types.int ''
213+ Number of samples to buffer per shard before we block reading of more
214+ samples from the WAL. It is recommended to have enough capacity in each
215+ shard to buffer several requests to keep throughput up while processing
216+ occasional slow remote requests.
217+ '';
218+ max_shards = mkOpt types.int ''
219+ Maximum number of shards, i.e. amount of concurrency.
220+ '';
221+ min_shards = mkOpt types.int ''
222+ Minimum number of shards, i.e. amount of concurrency.
223+ '';
224+ max_samples_per_send = mkOpt types.int ''
225+ Maximum number of samples per send.
226+ '';
227+ batch_send_deadline = mkOpt types.str ''
228+ Maximum time a sample will wait in buffer.
229+ '';
230+ min_backoff = mkOpt types.str ''
231+ Initial retry delay. Gets doubled for every retry.
232+ '';
233+ max_backoff = mkOpt types.str ''
234+ Maximum retry delay.
235+ '';
236+ };
237+ }) ''
238+ Configures the queue used to write to remote storage.
239+ '';
240+ metadata_config = mkOpt (types.submodule {
241+ options = {
242+ send = mkOpt types.bool ''
243+ Whether metric metadata is sent to remote storage or not.
244+ '';
245+ send_interval = mkOpt types.str ''
246+ How frequently metric metadata is sent to remote storage.
247+ '';
248+ };
249+ }) ''
250+ Configures the sending of series metadata to remote storage.
251+ Metadata configuration is subject to change at any point
252+ or be removed in future releases.
253+ '';
254 };
255 };
256