rename in_app to library_frame, reversing meaning (#385)

* rename in_app to library_frame, reversing meaning closes #384 * InLibrary -> LibraryFrame per feedback
elastic · Dec 8, 2017 · c602df5 · c602df5
1 parent 67270af
commit c602df5
Show file tree

Hide file tree

Showing 16 changed files with 97 additions and 96 deletions.
diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
@@ -8,6 +8,7 @@
 https://github.com/elastic/apm-server/compare/71df0d96445df35afe27f38bcf734a0828e0761d\...master[View commits]
 
 ==== Breaking changes
+- Renaming and reverse boolean `in_app` to `library_frame` {pull}385[385].
 - Renaming `app` to `service` {pull}377[377]
 - Move `trace.transaction_id` to `transaction.id` {pull}345[345], {pull}347[347], {pull}371[371]
 - Renaming `trace` to `span` {pull}352[352].

diff --git a/docs/data/elasticsearch/error.json b/docs/data/elasticsearch/error.json
@@ -120,7 +120,7 @@
                     },
                     "filename": "file/name.py",
                     "function": "foo",
-                    "in_app": false,
+                    "library_frame": true,
                     "line": {
                         "column": 4,
                         "context": "line3",
@@ -155,7 +155,7 @@
                     },
                     "filename": "lib/instrumentation/index.js",
                     "function": "instrumented",
-                    "in_app": false,
+                    "library_frame": true,
                     "line": {
                         "context": "    var result = original.apply(this, arguments)",
                         "number": 102
@@ -190,7 +190,7 @@
                     },
                     "filename": "file/name.py",
                     "function": "foo",
-                    "in_app": false,
+                    "library_frame": true,
                     "line": {
                         "column": 4,
                         "context": "line3",
@@ -225,7 +225,7 @@
                     },
                     "filename": "lib/instrumentation/index.js",
                     "function": "instrumented",
-                    "in_app": false,
+                    "library_frame": true,
                     "line": {
                         "context": "    var result = original.apply(this, arguments)",
                         "number": 102

diff --git a/docs/data/elasticsearch/span.json b/docs/data/elasticsearch/span.json
@@ -40,7 +40,7 @@
                 },
                 "filename": "net.js",
                 "function": "onread",
-                "in_app": false,
+                "library_frame": true,
                 "line": {
                     "column": 4,
                     "context": "line3",

diff --git a/docs/data/intake-api/generated/error/payload.json b/docs/data/intake-api/generated/error/payload.json
@@ -54,7 +54,7 @@
                             "line2"
                         ],
                         "context_line": "line3",
-                        "in_app": false,
+                        "library_frame": true,
                         "lineno": 3,
                         "module": "App::MyModule",
                         "colno": 4,
@@ -67,7 +67,7 @@
                         "filename": "lib/instrumentation/index.js",
                         "lineno": 102,
                         "function": "instrumented",
-                        "in_app": false,
+                        "library_frame": true,
                         "abs_path": "/Users/watson/code/node_modules/elastic/lib/instrumentation/index.js",
                         "vars": {
                             "key": "value"
@@ -116,7 +116,7 @@
                             "line2"
                         ],
                         "context_line": "line3",
-                        "in_app": false,
+                        "library_frame": true,
                         "lineno": 3,
                         "module": "App::MyModule",
                         "colno": 4,
@@ -129,7 +129,7 @@
                         "filename": "lib/instrumentation/index.js",
                         "lineno": 102,
                         "function": "instrumented",
-                        "in_app": false,
+                        "library_frame": true,
                         "abs_path": "/Users/watson/code/node_modules/elastic/lib/instrumentation/index.js",
                         "vars": {
                             "key": "value"

diff --git a/docs/data/intake-api/generated/transaction/null_values.json b/docs/data/intake-api/generated/transaction/null_values.json
@@ -150,7 +150,7 @@
                       "context_line": null,
                       "filename": "myfile",
                       "function": null,
-                      "in_app": null,
+                      "library_frame": null,
                       "lineno": 1,
                       "module": null,
                       "post_context": null,

diff --git a/docs/data/intake-api/generated/transaction/payload.json b/docs/data/intake-api/generated/transaction/payload.json
@@ -118,7 +118,7 @@
                             "abs_path": "net.js",
                             "filename": "net.js",
                             "lineno": 547,
-                            "in_app": false,
+                            "library_frame": true,
                             "vars": {
                               "key": "value"
                             },

diff --git a/docs/spec/stacktrace_frame.json b/docs/spec/stacktrace_frame.json
@@ -25,7 +25,7 @@
             "description": "The function involved in the stack frame",
             "type": ["string", "null"]
         },
-        "in_app": {
+        "library_frame": {
             "type": ["boolean", "null"]
         },
         "lineno": {

diff --git a/model/stacktrace_frame.go b/model/stacktrace_frame.go
@@ -6,17 +6,17 @@ import (
 )
 
 type StacktraceFrame struct {
-	AbsPath     *string `mapstructure:"abs_path"`
-	Filename    string
-	Lineno      int
-	Colno       *int
-	ContextLine *string `mapstructure:"context_line"`
-	Module      *string
-	Function    *string
-	InApp       *bool `mapstructure:"in_app"`
-	Vars        common.MapStr
-	PreContext  []string `mapstructure:"pre_context"`
-	PostContext []string `mapstructure:"post_context"`
+	AbsPath      *string `mapstructure:"abs_path"`
+	Filename     string
+	Lineno       int
+	Colno        *int
+	ContextLine  *string `mapstructure:"context_line"`
+	Module       *string
+	Function     *string
+	LibraryFrame *bool `mapstructure:"library_frame"`
+	Vars         common.MapStr
+	PreContext   []string `mapstructure:"pre_context"`
+	PostContext  []string `mapstructure:"post_context"`
 }
 
 type TransformStacktraceFrame func(s *StacktraceFrame) common.MapStr
@@ -30,7 +30,7 @@ func (s *StacktraceFrame) Transform() common.MapStr {
 	enhancer.Add(m, "module", s.Module)
 	enhancer.Add(m, "function", s.Function)
 	enhancer.Add(m, "vars", s.Vars)
-	enhancer.Add(m, "in_app", s.InApp)
+	enhancer.Add(m, "library_frame", s.LibraryFrame)
 
 	context := common.MapStr{}
 	enhancer.Add(context, "pre", s.PreContext)

diff --git a/model/stacktrace_frame_test.go b/model/stacktrace_frame_test.go
@@ -22,7 +22,7 @@ func TestStacktraceFrameTransform(t *testing.T) {
 	context := "context"
 	fct := "st function"
 	module := "some_module"
-	inApp := true
+	libraryFrame := true
 	tests := []struct {
 		StFrame StacktraceFrame
 		Output  common.MapStr
@@ -33,25 +33,25 @@ func TestStacktraceFrameTransform(t *testing.T) {
 		},
 		{
 			StFrame: StacktraceFrame{
-				AbsPath:     &path,
-				Filename:    filename,
-				Lineno:      lineno,
-				Colno:       &colno,
-				ContextLine: &context,
-				Module:      &module,
-				Function:    &fct,
-				InApp:       &inApp,
-				Vars:        map[string]interface{}{"k1": "v1", "k2": "v2"},
-				PreContext:  []string{"prec1", "prec2"},
-				PostContext: []string{"postc1", "postc2"},
+				AbsPath:      &path,
+				Filename:     filename,
+				Lineno:       lineno,
+				Colno:        &colno,
+				ContextLine:  &context,
+				Module:       &module,
+				Function:     &fct,
+				LibraryFrame: &libraryFrame,
+				Vars:         map[string]interface{}{"k1": "v1", "k2": "v2"},
+				PreContext:   []string{"prec1", "prec2"},
+				PostContext:  []string{"postc1", "postc2"},
 			},
 			Output: common.MapStr{
-				"abs_path": "~/some/abs_path",
-				"filename": "some file",
-				"function": "st function",
-				"module":   "some_module",
-				"in_app":   true,
-				"vars":     common.MapStr{"k1": "v1", "k2": "v2"},
+				"abs_path":      "~/some/abs_path",
+				"filename":      "some file",
+				"function":      "st function",
+				"module":        "some_module",
+				"library_frame": true,
+				"vars":          common.MapStr{"k1": "v1", "k2": "v2"},
 				"context": common.MapStr{
 					"pre":  []string{"prec1", "prec2"},
 					"post": []string{"postc1", "postc2"},

diff --git a/processor/error/package_tests/TestProcessErrorFull.approved.json b/processor/error/package_tests/TestProcessErrorFull.approved.json
@@ -123,7 +123,7 @@
                             },
                             "filename": "file/name.py",
                             "function": "foo",
-                            "in_app": false,
+                            "library_frame": true,
                             "line": {
                                 "column": 4,
                                 "context": "line3",
@@ -158,7 +158,7 @@
                             },
                             "filename": "lib/instrumentation/index.js",
                             "function": "instrumented",
-                            "in_app": false,
+                            "library_frame": true,
                             "line": {
                                 "context": "    var result = original.apply(this, arguments)",
                                 "number": 102
@@ -193,7 +193,7 @@
                             },
                             "filename": "file/name.py",
                             "function": "foo",
-                            "in_app": false,
+                            "library_frame": true,
                             "line": {
                                 "column": 4,
                                 "context": "line3",
@@ -228,7 +228,7 @@
                             },
                             "filename": "lib/instrumentation/index.js",
                             "function": "instrumented",
-                            "in_app": false,
+                            "library_frame": true,
                             "line": {
                                 "context": "    var result = original.apply(this, arguments)",
                                 "number": 102

diff --git a/processor/error/schema.go b/processor/error/schema.go
@@ -331,7 +331,7 @@ var errorSchema = `{
             "description": "The function involved in the stack frame",
             "type": ["string", "null"]
         },
-        "in_app": {
+        "library_frame": {
             "type": ["boolean", "null"]
         },
         "lineno": {
@@ -432,7 +432,7 @@ var errorSchema = `{
             "description": "The function involved in the stack frame",
             "type": ["string", "null"]
         },
-        "in_app": {
+        "library_frame": {
             "type": ["boolean", "null"]
         },
         "lineno": {

diff --git a/processor/transaction/package_tests/TestProcessTransactionFull.approved.json b/processor/transaction/package_tests/TestProcessTransactionFull.approved.json
@@ -3,33 +3,6 @@
         {
             "@timestamp": "2017-05-30T18:53:27.154Z",
             "context": {
-                "service": {
-                    "agent": {
-                        "name": "elastic-node",
-                        "version": "3.14.0"
-                    },
-                    "argv": [
-                        "node",
-                        "server.js"
-                    ],
-                    "environment": "staging",
-                    "framework": {
-                        "name": "Express",
-                        "version": "1.2.3"
-                    },
-                    "language": {
-                        "name": "ecmascript",
-                        "version": "8"
-                    },
-                    "name": "1234_service-12a3",
-                    "pid": 1234,
-                    "process_title": "node",
-                    "runtime": {
-                        "name": "node",
-                        "version": "8.0.0"
-                    },
-                    "version": "5.1.3"
-                },
                 "custom": {
                     "and_objects": {
                         "foo": [
@@ -85,6 +58,33 @@
                     "headers_sent": true,
                     "status_code": 200
                 },
+                "service": {
+                    "agent": {
+                        "name": "elastic-node",
+                        "version": "3.14.0"
+                    },
+                    "argv": [
+                        "node",
+                        "server.js"
+                    ],
+                    "environment": "staging",
+                    "framework": {
+                        "name": "Express",
+                        "version": "1.2.3"
+                    },
+                    "language": {
+                        "name": "ecmascript",
+                        "version": "8"
+                    },
+                    "name": "1234_service-12a3",
+                    "pid": 1234,
+                    "process_title": "node",
+                    "runtime": {
+                        "name": "node",
+                        "version": "8.0.0"
+                    },
+                    "version": "5.1.3"
+                },
                 "system": {
                     "architecture": "x64",
                     "hostname": "prod1.example.com",
@@ -116,18 +116,18 @@
         {
             "@timestamp": "2017-05-30T18:53:27.154Z",
             "context": {
+                "db": {
+                    "instance": "customers",
+                    "statement": "SELECT * FROM product_types WHERE user_id=?",
+                    "type": "sql",
+                    "user": "readonly_user"
+                },
                 "service": {
                     "agent": {
                         "name": "elastic-node",
                         "version": "3.14.0"
                     },
                     "name": "1234_service-12a3"
-                },
-                "db": {
-                    "instance": "customers",
-                    "statement": "SELECT * FROM product_types WHERE user_id=?",
-                    "type": "sql",
-                    "user": "readonly_user"
                 }
             },
             "processor": {
@@ -156,7 +156,7 @@
                         },
                         "filename": "net.js",
                         "function": "onread",
-                        "in_app": false,
+                        "library_frame": true,
                         "line": {
                             "column": 4,
                             "context": "line3",
@@ -429,18 +429,18 @@
         {
             "@timestamp": "2017-05-30T18:53:42.281999Z",
             "context": {
+                "db": {
+                    "instance": "customers",
+                    "statement": "SELECT * FROM product_types WHERE user_id=?",
+                    "type": "sql",
+                    "user": "readonly_user"
+                },
                 "service": {
                     "agent": {
                         "name": "elastic-node",
                         "version": "3.14.0"
                     },
                     "name": "1234_service-12a3"
-                },
-                "db": {
-                    "instance": "customers",
-                    "statement": "SELECT * FROM product_types WHERE user_id=?",
-                    "type": "sql",
-                    "user": "readonly_user"
                 }
             },
             "processor": {
@@ -462,4 +462,4 @@
             }
         }
     ]
-}
+}