Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Remove examples/shim #2484

Merged
merged 5 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions examples/.eslintrc.js

This file was deleted.

1 change: 0 additions & 1 deletion examples/.gitignore

This file was deleted.

7 changes: 0 additions & 7 deletions examples/README.md

This file was deleted.

13 changes: 13 additions & 0 deletions examples/instrumentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

We have moved our examples and tutorials over to [newrelic-node-examples](https://github.com/newrelic/newrelic-node-examples) as more robust applications. Here are some quick links for implementing custom instrumentation and using our shim API:

* [instrument](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/instrument) - example application that uses the [newrelic.instrument API](https://newrelic.github.io/node-newrelic/API.html#instrument) and associated [shim API](https://newrelic.github.io/node-newrelic/Shim.html) to instrument a toy queue library called Job Queue
* [instrumentDatastore](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/instrument-datastore) - example application that uses the [newrelic.instrumentDatastore API](https://newrelic.github.io/node-newrelic/API.html#instrumentDatastore) and [datastore shim API](https://newrelic.github.io/node-newrelic/DatastoreShim.html) to instrument a toy datastore called Simple Datastore
* [instrumentMessages](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/instrument-messages) - example application that uses the [newrelic.instrumentMessages API](https://newrelic.github.io/node-newrelic/API.html#instrumentMessages) and associated [messaging shim API](https://newrelic.github.io/node-newrelic/MessageShim.html) to instrument a toy messaging library called Nifty Messages
* [instrumentWebframework](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/instrument-webframework) - example application that uses the [newrelic.instrumentWebframework API](https://newrelic.github.io/node-newrelic/API.html#instrumentWebframework) and associated [WebFramework shim API](https://newrelic.github.io/node-newrelic/WebFrameworkShim.html) to instrument a hypothetical web framework
* [attributesAndEvents](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/attributes-and-events) - example application that demonstrates how to share custom [attributes](https://newrelic.github.io/node-newrelic/API.html#addCustomAttribute) and [events](https://newrelic.github.io/node-newrelic/API.html#recordCustomEvent)
* [backgroundTransactions](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/background-transactions) - example application that uses the newrelic API to create [background transactions](https://newrelic.github.io/node-newrelic/API.html#startBackgroundTransaction)
* [segments](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/segments) - example application that demonstrates how to use the [newrelic.startSegment API](https://newrelic.github.io/node-newrelic/API.html#startSegment) in a variety of cases: callback-based, promise-based, asyncronously, and syncronously
* [distributed tracing](https://github.com/amychisholm03/newrelic-node-examples/blob/main/custom-instrumentation/distributed-tracing) - example application that demonstrates distributed tracing

To request additional examples, please [file an issue](https://github.com/newrelic/node-newrelic/issues)!
amychisholm03 marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 5 additions & 0 deletions examples/jsdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"instrumentation":{
"title": "Instrumentation Examples"
}
}
322 changes: 0 additions & 322 deletions examples/shim/Context-Preservation.md

This file was deleted.

Loading