Skip to content

Commit f463dac

Browse files
authored
Merge pull request #162 from kaleido-io/pick-up-monitoring
pick up configuraitons for monitoring and liveness path
2 parents f7edc88 + 6e24c62 commit f463dac

31 files changed

+76
-36
lines changed

cmd/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright © 2024 Kaleido, Inc.
1+
// Copyright © 2025 Kaleido, Inc.
22
//
33
// SPDX-License-Identifier: Apache-2.0
44
//

cmd/evmconnect.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright © 2024 Kaleido, Inc.
1+
// Copyright © 2025 Kaleido, Inc.
22
//
33
// SPDX-License-Identifier: Apache-2.0
44
//

cmd/version.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright © 2024 Kaleido, Inc.
1+
// Copyright © 2025 Kaleido, Inc.
22
//
33
// SPDX-License-Identifier: Apache-2.0
44
//

config.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,8 @@
278278
|Key|Description|Type|Default Value|
279279
|---|-----------|----|-------------|
280280
|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`
283283
|port|The port on which the metrics HTTP API should listen|`int`|`6000`
284284
|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>`
285285
|readTimeout|The maximum time to wait when reading from an HTTP connection|[`time.Duration`](https://pkg.go.dev/time#Duration)|`15s`
@@ -313,6 +313,46 @@
313313
|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>`
314314
|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>`
315315

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+
316356
## persistence
317357

318358
|Key|Description|Type|Default Value|

evmconnect/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright © 2024 Kaleido, Inc.
1+
// Copyright © 2025 Kaleido, Inc.
22
//
33
// SPDX-License-Identifier: Apache-2.0
44
//

go.mod

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ require (
88
github.com/hashicorp/golang-lru v1.0.2
99
github.com/hyperledger/firefly-common v1.4.11
1010
github.com/hyperledger/firefly-signer v1.1.17
11-
github.com/hyperledger/firefly-transaction-manager v1.3.18
11+
github.com/hyperledger/firefly-transaction-manager v1.3.19
1212
github.com/sirupsen/logrus v1.9.3
1313
github.com/spf13/cobra v1.8.0
1414
github.com/stretchr/testify v1.8.4
@@ -73,7 +73,7 @@ require (
7373
github.com/prometheus/client_model v0.5.0 // indirect
7474
github.com/prometheus/common v0.45.0 // indirect
7575
github.com/prometheus/procfs v0.12.0 // indirect
76-
github.com/rs/cors v1.11.0 // indirect
76+
github.com/rs/cors v1.11.1 // indirect
7777
github.com/sagikazarmark/locafero v0.4.0 // indirect
7878
github.com/sagikazarmark/slog-shim v0.1.0 // indirect
7979
github.com/santhosh-tekuri/jsonschema/v5 v5.3.1 // indirect

go.sum

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ github.com/hyperledger/firefly-common v1.4.11 h1:WKv2hQuNpS7yP51THxzpzrqU3jkln23
104104
github.com/hyperledger/firefly-common v1.4.11/go.mod h1:E7w/RxNtVnX52WXLQW9f2xVAgZnW70voZeE9sZrx/q0=
105105
github.com/hyperledger/firefly-signer v1.1.17 h1:JV38nNeCS/K31kPDk5mwnoqw6SoulcYF+12JW8a3/Mw=
106106
github.com/hyperledger/firefly-signer v1.1.17/go.mod h1:HDaDdht94JypRTunRGrcPL5Pvxfh4yigjatTrie5JUI=
107-
github.com/hyperledger/firefly-transaction-manager v1.3.18 h1:had6Mp9KZ1WwX2GuhJToSzwvjKaRy45c2K/DeqLLQ7k=
108-
github.com/hyperledger/firefly-transaction-manager v1.3.18/go.mod h1:TLMmYp2QhzbC1jQEhvjYYlx3kByR1m9ALQ1CxUVTkiM=
107+
github.com/hyperledger/firefly-transaction-manager v1.3.19 h1:AzRYulDpk+AzeVPFGqw8nLRMPNJcX32FP7VBdsTM+L0=
108+
github.com/hyperledger/firefly-transaction-manager v1.3.19/go.mod h1:qZgj628oCJ+DP3CwS2y9pRN8zwJAJ8/U3ait/+fmQlg=
109109
github.com/imdario/mergo v0.3.11/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=
110110
github.com/imdario/mergo v0.3.16 h1:wwQJbIsHYGMUyLSPrEq1CT16AhnhNJQ51+4fdHUnCl4=
111111
github.com/imdario/mergo v0.3.16/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+hD27ysY=
@@ -199,8 +199,8 @@ github.com/prometheus/procfs v0.12.0 h1:jluTpSng7V9hY0O2R9DzzJHYb2xULk9VTR1V1R/k
199199
github.com/prometheus/procfs v0.12.0/go.mod h1:pcuDEFsWDnvcgNzo4EEweacyhjeA9Zk3cnaOZAZEfOo=
200200
github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
201201
github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
202-
github.com/rs/cors v1.11.0 h1:0B9GE/r9Bc2UxRMMtymBkHTenPkHDv0CW4Y98GBY+po=
203-
github.com/rs/cors v1.11.0/go.mod h1:XyqrcTp5zjWr1wsJ8PIRZssZ8b/WMcMf71DJnit4EMU=
202+
github.com/rs/cors v1.11.1 h1:eU3gRzXLRK57F5rKMGMZURNdIG4EoAmX8k94r9wXWHA=
203+
github.com/rs/cors v1.11.1/go.mod h1:XyqrcTp5zjWr1wsJ8PIRZssZ8b/WMcMf71DJnit4EMU=
204204
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
205205
github.com/sagikazarmark/locafero v0.4.0 h1:HApY1R9zGo4DBgr7dqsTH/JJxLTTsOt7u6keLGt6kNQ=
206206
github.com/sagikazarmark/locafero v0.4.0/go.mod h1:Pe1W6UlPYUk/+wc/6KFhbORCfqzgYEpgQ3O5fPuL3H4=

internal/ethereum/blocklistener.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright © 2024 Kaleido, Inc.
1+
// Copyright © 2025 Kaleido, Inc.
22
//
33
// SPDX-License-Identifier: Apache-2.0
44
//

internal/ethereum/blocklistener_blockquery.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright © 2024 Kaleido, Inc.
1+
// Copyright © 2025 Kaleido, Inc.
22
//
33
// SPDX-License-Identifier: Apache-2.0
44
//

internal/ethereum/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright © 2024 Kaleido, Inc.
1+
// Copyright © 2025 Kaleido, Inc.
22
//
33
// SPDX-License-Identifier: Apache-2.0
44
//

0 commit comments

Comments
 (0)