Skip to content

lifecycle.md

Latest commit

 

History

History
37 lines (25 loc) · 1.35 KB

lifecycle.md

File metadata and controls

37 lines (25 loc) · 1.35 KB
Raw

Entity Lifecycle

An entity is stored during eight days after it has stopped reporting. You can configure this value for each entity type in the definition.yml file, in the configuration section.

domain: EXT
type: PIHOLE

configuration:
  entityExpirationTime: EIGHT_DAYS

Other valid values are FOUR_HOURS, DAILY, QUARTERLY, and MANUAL.

  • MANUAL is only allowed for entity types that don't have a synthesis section. These entities are created only via direct action of a user, such as DASHBOARDS or WORKLOADS.
  • FOUR_HOURS is only allowed for entities that have a very short life span, such as CONTAINERS.

Alertable

By default, an entity is alertable which means you want to attach alerts to it. You can choose to change this behaviour by adding the alertable attribute like in the example below.

domain: EXT
type: PIHOLE

configuration:
  alertable: false

If alertable is set to true, the entity's metadata includes the field alertSeverity, which is updated when the telemetry associated to this entity breaks an alerting condition. Please also note that changing the value of alertable to false also causes that entity to stop showing up in the Explorer (but it will still show up in the Global Search).