Chapter 10. Integrating the OpenTelemetry SDK with APIcast

Procedure

1. Create a configuration file for APIcast instrumentation:

   • The configuration file specification is defined in the NGINX instrumentation library repo.

     $ oc apply -f - <<EOF

     apiVersion: v1
     kind: Secret
     metadata:
       name: otel-config
     type: Opaque
     stringData:
       config.json: |
         # "otlp" is the only supported exporter in APIcast
         exporter = "otlp"
         processor = "simple"
         [exporters.otlp]
         # Alternatively the OTEL_EXPORTER_OTLP_ENDPOINT environment variable can also be used.
         host = "${COLLECTOR_HOST}"
         port = ${COLLECTOR_PORT}
         # Optional: enable SSL, for endpoints that support it
         # use_ssl = true
         # Optional: set a filesystem path to a pem file to be used for SSL encryption
         # (when use_ssl = true)
         # ssl_cert_path = "/path/to/cert.pem"
         [processors.batch]
         max_queue_size = 2048
         schedule_delay_millis = 5000
         max_export_batch_size = 512
         [service]
         name = "apicast" # Opentelemetry resource name
     EOF

2. Define an APIcast custom resource (CR) that specifies openTelemetry attributes. In the CR definition, set the openTelemetry.tracingConfigSecretRef.name attribute to the name of the secret that contains your openTelemetry configuration details. The following example shows only content relative to configuring openTelemetry:

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIcast
   metadata:
     name: apicast1
   spec:
     ...
     openTelemetry:
       enabled: true
       tracingConfigSecretRef:
         name: "$NAME_OF_SECRET"