Metrics: phenix-node
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.node.modules.deployments.done | Whether all modules that should be deployed are currently deployed or not (0 or 1). Should be 1, apart from when starting or reconfiguring the system. |
| phenix.node.modules.deployments.module | The current uptime of the current module deployment |
| phenix.node.modules.deployment.uptime | The uptime for a specific module (each module deployment registration/instance has a unique set of tags) |
| phenix.node.aggregated.saml.no.errors | Whether all deployed instances of the SAML module are free from errors (0 or 1). Should be 1, apart from when starting or reconfiguring the system. |
| phenix.node.aggregated.saml.all.recently.loaded | Whether all deployed instances of the SAML module are have succeeded the last load operation (0 or 1). Should be 1, apart from when starting or reconfiguring the system. |
| phenix.node.aggregated.saml.has.only.expired.certificates | Whether at least one deployed instance of the SAML module has an entity with only expired certificates. |
| phenix.node.aggregated.saml.all.same.entities | Whether all deployed instances of the SAML module have the same set of loaded entities (0 or 1). Should be 1, apart from when starting or reconfiguring the system. |
| phenix.node.aggregated.saml.entries.missing.entities | The total number of meta data entries that are missing entities, across all SAML module instances. Should be 0. |
| phenix.node.aggregated.crypto.all.keystores.loaded | Whether all keystores in all loaded Crypto modules are loaded correctly or not (0 or 1). Should be 1, apart from when starting or reconfiguring the system. |
| phenix.node.aggregated.crypto.all.same.keystores | Whether all deployed instances of the Crypto module have the same set of keystores or not (0 or 1). Should be 1, apart from when starting or reconfiguring the system. |
| phenix.node.aggregated.crypto.expired.keystores | For how long the keystore has been expired |
| phenix.node.license.validity | The remaining license validity duration. If this hits zero during runtime (both file license check and online license check, if used) |
| phenix.node.license.graceperiod | The remaining grace period of using an invalid license before automatic server shutdown. See License Validation for details. |
Meter Details
phenix.node.modules.deployments.done
Whether all modules that should be deployed are currently deployed or not (0 or 1). Should be 1, apart from when starting or reconfiguring the system.
- Meter type: Gauge
- Unit: boolean
phenix.node.modules.deployments.module
The current uptime of the current module deployment
Meter type: TimeGauge
Accuracy: milliseconds
Tags
module.registration.parent: The parent module deployment registration id that deployed this instance, if applicable
module.registration.id: Unique id of the deployment of this module instance
module.name: The name of the module, if applicable
module.manager: The module manager that deployed this module, if applicable
phenix.node.modules.deployment.uptime
The uptime for a specific module (each module deployment registration/instance has a unique set of tags)
- Meter type: TimeGauge
- Accuracy: milliseconds
The uptime is updated periodically.
phenix.node.aggregated.saml.no.errors
Whether all deployed instances of the SAML module are free from errors (0 or 1). Should be 1, apart from when starting or reconfiguring the system.
- Meter type: Gauge
- Unit: boolean
If there are no deployed SAML modules (either because SAML hasn't been configured, or because the SAML modules have failed to deploy), it will return 1. To detect the latter, see the meter phenix.node.modules.deployments.done
This meter will validate the following for each deployed instance of the SAML module:
- That they have the same set of entity sources
- That each entity source has at least one entity
- That no entity source has expired
- It will not look at the individual entities' certificates
phenix.node.aggregated.saml.all.recently.loaded
Whether all deployed instances of the SAML module are have succeeded the last load operation (0 or 1). Should be 1, apart from when starting or reconfiguring the system.
- Meter type: Gauge
- Unit: boolean
If phenix.node.aggregated.saml.no.errors is 0, this will also return 0.
In addition to the meter above, this will also that there are no warnings:
- That the last attempt to load from source was successful for all entities
- A load operation might fail, ex. due to network issues - we will verify that the last attempt actually succeeded
phenix.node.aggregated.saml.has.only.expired.certificates
Whether at least one deployed instance of the SAML module has an entity with only expired certificates.
- Meter type: TimeGauge
- Accuracy: milliseconds
This meter will only exist, with it's tag, if all certificates for the entity, for at least one of the deployed SAML module instances, are invalid due to all certificate are expired.
The value is for how long the last expired certificate has been expired.
Tags
metadata.type: The type of metadata (internal or external)
metadata.source: The source of the metadata (url, resource in configuration or internal)
metadata.source.id: Where the metadata is loaded from
- In case the source in an url, this will be the url
- In case the source is a resource, this will be the id of the resource in the configuration
- In case the source is internal, this will be the id of the first entity
entity.id: The entity id of the meta data entry
phenix.node.aggregated.saml.all.same.entities
Whether all deployed instances of the SAML module have the same set of loaded entities (0 or 1). Should be 1, apart from when starting or reconfiguring the system.
- Meter type: Gauge
- Unit: boolean
If phenix.node.aggregated.saml.no.errors is 0, this will also return 0.
In addition to the meter above, this will also that there are no warnings:
- All deployed instances have the same set of entities for each entity source
- This is not a hard error since a temporary network glitch might result in one instance having slightly outdated metadata, seeing a difference between two instances - see the meter phenix.node.aggregated.saml.all.recently.loaded
phenix.node.aggregated.saml.entries.missing.entities
The total number of meta data entries that are missing entities, across all SAML module instances. Should be 0.
- Meter type: Gauge
- Unit: entries
This meter will count the total number of meta data entries in all deployed SAML modules that are missing entities. The expectation is that all meta data entries should have at least one SAML entity in it's meta data.
It's expected that this number is 0 under normal circumstances.
phenix.node.aggregated.crypto.all.keystores.loaded
Whether all keystores in all loaded Crypto modules are loaded correctly or not (0 or 1). Should be 1, apart from when starting or reconfiguring the system.
- Meter type: Gauge
- Unit: boolean
If there are no deployed Crypto modules (for example because the Crypto module(s) have failed to deploy), it will return 1. To detect that, see the meter phenix.node.modules.deployments.done
phenix.node.aggregated.crypto.all.same.keystores
Whether all deployed instances of the Crypto module have the same set of keystores or not (0 or 1). Should be 1, apart from when starting or reconfiguring the system.
- Meter type: Gauge
- Unit: boolean
If there are no deployed Crypto modules (for example because the Crypto module(s) have failed to deploy), it will return 1. To detect that, see the meter phenix.node.modules.deployments.done
phenix.node.aggregated.crypto.expired.keystores
For how long the keystore has been expired
Meter type: TimeGauge
Accuracy: milliseconds
Tags
- keystore.id: Id of the keystore that has expired
phenix.node.license.validity
The remaining license validity duration. If this hits zero during runtime (both file license check and online license check, if used)
- Meter type: TimeGauge
- Accuracy: milliseconds
then the 7 day grace period will start. See License Validation for details.
Tags
- license.validity.source: The source of the license validity date (file / online check)
phenix.node.license.graceperiod
The remaining grace period of using an invalid license before automatic server shutdown. See License Validation for details.
- Meter type: TimeGauge
- Accuracy: milliseconds