Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 2.32 KB

Tracing.md

File metadata and controls

60 lines (43 loc) · 2.32 KB

Tracing

The test framework will trace all your test/method invocations, so you can review how much time took to run a test or filter by tags as openshift, bare-metal, k8s or errors.

All the Junit Tags are going to be included as Span tags, so then later you can filter in Jaeger by your custom tags.

All errors are going to be tagged as error and the error message is going to be attached to your span as an event log.

In order to push your tracing events to your Jaeger you must provide the following system properties:

  • ts.jaeger-http-endpoint (required): Default Value: http://localhost:14268/api/traces Example, https://myjaeger.apps.ocp47.dynamic.quarkus:14268/api/traces
  • ts.service-name (required): your application service name Default Value: quarkus-test-framework Example myCryptoApp
  • ts.buildNumber: could be your Jenkins pipeline build number, in order to filter in Jaeger by this build. Default Value: quarkus-plugin.version system property value, otherwise 777-default.
  • ts.versionNumber: if your application is versioned, could be the version of your application Default Value: 999-default

Jaeger Installation

  • On bare metal:
docker run -p 16686:16686 -p 14268:14268 quay.io/jaegertracing/all-in-one:1.21.0

The JAEGER API URL will be available at http://localhost:14268. The JAEGER UI URL is http://localhost:16686.

  • On OpenShift:
oc new-project <PROJECT WHERE YOU WANT JAEGER TO BE INSTALLED>
oc apply -f jaeger-for-tracing.yaml

In order to get the Jaeger routes, do oc get routes:

jaeger-api   <JAEGER API URL>          jaeger-api   <all>                 None
jaeger-ui    <JAEGER UI URL>           jaeger-ui    <all>                 None

Usage

After installing Jaeger, then we can run our test suite, for example:

mvn clean verify -Dts.buildNumber="475" -Dts.service-name="1.2.1" -Dts.jaeger-http-endpoint="http://<JAEGER API URL>/api/traces"

The spanIds within the test framework must follow the next convention:

  • For a test method: <ClassName>_<methodName>
  • For a Test Scenario: <ClassName>
  • For a service: <ClassName> and the service name should be attached as a tag. For example, AlertMonitorIT Tags: kafka