Skip to content

Commit

Permalink
docs: Add AI Monitoring Disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanKadri committed Jan 9, 2025
1 parent f3c9731 commit c1524c5
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1765,6 +1765,10 @@ This section includes Go agent configurations for setting up AI monitoring.
If distributed tracing is disabled or high security mode is enabled, AI monitoring will not collect AI data.
</Callout>

<Callout variant="important">
When enabled, AI Monitoring will record a streaming copy of inputs and outputs sent to and from the models you choose to monitor, including any personal information contained therein. When using AI Monitoring, you are responsible for obtaining consent from your model users that their interactions may be recorded by a third party (New Relic) for the purpose of providing the AI Monitoring feature.
</Callout>

<CollapserGroup>
<Collapser
id="ai-monitoring-enabled"
Expand Down Expand Up @@ -3834,7 +3838,7 @@ Next initialize and enable the security agent.
nrsecurityagent.ConfigSecurityValidatorServiceEndPointUrl("wss://csec.nr-data.net"),
nrsecurityagent.ConfigSecurityEnable(true),
)
```
```


````
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1541,6 +1541,10 @@ This section details the Java agent configuration options for [AI monitoring](/d
If distributed tracing is disabled or high security mode is enabled, AI monitoring will not collect AI data.
</Callout>

<Callout variant="important">
When enabled, AI Monitoring will record a streaming copy of inputs and outputs sent to and from the models you choose to monitor, including any personal information contained therein. When using AI Monitoring, you are responsible for obtaining consent from your model users that their interactions may be recorded by a third party (New Relic) for the purpose of providing the AI Monitoring feature.

Check warning on line 1545 in src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'. Raw Output: {"message": "[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.", "location": {"path": "src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx", "range": {"start": {"line": 1545, "column": 124}}}, "severity": "INFO"}

Check warning on line 1545 in src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.SentenceLength] Try to keep sentences short (< 30 words). Raw Output: {"message": "[Microsoft.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx", "range": {"start": {"line": 1545, "column": 187}}}, "severity": "INFO"}

Check warning on line 1545 in src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Passive] 'be recorded' looks like passive voice. Raw Output: {"message": "[Microsoft.Passive] 'be recorded' looks like passive voice.", "location": {"path": "src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx", "range": {"start": {"line": 1545, "column": 305}}}, "severity": "INFO"}
</Callout>

<CollapserGroup>
<Collapser
id="ai-monitoring-enabled"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ tags:
- Configuration
metaDescription: 'How to configure the New Relic .NET agent using newrelic.config, including startup and instrumentation options, and disabling unwanted features.'
redirects:
- /docs/agents/net-agent/configuration/net-agent-configuration
- /docs/agents/net-agent/configuration/net-agent-configuration
- /docs/general/dotnet-agent-configuration
- /docs/dotnet/dotnet-agent-configuration
- /docs/agents/net-agent/installation/install/dotnet-agent
Expand Down Expand Up @@ -3704,6 +3704,10 @@ NEW_RELIC_CODE_LEVEL_METRICS_ENABLED=true

By default, AI monitoring is disabled. To enable AI monitoring, set the `enabled` attribute to `true` in the `aiMonitoring` element. The `aiMonitoring` element is a child of the `configuration` element.

<Callout variant="important">
When enabled, AI Monitoring will record a streaming copy of inputs and outputs sent to and from the models you choose to monitor, including any personal information contained therein. When using AI Monitoring, you are responsible for obtaining consent from your model users that their interactions may be recorded by a third party (New Relic) for the purpose of providing the AI Monitoring feature.

Check warning on line 3708 in src/content/docs/apm/agents/net-agent/configuration/net-agent-configuration.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'. Raw Output: {"message": "[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.", "location": {"path": "src/content/docs/apm/agents/net-agent/configuration/net-agent-configuration.mdx", "range": {"start": {"line": 3708, "column": 124}}}, "severity": "INFO"}
</Callout>

```xml
<aiMonitoring enabled="true" />
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -927,6 +927,10 @@ This section includes Node.js agent configurations for setting up AI monitoring.
You must enable [distributed tracing](/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration/#dt-main) to capture AI data. It's turned on by default in Node.js agents 8.3.0 and higher. If you've enabled high security mode, AI monitoring will not work.
</Callout>

<Callout variant="important">
When enabled, AI Monitoring will record a streaming copy of inputs and outputs sent to and from the models you choose to monitor, including any personal information contained therein. When using AI Monitoring, you are responsible for obtaining consent from your model users that their interactions may be recorded by a third party (New Relic) for the purpose of providing the AI Monitoring feature.

Check warning on line 931 in src/content/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'. Raw Output: {"message": "[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.", "location": {"path": "src/content/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration.mdx", "range": {"start": {"line": 931, "column": 124}}}, "severity": "INFO"}

Check warning on line 931 in src/content/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.SentenceLength] Try to keep sentences short (< 30 words). Raw Output: {"message": "[Microsoft.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "src/content/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration.mdx", "range": {"start": {"line": 931, "column": 187}}}, "severity": "INFO"}

Check warning on line 931 in src/content/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Passive] 'be recorded' looks like passive voice. Raw Output: {"message": "[Microsoft.Passive] 'be recorded' looks like passive voice.", "location": {"path": "src/content/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration.mdx", "range": {"start": {"line": 931, "column": 305}}}, "severity": "INFO"}
</Callout>

<CollapserGroup>
<Collapser
id="ai-monitoring-enabled"
Expand Down Expand Up @@ -1426,7 +1430,7 @@ This section defines the variables for [Node.js agent attributes](/docs/agents/n
Prefix of attributes to exclude from all destinations. Allows `*` as wildcard at end. For example, in the config file, this would include all parameters except `somethingSecret`:

```js
attributes: {
attributes: {
include: [ 'request.parameters.*' ],
exclude: [ 'request.parameters.somethingSecret' ]
}
Expand Down Expand Up @@ -1471,28 +1475,28 @@ This section defines the variables for [Node.js agent attributes](/docs/agents/n
</tbody>
</table>

Prefix of attributes to include from all destinations. Allows `*` as wildcard at end.
Prefix of attributes to include from all destinations. Allows `*` as wildcard at end.

For example, in the `config` file, this would include all parameters:

```js
attributes: {
attributes: {
include: [ 'request.parameters.*' ]
}
```

Using this example Express route definition and request URL:

```js
app.get('/api/users/:id', myMiddleware, myController)
```

```sh
curl http://localhost:3000/api/users/abc123?id=true
```

The _route parameter_ is `id`, and has a value of `abc123`. This becomes the attribute `request.parameters.route.id: abc123` on the Transaction, root Segment, and Span. This example also has a _query parameter_ of `id`, which has a value of `true`. This would become the attribute `request.parameters.id: true` on the Transaction, root Segment, and Span.

</Collapser>

<Collapser
Expand Down Expand Up @@ -2859,7 +2863,7 @@ This section defines the Node.js agent variables in the order they typically app
</tbody>
</table>

Prefix of attributes to exclude from transaction events. Allows `*` as wildcard at end.
Prefix of attributes to exclude from transaction events. Allows `*` as wildcard at end.
</Collapser>

<Collapser
Expand Down Expand Up @@ -2900,7 +2904,7 @@ This section defines the Node.js agent variables in the order they typically app
</tbody>
</table>

Prefix of attributes to include in transaction events. Allows `*` as wildcard at end.
Prefix of attributes to include in transaction events. Allows `*` as wildcard at end.
</Collapser>
</CollapserGroup>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ Here are detailed descriptions of each configuration method:
Starting with Python 3.11 the newer `.toml` syntax for configuration was added to the [standard library](https://docs.python.org/3/library/tomllib.html). Agent version `10.3.0` added support for using this newer format.
</Callout>
The configuration file uses Tom's Obvious Minimal Language `.toml` files. For more information, see the [official file format documentation](https://toml.io/en/).

To use the `.toml` syntax, the configuration file's name must end with `.toml` to indicate the syntax type. The standard `pyproject.toml` may be used alongside configuration for other libraries, or you may use a more specific file like `newrelic.toml`.

The basic structure should look like the following:

```ini
Expand Down Expand Up @@ -1448,6 +1448,10 @@ This section includes Python agent configurations for setting up AI monitoring.
You must enable [distributed tracing](/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration/#dt-main) to capture AI data. It's turned on by default in Python agent versions 7.0.0.166 and higher.
</Callout>

<Callout variant="important">
When enabled, AI Monitoring will record a streaming copy of inputs and outputs sent to and from the models you choose to monitor, including any personal information contained therein. When using AI Monitoring, you are responsible for obtaining consent from your model users that their interactions may be recorded by a third party (New Relic) for the purpose of providing the AI Monitoring feature.

Check warning on line 1452 in src/content/docs/apm/agents/python-agent/configuration/python-agent-configuration.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'. Raw Output: {"message": "[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.", "location": {"path": "src/content/docs/apm/agents/python-agent/configuration/python-agent-configuration.mdx", "range": {"start": {"line": 1452, "column": 124}}}, "severity": "INFO"}

Check warning on line 1452 in src/content/docs/apm/agents/python-agent/configuration/python-agent-configuration.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.SentenceLength] Try to keep sentences short (< 30 words). Raw Output: {"message": "[Microsoft.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "src/content/docs/apm/agents/python-agent/configuration/python-agent-configuration.mdx", "range": {"start": {"line": 1452, "column": 187}}}, "severity": "INFO"}

Check warning on line 1452 in src/content/docs/apm/agents/python-agent/configuration/python-agent-configuration.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Passive] 'be recorded' looks like passive voice. Raw Output: {"message": "[Microsoft.Passive] 'be recorded' looks like passive voice.", "location": {"path": "src/content/docs/apm/agents/python-agent/configuration/python-agent-configuration.mdx", "range": {"start": {"line": 1452, "column": 305}}}, "severity": "INFO"}
</Callout>

<CollapserGroup>
<Collapser
id="ai-monitoring-enabled"
Expand Down Expand Up @@ -4379,7 +4383,7 @@ For some tips on configuring logs for the Python agent, see [Configure Python lo
</tr>
</tbody>
</table>

A case-insensitive list of label names to exclude when you enable including labels in logs. This attribute does not support wildcards or regex.
<Callout variant="important">When adding labels as attributes, the agent prefixes the keys with `tags.`. This prefix is <b>NOT</b> included when matching against the exclude filtering rules.</Callout>
</Collapser>
Expand Down Expand Up @@ -5849,4 +5853,4 @@ To disable default instrumentation, provide a special `import-hook` section corr
enabled = false
```
</Collapser>
</CollapserGroup>
</CollapserGroup>
Original file line number Diff line number Diff line change
Expand Up @@ -1020,6 +1020,9 @@ Valid values (ordered lowest to highest):
This section includes Ruby agent configurations for setting up AI monitoring.

<Callout variant='important'>You need to enable distributed tracing to capture trace and feedback data. It is turned on by default in Ruby agents 8.0.0 and higher.</Callout>
<Callout variant='important'>
When enabled, AI Monitoring will record a streaming copy of inputs and outputs sent to and from the models you choose to monitor, including any personal information contained therein. When using AI Monitoring, you are responsible for obtaining consent from your model users that their interactions may be recorded by a third party (New Relic) for the purpose of providing the AI Monitoring feature.
</Callout>

<CollapserGroup>

Expand Down Expand Up @@ -3374,4 +3377,4 @@ not be reported to New Relic. Each string in this array will be turned into a re
If `true`, the agent automatically detects that it is running in a Pivotal Cloud Foundry environment.
</Collapser>

</CollapserGroup>
</CollapserGroup>
4 changes: 4 additions & 0 deletions src/install/ai-monitoring/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,7 @@ When you [install AI monitoring](/docs/ai-monitoring/intro-to-ai-monitoring), yo
<figcaption>
Go to **[one.newrelic.com](https://one.newrelic.com) > All Capabilities > AI Monitoring > AI Responses**
</figcaption>

<Callout variant="important">
When enabled, AI Monitoring will record a streaming copy of inputs and outputs sent to and from the models you choose to monitor, including any personal information contained therein. When using AI Monitoring, you are responsible for obtaining consent from your model users that their interactions may be recorded by a third party (New Relic) for the purpose of providing the AI Monitoring feature.
</Callout>

0 comments on commit c1524c5

Please sign in to comment.