refactor: remove examples/api/ (#2381)

newrelic · Jul 22, 2024 · fb964de · fb964de
1 parent b878930
commit fb964de
Show file tree

Hide file tree

Showing 15 changed files with 2 additions and 547 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -1,17 +1,7 @@
 # node-newrelic examples
 
-This directory contains examples of using the New Relic Node.js agent. You can run them by copying them into a new directory that contains a `newrelic.js` configuration file, like this:
+We are in the process of migrating these examples over to [newrelic-node-examples](https://github.com/newrelic/newrelic-node-examples) as more robust applications. If you are looking for the api/background-transactions, api/distributed-tracing, or api/segments examples, they are now [here](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation) as stand-alone applications.
 
-```bash
-$ mkdir node-newrelic-examples
-$ cd node-newrelic-examples
-$ npm i newrelic
-$ cp node_modules/newrelic/newrelic.js .
-$ # edit newrelic.js with your configuration details, like app name
-$ wget https://raw.githubusercontent.com/newrelic/node-newrelic/main/examples/api/background-transactions/example1-basic.js
-$ node example1-basic.js
-```
-
-Metrics generated by the examples will then show up in your New Relic One interface.
+The *shim* subdirectory and its revised contents will also be moved over to newrelic-node-examples at a later date.
 
 To request additional examples, please [file an issue](https://github.com/newrelic/node-newrelic/issues)!
diff --git a/examples/api/background-transactions/example-addCustomAttribute.js b/examples/api/background-transactions/example-addCustomAttribute.js
diff --git a/examples/api/background-transactions/example-addCustomAttributes.js b/examples/api/background-transactions/example-addCustomAttributes.js
diff --git a/examples/api/background-transactions/example-addCustomSpanAttribute.js b/examples/api/background-transactions/example-addCustomSpanAttribute.js
diff --git a/examples/api/background-transactions/example-addCustomSpanAttributes.js b/examples/api/background-transactions/example-addCustomSpanAttributes.js
diff --git a/examples/api/background-transactions/example-recordCustomEvent.js b/examples/api/background-transactions/example-recordCustomEvent.js
diff --git a/examples/api/background-transactions/example1-basic.js b/examples/api/background-transactions/example1-basic.js
diff --git a/examples/api/background-transactions/example2-grouping.js b/examples/api/background-transactions/example2-grouping.js
diff --git a/examples/api/background-transactions/example3-results.js b/examples/api/background-transactions/example3-results.js
diff --git a/examples/api/background-transactions/example4-promises.js b/examples/api/background-transactions/example4-promises.js
diff --git a/examples/api/distributed-tracing/example1-background.js b/examples/api/distributed-tracing/example1-background.js