You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: config.md
+46-2
Original file line number
Diff line number
Diff line change
@@ -75,6 +75,7 @@
75
75
|idleTimeout|The max duration to hold a HTTP keepalive connection between calls|[`time.Duration`](https://pkg.go.dev/time#Duration)|`475ms`
76
76
|maxConnsPerHost|The max number of connections, per unique hostname. Zero means no limit|`int`|`0`
77
77
|maxIdleConns|The max number of idle connections to hold pooled|`int`|`100`
78
+
|maxIdleConnsPerHost|The max number of idle connections, per unique hostname. Zero means net/http uses the default of only 2.|`int`|`100`
78
79
|passthroughHeadersEnabled|Enable passing through the set of allowed HTTP request headers|`boolean`|`false`
79
80
|requestTimeout|The maximum amount of time that a request is allowed to remain open|[`time.Duration`](https://pkg.go.dev/time#Duration)|`30s`
80
81
|tlsHandshakeTimeout|The maximum amount of time to wait for a successful TLS handshake|[`time.Duration`](https://pkg.go.dev/time#Duration)|`10s`
@@ -261,8 +262,8 @@
261
262
|Key|Description|Type|Default Value|
262
263
|---|-----------|----|-------------|
263
264
|address|The IP address on which the metrics HTTP API should listen|`int`|`127.0.0.1`
264
-
|enabled|Enables the metrics API|`boolean`|`false`
265
-
|path|The path from which to serve the Prometheus metrics|`string`|`/metrics`
265
+
|enabled|Deprecated: Please use 'monitoring.enabled' instead|`boolean`|`false`
266
+
|path|Deprecated: Please use 'monitoring.metricsPath' instead|`string`|`/metrics`
266
267
|port|The port on which the metrics HTTP API should listen|`int`|`6000`
267
268
|publicURL|The fully qualified public URL for the metrics API. This is used for building URLs in HTTP responses and in OpenAPI Spec generation|URL `string`|`<nil>`
268
269
|readTimeout|The maximum time to wait when reading from an HTTP connection|[`time.Duration`](https://pkg.go.dev/time#Duration)|`15s`
@@ -296,6 +297,46 @@
296
297
|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>`
297
298
|requiredDNAttributes|A set of required subject DN attributes. Each entry is a regular expression, and the subject certificate must have a matching attribute of the specified type (CN, C, O, OU, ST, L, STREET, POSTALCODE, SERIALNUMBER are valid attributes)|`map[string]string`|`<nil>`
298
299
300
+
## monitoring
301
+
302
+
|Key|Description|Type|Default Value|
303
+
|---|-----------|----|-------------|
304
+
|address|Listener address|`int`|`127.0.0.1`
305
+
|enabled|Enables the monitoring APIs|`boolean`|`false`
306
+
|metricsPath|The path from which to serve the Prometheus metrics|`string`|`/metrics`
307
+
|port|Listener port|`int`|`6000`
308
+
|publicURL|Externally available URL for the HTTP endpoint|`string`|`<nil>`
309
+
|readTimeout|HTTP server read timeout|[`time.Duration`](https://pkg.go.dev/time#Duration)|`15s`
310
+
|shutdownTimeout|HTTP server shutdown timeout|[`time.Duration`](https://pkg.go.dev/time#Duration)|`10s`
311
+
|writeTimeout|HTTP server write timeout|[`time.Duration`](https://pkg.go.dev/time#Duration)|`15s`
312
+
313
+
## monitoring.auth
314
+
315
+
|Key|Description|Type|Default Value|
316
+
|---|-----------|----|-------------|
317
+
|type|The auth plugin to use for server side authentication of requests|`string`|`<nil>`
318
+
319
+
## monitoring.auth.basic
320
+
321
+
|Key|Description|Type|Default Value|
322
+
|---|-----------|----|-------------|
323
+
|passwordfile|The path to a .htpasswd file to use for authenticating requests. Passwords should be hashed with bcrypt.|`string`|`<nil>`
324
+
325
+
## monitoring.tls
326
+
327
+
|Key|Description|Type|Default Value|
328
+
|---|-----------|----|-------------|
329
+
|ca|The TLS certificate authority in PEM format (this option is ignored if caFile is also set)|`string`|`<nil>`
330
+
|caFile|The path to the CA file for TLS on this API|`string`|`<nil>`
331
+
|cert|The TLS certificate in PEM format (this option is ignored if certFile is also set)|`string`|`<nil>`
332
+
|certFile|The path to the certificate file for TLS on this API|`string`|`<nil>`
333
+
|clientAuth|Enables or disables client auth for TLS on this API|`string`|`<nil>`
334
+
|enabled|Enables or disables TLS on this API|`boolean`|`false`
335
+
|insecureSkipHostVerify|When to true in unit test development environments to disable TLS verification. Use with extreme caution|`boolean`|`<nil>`
336
+
|key|The TLS certificate key in PEM format (this option is ignored if keyFile is also set)|`string`|`<nil>`
337
+
|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>`
338
+
|requiredDNAttributes|A set of required subject DN attributes. Each entry is a regular expression, and the subject certificate must have a matching attribute of the specified type (CN, C, O, OU, ST, L, STREET, POSTALCODE, SERIALNUMBER are valid attributes)|`map[string]string`|`<nil>`
339
+
299
340
## persistence
300
341
301
342
|Key|Description|Type|Default Value|
@@ -361,6 +402,7 @@
361
402
|idleTimeout|The max duration to hold a HTTP keepalive connection between calls|[`time.Duration`](https://pkg.go.dev/time#Duration)|`475ms`
362
403
|maxConnsPerHost|The max number of connections, per unique hostname. Zero means no limit|`int`|`0`
363
404
|maxIdleConns|The max number of idle connections to hold pooled|`int`|`100`
405
+
|maxIdleConnsPerHost|The max number of idle connections, per unique hostname. Zero means net/http uses the default of only 2.|`int`|`100`
364
406
|method|Deprecated: Please use 'transactions.handler.simple.gasOracle.method' instead|`string`|`GET`
365
407
|mode|Deprecated: Please use 'transactions.handler.simple.gasOracle.mode' instead|'connector', 'restapi', 'fixed', or 'disabled'|`connector`
366
408
|passthroughHeadersEnabled|Enable passing through the set of allowed HTTP request headers|`boolean`|`false`
@@ -462,6 +504,7 @@
462
504
|idleTimeout|The max duration to hold a HTTP keepalive connection between calls|[`time.Duration`](https://pkg.go.dev/time#Duration)|`475ms`
463
505
|maxConnsPerHost|The max number of connections, per unique hostname. Zero means no limit|`int`|`0`
464
506
|maxIdleConns|The max number of idle connections to hold pooled|`int`|`100`
507
+
|maxIdleConnsPerHost|The max number of idle connections, per unique hostname. Zero means net/http uses the default of only 2.|`int`|`100`
465
508
|method|The HTTP Method to use when invoking the Gas Oracle REST API|`string`|`GET`
466
509
|mode|The gas oracle mode|'connector', 'restapi', 'fixed', or 'disabled'|`connector`
467
510
|passthroughHeadersEnabled|Enable passing through the set of allowed HTTP request headers|`boolean`|`false`
@@ -535,6 +578,7 @@
535
578
|idleTimeout|The max duration to hold a HTTP keepalive connection between calls|[`time.Duration`](https://pkg.go.dev/time#Duration)|`475ms`
536
579
|maxConnsPerHost|The max number of connections, per unique hostname. Zero means no limit|`int`|`0`
537
580
|maxIdleConns|The max number of idle connections to hold pooled|`int`|`100`
581
+
|maxIdleConnsPerHost|The max number of idle connections, per unique hostname. Zero means net/http uses the default of only 2.|`int`|`100`
538
582
|passthroughHeadersEnabled|Enable passing through the set of allowed HTTP request headers|`boolean`|`false`
539
583
|requestTimeout|The maximum amount of time that a request is allowed to remain open|[`time.Duration`](https://pkg.go.dev/time#Duration)|`30s`
540
584
|tlsHandshakeTimeout|The maximum amount of time to wait for a successful TLS handshake|[`time.Duration`](https://pkg.go.dev/time#Duration)|`10s`
0 commit comments