[7.x] New tracer (#3836) (#3923)

* script: add detection of Elastic License * Support new instrumentation config and tracer from Libbeat (#3836) * Update beats framework to f9b5f18382ac Co-authored-by: Andrew Wilkins <[email protected]>
elastic · Jul 1, 2020 · ecd8237 · ecd8237
1 parent e0e8af1
commit ecd8237
Show file tree

Hide file tree

Showing 12 changed files with 253 additions and 316 deletions.
diff --git a/NOTICE.txt b/NOTICE.txt
@@ -1,7 +1,7 @@
 Elastic APM Server
 Copyright 2017-2020 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/).
 
 ==========================================================================
@@ -152,7 +152,7 @@ License type (autodetected): Apache-2.0
 Contents of "NOTICE.txt":
 
     AWS SDK for Go
-    Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. 
+    Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
     Copyright 2014-2015 Stripe, Inc.
 
 --------------------------------------------------------------------
@@ -891,14 +891,14 @@ Version: v0.10.5
 License type (autodetected): Apache-2.0
 Contents of "NOTICE":
 
-    Copyright (c) [2009-2011] VMware, Inc. All Rights Reserved. 
+    Copyright (c) [2009-2011] VMware, Inc. All Rights Reserved.
 
-    This product is licensed to you under the Apache License, Version 2.0 (the "License").  
-    You may not use this product except in compliance with the License.  
+    This product is licensed to you under the Apache License, Version 2.0 (the "License").
+    You may not use this product except in compliance with the License.
 
     This product includes a number of subcomponents with
     separate copyright notices and license terms. Your use of these
-    subcomponents is subject to the terms and conditions of the 
+    subcomponents is subject to the terms and conditions of the
     subcomponent's license, as noted in the LICENSE file.
 
 --------------------------------------------------------------------
@@ -3449,13 +3449,13 @@ Contents of "LICENSE":
     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
@@ -3469,7 +3469,7 @@ Contents of "LICENSE":
     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/_meta/beat.yml b/_meta/beat.yml
@@ -38,39 +38,6 @@ apm-server:
     # Url to expose expvar.
     #url: "/debug/vars"
 
-  # Instrumentation support for the server's HTTP endpoints and event publisher.
-  #instrumentation:
-    # Set to true to enable instrumentation of the APM Server itself.
-    #enabled: false
-
-    # Environment in which the APM Server is running on (eg: staging, production, etc.)
-    #environment: ""
-
-    # Remote hosts to report instrumentation results to.
-    #hosts:
-    #  - http://remote-apm-server:8200
-
-    # API Key for the remote APM Server(s).
-    # If api_key is set then secret_token will be ignored.
-    #api_key:
-
-    # Secret token for the remote APM Server(s).
-    #secret_token:
-
-    # Enable profiling of the server, recording profile samples as events.
-    #
-    # This feature is experimental.
-    #profiling:
-      #cpu:
-        # Set to true to enable CPU profiling.
-        #enabled: false
-        #interval: 60s
-        #duration: 10s
-      #heap:
-        # Set to true to enable heap profiling.
-        #enabled: false
-        #interval: 60s
-
   # A pipeline is a definition of processors applied to documents when ingesting them to Elasticsearch.
   # Using pipelines involves two steps:
   # (1) registering a pipeline
@@ -983,6 +950,43 @@ output.elasticsearch:
   # Kerberos realm.
   #kerberos.realm: ELASTIC
 
+#============================= Instrumentation =============================
+
+# Instrumentation support for the server's HTTP endpoints and event publisher.
+#instrumentation:
+
+  # Set to true to enable instrumentation of the APM Server itself.
+  #enabled: false
+
+  # Environment in which the APM Server is running on (eg: staging, production, etc.)
+  #environment: ""
+
+  # Hosts to report instrumentation results to.
+  # For reporting to itself, leave this field commented
+  #hosts:
+  #  - http://remote-apm-server:8200
+
+  # API Key for the remote APM Server(s).
+  # If api_key is set then secret_token will be ignored.
+  #api_key:
+
+  # Secret token for the remote APM Server(s).
+  #secret_token:
+
+  # Enable profiling of the server, recording profile samples as events.
+  #
+  # This feature is experimental.
+  #profiling:
+    #cpu:
+      # Set to true to enable CPU profiling.
+      #enabled: false
+      #interval: 60s
+      #duration: 10s
+  #heap:
+    # Set to true to enable heap profiling.
+    #enabled: false
+    #interval: 60s
+
 #================================= Paths ==================================
 
 # The home path for the apm-server installation. This is the default base path

diff --git a/apm-server.docker.yml b/apm-server.docker.yml
@@ -38,39 +38,6 @@ apm-server:
     # Url to expose expvar.
     #url: "/debug/vars"
 
-  # Instrumentation support for the server's HTTP endpoints and event publisher.
-  #instrumentation:
-    # Set to true to enable instrumentation of the APM Server itself.
-    #enabled: false
-
-    # Environment in which the APM Server is running on (eg: staging, production, etc.)
-    #environment: ""
-
-    # Remote hosts to report instrumentation results to.
-    #hosts:
-    #  - http://remote-apm-server:8200
-
-    # API Key for the remote APM Server(s).
-    # If api_key is set then secret_token will be ignored.
-    #api_key:
-
-    # Secret token for the remote APM Server(s).
-    #secret_token:
-
-    # Enable profiling of the server, recording profile samples as events.
-    #
-    # This feature is experimental.
-    #profiling:
-      #cpu:
-        # Set to true to enable CPU profiling.
-        #enabled: false
-        #interval: 60s
-        #duration: 10s
-      #heap:
-        # Set to true to enable heap profiling.
-        #enabled: false
-        #interval: 60s
-
   # A pipeline is a definition of processors applied to documents when ingesting them to Elasticsearch.
   # Using pipelines involves two steps:
   # (1) registering a pipeline
@@ -983,6 +950,43 @@ output.elasticsearch:
   # Kerberos realm.
   #kerberos.realm: ELASTIC
 
+#============================= Instrumentation =============================
+
+# Instrumentation support for the server's HTTP endpoints and event publisher.
+#instrumentation:
+
+  # Set to true to enable instrumentation of the APM Server itself.
+  #enabled: false
+
+  # Environment in which the APM Server is running on (eg: staging, production, etc.)
+  #environment: ""
+
+  # Hosts to report instrumentation results to.
+  # For reporting to itself, leave this field commented
+  #hosts:
+  #  - http://remote-apm-server:8200
+
+  # API Key for the remote APM Server(s).
+  # If api_key is set then secret_token will be ignored.
+  #api_key:
+
+  # Secret token for the remote APM Server(s).
+  #secret_token:
+
+  # Enable profiling of the server, recording profile samples as events.
+  #
+  # This feature is experimental.
+  #profiling:
+    #cpu:
+      # Set to true to enable CPU profiling.
+      #enabled: false
+      #interval: 60s
+      #duration: 10s
+  #heap:
+    # Set to true to enable heap profiling.
+    #enabled: false
+    #interval: 60s
+
 #================================= Paths ==================================
 
 # The home path for the apm-server installation. This is the default base path

diff --git a/apm-server.yml b/apm-server.yml
@@ -38,39 +38,6 @@ apm-server:
     # Url to expose expvar.
     #url: "/debug/vars"
 
-  # Instrumentation support for the server's HTTP endpoints and event publisher.
-  #instrumentation:
-    # Set to true to enable instrumentation of the APM Server itself.
-    #enabled: false
-
-    # Environment in which the APM Server is running on (eg: staging, production, etc.)
-    #environment: ""
-
-    # Remote hosts to report instrumentation results to.
-    #hosts:
-    #  - http://remote-apm-server:8200
-
-    # API Key for the remote APM Server(s).
-    # If api_key is set then secret_token will be ignored.
-    #api_key:
-
-    # Secret token for the remote APM Server(s).
-    #secret_token:
-
-    # Enable profiling of the server, recording profile samples as events.
-    #
-    # This feature is experimental.
-    #profiling:
-      #cpu:
-        # Set to true to enable CPU profiling.
-        #enabled: false
-        #interval: 60s
-        #duration: 10s
-      #heap:
-        # Set to true to enable heap profiling.
-        #enabled: false
-        #interval: 60s
-
   # A pipeline is a definition of processors applied to documents when ingesting them to Elasticsearch.
   # Using pipelines involves two steps:
   # (1) registering a pipeline
@@ -983,6 +950,43 @@ output.elasticsearch:
   # Kerberos realm.
   #kerberos.realm: ELASTIC
 
+#============================= Instrumentation =============================
+
+# Instrumentation support for the server's HTTP endpoints and event publisher.
+#instrumentation:
+
+  # Set to true to enable instrumentation of the APM Server itself.
+  #enabled: false
+
+  # Environment in which the APM Server is running on (eg: staging, production, etc.)
+  #environment: ""
+
+  # Hosts to report instrumentation results to.
+  # For reporting to itself, leave this field commented
+  #hosts:
+  #  - http://remote-apm-server:8200
+
+  # API Key for the remote APM Server(s).
+  # If api_key is set then secret_token will be ignored.
+  #api_key:
+
+  # Secret token for the remote APM Server(s).
+  #secret_token:
+
+  # Enable profiling of the server, recording profile samples as events.
+  #
+  # This feature is experimental.
+  #profiling:
+    #cpu:
+      # Set to true to enable CPU profiling.
+      #enabled: false
+      #interval: 60s
+      #duration: 10s
+  #heap:
+    # Set to true to enable heap profiling.
+    #enabled: false
+    #interval: 60s
+
 #================================= Paths ==================================
 
 # The home path for the apm-server installation. This is the default base path

diff --git a/beater/beater.go b/beater/beater.go
@@ -130,12 +130,14 @@ type beater struct {
 // Run runs the APM Server, blocking until the beater's Stop method is called,
 // or a fatal error occurs.
 func (bt *beater) Run(b *beat.Beat) error {
-	tracer, tracerServer, err := initTracer(b.Info, bt.config, bt.logger)
-	if err != nil {
-		return err
+
+	var tracerServer *tracerServer
+	var err error
+	if listener := b.Instrumentation.Listener(); listener != nil {
+		tracerServer = newTracerServer(bt.config, listener)
 	}
-	defer tracer.Close()
 
+	tracer := b.Instrumentation.Tracer()
 	runServer := runServer
 	if tracerServer != nil {
 		runServer = runServerWithTracerServer(runServer, tracerServer, tracer)

diff --git a/beater/server_test.go b/beater/server_test.go
@@ -35,6 +35,7 @@ import (
 
 	"github.com/elastic/beats/v7/libbeat/beat"
 	"github.com/elastic/beats/v7/libbeat/common"
+	"github.com/elastic/beats/v7/libbeat/instrumentation"
 	"github.com/elastic/beats/v7/libbeat/logp"
 	"github.com/elastic/beats/v7/libbeat/outputs"
 	pubs "github.com/elastic/beats/v7/libbeat/publisher"
@@ -514,11 +515,15 @@ func setupServer(t *testing.T, cfg *common.Config, beatConfig *beat.BeatConfig,
 		pub = dummyPipeline(cfg, info)
 	}
 
+	instrumentation, err := instrumentation.New(baseConfig, info.Beat, info.Version)
+	require.NoError(t, err)
+
 	// create a beat
 	apmBeat := &beat.Beat{
-		Publisher: pub,
-		Info:      info,
-		Config:    beatConfig,
+		Publisher:       pub,
+		Info:            info,
+		Config:          beatConfig,
+		Instrumentation: instrumentation,
 	}
 	return setupBeater(t, apmBeat, baseConfig, beatConfig)
 }