Introduce metricset.name (#4857)

axw · web-flow · commit 5f72138f0bd8 · 2021-02-22T19:53:11.000+08:00
* Add metricset.name field to metrics docs

* aggregation/txmetrics: set metricset.name

* aggregation/spanmetrics: set metricset.name

* Add changelog entry
diff --git a/NOTICE.txt b/NOTICE.txt
@@ -1,7 +1,7 @@
 Elastic APM Server
 Copyright 2014-2021 Elasticsearch BV
 
-This product includes software developed by The Apache Software
+This product includes software developed by The Apache Software 
 Foundation (http://www.apache.org/).
 
 ================================================================================
@@ -19976,13 +19976,13 @@ Contents of probable licence file $GOMODCACHE/howett.net/plist@v0.0.0-2020120308
 Copyright (c) 2013, Dustin L. Howett. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+modification, are permitted provided that the following conditions are met: 
 
 1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+   list of conditions and the following disclaimer. 
 2. Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
+   and/or other materials provided with the distribution. 
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
@@ -19996,7 +19996,7 @@ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 The views and conclusions contained in the software and documentation are those
-of the authors and should not be interpreted as representing official policies,
+of the authors and should not be interpreted as representing official policies, 
 either expressed or implied, of the FreeBSD Project.
 
 --------------------------------------------------------------------------------
diff --git a/apmpackage/apm/0.1.0/data_stream/app_metrics/fields/fields.yml b/apmpackage/apm/0.1.0/data_stream/app_metrics/fields/fields.yml
@@ -24,6 +24,10 @@
   type: keyword
   description: |
     Kubernetes Pod UID
+- name: metricset.name
+  type: keyword
+  description: |
+    Name of the set of metrics.
 - name: metricset.period
   type: long
   description: Current data collection period for this event in milliseconds.
diff --git a/apmpackage/apm/0.1.0/data_stream/internal_metrics/fields/fields.yml b/apmpackage/apm/0.1.0/data_stream/internal_metrics/fields/fields.yml
@@ -24,6 +24,10 @@
   type: keyword
   description: |
     Kubernetes Pod UID
+- name: metricset.name
+  type: keyword
+  description: |
+    Name of the set of metrics.
 - name: metricset.period
   type: long
   description: Current data collection period for this event in milliseconds.
diff --git a/apmpackage/apm/0.1.0/docs/README.md b/apmpackage/apm/0.1.0/docs/README.md
@@ -451,6 +451,7 @@ Metrics are written to `metrics-apm.*`, `metrics-apm.internal.*` and `metrics-ap
 |kubernetes.pod.name|Kubernetes pod name|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png)  |
 |kubernetes.pod.uid|Kubernetes Pod UID|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png)  |
 |labels|A flat mapping of user-defined labels with string, boolean or number values.|object|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
+|metricset.name|Name of the set of metrics.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png)  |
 |metricset.period|Current data collection period for this event in milliseconds.|long|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png)  |
 |observer.hostname|Hostname of the APM Server.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |observer.listening|Address the server is listening on.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png)  |
diff --git a/changelogs/head.asciidoc b/changelogs/head.asciidoc
@@ -31,6 +31,7 @@ https://github.com/elastic/apm-server/compare/7.11\...master[View commits]
 * Support additional config options when running under Fleet {pull}4690[4690]
 * Upgrade Go to 1.15.8 {pull}4733[4733]
 * Add support for Node.js wall time profiles {pull}4728[4728]
+* Add metricset.name field to metric docs {pull}4857[4857]
 
 [float]
 ==== Deprecated
diff --git a/docs/fields.asciidoc b/docs/fields.asciidoc
@@ -4857,6 +4857,19 @@ type: object
 
 --
 
+
+*`metricset.name`*::
++
+--
+Name of the set of metrics.
+
+
+type: keyword
+
+example: transaction
+
+--
+
 [float]
 === service
 
diff --git a/include/fields.go b/include/fields.go
diff --git a/model/metricset.go b/model/metricset.go
@@ -85,6 +85,9 @@ type Metricset struct {
 	// instance, such as a hash of the labels used for aggregating the
 	// metrics.
 	TimeseriesInstanceID string
+
+	// Name holds an optional name for the metricset.
+	Name string
 }
 
 // Sample represents a single named metric.
@@ -197,6 +200,10 @@ func (me *Metricset) Transform(ctx context.Context, cfg *transform.Config) []bea
 		fields["timeseries"] = common.MapStr{"instance": me.TimeseriesInstanceID}
 	}
 
+	if me.Name != "" {
+		fields["metricset.name"] = me.Name
+	}
+
 	fields["processor"] = metricsetProcessorEntry
 
 	if cfg.DataStreams {
diff --git a/model/metricset/_meta/fields.yml b/model/metricset/_meta/fields.yml
@@ -37,6 +37,15 @@
       description: >
         A flat mapping of user-defined labels with string, boolean or number values.
 
+    - name: metricset
+      type: group
+      fields:
+        - name: name
+          type: keyword
+          description: >
+            Name of the set of metrics.
+          example: transaction
+
     - name: service
       type: group
       dynamic: false
diff --git a/model/metricset_test.go b/model/metricset_test.go
@@ -72,6 +72,21 @@ func TestTransform(t *testing.T) {
 			},
 			Msg: "Payload with empty metric.",
 		},
+		{
+			Metricset: &Metricset{Timestamp: timestamp, Metadata: metadata, Name: "raj"},
+			Output: []common.MapStr{
+				{
+					"data_stream.type":    "metrics",
+					"data_stream.dataset": "apm.app.myservice",
+					"processor":           common.MapStr{"event": "metric", "name": "metric"},
+					"metricset.name":      "raj",
+					"service": common.MapStr{
+						"name": "myservice",
+					},
+				},
+			},
+			Msg: "Payload with metricset name.",
+		},
 		{
 			Metricset: &Metricset{
 				Metadata:  metadata,
diff --git a/model/modeldecoder/rumv3/metricset_test.go b/model/modeldecoder/rumv3/metricset_test.go
@@ -86,6 +86,7 @@ func TestDecodeMapToMetricsetModel(t *testing.T) {
 				strings.HasPrefix(key, "Transaction") ||
 				// only set by aggregator
 				strings.HasPrefix(key, "Event") ||
+				key == "Name" ||
 				key == "TimeseriesInstanceID" ||
 				strings.HasPrefix(key, "Span.DestinationService") ||
 				// test Samples separately
diff --git a/model/modeldecoder/v2/metricset_test.go b/model/modeldecoder/v2/metricset_test.go
@@ -85,6 +85,7 @@ func TestDecodeMapToMetricsetModel(t *testing.T) {
 			if strings.HasPrefix(key, "Metadata") ||
 				// only set by aggregator
 				strings.HasPrefix(key, "Event") ||
+				key == "Name" ||
 				key == "TimeseriesInstanceID" ||
 				key == "Transaction.Result" ||
 				key == "Transaction.Root" ||
diff --git a/systemtest/approvals/TestServiceDestinationAggregation.approved.json b/systemtest/approvals/TestServiceDestinationAggregation.approved.json
@@ -15,6 +15,7 @@
             "metricset": {
                 "period": 1000
             },
+            "metricset.name": "service_destination",
             "observer": {
                 "ephemeral_id": "dynamic",
                 "hostname": "dynamic",
diff --git a/systemtest/approvals/TestTransactionAggregation.approved.json b/systemtest/approvals/TestTransactionAggregation.approved.json
@@ -17,6 +17,7 @@
                 "hostname": "beowulf",
                 "name": "beowulf"
             },
+            "metricset.name": "transaction",
             "observer": {
                 "ephemeral_id": "dynamic",
                 "hostname": "dynamic",
@@ -71,6 +72,7 @@
                 "hostname": "beowulf",
                 "name": "beowulf"
             },
+            "metricset.name": "transaction",
             "observer": {
                 "ephemeral_id": "dynamic",
                 "hostname": "dynamic",
diff --git a/systemtest/approvals/TestTransactionAggregationShutdown.approved.json b/systemtest/approvals/TestTransactionAggregationShutdown.approved.json
@@ -17,6 +17,7 @@
                 "hostname": "beowulf",
                 "name": "beowulf"
             },
+            "metricset.name": "transaction",
             "observer": {
                 "ephemeral_id": "dynamic",
                 "hostname": "dynamic",
diff --git a/x-pack/apm-server/aggregation/spanmetrics/aggregator.go b/x-pack/apm-server/aggregation/spanmetrics/aggregator.go
@@ -19,6 +19,10 @@ import (
 	"github.com/elastic/beats/v7/libbeat/logp"
 )
 
+const (
+	metricsetName = "service_destination"
+)
+
 // AggregatorConfig holds configuration for creating an Aggregator.
 type AggregatorConfig struct {
 	// Report is a publish.Reporter for reporting metrics documents.
@@ -260,6 +264,7 @@ type spanMetrics struct {
 func makeMetricset(timestamp time.Time, key aggregationKey, metrics spanMetrics, interval int64) model.Metricset {
 	out := model.Metricset{
 		Timestamp: timestamp,
+		Name:      metricsetName,
 		Metadata: model.Metadata{
 			Service: model.Service{
 				Name:        key.serviceName,
diff --git a/x-pack/apm-server/aggregation/spanmetrics/aggregator_test.go b/x-pack/apm-server/aggregation/spanmetrics/aggregator_test.go
@@ -126,6 +126,7 @@ func TestAggregatorRun(t *testing.T) {
 	}
 
 	assert.ElementsMatch(t, []*model.Metricset{{
+		Name: "service_destination",
 		Metadata: model.Metadata{
 			Service: model.Service{Name: "service-A", Agent: model.Agent{Name: "java"}},
 		},
@@ -141,6 +142,7 @@ func TestAggregatorRun(t *testing.T) {
 			{Name: "metricset.period", Value: 10},
 		},
 	}, {
+		Name: "service_destination",
 		Metadata: model.Metadata{
 			Service: model.Service{Name: "service-A", Agent: model.Agent{Name: "java"}},
 		},
@@ -156,6 +158,7 @@ func TestAggregatorRun(t *testing.T) {
 			{Name: "metricset.period", Value: 10},
 		},
 	}, {
+		Name: "service_destination",
 		Metadata: model.Metadata{
 			Service: model.Service{Name: "service-A", Agent: model.Agent{Name: "java"}},
 		},
@@ -171,6 +174,7 @@ func TestAggregatorRun(t *testing.T) {
 			{Name: "metricset.period", Value: 10},
 		},
 	}, {
+		Name: "service_destination",
 		Metadata: model.Metadata{
 			Service: model.Service{Name: "service-B", Agent: model.Agent{Name: "python"}},
 		},
@@ -231,6 +235,7 @@ func TestAggregatorOverflow(t *testing.T) {
 
 		m.Timestamp = time.Time{}
 		assert.Equal(t, &model.Metricset{
+			Name: "service_destination",
 			Metadata: model.Metadata{
 				Service: model.Service{Name: "service", Agent: model.Agent{Name: "agent"}},
 			},
diff --git a/x-pack/apm-server/aggregation/txmetrics/aggregator.go b/x-pack/apm-server/aggregation/txmetrics/aggregator.go
@@ -42,6 +42,8 @@ const (
 	// tooManyGroupsLoggerRateLimit is the maximum frequency at which
 	// "too many groups" log messages are logged.
 	tooManyGroupsLoggerRateLimit = time.Minute
+
+	metricsetName = "transaction"
 )
 
 // Aggregator aggregates transaction durations, periodically publishing histogram metrics.
@@ -365,6 +367,7 @@ func (a *Aggregator) makeTransactionAggregationKey(tx *model.Transaction) transa
 func makeMetricset(key transactionAggregationKey, hash uint64, ts time.Time, counts []int64, values []float64) model.Metricset {
 	out := model.Metricset{
 		Timestamp: ts,
+		Name:      metricsetName,
 		Metadata: model.Metadata{
 			Service: model.Service{
 				Name:        key.serviceName,
diff --git a/x-pack/apm-server/aggregation/txmetrics/aggregator_test.go b/x-pack/apm-server/aggregation/txmetrics/aggregator_test.go
@@ -113,6 +113,7 @@ func TestProcessTransformablesOverflow(t *testing.T) {
 
 		m.Timestamp = time.Time{}
 		assert.Equal(t, &model.Metricset{
+			Name:     "transaction",
 			Metadata: model.Metadata{},
 			Transaction: model.MetricsetTransaction{
 				Name: "baz",
@@ -288,6 +289,7 @@ func TestAggregateRepresentativeCount(t *testing.T) {
 
 		m.Timestamp = time.Time{}
 		assert.Equal(t, &model.Metricset{
+			Name:                 "transaction",
 			Metadata:             model.Metadata{},
 			TimeseriesInstanceID: ":foo:1db641f187113b17",
 			Transaction: model.MetricsetTransaction{
@@ -398,6 +400,7 @@ func TestAggregationFields(t *testing.T) {
 	var expected []model.Metricset
 	addExpectedCount := func(expectedCount int64) {
 		expected = append(expected, model.Metricset{
+			Name:     "transaction",
 			Metadata: input.Metadata,
 			Event: model.MetricsetEventCategorization{
 				Outcome: input.Outcome,
