mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-22 08:50:27 +00:00
13be70e416
* updated documentation * addressing pyline findings * addressing pyline findings * doc update Co-authored-by: parthp2107 <parth@getcollate.io>
37 lines
1.5 KiB
Markdown
37 lines
1.5 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`.
|
|
|
|
**$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](../types/basic.md#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
|
|
- **description**
|
|
- Description of metrics instance, what it is, and how to use it.
|
|
- Type: `string`
|
|
- **href**
|
|
- Link to the resource corresponding to this entity.
|
|
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
|
|
- **owner**
|
|
- Owner of this metrics.
|
|
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
|
- **service** `required`
|
|
- Link to service where this metrics is hosted in.
|
|
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
|
- **usageSummary**
|
|
- Latest usage information for this database.
|
|
- $ref: [../../type/usageDetails.json](../types/usagedetails.md)
|
|
|
|
_This document was updated on: Thursday, September 16, 2021_ |