Metrics: phenix-crypto
Metrics Shared Tags
Shared tags are being set by default, for more information, see the article Metrics Configuration for the default configuration and other details.
Common Module Tags
This is a PAS module. Since modules might be deployed multiple times, ex. due to being referenced in multiple places, or being deployed in multiple instances, or being redeployed due to reconfigurations, each instance of the module might have some common tags set in order to differentiate between the meter instances.
| Tag name | Description |
|---|---|
| module.deployment.registration.id | The deployment registration id |
Meters Overview
| Meter | Description |
|---|---|
| phenix.crypto.keystores.temporary.access.reads | The number of reads for a temporary keystore |
| phenix.crypto.keystores.entry.lookups | Lookups for a specific keystore |
| phenix.crypto.keystores.software.lookups | Timings for software keystore lookups |
| phenix.crypto.keystores.software.lookups.failed | The number of failed software lookups |
| phenix.crypto.keystores.software.lookups.successful | The number of successful software lookups |
| phenix.crypto.keystores.expiration.time | The amount of time left until the certificate in the keystore expires |
| phenix.crypto.keystores.hsm.lookups | Timings for HSM (Hardware Security Module) keystore lookups |
| phenix.crypto.keystores.hsm.lookups.failed | The number of failed HSM (Hardware Security Module) lookups |
| phenix.crypto.keystores.hsm.lookups.successful | The number of successful HSM (Hardware Security Module) lookups |
Meter Details
phenix.crypto.keystores.temporary.access.reads
The number of reads for a temporary keystore
- Meter type: Counter
- Unit: reads
This is used by for example CreateShortTermKeyStoreValve
Tags
keystore.alias: The alias of the keystore
This is not a keystore id in the configuration, it's a temporary alias with a short lifetime. The keystore has been created temporarily in a previous valve or similar.
phenix.crypto.keystores.entry.lookups
Lookups for a specific keystore
- Meter type: Timer
This is timing all keystore lookups.
Tags
keystore.id: The id of the keystore
keystore.name: The name of the keystore
phenix.crypto.keystores.software.lookups
Timings for software keystore lookups
- Meter type: Timer
This is timing all software keystore lookups
This timer will also record requests for non-existent keystores.
phenix.crypto.keystores.software.lookups.failed
The number of failed software lookups
- Meter type: Counter
- Unit: lookups
This is counting all failed software keystore lookups.
phenix.crypto.keystores.software.lookups.successful
The number of successful software lookups
- Meter type: Counter
- Unit: lookups
This is counting all successful software keystore lookups.
phenix.crypto.keystores.expiration.time
The amount of time left until the certificate in the keystore expires
- Meter type: TimeGauge
- Accuracy: milliseconds
This is updated on a periodic interval by comparing the certificate expiration date with the system clock.
Tags
keystore.id: The id of the keystore
keystore.name: The name of the keystore
phenix.crypto.keystores.hsm.lookups
Timings for HSM (Hardware Security Module) keystore lookups
- Meter type: Timer
This is timing all keystore lookups if HSM (Hardware Security Module) has been configured. It does not matter if the requested keystore is a HSM certificate or not. See the article Hardware Security Modules (HSM) Keystores for more details about HSM.
This timer will also record requests for non-existent keystores.
phenix.crypto.keystores.hsm.lookups.failed
The number of failed HSM (Hardware Security Module) lookups
- Meter type: Counter
- Unit: lookups
This is counting all failed keystore lookups, if the requested keystore is stored in HSM (Hardware Security Module). See the article Hardware Security Modules (HSM) Keystores for more details about HSM.
phenix.crypto.keystores.hsm.lookups.successful
The number of successful HSM (Hardware Security Module) lookups
- Meter type: Counter
- Unit: lookups
This is counting all successful keystore lookups, if the requested keystore is stored in HSM (Hardware Security Module). See the article Hardware Security Modules (HSM) Keystores for more details about HSM.