@dx-do/cli 6.0.4 → 6.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# NASS Metric Types
|
|
2
|
+
|
|
3
|
+
Metrics in the DXO2 datastore carry a **type** that encodes both their underlying data kind (integer, long, double, string) and their semantic class (duration, rate, counter, etc.). You can specify the type two ways:
|
|
4
|
+
|
|
5
|
+
## `enumMetricType` — recommended
|
|
6
|
+
|
|
7
|
+
A comma-separated list of named type tokens. The platform ORs the corresponding bit values together to produce the numeric type.
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
enumMetricType=MONITOR_INT_DURATION,TYPE_INFO_FRONTEND
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
### Monitor types (pick one)
|
|
14
|
+
|
|
15
|
+
| Token | Meaning |
|
|
16
|
+
|---|---|
|
|
17
|
+
| `MONITOR_INT_DURATION` | Integer duration (ms) |
|
|
18
|
+
| `MONITOR_LONG_DURATION` | Long duration (ms) |
|
|
19
|
+
| `MONITOR_INT_RATE` | Integer rate (per interval) |
|
|
20
|
+
| `MONITOR_LONG_RATE` | Long rate |
|
|
21
|
+
| `MONITOR_PERCENTAGE` | Percentage (0–100) |
|
|
22
|
+
| `MONITOR_INT_INTERVAL_COUNTER` | Integer interval counter |
|
|
23
|
+
| `MONITOR_LONG_INTERVAL_COUNTER` | Long interval counter |
|
|
24
|
+
| `MONITOR_DOUBLE_INTERVAL_COUNTER` | Double interval counter |
|
|
25
|
+
| `MONITOR_INT_SATURATION` | Integer saturation |
|
|
26
|
+
| `MONITOR_LONG_SATURATION` | Long saturation |
|
|
27
|
+
| `MONITOR_STRING` | String metric |
|
|
28
|
+
| `MONITOR_INT_COUNTER` | Integer counter |
|
|
29
|
+
| `MONITOR_LONG_COUNTER` | Long counter |
|
|
30
|
+
| `MONITOR_DOUBLE_COUNTER` | Double counter |
|
|
31
|
+
|
|
32
|
+
### Info flags (add one or more)
|
|
33
|
+
|
|
34
|
+
| Token | Meaning |
|
|
35
|
+
|---|---|
|
|
36
|
+
| `TYPE_INFO_FRONTEND` | Frontend / application layer |
|
|
37
|
+
| `TYPE_INFO_BACKEND` | Backend / infrastructure layer |
|
|
38
|
+
| `TYPE_INFO_BUSINESS_TRANSACTION` | Business transaction |
|
|
39
|
+
| `TYPE_TAGS` | Tag-style metric |
|
|
40
|
+
| `TYPE_VIRTUAL` | Virtual (computed) metric |
|
|
41
|
+
| `TYPE_FUTURE` | Reserved for future use |
|
|
42
|
+
|
|
43
|
+
### Examples
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
# Integer response-time metric on a frontend application
|
|
47
|
+
enumMetricType=MONITOR_INT_DURATION,TYPE_INFO_FRONTEND
|
|
48
|
+
|
|
49
|
+
# Long counter on a backend service
|
|
50
|
+
enumMetricType=MONITOR_LONG_COUNTER,TYPE_INFO_BACKEND
|
|
51
|
+
|
|
52
|
+
# String metric (min and max must be null when storing values)
|
|
53
|
+
enumMetricType=MONITOR_STRING
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## `numericMetricType` — advanced
|
|
59
|
+
|
|
60
|
+
The raw 32-bit integer produced by ORing the bit values above. Useful when you have the numeric type from an existing metric (e.g. from a `nass query-metadata` response) and want to re-register with the same type.
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
numericMetricType=268436481
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
`268436481` = `MONITOR_INT_DURATION (0x401)` | `TYPE_INFO_FRONTEND (0x10000000)` = `0x10000401`
|
|
67
|
+
|
|
68
|
+
If both `numericMetricType` and `enumMetricType` are provided, the server uses `enumMetricType`.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## `metricAttribute` — optional metadata
|
|
73
|
+
|
|
74
|
+
Attach arbitrary key-value metadata to a metric using the `metricAttribute` prefix argument. Repeat for multiple attributes:
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
metricAttribute.unit=ms metricAttribute.team=platform metricAttribute.slo=500
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
These attributes are returned on query and can be used to filter metrics.
|