Skip to content

Commit 57b5755

Browse files
Updated documentation for Metrics feature
1 parent 2afddd7 commit 57b5755

File tree

4 files changed

+40
-2
lines changed

4 files changed

+40
-2
lines changed

Readme.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,13 +293,41 @@ Origin | What created this object (`System`, `App`, `Terraform`, `User`)
293293
ID | Object ID
294294
Name | Object Name
295295
Stages | Number of stages in worksheet
296-
Stages | Number of parameters in worksheet
296+
Parameters | Number of parameters in worksheet
297297
Uses | What this object uses as data inputs and data links
298298
Created | Who and when created this object
299299
Updated | Who and when updates this object last
300300

301301
![Worksheets List](/docs/screenshots/list/worksheet/Worksheets.png?raw=true)
302302

303+
## Metrics List
304+
305+
Metrics page shows all metrics
306+
307+
Column | Description
308+
-- | --
309+
View | Links to the [Dataset Detail](#dataset-detail) page
310+
Origin | What created dataset (`System`, `App`, `Terraform`, `User`)
311+
Dataset ID | Dataset ID of dataset defining this metric
312+
Dataset | Dataset Name of dataset defining this metric
313+
View | Links to the [Metric Detail](#metric-detail) page
314+
Data | Open object page in Observe in data mode
315+
Name | Name of metric
316+
Desc. | Description of metric, if available
317+
Type | Type of metric
318+
Unit | Unit of metric
319+
Rollup | Type of metric rollup
320+
Agg. | Type of metric aggregation
321+
Bucket Size | Size of the default metric aggregation bucket
322+
Cardinality | Detected cardinality
323+
Points | Detected points
324+
Link Labels | Number of detected link labels
325+
Tags | Number of detected tags
326+
State | State of metric
327+
Last Data | When last data point was received
328+
329+
![Metrics List](/docs/screenshots/list/metric/Metrics.png?raw=true)
330+
303331
## RBAC Settings
304332

305333
Role based access control settings for users, groups and statements.
@@ -362,6 +390,10 @@ List of all worksheets using this dataset.
362390

363391
![Dataset Related Worksheets](/docs/screenshots/details/dataset/DatasetRelatedWorksheets.png?raw=true)
364392

393+
List of all Metrics defined by this dataset.
394+
395+
![Dataset Metrics](/docs/screenshots/details/dataset/DatasetMetrics.png?raw=true)
396+
365397
## Dashboard Detail
366398

367399
Summary information about the dashboard.
@@ -426,7 +458,13 @@ Visual diagram showing relationship between datasets related to this monitor.
426458

427459
Summary information about the worksheet.
428460

429-
![Monitor Details](/docs/screenshots/details/worksheet/WorksheetDetails.png?raw=true)
461+
![Worksheet Details](/docs/screenshots/details/worksheet/WorksheetDetails.png?raw=true)
462+
463+
## Metric Detail
464+
465+
Summary information about the metric, and what components (dataset, monitor, dashboard, worksheet) are using it.
466+
467+
![Metric Details](/docs/screenshots/details/metric/MetricDetails.png?raw=true)
430468

431469
## Datastream and Tokens
432470

229 KB
Loading
194 KB
Loading
888 KB
Loading

0 commit comments

Comments
 (0)