Contact Us 1-800-596-4880
  1. Homepage
  2. Monitoring

  3. Exporting Telemetry Data

Exporting Telemetry Data to Third-Party Monitoring Systems

The Telemetry Exporter enables you to export audit logs and Mule app trace data to third-party observability and analytics platforms, such as Azure Monitor, Splunk HEC, and OpenTelemetry compliant tools. Exporting trace data is supported only for Mule apps deployed using compatible versions of CloudHub 2.0 and Runtime Fabric.

To use the Telemetry Exporter, you must:

  • Create a connection by providing a third-party observability platform credential that authorizes Anypoint Platform to share data with the observability platform. See also, Supported Third-Party Monitoring Products.

  • Create a configuration that specifies the type of data Anypoint Platform exports and which business group and environment allows content to be exported to the connections that you configure.

You can also edit and delete connections and configurations. Telemetry Exporter checks for changes to connections and configurations on an hourly basis. When you create or modify a connection or configuration, there might be a delay in applying your new settings.

When exported, audit logs have a unique ID in the mulesoft.audit.id attribute. In usual operations, each log is delivered only once, but under certain circumstances, some logs are delivered more than once. Duplicate log entries always share the unique mulesoft.audit.id attribute, so this attribute can be used to safely block or remove duplicate logs from the target system.

Supported Third-Party Monitoring Products

The Telemetry Exporter enables you to create connections to most third-party observability and analytics platforms that:

  • Have OpenTelemetry-supported endpoints. For example, the endpoint URL for New Relic is https://otlp.nr-data.net:4318. Your team must set up endpoints for the monitoring platform you use.

  • Allow you to create an instrumentation key or access token.

Azure Monitor and Splunk HEC are also compatible.

Before You Begin

Before you configure the Telemetry Exporter, ensure that you have:

  • The Anypoint Integration Advanced package or a Titanium subscription to Anypoint Platform.

  • Telemetry Exporter Administrator permission, so you can create or modify connections. For more information, see Managing Permissions for Anypoint Monitoring.

  • Telemetry Exporter Configurations Manager permission, so you can create or modify configurations. For more information, see Managing Permissions for Anypoint Monitoring.

  • Access information for your third-party observability platform.

  • The ability to create an instrumentation key or access token for your third-party observability platform.

  • Enabled trace data collection for CloudHub 2.0 apps deployed to shared or private spaces. This requirement applies only if you want to export trace data for CloudHub 2.0.

  • Enabled trace data collection for Runtime Fabric apps. This requirement applies only if you want to export trace data for Runtime Fabric.

Access Telemetry Exporter

  1. Log in to Anypoint Platform using an account that has the Telemetry Exporter Administrator or Telemetry Exporter Configurations Manager permission.

  2. In the sidebar or the main Anypoint Platform screen, click Monitoring.

  3. Click Telemetry Exporter.

You can switch between the Configurations and Connections tabs to create, edit, or view data configurations and connections to third-party observability platforms.

Manage a Connection

Anypoint Platform needs permission to send data to third-party observability platforms. Create a connection with a third-party platform, such as New Relic or Splunk, to authorize data transfers. You can configure up to 10 connections.

Telemetry Exporter checks for changes to connections and configurations on an hourly basis. When you create or modify a connection or configuration, there might be a delay in applying your new settings.

Create a Connection

  1. Log in to Anypoint Platform using an account that has the Telemetry Exporter Administrator permission.

  2. In the sidebar or the main Anypoint Platform screen, click Monitoring.

  3. Click Telemetry Exporter.

  4. Click the Connections tab.

  5. Click New Connection.

  6. On the Connection Details page, enter the following information:

    • Connection Name: Name for your connection, using only alphanumeric characters and hyphens.

    • Destination Type: Third-party observability platform to which you want to transfer data.

    • Endpoint URL: Endpoint that enables external connections to your third-party observability platform (see Supported Third-Party Monitoring Products). Some platforms, such as DataDog, require an OpenTelemetry collector endpoint that is enabled to translate the OpenTelemetry standard to DataDog formats.

  7. Click Next.

  8. On the Authentication page, enter the information needed to authenticate your connection to the observability platform. Some platforms require only access tokens, while others also require a header key.

  9. Click Test Connection to ensure that Anypoint Platform can connect to your third-party observability platform.

  10. Click Save Connection.

    The new connection appears in the Connections tab on the Telemetry Exporter page.

Edit a Connection

  1. Log in to Anypoint Platform using an account that has the Telemetry Exporter Administrator permission.

  2. In the sidebar or the main Anypoint Platform screen, click Monitoring.

  3. Click Telemetry Exporter.

  4. Click the Connections tab.

  5. Next to the connection you want to edit, click …​ and select Edit Connection.

  6. On the Connection Details page, edit each field you want to change and click Next.

  7. On the Authentication page, edit each field you want to change and click Test Connection.

  8. If the connection is successful, click Save Connection.

Delete a Connection

  1. Log in to Anypoint Platform using an account that has the Telemetry Exporter Administrator permission.

  2. In the sidebar or the main Anypoint Platform screen, click Monitoring.

  3. Click Telemetry Exporter.

  4. Next to the connection you want to delete, click …​ and select Delete Connection.

  5. A warning appears:

    • If the connection is not in use, the warning asks whether to delete the connection. Click Delete Connection.

    • If the connection is in use, the warning states that you must delete or redirect connections for any configurations that use the connection. Click Dismiss, and then edit your configurations to use other existing connections before deleting the current connection.

Manage Configurations

After you create a connection to your third-party observability platform, you must create a configuration to specify the scope of the data to send to the platform. When you create a new configuration, specify a data type, business group, environment type (traces only), and destination. You can export traces and audit logs from all of your business groups or a specific business group.

Telemetry Exporter checks for changes to connections and configurations on an hourly basis. When you create or modify a connection or configuration, there might be a delay in applying your new settings.

Create a Configuration

  1. Log in to Anypoint Platform using an account that has the Telemetry Exporter Configurations Manager permission.

  2. In the sidebar or the main Anypoint Platform screen, click Monitoring.

  3. Click Telemetry Exporter.

  4. Click New Configuration.

  5. On the General Information page, enter the following information:

    • Configuration Name: Name for your configuration that uses only alphanumeric characters.

    • Connection: Existing connection that you configured.

    • Data Type: Audit logs or trace data

  6. Click Next.

  7. In the Select Business Group section, select one of the following:

    • All business groups: Audit logs are sourced from all business groups in the organization.

    • Select a business group: Data of the type you specified is sourced only from the selected business group.

  8. Click Next.

  9. If you selected trace data as the data type, select the environment type:

    • Production

    • Sandbox

    • Design

  10. Click Save Configuration.

Edit Configurations

When you edit configurations, you can change the configuration name and connection. If you want to modify the data type business group or environment type, you must create a new configuration.

  1. Log in to Anypoint Platform using an account that has the Telemetry Exporter Configurations Manager permission.

  2. In the sidebar or the main Anypoint Platform screen, click Monitoring.

  3. Click Telemetry Exporter.

  4. Next to the configuration you want to edit, click …​ and select Edit Configuration.

  5. On the General Information page, edit each field you want to change and click Next.

  6. On the Business Group & Environment Type page, Next.

  7. Click Save Configuration.

Delete Configurations

  1. Log in to Anypoint Platform using an account that has the Telemetry Exporter Configurations Manager permission.

  2. In the sidebar or the main Anypoint Platform screen, click Monitoring.

  3. Click Telemetry Exporter.

  4. Next to the configuration you want to delete, click …​ and select Delete Connection.

    A warning appears that confirms whether you want to delete the configuration.

  5. Click Delete Configuration.

Errors

If you receive this error, ensure that your endpoint supports OpenTelemetry:

Error : validating connection request. Please check your request and try again

See Supported Third-Party Monitoring Products.

Known Issues

Telemetry Exporter currently has the following data differences, limitations, and known issues:

  • For failed requests, Telemetry Exporter retries are handled using the OpenTelemetry specifications for handling failures:

    • Permanent failures, such as bad requests, do not retry.

    • 5xx errors that can retry wait for a specific interval. Retries continue for 300 seconds before timing out.

  • When you create configurations for the same connection, you cannot create a configuration that uses all business groups if there are configurations that use individual business groups. Conversely, you cannot create configurations for that connection if there is a configuration that uses all business groups.
    For example, Connection A to Splunk has Configuration A and Configuration B that map to Business Group A and Business Group B. In this scenario, you are unable to use Connection A to create a configuration that exports data from all business groups.

  • Because Azure Monitor Exporter does not support sending persistent queues, connections that use it might experience data loss. Data might be deleted from the sending queue when the Telemetry Exporter restarts hourly to apply updates.

  • The audit logs that the Telemetry Exporter sends to third-party apps often have different field names from the audit logs that appear in Access Management or the Audit Query Log API.
    For example, audit logs shown in the UI or retrieved by the Audit Log Query API describe a user action (such as update or delete) as action, whereas the OpenTelemetry attribute refers to it as mulesoft.audit.action.

  • If the audit log entry metadata and payload field exceed 30KB when compressed, the payload is truncated before compression.