@@ -23,76 +23,156 @@ import (
2323 "crypto"
2424 "fmt"
2525 "github.com/nuts-foundation/nuts-node/core"
26+ "github.com/prometheus/client_golang/prometheus"
2627 "regexp"
28+ "time"
2729)
2830
2931// wrapper wraps a Storage backend and checks the validity of the kid on each of the relevant functions before
3032// forwarding the call to the wrapped backend.
31- type wrapper struct {
33+ type validationWrapper struct {
3234 kidPattern * regexp.Regexp
3335 wrappedBackend Storage
3436}
3537
36- func (w wrapper ) Name () string {
38+ func (w validationWrapper ) Name () string {
3739 return w .wrappedBackend .Name ()
3840}
3941
40- func (w wrapper ) CheckHealth () map [string ]core.Health {
42+ func (w validationWrapper ) CheckHealth () map [string ]core.Health {
4143 return w .wrappedBackend .CheckHealth ()
4244}
4345
4446// NewValidatedKIDBackendWrapper creates a new wrapper for storage backends.
4547// Every call to the backend which takes a kid as param, gets the kid validated against the provided kidPattern.
4648func NewValidatedKIDBackendWrapper (backend Storage , kidPattern * regexp.Regexp ) Storage {
47- return wrapper {
49+ return validationWrapper {
4850 kidPattern : kidPattern ,
4951 wrappedBackend : backend ,
5052 }
5153}
5254
53- func (w wrapper ) validateKID (kid string ) error {
55+ func (w validationWrapper ) validateKID (kid string ) error {
5456 if ! w .kidPattern .MatchString (kid ) {
5557 return fmt .Errorf ("invalid key ID: %s" , kid )
5658 }
5759 return nil
5860}
5961
60- func (w wrapper ) GetPrivateKey (ctx context.Context , keyName string , version string ) (crypto.Signer , error ) {
62+ func (w validationWrapper ) GetPrivateKey (ctx context.Context , keyName string , version string ) (crypto.Signer , error ) {
6163 if err := w .validateKID (keyName ); err != nil {
6264 return nil , err
6365 }
6466 return w .wrappedBackend .GetPrivateKey (ctx , keyName , version )
6567}
6668
67- func (w wrapper ) PrivateKeyExists (ctx context.Context , keyName string , version string ) (bool , error ) {
69+ func (w validationWrapper ) PrivateKeyExists (ctx context.Context , keyName string , version string ) (bool , error ) {
6870 if err := w .validateKID (keyName ); err != nil {
6971 return false , err
7072 }
7173 return w .wrappedBackend .PrivateKeyExists (ctx , keyName , version )
7274}
7375
74- func (w wrapper ) SavePrivateKey (ctx context.Context , kid string , key crypto.PrivateKey ) error {
76+ func (w validationWrapper ) SavePrivateKey (ctx context.Context , kid string , key crypto.PrivateKey ) error {
7577 if err := w .validateKID (kid ); err != nil {
7678 return err
7779 }
7880 return w .wrappedBackend .SavePrivateKey (ctx , kid , key )
7981}
8082
81- func (w wrapper ) DeletePrivateKey (ctx context.Context , keyName string ) error {
83+ func (w validationWrapper ) DeletePrivateKey (ctx context.Context , keyName string ) error {
8284 if err := w .validateKID (keyName ); err != nil {
8385 return err
8486 }
8587 return w .wrappedBackend .DeletePrivateKey (ctx , keyName )
8688}
8789
88- func (w wrapper ) ListPrivateKeys (ctx context.Context ) []KeyNameVersion {
90+ func (w validationWrapper ) ListPrivateKeys (ctx context.Context ) []KeyNameVersion {
8991 return w .wrappedBackend .ListPrivateKeys (ctx )
9092}
9193
92- func (w wrapper ) NewPrivateKey (ctx context.Context , keyName string ) (crypto.PublicKey , string , error ) {
94+ func (w validationWrapper ) NewPrivateKey (ctx context.Context , keyName string ) (crypto.PublicKey , string , error ) {
9395 publicKey , version , err := w .wrappedBackend .NewPrivateKey (ctx , keyName )
9496 if err != nil {
9597 return nil , "" , err
9698 }
9799 return publicKey , version , err
98100}
101+
102+ func NewPrometheusWrapper (backend Storage ) * PrometheusWrapper {
103+ return & PrometheusWrapper {
104+ wrappedBackend : backend ,
105+ opDurationMetric : prometheus .NewHistogramVec (prometheus.HistogramOpts {
106+ Name : "crypto_storage_op_duration_seconds" ,
107+ Help : "Duration of crypto storage operations in seconds (experimental, may be removed without notice)" ,
108+ Buckets : []float64 {0.01 , 0.05 , 0.1 , .5 , 1 , 2 },
109+ }, []string {"op" }),
110+ }
111+ }
112+
113+ var _ Storage = (* PrometheusWrapper )(nil )
114+
115+ type PrometheusWrapper struct {
116+ wrappedBackend Storage
117+ opDurationMetric * prometheus.HistogramVec
118+ }
119+
120+ func (p PrometheusWrapper ) Collectors () []prometheus.Collector {
121+ return []prometheus.Collector {p .opDurationMetric }
122+ }
123+
124+ func (p PrometheusWrapper ) Name () string {
125+ return p .wrappedBackend .Name ()
126+ }
127+
128+ func (p PrometheusWrapper ) CheckHealth () map [string ]core.Health {
129+ return p .wrappedBackend .CheckHealth ()
130+ }
131+
132+ func (p PrometheusWrapper ) NewPrivateKey (ctx context.Context , keyName string ) (crypto.PublicKey , string , error ) {
133+ start := time .Now ()
134+ defer func () {
135+ p .opDurationMetric .WithLabelValues ("new_private_key" ).Observe (time .Since (start ).Seconds ())
136+ }()
137+ return p .wrappedBackend .NewPrivateKey (ctx , keyName )
138+ }
139+
140+ func (p PrometheusWrapper ) GetPrivateKey (ctx context.Context , keyName string , version string ) (crypto.Signer , error ) {
141+ start := time .Now ()
142+ defer func () {
143+ p .opDurationMetric .WithLabelValues ("get_private_key" ).Observe (time .Since (start ).Seconds ())
144+ }()
145+ return p .wrappedBackend .GetPrivateKey (ctx , keyName , version )
146+ }
147+
148+ func (p PrometheusWrapper ) PrivateKeyExists (ctx context.Context , keyName string , version string ) (bool , error ) {
149+ start := time .Now ()
150+ defer func () {
151+ p .opDurationMetric .WithLabelValues ("private_key_exists" ).Observe (time .Since (start ).Seconds ())
152+ }()
153+ return p .wrappedBackend .PrivateKeyExists (ctx , keyName , version )
154+ }
155+
156+ func (p PrometheusWrapper ) SavePrivateKey (ctx context.Context , keyname string , key crypto.PrivateKey ) error {
157+ start := time .Now ()
158+ defer func () {
159+ p .opDurationMetric .WithLabelValues ("save_private_key" ).Observe (time .Since (start ).Seconds ())
160+ }()
161+ return p .wrappedBackend .SavePrivateKey (ctx , keyname , key )
162+ }
163+
164+ func (p PrometheusWrapper ) ListPrivateKeys (ctx context.Context ) []KeyNameVersion {
165+ start := time .Now ()
166+ defer func () {
167+ p .opDurationMetric .WithLabelValues ("list_private_keys" ).Observe (time .Since (start ).Seconds ())
168+ }()
169+ return p .wrappedBackend .ListPrivateKeys (ctx )
170+ }
171+
172+ func (p PrometheusWrapper ) DeletePrivateKey (ctx context.Context , keyName string ) error {
173+ start := time .Now ()
174+ defer func () {
175+ p .opDurationMetric .WithLabelValues ("delete_private_key" ).Observe (time .Since (start ).Seconds ())
176+ }()
177+ return p .wrappedBackend .DeletePrivateKey (ctx , keyName )
178+ }
0 commit comments