The behaviour of the Scope Agent can be modified using environment variables or a configuration file
scope.yml in the source root of the project.
If these properties are manually configured, use
falseonly for the boolean value.
Changing Scope Logger level
You can change the Scope Logger level using the values
trace levels. By default, Scope Logger level is
Changing Scope Logger root path
By default, Scope Java agent will create a log file in the following folder path based on your platform:
You can set the Scope Logger root path manually.
Disabling Scope instrumentation
Scope auto instruments your code and tests by default. You can disable this behaviour.
Changing service name
You can specify the name of the service when sending data to Scope. Scope uses
default as fallback.
Setting Scope as Global Tracer
If you set Scope as OpenTracing Global Tracer, your own spans will be captured and shown as part of the Scope trace view for a certain test.
Change testing mode
This variable indicates whether the agent is running tests (
true) or it is being used for runtime instrumentation (
SCOPE_TESTING_MODE is not set, the agent sets to
true when testing frameworks are present in classpath. Otherwise, the agent sets to
Adding agent metadata
You can send arbitrary metadata for every test associated with certain commit which will be shown by Scope.
Additionally, it is possible to set an environment variable as metadata value for a certain key, whose final value will be evaluated at runtime.
Select agent metadata as test configuration
Yon can select metadata keys to be considered as relevant in the configuration of the test.
By default, Scope Java agent adds the
java.version metadata key to the test configuration.
Adding Code Path information
You can add Code Path information to certain spans to show the executed lines given a certain test in a certain commit.
Apart from the activation/deactivation of the Code Path flag, it is needed to configure which packages will be needed to be tracked by the Scope Java Agent.
You just need to indicate the base package, and every sub-package, starting from that point, will be included as observable package.
base_packages: "foo.bar.xyz, bar.foo"
Include DB statements values in DB span tags
You can include DB statement values in the related DB spans.
By default, Scope Java Agent will not send DB statement values as they are considered sensitive information.
Include HTTP payloads in HTTP span tags
You can include HTTP payloads in the related HTTP spans, truncated to the first 512 bytes.
By default, Scope Java Agent will not send HTTP payloads as they are considered sensitive information.
Include additional HTTP Headers in HTTP span tags
You can include additional HTTP Headers in HTTP span tags.
By default, Scope Java agent will send common HTTP headers, filtering the content of those which can contain sensitive information, such as:
Note that the content of every header configured explicitly to be shown in the HTTP span tags will not be filtered.
Scope Intelligent Test Runner
Scope's Intelligent Test Runner will selectively run only the subset of tests affected by code changes.
Enable or disable
Through this configuration parameter you can enable or disable Scope Intelligent Test Runner. The rest of
runner configuration parameters will have no effect if
enabled is false.
Included and excluded branches
There are two parameters to control the branches in which you want to run the Scope Intelligent Test Runner:
runner.exclude_branches. The way they work is the following:
runner.include_branchesis configured, only configured branches are included.
runner.exclude_branchesis configured, all branches except configured branches are included.
- If both
runner.exclude_branchesare configured, runner only will take into account
runner.include_branches. If the same branch is configured, a warning message will be shown.