OpenMetadata/docs/openmetadata-apis/schemas/entities/metrics.md

Metrics

This schema defines the Metrics entity. Metrics are measurements computed from data such as Monthly Active Users. Some of the metrics that measures used to determine performance against an objective are called KPIs or Key Performance Indicators, such as User Retention.

**$id: **https://open-metadata.org/schema/entity/data/metrics.json

Type: object

Properties

• id required
  • Unique identifier that identifies this metrics instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Name that identifies this metrics instance uniquely.
  • Type: string
  • Length: between 1 and 64
• fullyQualifiedName
  • A unique name that identifies a metric in the format 'ServiceName.MetricName'.
  • Type: string
  • Length: between 1 and 64
• displayName
  • Display Name that identifies this metric.
  • Type: string
• description
  • Description of metrics instance, what it is, and how to use it.
  • Type: string
• version
  • Metadata version of the entity.
  • $ref: ../../type/basic.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity.
  • $ref: ../../type/basic.json#/definitions/dateTime
• updatedBy
  • User who made the update.
  • Type: string
• href
  • Link to the resource corresponding to this entity.
  • $ref: ../../type/basic.json#/definitions/href
• owner
  • Owner of this metrics.
  • $ref: ../../type/entityReference.json
• service required
  • Link to service where this metrics is hosted in.
  • $ref: ../../type/entityReference.json
• usageSummary
  • Latest usage information for this database.
  • $ref: ../../type/usageDetails.json

This document was updated on: Monday, October 18, 2021