mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-25 18:30:00 +00:00
36 lines
2.2 KiB
Markdown
36 lines
2.2 KiB
Markdown
# 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`.
|
|
|
|
<b id="httpsopen-metadata.orgschemaentitydatametrics.json">$id: https://open-metadata.org/schema/entity/data/metrics.json</b>
|
|
|
|
Type: `object`
|
|
|
|
## Properties
|
|
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/id">id</b> `required`
|
|
- Unique identifier that identifies this metrics instance.
|
|
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
|
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/name">name</b> `required`
|
|
- Name that identifies this metrics instance uniquely.
|
|
- Type: `string`
|
|
- Length: between 1 and 64
|
|
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/fullyQualifiedName">fullyQualifiedName</b>
|
|
- A unique name that identifies a metric in the format 'ServiceName.MetricName'.
|
|
- Type: `string`
|
|
- Length: between 1 and 64
|
|
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/description">description</b>
|
|
- Description of metrics instance, what it is, and how to use it.
|
|
- Type: `string`
|
|
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/href">href</b>
|
|
- Link to the resource corresponding to this entity.
|
|
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
|
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/owner">owner</b>
|
|
- Owner of this metrics.
|
|
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
|
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/service">service</b> `required`
|
|
- Link to service where this metrics is hosted in.
|
|
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
|
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/usageSummary">usageSummary</b>
|
|
- Latest usage information for this database.
|
|
- $ref: [../../type/usageDetails.json](#....typeusagedetails.json)
|