From 6312905acf69faa3d07b1f8b23a67ece283ea701 Mon Sep 17 00:00:00 2001 From: Duke Date: Thu, 20 Oct 2022 11:34:11 -0700 Subject: [PATCH 1/5] W-11939773-businessEvents-duke --- modules/ROOT/pages/business-events.adoc | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/modules/ROOT/pages/business-events.adoc b/modules/ROOT/pages/business-events.adoc index 352a50300..5ab3d394c 100644 --- a/modules/ROOT/pages/business-events.adoc +++ b/modules/ROOT/pages/business-events.adoc @@ -14,10 +14,9 @@ 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. +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[] From ed6a924016905c0d933001df1043c3980f34c459 Mon Sep 17 00:00:00 2001 From: dukesphere Date: Thu, 20 Oct 2022 11:58:11 -0700 Subject: [PATCH 2/5] W-11939773-businessEvents-duke --- modules/ROOT/pages/_partials/set-transaction-id.adoc | 6 +++--- modules/ROOT/pages/business-events-custom.adoc | 3 ++- modules/ROOT/pages/business-events-in-components.adoc | 11 ++++++----- modules/ROOT/pages/business-events.adoc | 4 ++-- 4 files changed, 13 insertions(+), 11 deletions(-) diff --git a/modules/ROOT/pages/_partials/set-transaction-id.adoc b/modules/ROOT/pages/_partials/set-transaction-id.adoc index b21295f8e..f153f1ecb 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 8df008be0..5a4f8f09c 100644 --- a/modules/ROOT/pages/business-events-custom.adoc +++ b/modules/ROOT/pages/business-events-custom.adoc @@ -47,4 +47,5 @@ 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:business-events.adoc[] diff --git a/modules/ROOT/pages/business-events-in-components.adoc b/modules/ROOT/pages/business-events-in-components.adoc index 1483e0e30..76d938d85 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 5ab3d394c..f01c9b4c8 100644 --- a/modules/ROOT/pages/business-events.adoc +++ b/modules/ROOT/pages/business-events.adoc @@ -13,7 +13,7 @@ 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. + +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[] for configuration details. @@ -32,7 +32,7 @@ Consider the following recommended practices when configuring business events tr * 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 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. +* 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 From 5a292eeb9f3c13bc34ef8714efd3818d1802d31a Mon Sep 17 00:00:00 2001 From: dukesphere Date: Thu, 20 Oct 2022 12:13:22 -0700 Subject: [PATCH 3/5] W-11939773-businessEvents-duke --- modules/ROOT/pages/business-events-custom.adoc | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/modules/ROOT/pages/business-events-custom.adoc b/modules/ROOT/pages/business-events-custom.adoc index 5a4f8f09c..04bbff636 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`: + @@ -48,4 +55,4 @@ For your KPIs, use names that are easy to search for in the Anypoint Runtime Man == See Also * xref:business-events.adoc[] -* xref:business-events.adoc[] +* xref:set-transaction-id.adoc[] From bf21f07dd03e199e9f2d9bc4b4349b45e4011d3f Mon Sep 17 00:00:00 2001 From: dukesphere Date: Thu, 20 Oct 2022 12:48:25 -0700 Subject: [PATCH 4/5] W-11939773-businessEvents-duke --- modules/ROOT/pages/business-events-custom.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/business-events-custom.adoc b/modules/ROOT/pages/business-events-custom.adoc index 04bbff636..50036c002 100644 --- a/modules/ROOT/pages/business-events-custom.adoc +++ b/modules/ROOT/pages/business-events-custom.adoc @@ -35,7 +35,7 @@ For example: [source,xml,linenums] ---- - + ---- From 63dd4c10f1a0f553826f69b8f9422c7b65139436 Mon Sep 17 00:00:00 2001 From: dukesphere Date: Thu, 20 Oct 2022 12:53:42 -0700 Subject: [PATCH 5/5] W-11939773-businessEvents-duke --- modules/ROOT/pages/business-events-custom.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/ROOT/pages/business-events-custom.adoc b/modules/ROOT/pages/business-events-custom.adoc index 50036c002..094f1e80b 100644 --- a/modules/ROOT/pages/business-events-custom.adoc +++ b/modules/ROOT/pages/business-events-custom.adoc @@ -56,3 +56,4 @@ For your KPIs, use names that are easy to search for in the Anypoint Runtime Man * xref:business-events.adoc[] * xref:set-transaction-id.adoc[] +* xref:transaction-management.adoc[]