Skip to content

Commit

Permalink
Merge pull request #19438 from ptang-nr/NR-323599-update-logs-api-doc
Browse files Browse the repository at this point in the history
chore(browser): update doc regarding logs api `wrapLogger`
  • Loading branch information
WriteMayur authored Dec 5, 2024
2 parents 4342e75 + ce5e2fe commit 27d0add
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ For more information, see the [npm browser installation documentation](https://w

After you provide this method with a valid parent container and child function name, the browser agent will record a new log event every time the wrapped function is invoked. The first argument is passed to the invoked function as the log's message. See the [Logs UI](/docs/logs/ui-data/use-logs-ui/) for more information about log events.

Optional configurations can be passed along with these captured logs with the `options` argument. Any custom attributes supplied to the API call in the `options` argument (`options.customAttributes`) will be appended as top-level attributes on every log event created by this wrapper. You can control the `level` of the captured log by supplying a `level` to the `options` argument (`options.level`), which defaults to `info`. Note that once successfully wrapped, the function's logging detection can't be altered.
You can pass the optional configurations along with these captured logs using the `options` argument. Any custom attributes supplied to the API call in the `options` argument (`options.customAttributes`) are appended as top-level attributes on every log event created by this wrapper. Supply a `level` to the `options` argument (`options.level`) to control the `level` of captured log. By default, the log level is set to `info`.

## Parameters [#wrap-parameters]

Expand Down

0 comments on commit 27d0add

Please sign in to comment.