Axway APIM Integration with OpenTelemetry using OpenTelemetry Java SDK

This artefact tested with following version:

• V7.7 May 2023

In build.gradle file, update dependencies location:

• Set the variable apim_folder to you API-Gateway installation folder (e.g. opt/Axway/APIM/apigateway)

gradlew clean jar

Copy following jar files

• Copy opentelemetry-apim-agent--x.x.x.jar file to apigateway/ext/lib

• Copy Aspectj weaver - https://repo1.maven.org/maven2/org/aspectj/aspectjweaver/1.9.6/aspectjweaver-1.9.6.jar to apigateway/ext/lib

• Copy opentelmetry sdk jar files to apigateway/ext/lib

  • opentelemetry-api-1.30.1.jar
  • opentelemetry-exporter-logging-1.30.1.jar
  • opentelemetry-sdk-1.30.1.jar
  • opentelemetry-sdk-metrics-1.30.1.jar
  • kotlin-stdlib-1.6.10.jar
  • opentelemetry-api-events-1.30.1-alpha.jar
  • opentelemetry-exporter-otlp-1.30.1.jar
  • opentelemetry-sdk-common-1.30.1.jar
  • opentelemetry-sdk-trace-1.30.1.jar
  • okhttp-4.11.0.jar
  • opentelemetry-exporter-otlp-common-1.30.1.jar
  • opentelemetry-sdk-extension-autoconfigure-1.30.1.jar
  • opentelemetry-semconv-1.30.1-alpha.jar
  • okio-jvm-3.2.0.jar
  • opentelemetry-context-1.30.1.jar
  • opentelemetry-exporter-sender-okhttp-1.30.1.jar
  • opentelemetry-sdk-extension-autoconfigure-spi-1.30.1.jar
  • opentelemetry-exporter-common-1.30.1.jar
  • opentelemetry-extension-incubator-1.30.1-alpha.jar
  • opentelemetry-sdk-logs-1.30.1.jar

• Environment variables for API Gateway to send metrics to Jaeger / any other OTLP supported vendors

export OTEL_EXPORTER_OTLP_ENDPOINT=http:https://10.129.61.129:4317
export OTEL_EXPORTER_OTLP_TRACES_PROTOCOL=grpc
export OTEL_TRACES_EXPORTER=otlp
export OTEL_SERVICE_NAME=apim-gw
export OTEL_METRICS_EXPORTER=none

• Create a file named jvm.xml under APIGATEWAY_INSTALL_DIR/apigateway/conf/

  <ConfigurationFragment>
      <VMArg name="-javaagent:/home/axway/Axway-7.7.0/apigateway/ext/lib/aspectjweaver-1.9.6.jar"/>
  </ConfigurationFragment>

• Restart API Gateway instances

• Start Jaeger server

docker run --name jaeger   -e COLLECTOR_OTLP_ENABLED=true   -p 16686:16686   -p 4317:4317   -p 4318:4318   jaegertracing/all-in-one:1.49

• Policy exposed as Endpoint.
• API manager Traffic
• API Repository defined in Policystudio
• API Manager UI traffic

• API Manager REST API call.
• Servlet defined in Policystudio.

Please read Contributing.md for details on our code of conduct, and the process for submitting pull requests to us.

Axway Team

Apache License 2.0