Monitoring end-to-end transactions in IBM webMethods Hybrid Integration

You can configure IBM® App Connect Enterprise to send data for end-to-end monitoring in IBM webMethods Hybrid Integration. Configure the server.conf.yaml file for your integration server and provide end-to-end monitoring credentials in a vault.

To configure an App Connect Enterprise integration server for end-to-end monitoring, complete the following steps.

1. Copy the API key and OpenTelemetry endpoint from the End-to-end monitoring page in IBM webMethods Hybrid Integration.
   You use the API key to authenticate with the end-to-end monitoring OpenTelemetry receiver endpoint.
   1. In the webMethods Hybrid Integration main menu (), click End-to-end monitoring.
   2. In the End-to-end monitoring navigation pane, click Manage, then click API key.
   3. If the API key exists, click Show API key, then click Copy . If no API key exists, click Generate. Retain the API key for a later step.
   4. Copy the OTLP/HTTP Endpoint value and retain it for a later step.
      The OTLP/gRPC Endpoint is deprecated; you must use the OTLP/HTTP Endpoint.
2. In App Connect Enterprise, create a work directory for your integration server by running the mqsicreateworkdir command.
   For more information, see mqsicreateworkdir command.
3. In App Connect Enterprise, create a vault by running the mqsivault command.
   For example, the following command creates a vault in the current work directory. The vault key must be at least 8 characters long.

   mqsivault –-work-dir . –-vault-key <vaultKey> --create 

   For more information, see mqsivault command.
4. In App Connect Enterprise, encrypt and store the end-to-end monitoring credentials in the vault by using the mqsicredentials command.
   For example, the following command stores the username and password for end-to-end monitoring in the vault that you created in the previous step.

   mqsicredentials --work-dir . --vault-key <vaultKey> --create --credential-type opentelemetry --credential-name <credName> --username <envID> --password <APIkeyfromE2E> 

   • You use the credential-name property to identify this set of credentials when you update the server.conf.yaml file for the integration server.
   • The username is the alphanumeric environment ID from your webMethods Hybrid Integration instance. To find your environment ID, go to the webMethods Hybrid Integration main menu and click Environment management. You can also find this environment ID after https:// in the URL of your webMethods Hybrid Integration instance. For example, if the URL of your webMethods Hybrid Integration instance is https://dev1234567.a-vir-b1.platform.ipaas.automation.ibm.com/, the environment ID is dev1234567.
   • The password is the API key that you copied from end-to-end monitoring in step 1.

   For more information, see mqsicredentials command.
5. In App Connect Enterprise, update the EnvironmentVariables and OpenTelemetryManager sections of the server.conf.yaml file with your webMethods Hybrid Integration environment ID and end-to-end monitoring credentials.
   • In the EnvironmentVariables section, set MQSI_TENANT_AUTH_URL and MQSI_TENANT_ID to the environment ID for your webMethods Hybrid Integration instance.
   • In the OpenTelemetryManager section, set openTelemetryEnabled to true.
   • Set exporterOtlpHttpEndpoint to the OTLP/HTTP Endpoint value that you copied in step 1.
   • Set openTelemetryHttpSecurityId to the value of the credential name that you specified in the mqsicredentials command.

   For more information, see Configuring an integration server by modifying the server.conf.yaml file.
   The following example shows the settings.

   EnvironmentVariables:
      MQSI_TENANT_AUTH_URL: 'envID'
      MQSI_TENANT_ID: 'envID'
   OpenTelemetryManager:
      openTelemetryEnabled: true
      exporterOtlpHttpEndpoint: 'https://uhm.a-vir-r1.e2em.ipaas.automation.ibm.com:443/v1/traces'
      openTelemetryHttpSecurityId: 'credName'

6. Start the configured integration server.
   For example, run the following IntegrationServer command with the vault key for your integration server vault.

   IntegrationServer --work-dir . --vault-key <vaultKey> 

   For more information, see IntegrationServer command.