Skip to content

Commit 66ee465

Browse files
chore: Adjust typing tag (#1568)
1 parent 97f8eaa commit 66ee465

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,9 @@ browserAgent.recordCustomEvent(...)
245245

246246
## Deploying one or more "micro" agents per page
247247

248+
> **ℹ️ Note:**
249+
> This loader strategy is slated to be deprecated and eventually removed in a future product release. For better memory usage, build size impacts, entity management and relationships -- a new strategy focused around using a single centralized browser agent instance is actively being worked on. Reach out by email to browser-agent@newrelic.com for more information or if you would like to participate in a limited preview when the feature is ready for early adoption.
250+
248251
The examples above use the `Agent` class at their core, which is ideal for most cases as it will automatically detect page-level events across your web application.
249252

250253
Using the `MicroAgent` class, it is possible to skip the "auto" instrumentation phases of the other loader types, and provide a *very small* agent designed for capturing data in a controlled manner via the API interfaces. The `MicroAgent` captures a distinct `PageView` event when instantiated, and additional `PageAction` and `JavaScriptError` events may be captured by calling the `noticeError` and `addPageAction` methods.

src/loaders/micro-agent.js

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,13 @@ const nonAutoFeatures = [
3434
]
3535

3636
/**
37-
* @deprecated This feature has been deprecated and will be removed in a future release. A future product centralizing around a single agent instance will be released as a replacement, at which time this loader will be removed.
38-
* --- A minimal agent class designed to only respond to manual user input. As such, this class does not
37+
* A minimal agent class designed to only respond to manual user input. As such, this class does not
3938
* automatically instrument. Instead, each MicroAgent instance will lazy load the required features and can support loading multiple instances on one page.
4039
* Out of the box, it can manually handle and report Page View, Page Action, and Error events.
40+
*
41+
* @note This loader strategy is slated to be deprecated and eventually removed in a future product release. For better memory usage, build size impacts, entity management and relationships -- a new strategy focused around using a single centralized browser agent instance is actively being worked on. Reach out by email to browser-agent@newrelic.com for more information or if you would like to participate in a limited preview when the feature is ready for early adoption.
42+
*
43+
* @see {@link https://www.npmjs.com/package/@newrelic/browser-agent#deploying-one-or-more-micro-agents-per-page} for more information in the documentation.
4144
*/
4245
export class MicroAgent extends MicroAgentBase {
4346
/**

0 commit comments

Comments
 (0)