Skip to content

Commit

Permalink
Merge pull request #18800 from lavarou/feat/php-agent-configuration/c…
Browse files Browse the repository at this point in the history 
…omposer-api

feat(apm/php): add `newrelic.vulnerability_management.composer_api.enabled` description
  • Loading branch information
@rhetoric101
rhetoric101 authored Oct 1, 2024
2 parents 8c2d585 + 5d9c99a commit 993a8bf
Show file tree
Hide file tree
Showing 2 changed files with 113 additions and 54 deletions.
159 changes: 108 additions & 51 deletions src/content/docs/apm/agents/php-agent/configuration/php-agent-configuration.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3934,6 +3934,114 @@ Setting one of the following tags will help you identify which versions of your

An upcoming release of errors inbox will automatically track which versions of your software are producing errors. Any version data will also be displayed in [CodeStream](/docs/codestream/how-use-codestream/performance-monitoring/#buildsha).

## Vulnerability management settings [#inivar-vulnerability-management]

This section lists the settings that affect the reporting of PHP packages.

<CollapserGroup>
<Collapser
id="inivar-package-detection"
title="newrelic.vulnerability_management.package_detection.enabled"
>
<table>
<tbody>
<tr>
<th>
Scope:
</th>

<td>
PERDIR
</td>
</tr>

<tr>
<th>
Type:
</th>

<td>
Boolean
</td>
</tr>

<tr>
<th>
Default:
</th>

<td>
`true`
</td>
</tr>

<tr>
<th>
Notes:
</th>

<td>
Introduced in PHP agent version 10.17
</td>
</tr>
</tbody>
</table>

When set to `true`, the agent will send up package detection information that can be viewed on the environment page.
</Collapser>

<Collapser
id="inivar-package-detection-use-composer-api"
title="newrelic.vulnerability_management.composer_api.enabled"
>
<table>
<tbody>
<tr>
<th>
Scope:
</th>

<td>
PERDIR
</td>
</tr>

<tr>
<th>
Type:
</th>

<td>
Boolean
</td>
</tr>

<tr>
<th>
Default:
</th>

<td>
`false`
</td>
</tr>
<tr>
<th>
Notes:
</th>

<td>
Introduced in PHP agent version 11.2
</td>
</tr>
</tbody>
</table>

When set to `true`, the agent will try using [Composer's runtime API](https://getcomposer.org/doc/07-runtime.md) for package detection.

</Collapser>
</CollapserGroup>

## Other .ini settings [#inivar-rare-settings]

This section lists the remaining newrelic.ini settings.
Expand Down Expand Up @@ -4294,55 +4402,4 @@ This section lists the remaining newrelic.ini settings.

Enables the detection of frameworks and libraries when preloading is enabled. Preloading was introduced in PHP version 7.4. `newrelic.preload_framework_library_detection` will only take effect when `opcache.preload` is set in the `php.ini` file.
</Collapser>

<Collapser
id="inivar-package-detection"
title="newrelic.vulnerability_management.package_detection.enabled"
>
<table>
<tbody>
<tr>
<th>
Scope:
</th>

<td>
SYSTEM
</td>
</tr>

<tr>
<th>
Type:
</th>

<td>
Boolean
</td>
</tr>

<tr>
<th>
Default:
</th>

<td>
`true`
</td>
</tr>

<tr>
<th>
Notes:
</th>

<td>
Introduced in PHP agent version 10.17
</td>
</tr>
</tbody>
</table>

When set to `true`, the agent will send up package detection information that can be viewed on the environment page.
</Collapser>
</CollapserGroup>
8 changes: 5 additions & 3 deletions src/content/docs/vulnerability-management/integrations/intro.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ CVE detection coverage differs between agents:
id="php-packages"
title="PHP package support"
>
Our New Relic [PHP APM Agent](/docs/apm/agents/php-agent/getting-started/introduction-new-relic-php) currently supports detecting CVEs related to packages from the following frameworks:
By default, New Relic [PHP APM Agent](/docs/apm/agents/php-agent/getting-started/introduction-new-relic-php) supports detecting CVEs in the core packages of the following frameworks:

<table>
<thead>
Expand Down Expand Up @@ -268,9 +268,11 @@ CVE detection coverage differs between agents:
</tbody>
</table>

We recommend using [officially supported versions](/docs/apm/agents/php-agent/getting-started/php-agent-compatibility-requirements/) of PHP. Note, the PHP agent differs from other language agents as it's not aware of packages until they are used. If the version is not specified in the package's source code in an accessible way, the PHP agent is unable to provide version detection information for that package, and vulnerabilities will not be shown.
We recommend you use [officially supported versions](/docs/apm/agents/php-agent/getting-started/php-agent-compatibility-requirements/) of PHP.
If your project uses [Composer](https://getcomposer.org/) to manage dependencies, you can configure the New Relic [PHP APM agent](/docs/apm/agents/php-agent/getting-started/introduction-new-relic-php) to detect vulnerabilities in all your packages. This feature is disabled by default.

See the Vulnerability Management settings in [PHP agent configuration](/docs/apm/agents/php-agent/configuration/php-agent-configuration/#inivar-vulnerability-management) for detailed information about how to configure the integration in the New Relic PHP APM agent.

To disable package detection for Vulnerability Management, you can find more information on the [configuration page](/docs/apm/agents/php-agent/configuration/php-agent-configuration/#inivar-package-detection).
</Collapser>
</CollapserGroup>

Expand Down

0 comments on commit 993a8bf

Please sign in to comment.