Allow numbers and boolean values for tags. (#1712) (#1784)

* Allow numbers and boolean values for tags. (#1712) fixes #828.
elastic · Jan 14, 2019 · 51ae8ed · 51ae8ed
1 parent cb4d0fc
commit 51ae8ed
Show file tree

Hide file tree

Showing 42 changed files with 157 additions and 97 deletions.
diff --git a/_meta/fields.common.yml b/_meta/fields.common.yml
@@ -90,7 +90,11 @@
 
         - name: tags
           type: object
-          object_type: keyword
+          object_type_params:
+            - object_type: keyword
+            - object_type: boolean
+            - object_type: scaled_float
+              scaling_factor: 1000000
           dynamic: true
           description: >
             A flat mapping of user-defined tags with string values.

diff --git a/changelogs/head.asciidoc b/changelogs/head.asciidoc
@@ -11,6 +11,11 @@ https://github.com/elastic/apm-server/compare/6.5\...6.x[View commits]
 - Make `service.framework` properties optional and nullable {pull}1546[1546].
 - Add `transaction.sampled` to errors {pull}1662[1662].
 - Remove formatting of `duration.us` to milliseconds in index pattern pull{1717}[1717].
+- Allow numbers and boolean values for `transaction.tags`, `span.tags`, `metricset.tags` {pull}1712[1712].
+
+[float]
+==== Removed
+- Remove support for using dots in tags for experimental metricset endpoint {pull}1712[1712].
 
 [float]
 ==== Bug fixes

diff --git a/docs/data/elasticsearch/generated/metricsets.json b/docs/data/elasticsearch/generated/metricsets.json
@@ -18,8 +18,9 @@
                     "name": "1234_service-12a3"
                 },
                 "tags": {
-                    "code": "200",
-                    "some.other.code": "abc"
+                    "code": 200,
+                    "some": "abc",
+                    "success": true
                 }
             },
             "dotted": {
@@ -31,8 +32,9 @@
             "float_gauge": 9.16,
             "integer_gauge": 42767,
             "labels": {
-                "code": "200",
-                "some.other.code": "abc"
+                "code": 200,
+                "some": "abc",
+                "success": true
             },
             "long_gauge": 3147483648,
             "negative": {

diff --git a/docs/data/elasticsearch/generated/spans.json b/docs/data/elasticsearch/generated/spans.json
@@ -90,7 +90,10 @@
                     "name": "backendspans"
                 },
                 "tags": {
-                    "tag1": "value1"
+                    "tag1": "value1",
+                    "tag2": 123,
+                    "tag3": 12.34,
+                    "tag4": true
                 }
             },
             "parent": {

diff --git a/docs/data/elasticsearch/generated/transactions.json b/docs/data/elasticsearch/generated/transactions.json
@@ -183,7 +183,10 @@
                     "platform": "darwin"
                 },
                 "tags": {
-                    "organization_uuid": "9f0e9d64-c185-4d21-a6f4-4673ed561ec8"
+                    "organization_uuid": "9f0e9d64-c185-4d21-a6f4-4673ed561ec8",
+                    "tag2": 12,
+                    "tag3": 12.45,
+                    "tag4": false
                 },
                 "user": {
                     "email": "[email protected]",

diff --git a/docs/data/elasticsearch/metric.json b/docs/data/elasticsearch/metric.json
@@ -31,8 +31,9 @@
             "platform": "darwin"
         },
         "tags": {
-            "code": "200",
-            "some.other.code": "abc"
+            "code": 200,
+            "key": "value",
+            "success": true
         }
     },
     "dotted": {
@@ -44,8 +45,9 @@
     "float_gauge": 9.16,
     "integer_gauge": 42767,
     "labels": {
-        "code": "200",
-        "some.other.code": "abc"
+        "code": 200,
+        "key": "value",
+        "success": true
     },
     "long_gauge": 3147483648,
     "negative": {

diff --git a/docs/data/elasticsearch/span.json b/docs/data/elasticsearch/span.json
@@ -19,6 +19,8 @@
             "name": "1234_service-12a3"
         },
         "tags": {
+            "bool_error": false,
+            "number_code": 200,
             "span_tag": "something"
         }
     },

diff --git a/docs/data/elasticsearch/transaction.json b/docs/data/elasticsearch/transaction.json
@@ -99,6 +99,8 @@
             "platform": "darwin"
         },
         "tags": {
+            "bool_error": false,
+            "number_code": 2,
             "organization_uuid": "9f0e9d64-c185-4d21-a6f4-4673ed561ec8"
         },
         "user": {

diff --git a/docs/spec/metricsets/common_metricset.json b/docs/spec/metricsets/common_metricset.json
@@ -15,15 +15,7 @@
             "additionalProperties": false
         },
         "tags": {
-            "type": ["object", "null"],
-            "description": "A flat mapping of user-defined tags with string values.",
-            "patternProperties": {
-                "^[^*\"]*$": {
-                    "type": ["string", "null"],
-                    "maxLength": 1024
-                }
-            },
-            "additionalProperties": false
+            "$ref": "../tags.json"
         }
     },
     "required": ["samples"]

diff --git a/docs/spec/tags.json b/docs/spec/tags.json
@@ -2,10 +2,10 @@
     "$id": "doc/spec/tags.json",
     "title": "Tags",
     "type": ["object", "null"],
-    "description": "A flat mapping of user-defined tags with string values.",
+    "description": "A flat mapping of user-defined tags with string, boolean or number values.",
     "patternProperties": {
         "^[^.*\"]*$": {
-            "type": ["string", "null"],
+            "type": ["string", "boolean", "number", "null"],
             "maxLength": 1024
         }
     },

diff --git a/include/fields.go b/include/fields.go
diff --git a/model/error/generated/schema/error.go b/model/error/generated/schema/error.go
@@ -176,10 +176,10 @@ const ModelSchema = `{
                 "$id": "doc/spec/tags.json",
     "title": "Tags",
     "type": ["object", "null"],
-    "description": "A flat mapping of user-defined tags with string values.",
+    "description": "A flat mapping of user-defined tags with string, boolean or number values.",
     "patternProperties": {
         "^[^.*\"]*$": {
-            "type": ["string", "null"],
+            "type": ["string", "boolean", "number", "null"],
             "maxLength": 1024
         }
     },

diff --git a/model/error/generated/schema/payload.go b/model/error/generated/schema/payload.go
@@ -296,10 +296,10 @@ const PayloadSchema = `{
                 "$id": "doc/spec/tags.json",
     "title": "Tags",
     "type": ["object", "null"],
-    "description": "A flat mapping of user-defined tags with string values.",
+    "description": "A flat mapping of user-defined tags with string, boolean or number values.",
     "patternProperties": {
         "^[^.*\"]*$": {
-            "type": ["string", "null"],
+            "type": ["string", "boolean", "number", "null"],
             "maxLength": 1024
         }
     },

diff --git a/model/metricset/generated/schema/metricset.go b/model/metricset/generated/schema/metricset.go
@@ -46,15 +46,17 @@ const ModelSchema = `{
             "additionalProperties": false
         },
         "tags": {
-            "type": ["object", "null"],
-            "description": "A flat mapping of user-defined tags with string values.",
-            "patternProperties": {
-                "^[^*\"]*$": {
-                    "type": ["string", "null"],
-                    "maxLength": 1024
-                }
-            },
-            "additionalProperties": false
+                "$id": "doc/spec/tags.json",
+    "title": "Tags",
+    "type": ["object", "null"],
+    "description": "A flat mapping of user-defined tags with string, boolean or number values.",
+    "patternProperties": {
+        "^[^.*\"]*$": {
+            "type": ["string", "boolean", "number", "null"],
+            "maxLength": 1024
+        }
+    },
+    "additionalProperties": false
         }
     },
     "required": ["samples"]  }, 

diff --git a/model/metricset/generated/schema/payload.go b/model/metricset/generated/schema/payload.go
@@ -55,15 +55,17 @@ const PayloadSchema = `{
             "additionalProperties": false
         },
         "tags": {
-            "type": ["object", "null"],
-            "description": "A flat mapping of user-defined tags with string values.",
-            "patternProperties": {
-                "^[^*\"]*$": {
-                    "type": ["string", "null"],
-                    "maxLength": 1024
-                }
-            },
-            "additionalProperties": false
+                "$id": "doc/spec/tags.json",
+    "title": "Tags",
+    "type": ["object", "null"],
+    "description": "A flat mapping of user-defined tags with string, boolean or number values.",
+    "patternProperties": {
+        "^[^.*\"]*$": {
+            "type": ["string", "boolean", "number", "null"],
+            "maxLength": 1024
+        }
+    },
+    "additionalProperties": false
         }
     },
     "required": ["samples"]  },

diff --git a/model/span/generated/schema/span.go b/model/span/generated/schema/span.go
@@ -74,10 +74,10 @@ const ModelSchema = `{
                         "$id": "doc/spec/tags.json",
     "title": "Tags",
     "type": ["object", "null"],
-    "description": "A flat mapping of user-defined tags with string values.",
+    "description": "A flat mapping of user-defined tags with string, boolean or number values.",
     "patternProperties": {
         "^[^.*\"]*$": {
-            "type": ["string", "null"],
+            "type": ["string", "boolean", "number", "null"],
             "maxLength": 1024
         }
     },

diff --git a/model/transaction/generated/schema/payload.go b/model/transaction/generated/schema/payload.go
@@ -322,10 +322,10 @@ const PayloadSchema = `{
                 "$id": "doc/spec/tags.json",
     "title": "Tags",
     "type": ["object", "null"],
-    "description": "A flat mapping of user-defined tags with string values.",
+    "description": "A flat mapping of user-defined tags with string, boolean or number values.",
     "patternProperties": {
         "^[^.*\"]*$": {
-            "type": ["string", "null"],
+            "type": ["string", "boolean", "number", "null"],
             "maxLength": 1024
         }
     },
@@ -478,10 +478,10 @@ const PayloadSchema = `{
                         "$id": "doc/spec/tags.json",
     "title": "Tags",
     "type": ["object", "null"],
-    "description": "A flat mapping of user-defined tags with string values.",
+    "description": "A flat mapping of user-defined tags with string, boolean or number values.",
     "patternProperties": {
         "^[^.*\"]*$": {
-            "type": ["string", "null"],
+            "type": ["string", "boolean", "number", "null"],
             "maxLength": 1024
         }
     },

diff --git a/model/transaction/generated/schema/transaction.go b/model/transaction/generated/schema/transaction.go
@@ -175,10 +175,10 @@ const ModelSchema = `{
                 "$id": "doc/spec/tags.json",
     "title": "Tags",
     "type": ["object", "null"],
-    "description": "A flat mapping of user-defined tags with string values.",
+    "description": "A flat mapping of user-defined tags with string, boolean or number values.",
     "patternProperties": {
         "^[^.*\"]*$": {
-            "type": ["string", "null"],
+            "type": ["string", "boolean", "number", "null"],
             "maxLength": 1024
         }
     },

diff --git a/processor/error/package_tests/attrs_common.go b/processor/error/package_tests/attrs_common.go
@@ -183,11 +183,11 @@ func schemaTestData(td []tests.SchemaTestData) []tests.SchemaTestData {
 		{Key: "errors.context.request.cookies", Valid: val{obj{}},
 			Invalid: []tests.Invalid{{Msg: `/context/properties/request/properties/cookies/type`, Values: val{102, "a"}}}},
 		{Key: "errors.context.tags",
-			Valid: val{obj{tests.Str1024Special: tests.Str1024Special}},
+			Valid: val{obj{tests.Str1024Special: tests.Str1024Special}, obj{tests.Str1024: 123.45}, obj{tests.Str1024: true}},
 			Invalid: []tests.Invalid{
-				{Msg: `context/properties/tags/type`, Values: val{"tags"}},
-				{Msg: `context/properties/tags/patternproperties`, Values: val{obj{"invalid": tests.Str1025}, obj{tests.Str1024: 123}, obj{tests.Str1024: obj{}}}},
-				{Msg: `context/properties/tags/additionalproperties`, Values: val{obj{"invali*d": "hello"}, obj{"invali\"d": "hello"}, obj{"invali.d": "hello"}}}}},
+				{Msg: `tags/type`, Values: val{"tags"}},
+				{Msg: `tags/patternproperties`, Values: val{obj{"invalid": tests.Str1025}, obj{tests.Str1024: obj{}}}},
+				{Msg: `tags/additionalproperties`, Values: val{obj{"invali*d": "hello"}, obj{"invali\"d": "hello"}, obj{"invali.d": "hello"}}}}},
 		{Key: "errors.context.user.id", Valid: val{123, tests.Str1024Special},
 			Invalid: []tests.Invalid{
 				{Msg: `context/properties/user/properties/id/type`, Values: val{obj{}}},

diff --git a/processor/metricset/package_tests/TestProcessMetricset.approved.json b/processor/metricset/package_tests/TestProcessMetricset.approved.json
@@ -34,8 +34,9 @@
                     "platform": "darwin"
                 },
                 "tags": {
-                    "code": "200",
-                    "some.other.code": "abc"
+                    "code": 200,
+                    "key": "value",
+                    "success": true
                 }
             },
             "dotted": {
@@ -47,8 +48,9 @@
             "float_gauge": 9.16,
             "integer_gauge": 42767,
             "labels": {
-                "code": "200",
-                "some.other.code": "abc"
+                "code": 200,
+                "key": "value",
+                "success": true
             },
             "long_gauge": 3147483648,
             "negative": {

diff --git a/processor/metricset/package_tests/json_schema_test.go b/processor/metricset/package_tests/json_schema_test.go
@@ -56,12 +56,11 @@ func TestInvalidPayloads(t *testing.T) {
 				{Msg: `timestamp/format`, Values: val{"2017-05-30T18:53Z", "2017-05-30T18:53:27.Z", "2017-05-30T18:53:27a123Z"}},
 				{Msg: `timestamp/pattern`, Values: val{"2017-05-30T18:53:27.000+00:20", "2017-05-30T18:53:27ZNOTCORRECT"}}}},
 		{Key: "metrics.tags",
-			Valid: val{obj{tests.Str1024Special: tests.Str1024Special}},
+			Valid: val{obj{tests.Str1024Special: tests.Str1024Special}, obj{tests.Str1024: 123.45}, obj{tests.Str1024: true}},
 			Invalid: []tests.Invalid{
 				{Msg: `tags/type`, Values: val{"tags"}},
-				{Msg: `tags/patternproperties`, Values: val{obj{"invalid": tests.Str1025}, obj{tests.Str1024: 123}, obj{tests.Str1024: obj{}}}},
-				{Msg: `tags/additionalproperties`, Values: val{obj{"invali*d": "hello"}, obj{"invali\"d": "hello"}}}},
-		},
+				{Msg: `tags/patternproperties`, Values: val{obj{"invalid": tests.Str1025}, obj{tests.Str1024: obj{}}}},
+				{Msg: `tags/additionalproperties`, Values: val{obj{"invali*d": "hello"}, obj{"invali\"d": "hello"}, obj{"invali.d": "hello"}}}}},
 		{
 			Key: "metrics.samples",
 			Valid: val{

diff --git a/processor/stream/approved-es-documents/testV2IntakeIntegrationMetricsets.approved.json b/processor/stream/approved-es-documents/testV2IntakeIntegrationMetricsets.approved.json
@@ -18,8 +18,9 @@
                     "name": "1234_service-12a3"
                 },
                 "tags": {
-                    "code": "200",
-                    "some.other.code": "abc"
+                    "code": 200,
+                    "some": "abc",
+                    "success": true
                 }
             },
             "dotted": {
@@ -31,8 +32,9 @@
             "float_gauge": 9.16,
             "integer_gauge": 42767,
             "labels": {
-                "code": "200",
-                "some.other.code": "abc"
+                "code": 200,
+                "some": "abc",
+                "success": true
             },
             "long_gauge": 3147483648,
             "negative": {

diff --git a/processor/stream/approved-es-documents/testV2IntakeIntegrationSpans.approved.json b/processor/stream/approved-es-documents/testV2IntakeIntegrationSpans.approved.json
@@ -90,7 +90,10 @@
                     "name": "backendspans"
                 },
                 "tags": {
-                    "tag1": "value1"
+                    "tag1": "value1",
+                    "tag2": 123,
+                    "tag3": 12.34,
+                    "tag4": true
                 }
             },
             "parent": {

diff --git a/processor/stream/approved-es-documents/testV2IntakeIntegrationTransactions.approved.json b/processor/stream/approved-es-documents/testV2IntakeIntegrationTransactions.approved.json
@@ -183,7 +183,10 @@
                     "platform": "darwin"
                 },
                 "tags": {
-                    "organization_uuid": "9f0e9d64-c185-4d21-a6f4-4673ed561ec8"
+                    "organization_uuid": "9f0e9d64-c185-4d21-a6f4-4673ed561ec8",
+                    "tag2": 12,
+                    "tag3": 12.45,
+                    "tag4": false
                 },
                 "user": {
                     "email": "[email protected]",

diff --git a/processor/stream/package_tests/error_attrs_test.go b/processor/stream/package_tests/error_attrs_test.go
@@ -223,10 +223,10 @@ func TestPayloadDataForError(t *testing.T) {
 			{Key: "error.context.request.cookies", Valid: val{obj{}},
 				Invalid: []tests.Invalid{{Msg: `/context/properties/request/properties/cookies/type`, Values: val{102, "a"}}}},
 			{Key: "error.context.tags",
-				Valid: val{obj{tests.Str1024Special: tests.Str1024Special}},
+				Valid: val{obj{tests.Str1024Special: tests.Str1024Special}, obj{tests.Str1024: 123.45}, obj{tests.Str1024: true}},
 				Invalid: []tests.Invalid{
 					{Msg: `context/properties/tags/type`, Values: val{"tags"}},
-					{Msg: `context/properties/tags/patternproperties`, Values: val{obj{"invalid": tests.Str1025}, obj{tests.Str1024: 123}, obj{tests.Str1024: obj{}}}},
+					{Msg: `context/properties/tags/patternproperties`, Values: val{obj{"invalid": tests.Str1025}, obj{tests.Str1024: obj{}}}},
 					{Msg: `context/properties/tags/additionalproperties`, Values: val{obj{"invali*d": "hello"}, obj{"invali\"d": "hello"}, obj{"invali.d": "hello"}}}}},
 			{Key: "error.context.user.id", Valid: val{123, tests.Str1024Special},
 				Invalid: []tests.Invalid{