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.

Sign up for GitHub

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

docs: AIM Disclaimer #19653

Merged
merged 2 commits into from
Jan 16, 2025
Merged

docs: AIM Disclaimer #19653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ae83aa
docs: Add AI Monitoring Disclaimer
RyanKadri Jan 9, 2025
56fe21e
minor enhancement
cbehera-newrelic Jan 16, 2025
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
7 changes: 6 additions & 1 deletion src/content/docs/apm/agents/go-agent/configuration/go-agent-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1765,6 +1765,11 @@ 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 records a streaming copy of inputs and outputs sent to and from the models you choose to monitor, including any personal information contained therein.
You're 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 +3839,7 @@ Next initialize and enable the security agent.
nrsecurityagent.ConfigSecurityValidatorServiceEndPointUrl("wss://csec.nr-data.net"),
nrsecurityagent.ConfigSecurityEnable(true),
)
```
```


````
Expand Down
5 changes: 5 additions & 0 deletions ...cs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1541,6 +1541,11 @@
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 records a streaming copy of inputs and outputs sent to and from the models you choose to monitor, including any personal information contained therein.

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": 121}}}, "severity": "INFO"}
You're 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 1546 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": 1546, "column": 3}}}, "severity": "INFO"}

Check warning on line 1546 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": 1546, "column": 94}}}, "severity": "INFO"}
</Callout>

<CollapserGroup>
<Collapser
id="ai-monitoring-enabled"
Expand Down
6 changes: 5 additions & 1 deletion src/content/docs/apm/agents/net-agent/configuration/net-agent-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- 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 @@

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
22 changes: 13 additions & 9 deletions ...m/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,6 +927,10 @@
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 @@
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 @@
</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 @@
</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 @@
</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
13 changes: 9 additions & 4 deletions ...ntent/docs/apm/agents/python-agent/configuration/python-agent-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@
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,11 @@
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 records a streaming copy of inputs and outputs sent to and from the models you choose to monitor, including any personal information contained therein.

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": 121}}}, "severity": "INFO"}
You're 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 1453 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": 1453, "column": 3}}}, "severity": "INFO"}

Check warning on line 1453 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": 1453, "column": 94}}}, "severity": "INFO"}
</Callout>

<CollapserGroup>
<Collapser
id="ai-monitoring-enabled"
Expand Down Expand Up @@ -4379,7 +4384,7 @@
</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 +5854,4 @@
enabled = false
```
</Collapser>
</CollapserGroup>
</CollapserGroup>
5 changes: 5 additions & 0 deletions src/install/ai-monitoring/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,8 @@ 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 records a streaming copy of inputs and outputs sent to and from the models you choose to monitor, including any personal information contained therein.
You're 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>
Loading