feat: Added segment synthesizer and provided ability to convert http …

…client otel spans to external http trace segments (#2745)

THIRD_PARTY_NOTICES.md

@@ -18,6 +18,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [@grpc/proto-loader](#grpcproto-loader)
 * [@newrelic/security-agent](#newrelicsecurity-agent)
 * [@opentelemetry/api](#opentelemetryapi)
+* [@opentelemetry/semantic-conventions](#opentelemetrysemantic-conventions)
 * [@tyriar/fibonacci-heap](#tyriarfibonacci-heap)
 * [concat-stream](#concat-stream)
 * [https-proxy-agent](#https-proxy-agent)
@@ -764,6 +765,215 @@ This product includes source derived from [@opentelemetry/api](https://github.co
 
 ```
 
+### @opentelemetry/semantic-conventions
+
+This product includes source derived from [@opentelemetry/semantic-conventions](https://github.com/open-telemetry/opentelemetry-js) ([v1.27.0](https://github.com/open-telemetry/opentelemetry-js/tree/v1.27.0)), distributed under the [Apache-2.0 License](https://github.com/open-telemetry/opentelemetry-js/blob/v1.27.0/LICENSE):
+
+```
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+```
+
 ### @tyriar/fibonacci-heap
 
 This product includes source derived from [@tyriar/fibonacci-heap](https://github.com/gwtw/ts-fibonacci-heap) ([v2.0.9](https://github.com/gwtw/ts-fibonacci-heap/tree/v2.0.9)), distributed under the [MIT License](https://github.com/gwtw/ts-fibonacci-heap/blob/v2.0.9/LICENSE):
@@ -826,7 +1036,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### https-proxy-agent
 
-This product includes source derived from [https-proxy-agent](https://github.com/TooTallNate/proxy-agents) ([v7.0.5](https://github.com/TooTallNate/proxy-agents/tree/v7.0.5)), distributed under the [MIT License](https://github.com/TooTallNate/proxy-agents/blob/v7.0.5/LICENSE):
+This product includes source derived from [https-proxy-agent](https://github.com/TooTallNate/proxy-agents) ([v7.0.4](https://github.com/TooTallNate/proxy-agents/tree/v7.0.4)), distributed under the [MIT License](https://github.com/TooTallNate/proxy-agents/blob/v7.0.4/LICENSE):
 
 ```
 (The MIT License)
@@ -1229,7 +1439,7 @@ SOFTWARE.
 
 ### semver
 
-This product includes source derived from [semver](https://github.com/npm/node-semver) ([v7.6.3](https://github.com/npm/node-semver/tree/v7.6.3)), distributed under the [ISC License](https://github.com/npm/node-semver/blob/v7.6.3/LICENSE):
+This product includes source derived from [semver](https://github.com/npm/node-semver) ([v7.6.2](https://github.com/npm/node-semver/tree/v7.6.2)), distributed under the [ISC License](https://github.com/npm/node-semver/blob/v7.6.2/LICENSE):
 
 ```
 The ISC License

lib/metrics/recorders/database.js

@@ -61,10 +61,10 @@ function recordQueryMetrics(segment, scope, transaction) {
 
   if (this.raw) {
     transaction.agent.queries.add({
-      segment, 
+      segment,
       transaction,
-      type: this.type.toLowerCase(), 
-      query: this.raw, 
+      type: this.type.toLowerCase(),
+      query: this.raw,
       trace: this.trace
     })
   }

lib/otel/rules.js

@@ -49,6 +49,7 @@ class Rule {
   #name
   #spanKinds
   #requiredAttributes
+  #type
   #mappings
 
   /**
@@ -63,6 +64,7 @@ class Rule {
     }
 
     this.#name = input.name
+    this.#type = input.type
     this.#spanKinds = input.matcher.required_span_kinds?.map((v) => v.toLowerCase()) ?? []
     this.#requiredAttributes = input.matcher.required_attribute_keys ?? []
     this.#mappings = input.target.attribute_mappings ?? []
@@ -72,6 +74,10 @@ class Rule {
     return this.#name
   }
 
+  get type() {
+    return this.#type
+  }
+
   get isServerRule() {
     return this.#spanKinds.includes(Rule.OTEL_SPAN_KIND_SERVER)
   }

lib/otel/rules.json

@@ -229,6 +229,7 @@
   },
   {
     "name": "OtelDbClientRedis1_24",
+    "type": "db",
     "matcher": {
       "required_span_kinds": [
         "client"
@@ -267,6 +268,7 @@
   },
   {
     "name": "OtelDbClient1_24",
+    "type": "db",
     "matcher": {
       "required_span_kinds": [
         "client"
@@ -302,6 +304,7 @@
   },
   {
     "name": "OtelHttpClient1_23",
+    "type": "external",
     "matcher": {
       "required_metric_names": [
         "http.client.request.duration"
@@ -338,6 +341,7 @@
   },
   {
     "name": "OtelHttpClient1_20",
+    "type": "external",
     "matcher": {
       "required_metric_names": [
         "http.client.duration"
@@ -410,6 +414,7 @@
   },
   {
     "name": "FallbackClient",
+    "type": "external",
     "matcher": {
       "required_metric_names": [
         "rpc.client.duration",

lib/otel/segment-synthesis.js

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2024 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+const { RulesEngine } = require('./rules')
+const defaultLogger = require('../logger').child({ component: 'segment-synthesizer' })
+const NAMES = require('../metrics/names')
+const { SEMATTRS_HTTP_HOST } = require('@opentelemetry/semantic-conventions')
+
+class SegmentSynthesizer {
+  constructor(agent, { logger = defaultLogger } = {}) {
+    this.agent = agent
+    this.logger = logger
+    this.engine = new RulesEngine()
+  }
+
+  synthesize(otelSpan) {
+    const rule = this.engine.test(otelSpan)
+    if (!rule?.type) {
+      this.logger.debug(
+        'Cannot match a rule to span name: %s, kind %s',
+        otelSpan?.name,
+        otelSpan?.kind
+      )
+      return
+    }
+
+    if (rule?.type === 'external') {
+      return this.createExternalSegment(otelSpan)
+    }
+    this.logger.debug('Found type: %s, no synthesize rule currently built', rule.type)
+  }
+
+  // TODO: should we move these to somewhere else and use in the places
+  // where external segments are created in our agent
+  createExternalSegment(otelSpan) {
+    const context = this.agent.tracer.getContext()
+    const host = otelSpan.attributes[SEMATTRS_HTTP_HOST] || 'Unknown'
+    const name = NAMES.EXTERNAL.PREFIX + host
+    return this.agent.tracer.createSegment({
+      name,
+      parent: context.segment,
+      transaction: context.transaction
+    })
+  }
+}
+
+module.exports = SegmentSynthesizer

package.json

@@ -198,6 +198,7 @@
     "@grpc/proto-loader": "^0.7.5",
     "@newrelic/security-agent": "^2.0.0",
     "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/semantic-conventions": "^1.27.0",
     "@tyriar/fibonacci-heap": "^2.0.7",
     "concat-stream": "^2.0.0",
     "https-proxy-agent": "^7.0.1",

test/integration/core/crypto.test.js

@@ -26,7 +26,6 @@ test('pbkdf2', function (t, end) {
     crypto.pbkdf2('hunter2', 'saltine', 5, 32, 'sha1', function (err, key) {
       assert.ok(!err, 'should not error')
       assert.equal(key.length, 32)
-      debugger
       verifySegments({ agent, end, name: 'crypto.pbkdf2' })
     })
   })

test/integration/core/fs.test.js

@@ -854,7 +854,6 @@ test('read', async function (t) {
       plan.equal(agent.getTransaction(), trans, 'should preserve transaction')
       const children = trans.trace.getChildren(trans.trace.root.id)
       plan.equal(children.length, 0, 'should not create any segments')
-
     })
   })