Documentation/Type definitions for Browser Agent configuration API options

[alexUXUI]

Summary

As a user of Browser Agent, I would like to have reference material for the Browser Agent configuration options in a format that is low effort for engineers to access.

Currently, there is tons of great documentation in the form of guides and tutorials here: https://docs.newrelic.com/docs/browser/new-relic-browser/configuration/browser-app-settings-page/

However, despite my best faith attempts, I cannot seem to find an API definition, declaring all the configuration options available to me.

Lastly, I came to the source code, and I cannot find type definitions.

Desired Behavior

There is a place that says what the configuration options for Browser Agent are and I can access this place through the documentation website, or intellisense, or NPM docs.

Possible Solution

1. API section in docs website
2. Type Definitions shipped with NPM package
3. Docs shipped with NPM package

Additional context

This all started when I wanted to figure out if there was some way I could give a browser agent a name of unique ID of sorts so that we can partition based on env.

[workato-integration]

https://new-relic.atlassian.net/browse/NR-358047

[metal-messiah]

Hi @alexUXUI

Thanks for reaching out with feedback. Have you had a chance to check out the API documentation here? On the side nav, there are links to all the various browser agent API methods.

As for typings, the NPM package ships with type definitions, which can be found in the dist directory (of the installed package), and should be automatically detected by your IDE when installing the NPM package. A web link using unpkg (just for example reference) can be found here.

I'll take the feedback about Docs shipped with NPM package to the team and work on prioritizing that. Please let me know if the above does not meet what you were looking for and we can figure out where to go from there!

[alexUXUI]

Thanks so much for taking a look at this @metal-messiah!

Have you had a chance to check out the API documentation here?

Yep, that was the first place I looked. The tutorials and guides are great. I am just looking for the specific options object to pass the Browser Agent.

As for typings, the NPM package ships with type definitions, which can be found in the dist directory

You are correct but there is no type definition for the options object

I'll take the feedback about Docs shipped with NPM package to the team and work on prioritizing that

Awesome! Thanks so much for your collaboration and consideration. I am absolutely floored with New Relic as a long time Sentry/Splunk et. al. user.

I'd like my org to centralize as much of our operations as we can in New Relic.

[metal-messiah]

Perfect thanks for expanding on that! I'm going to create some stories to expand the docs, particularly around NPM which has been a sore-spot here for some time. Hopefully should get those addressed within the next few weeks

[metal-messiah]

Just an update @alexUXUI. Tickets have been added to our backlog for adding documentation in the docs site and NPM readme, and adding typings for the options intended to be passed to the NPM entry point. These tickets will likely be pulled into an upcoming sprint. Closing this issue for now, feel free to re-open if something else comes up. Thanks for the feedback!