erlang:profile

Full name:

eu.lindenbaum:maven-erlang-plugin:2.2.0:profile

Description:

Performs function profiling using eprof, by executing any EUnit test modules, with the suffix [module]_prof.erl, found among the test sources. The profiling result are filtered and written out to the file (PROFILING-${project.artifactId}.txt), which may be used to generate a profiling-report.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Since version: 2.1.0.
  • Binds by default to the lifecycle phase: pre-site lifecycle="site".
  • Invokes the execution of the lifecycle phase test-compile prior to executing itself.

Optional Parameters

Name Type Since Description
cookie String 2.1.0 The cookie to use for the java and the backend node.
details boolean 2.1.0 Setting this to true will print the complete profiling results, and not only the profiling top-10.
Default value is: false.
erlCommand String 2.1.0 The erlang command used to start an erlang backend node. The path must exist and the destination must be executable. If the given command does not fullfill these requirements erl is used (assuming the command is part of the hosts PATH). The path must not contain any arguments.
silent boolean 2.1.0 Setting this to true will silent the console output and only generate the profiling output file.
Default value is: false.
test String 2.1.0 Setting this to some test module name, or a comma separated list of test module names, will use only those tests for profiling.
timeout int 2.1.0 The time, in seconds, that the full profiling is allowed to take. Must be a positive integer. If the profiling tests run longer than this, without responding with any results, it is considered to have failed.
Default value is: 600.

Parameter Details

cookie:

The cookie to use for the java and the backend node.
  • Type: java.lang.String
  • Since: 2.1.0
  • Required: No
  • Expression: ${cookie}

details:

Setting this to true will print the complete profiling results, and not only the profiling top-10.
  • Type: boolean
  • Since: 2.1.0
  • Required: No
  • Expression: ${details}
  • Default: false

erlCommand:

The erlang command used to start an erlang backend node. The path must exist and the destination must be executable. If the given command does not fullfill these requirements erl is used (assuming the command is part of the hosts PATH). The path must not contain any arguments.
  • Type: java.lang.String
  • Since: 2.1.0
  • Required: No
  • Expression: ${erlCommand}

silent:

Setting this to true will silent the console output and only generate the profiling output file.
  • Type: boolean
  • Since: 2.1.0
  • Required: No
  • Expression: ${silent}
  • Default: false

test:

Setting this to some test module name, or a comma separated list of test module names, will use only those tests for profiling.
  • Type: java.lang.String
  • Since: 2.1.0
  • Required: No
  • Expression: ${test}

timeout:

The time, in seconds, that the full profiling is allowed to take. Must be a positive integer. If the profiling tests run longer than this, without responding with any results, it is considered to have failed.
  • Type: int
  • Since: 2.1.0
  • Required: No
  • Expression: ${timeout}
  • Default: 600