|
278 | 278 | |Key|Description|Type|Default Value| |
279 | 279 | |---|-----------|----|-------------| |
280 | 280 | |address|The IP address on which the metrics HTTP API should listen|`int`|`127.0.0.1` |
281 | | -|enabled|Enables the metrics API|`boolean`|`false` |
282 | | -|path|The path from which to serve the Prometheus metrics|`string`|`/metrics` |
| 281 | +|enabled|Deprecated: Please use 'monitoring.enabled' instead|`boolean`|`false` |
| 282 | +|path|Deprecated: Please use 'monitoring.metricsPath' instead|`string`|`/metrics` |
283 | 283 | |port|The port on which the metrics HTTP API should listen|`int`|`6000` |
284 | 284 | |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>` |
285 | 285 | |readTimeout|The maximum time to wait when reading from an HTTP connection|[`time.Duration`](https://pkg.go.dev/time#Duration)|`15s` |
|
313 | 313 | |keyFile|The path to the private key file for TLS on this API|`string`|`<nil>` |
314 | 314 | |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>` |
315 | 315 |
|
| 316 | +## monitoring |
| 317 | + |
| 318 | +|Key|Description|Type|Default Value| |
| 319 | +|---|-----------|----|-------------| |
| 320 | +|address|Listener address|`int`|`127.0.0.1` |
| 321 | +|enabled|Enables the monitoring APIs|`boolean`|`false` |
| 322 | +|metricsPath|The path from which to serve the Prometheus metrics|`string`|`/metrics` |
| 323 | +|port|Listener port|`int`|`6000` |
| 324 | +|publicURL|Externally available URL for the HTTP endpoint|`string`|`<nil>` |
| 325 | +|readTimeout|HTTP server read timeout|[`time.Duration`](https://pkg.go.dev/time#Duration)|`15s` |
| 326 | +|shutdownTimeout|HTTP server shutdown timeout|[`time.Duration`](https://pkg.go.dev/time#Duration)|`10s` |
| 327 | +|writeTimeout|HTTP server write timeout|[`time.Duration`](https://pkg.go.dev/time#Duration)|`15s` |
| 328 | + |
| 329 | +## monitoring.auth |
| 330 | + |
| 331 | +|Key|Description|Type|Default Value| |
| 332 | +|---|-----------|----|-------------| |
| 333 | +|type|The auth plugin to use for server side authentication of requests|`string`|`<nil>` |
| 334 | + |
| 335 | +## monitoring.auth.basic |
| 336 | + |
| 337 | +|Key|Description|Type|Default Value| |
| 338 | +|---|-----------|----|-------------| |
| 339 | +|passwordfile|The path to a .htpasswd file to use for authenticating requests. Passwords should be hashed with bcrypt.|`string`|`<nil>` |
| 340 | + |
| 341 | +## monitoring.tls |
| 342 | + |
| 343 | +|Key|Description|Type|Default Value| |
| 344 | +|---|-----------|----|-------------| |
| 345 | +|ca|The TLS certificate authority in PEM format (this option is ignored if caFile is also set)|`string`|`<nil>` |
| 346 | +|caFile|The path to the CA file for TLS on this API|`string`|`<nil>` |
| 347 | +|cert|The TLS certificate in PEM format (this option is ignored if certFile is also set)|`string`|`<nil>` |
| 348 | +|certFile|The path to the certificate file for TLS on this API|`string`|`<nil>` |
| 349 | +|clientAuth|Enables or disables client auth for TLS on this API|`string`|`<nil>` |
| 350 | +|enabled|Enables or disables TLS on this API|`boolean`|`false` |
| 351 | +|insecureSkipHostVerify|When to true in unit test development environments to disable TLS verification. Use with extreme caution|`boolean`|`<nil>` |
| 352 | +|key|The TLS certificate key in PEM format (this option is ignored if keyFile is also set)|`string`|`<nil>` |
| 353 | +|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>` |
| 354 | +|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>` |
| 355 | + |
316 | 356 | ## persistence |
317 | 357 |
|
318 | 358 | |Key|Description|Type|Default Value| |
|
0 commit comments