diff --git a/modules/ROOT/pages/_partials/set-transaction-id.adoc b/modules/ROOT/pages/_partials/set-transaction-id.adoc index b21295f8e8..f153f1ecb4 100644 --- a/modules/ROOT/pages/_partials/set-transaction-id.adoc +++ b/modules/ROOT/pages/_partials/set-transaction-id.adoc @@ -33,9 +33,9 @@ image:mruntime-custom-transaction-id.png[custom-transaction-id] //tag::transactionIdReference[] == Set Transaction ID Reference -[%header,cols="1,4"] +[%header,cols="1a,1a,4a"] |=== -| Field | Description -| Transaction ID (`id`) a| Defines the value of the identifier. It can be an expression or a literal. By default, the component assigns a numeric value. +| Field | XML | Description +| Transaction ID | `id` | Defines the value of the identifier. It can be an expression or a literal. By default, the component assigns a numeric value. |=== //end::transactionIdReference[] diff --git a/modules/ROOT/pages/business-events-custom.adoc b/modules/ROOT/pages/business-events-custom.adoc index 8df008be06..094f1e80b9 100644 --- a/modules/ROOT/pages/business-events-custom.adoc +++ b/modules/ROOT/pages/business-events-custom.adoc @@ -3,23 +3,30 @@ ifndef::env-site,env-github[] include::_attributes.adoc[] endif::[] -Use the Custom Business Event component (`tracking:custom-event` element in the XML view) to add metadata and Key Performance Indicators (KPIs) to your flow. Configure the component as follows: +Use the Custom Business Event component (``) to add metadata and Key Performance Indicators (KPIs) to your flow. Configure the component in the Anypoint Studio UI or the configuration XML for the Mule application as follows: +* In the Studio UI: . Click the *Mule Palette* tab in Anypoint Studio. . Drag *Custom Business Event* to any point of your flow. . Open the component properties view and specify values for *Display Name* and *Event Name*: + image::mruntime-custom-business-event.png[custom-business-event] +* In the configuration XML for the same custom business event: ++ +[source,xml] +---- + +---- You can also configure Key Performance Indicators (KPIs) to capture information from the message payload: -* In the UI: +* In the Studio UI: . Click the plus button (image:green-plus-icon.png[2%,2%]) inside *Key Performance Indicators*. . Configure *Name* and *Expression / Value*: + image::mruntime-business-events-kpi.png[business-events-kpi] -* In the XML: +* In the configuration XML for the same KPI configuration: . Add a child `tracking:meta-data` element to the `tracking:custom-event`. . Configure the `key` and `value` attributes inside `tracking:meta-data`: + @@ -28,7 +35,7 @@ For example: [source,xml,linenums] ---- - + ---- @@ -47,4 +54,6 @@ For your KPIs, use names that are easy to search for in the Anypoint Runtime Man == See Also -xref:business-events.adoc[Business Events] +* xref:business-events.adoc[] +* xref:set-transaction-id.adoc[] +* xref:transaction-management.adoc[] diff --git a/modules/ROOT/pages/business-events-in-components.adoc b/modules/ROOT/pages/business-events-in-components.adoc index 1483e0e307..76d938d85b 100644 --- a/modules/ROOT/pages/business-events-in-components.adoc +++ b/modules/ROOT/pages/business-events-in-components.adoc @@ -8,7 +8,7 @@ Because event tracking requires processing and network overhead to aggregate and * At the flow level * At the message processor (connector or component) level, which takes precedence over the flow level setting -After you enable event tracking, customize the transaction ID to identify specific tracked events so that you can analyze them at runtime. +After you enable event tracking, customize the transaction ID with <> to identify specific tracked events so that you can analyze them at runtime. [events_tracking_flow_level] == Flow-Level Event Tracking @@ -16,8 +16,9 @@ After you enable event tracking, customize the transaction ID to identify specif Use this option to enable default event tracking for all elements in a flow that support event tracking. You can disable tracking for specific processors or connectors to override the flow level setting. -Steps to enable default events tracking for all components in a flow: +Steps to enable default events tracking for all components in a flow within Anypoint Studio and the configuration XML for a Mule application: +* In Studio: . Select your flow component to open the properties view. . Enable default business events using either the UI or XML: + @@ -25,7 +26,7 @@ Steps to enable default events tracking for all components in a flow: + image::mruntime-business-event-flow.png[default-event-tracking-flow] + -* In the XML, add attribute `tracking:enable-default-events="true"` to the `flow` element: +* In the configuration XML, add the attribute `tracking:enable-default-events="true"` to the `flow` element: + [source,xml,linenums] ---- @@ -43,11 +44,11 @@ Steps to enable enable default events tracking for an individual component: . Open the connector or component properties view. . Enable default business events using any of the following options: + -* In the UI, select *Enable default events tracking*: +* In the Studio UI, select *Enable default events tracking*: + image::mruntime-business-event-component.png[default-event-tracking-component] + -* In the XML, add attribute `tracking:enable-default-events="true"` inside your component element: +* In the configuration XML, add attribute `tracking:enable-default-events="true"` inside your component element: + [source,xml,linenums] ---- diff --git a/modules/ROOT/pages/business-events.adoc b/modules/ROOT/pages/business-events.adoc index 352a503004..f01c9b4c88 100644 --- a/modules/ROOT/pages/business-events.adoc +++ b/modules/ROOT/pages/business-events.adoc @@ -13,11 +13,10 @@ Mule applications collect _business event_ information (such as transaction exec You can track two types of business events: _default events_ and _custom events_. -Default event tracking is supported by all connectors and selected message processors. Enabling default events for these elements enables you to perform advanced debugging at runtime. You can enable default event tracking at either the flow level or the message processor level. + -See xref:business-events-in-components.adoc[Configure Default Events Tracking] for configuration details. +Default event tracking is supported by all connectors and selected message processors. Enabling default events for these elements enables you to perform advanced debugging at runtime. You can enable default event tracking at either the flow level or the message processor level. +See xref:business-events-in-components.adoc[] for configuration details. -Custom event tracking is supported by the Custom Business Event component. Custom events are always tracked, enabling you to monitor high-level activities in your flow that are relevant to your business. + -See xref:business-events-custom.adoc[Custom Business Event Component] for configuration details. +Custom event tracking is supported by the Custom Business Event component. Custom events are always tracked, enabling you to monitor high-level activities in your flow that are relevant to your business. See xref:business-events-custom.adoc[] for configuration details. == Monitoring Business Events @@ -25,20 +24,20 @@ You can enable Insight in Runtime Manager to monitor business events at runtime. Certain default events are tracked automatically after you enable Insight, but you must enable others in your application before they are tracked. -See the xref:runtime-manager::insight.adoc[Insight] documentation for more details. +See xref:runtime-manager::insight.adoc[] for more details. == Best Practices for Business Events Consider the following recommended practices when configuring business events tracking: * Enable default events only for processes that have particular value to you. To filter out unnecessary information, determine which stages within a business transaction you need to track, and enable tracking for only those stages. -* Use custom events to track key process indicators: for example, "Total Order Amount" or "Tracking Number" to surface the high-level business activities in your flow. -* Customize the transaction ID so that meaningful information, such as an order number, an employee identification number, or a shipment tracking number, is displayed for a transaction. + +* Use custom events to track key process indicators, for example, "Total Order Amount" or "Tracking Number" to surface the high-level business activities in your flow. +* Customize the transaction ID with xref:set-transaction-id.adoc[Set Transaction Id] so that meaningful information, such as an order number, an employee identification number, or a shipment tracking number, is displayed for a transaction. This practice makes analysis and debugging easier and more intuitive at runtime. == See Also -* xref:about-mule-event.adoc[Mule Events] -* xref:transaction-management.adoc[Transaction Management] -* xref:business-events-in-components[Configure Default Events Tracking] -* xref:business-events-custom.adoc[Custom Business Event Component] +* xref:about-mule-event.adoc[] +* xref:transaction-management.adoc[] +* xref:business-events-in-components[] +* xref:business-events-custom.adoc[]