example-entity-definition.yml

#  [mandatory] The domain of an entity, default to EXT unless otherwise indicated by the maintainers.
domain: DOMAIN
# [mandatory] The type of an entity. Must be unique within its domain, but may be duplicated between domains.
type: TYPE

# Entity definitions without this section are synthesized based on rules defined elsewhere.
synthesis:
  # [mandatory] The name of a telemetry attribute that will be used as the name of the entity (i.e. k8s.cluster.name).
  name: attributeNameA
  # [mandatory] The name of a telemetry attribute that will be used as the id of the entity, so it needs to be unique,
  # it can be the same field used for the name or not.
  identifier: attributeNameA

  # Set to true if the identifier is expected to be longer than our maximum allowed characters (see README guidelines), defaults to false
  encodeIdentifierInGUID: false

  # Condition that must be met for this entity to be synthesized.
  # Can be added if the attribute used for the identifier is too generic to differentiate this entity from others
  # Please refer to the documentation to see the different types of conditions supported.
  conditions:
    # The attribute’s value must match the provided value
    - attribute: attributeName
      value: value

  # Tags associated with the entity that can be extracted from the telemetry attributes.
  tags:
    - attributeNameB
    - attributeNameC

# Template that can be used to generate a dashboard for the entity.
dashboardTemplates:
 - ./dashboard.json

# Reference to the golden and/or summary metrics associated with the entity (if any).
compositeMetrics:
  goldenMetrics:
    - ./domain-type-golden_metrics.yml
  summaryMetrics:
    - ./domain-type-summary_metrics.yml

# The golden tags associated with the entity. They must be existing NewRelic tags which includes:
#   - Tags extracted from telemetry attributes and defined here in the `tags` section.
#   - Tags added to the entity through other means.
goldenTags:
  - tagNameA
  - tagNameB

# Additional configurations for a more granular control of the entity's behavior
configuration:
  # The amount of time without receiving telemetry before an entity is deleted. Defaults to EIGHT_DAYS
  entityExpirationTime: EIGHT_DAYS