Add units to metric duration fields (#5395)

* add units to metric duration fields * Apply suggestions from code review Co-authored-by: Andrew Wilkins <[email protected]> * make update * Add changelog Co-authored-by: Andrew Wilkins <[email protected]>
elastic · Jun 3, 2021 · fedc1db · fedc1db
1 parent 9980296
commit fedc1db
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 8 deletions.
diff --git a/apmpackage/apm/0.3.0/data_stream/app_metrics/fields/fields.yml b/apmpackage/apm/0.3.0/data_stream/app_metrics/fields/fields.yml
@@ -33,6 +33,7 @@
 - name: metricset.period
   type: long
   description: Current data collection period for this event in milliseconds.
+  unit: ms
 - name: observer.listening
   type: keyword
   description: |

diff --git a/apmpackage/apm/0.3.0/data_stream/internal_metrics/fields/fields.yml b/apmpackage/apm/0.3.0/data_stream/internal_metrics/fields/fields.yml
@@ -33,6 +33,7 @@
 - name: metricset.period
   type: long
   description: Current data collection period for this event in milliseconds.
+  unit: ms
 - name: observer.listening
   type: keyword
   description: |
@@ -81,13 +82,15 @@
 - name: span.destination.service.response_time.sum.us
   type: long
   description: Aggregated duration of outgoing requests, in microseconds.
+  unit: micros
 - name: span.self_time.count
   type: long
   description: Number of aggregated spans.
 - name: span.self_time.sum.us
   type: long
   description: |
     Aggregated span duration, excluding the time periods where a direct child was running, in microseconds.
+  unit: micros
 - name: span.subtype
   type: keyword
   description: |
@@ -202,6 +205,7 @@
 - name: transaction.duration.sum.us
   type: long
   description: Aggregated transaction duration, in microseconds.
+  unit: micros
 - name: transaction.name
   type: keyword
   description: |
@@ -224,6 +228,7 @@
   type: long
   description: |
     Aggregated transaction duration, excluding the time periods where a direct child was running, in microseconds.
+  unit: micros
 - name: transaction.type
   type: keyword
   description: |

diff --git a/apmpackage/apm/0.3.0/data_stream/profile_metrics/fields/fields.yml b/apmpackage/apm/0.3.0/data_stream/profile_metrics/fields/fields.yml
@@ -50,10 +50,12 @@
   type: long
   description: |
     Amount of CPU time profiled, in nanoseconds.
+  unit: nanos
 - name: profile.duration
   type: long
   description: |
-    Duration of the profile, in microseconds. All samples within a profile will have the same duration. To aggregate durations, you should first group by the profile ID.
+    Duration of the profile, in nanoseconds. All samples within a profile will have the same duration. To aggregate durations, you should first group by the profile ID.
+  unit: nanos
 - name: profile.id
   type: keyword
   description: |
@@ -106,6 +108,7 @@
   type: long
   description: |
     Amount of wall time profiled, in microseconds.
+  unit: micros
 - name: service.environment
   type: keyword
   description: |

diff --git a/changelogs/head.asciidoc b/changelogs/head.asciidoc
@@ -24,6 +24,8 @@ https://github.com/elastic/apm-server/compare/7.13\...master[View commits]
 * Tail-sampling processor now resumes subscription from previous position after restart {pull}5350[5350]
 * Add support for histograms to metrics intake {pull}5360[5360]
 * Upgrade Go to 1.16.4 {pull}5381[5381]
+* Add units to metric fields {pull}5395[5395]
+
 
 [float]
 ==== Deprecated
diff --git a/docs/fields.asciidoc b/docs/fields.asciidoc
@@ -2319,7 +2319,7 @@ type: keyword
 *`profile.duration`*::
 +
 --
-Duration of the profile, in microseconds. All samples within a profile will have the same duration. To aggregate durations, you should first group by the profile ID.
+Duration of the profile, in nanoseconds. All samples within a profile will have the same duration. To aggregate durations, you should first group by the profile ID.
 
 
 type: long

diff --git a/include/fields.go b/include/fields.go
diff --git a/model/metricset/_meta/fields.yml b/model/metricset/_meta/fields.yml
@@ -176,6 +176,7 @@
               fields:
                 - name: us
                   type: long
+                  unit: micros
                   overwrite: true
                   description: Aggregated transaction duration, in microseconds.
 
@@ -193,6 +194,7 @@
               fields:
                 - name: us
                   type: long
+                  unit: micros
                   overwrite: true
                   description: >
                     Aggregated transaction duration, excluding the time periods where a
@@ -245,6 +247,7 @@
             fields:
               - name: us
                 type: long
+                unit: micros
                 overwrite: true
                 description: >
                   Aggregated span duration, excluding the time periods where a
@@ -421,7 +424,6 @@
           overwrite: true
           description: >
             Hostname of the APM Server.
-          overwrite: true
 
         - name: version
           type: keyword
@@ -440,7 +442,6 @@
           overwrite: true
           description: >
             The type will be set to `apm-server`.
-          overwrite: true
 
     - name: user
       type: group

diff --git a/model/profile/_meta/fields.yml b/model/profile/_meta/fields.yml
@@ -633,9 +633,10 @@
 
         - name: duration
           type: long
+          unit: nanos
           count: 1
           description: >
-            Duration of the profile, in microseconds.
+            Duration of the profile, in nanoseconds.
             All samples within a profile will have the same duration.
             To aggregate durations, you should first group by the profile ID.
 
@@ -644,15 +645,17 @@
           fields:
             - name: ns
               type: long
+              unit: nanos
               count: 1
               description: >
                 Amount of CPU time profiled, in nanoseconds.
-        
+
         - name: wall
           type: group
           fields:
             - name: us
               type: long
+              unit: micros
               count: 1
               description: >
                 Amount of wall time profiled, in microseconds.

diff --git a/x-pack/apm-server/fields/_meta/fields.yml b/x-pack/apm-server/fields/_meta/fields.yml
@@ -25,6 +25,7 @@
   short_config: true
   fields:
     - name: metricset.period
+      unit: ms
       type: long
       description: Current data collection period for this event in milliseconds.
     - name: span
@@ -39,5 +40,6 @@
             type: long
             description: Number of aggregated outgoing requests.
           - name: response_time.sum.us
+            unit: micros
             type: long
             description: Aggregated duration of outgoing requests, in microseconds.
diff --git a/x-pack/apm-server/include/fields.go b/x-pack/apm-server/include/fields.go