The JaCoCo Agent Framework causes an application to be automatically configured to work with a bound JaCoCo Service.
| Detection Criterion | Existence of a single bound JaCoCo service.
|
| Tags | jacoco-agent=<version> |
Users may optionally provide their own JaCoCo service. A user-provided JaCoCo service must have a name or tag with jacoco in it so that the JaCoCo Agent Framework will automatically configure the application to work with the service.
The credential payload of the service may contain the following entries:
| Name | Description |
|---|---|
address |
The host for the agent to connect to or listen on |
excludes |
(Optional) A list of class names that should be excluded from execution analysis. The list entries are separated by a colon (:) and may use wildcard characters (* and ?). |
includes |
(Optional) A list of class names that should be included in execution analysis. The list entries are separated by a colon (:) and may use wildcard characters (* and ?). |
port |
(Optional) The port for the agent to connect to or listen on |
output |
(Optional) The mode for the agent. Possible values are either tcpclient (default) or tcpserver. |
For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to Configuration and Extension.
The framework can be configured by modifying the [config/jacoc_agent.yml][] file in the buildpack fork. The framework uses the Repository utility support and so it supports the version syntax defined there.
| Name | Description |
|---|---|
repository_root |
The URL of the JaCoCo repository index (details). |
version |
The version of JaCoCo to use. Candidate versions can be found in this listing. |
The framework can also be configured by overlaying a set of resources on the default distribution. To do this, add files to the resources/jacoco_agent directory in the buildpack fork. For example, to override the default jacoco.yml add your custom file to resources/jacoco_agent/jacoco.yml.