microsoft/ApplicationInsights-SAP-Fiori-Plugin

microsoft/ApplicationInsights-SAP-Fiori-Plugin

Description: SAP Fiori Launchpad Plugin to gain insights into Fiori metrics with Azure Application Insights

Language: JavaScript

License: MIT

Stars: 13

Forks: 2

Open issues: 15

Created: 2022-12-21T12:16:30Z

Pushed: 2026-06-12T02:21:22Z

Default branch: main

Fork: no

Archived: no

README:

Azure App Insights SAP-Fiori plugin Quickstart (PREVIEW)

This repos describes how to utilize a SAP Fiori Launchpad Plugin to gain client-side insights into Fiori metrics with Azure Application Insights. It leverages the standard views for Azure Application Insights and a dedicated Azure Monitor Workbook for SAP.

> [!Note] > Find official API documentation for the Azure Application Insights JS snippet here.

A typical single instance setup would look like below. The plugin concept applies to native SAP on Azure deployments, SAP RISE, on-premises and SAP BTP Build WorkZone, Standard edition.

> [!Note] > Connection from BTP to the SAP workload on Azure can be done with the cloud-native SAP Private Link Service for Azure or the SAP Cloud Connector (SCC). For any-premises choose Azure VNet integration via ExpressRoute/VPN or the SCC.


> [!Note] > The reverse proxy is required in case of strict CORS policies. Proxy choices range from managed services like Azure Front Door or Azure Application Gateway to self-hosted solutions like Apache.

🧪Tested with Business Suite NW 7.51 and S/4HANA 2022 using Edge Browser.

Prerequisites

1. Azure Application Insights instance (access to connection string) 2. Imported [Azure Monitor Workbook](Fiori-Performance-Analysis.workbook) (Create new, open code view , select Gallery template, copy & paste the json into it and save) 3. Fiori Launchpad with SAPUI5 1.86+ (older Fiori stacks need to consider [alternatives](#sapui5-feature-dependencies)).

> [!Note] > You may upgrade your UI5 stack independently from the NetWeaver release

4. Fiori Launchpad configured to use custom Plug-Ins. See SAP's Fiori docs (especially steps 76 onwards) to get started.

| Parameter | Value | Description | | ----------- | ----------- | ----------- | | Launchpad Plugin ID | ZAZUREFLPPLUGIN | Retrieve from builder.customTasks.configuration.app.name in [ui5-deploy.yaml](ui5-deploy.yaml) | | Launchpad Plugin URL | /sap/bc/ui5_ui5/sap/ | Re-use from here or collect from npm run deploy output | | UI5 Component ID | microsoft.com.flpmonitor | Verify from sap.app.id in [manifest.json](/webapp/manifest.json) |

> [!Note] > Optionally add Azure Monitor for SAP Solutions Instance for infrastructure telemetery correlation

SAPUI5 feature dependencies

Default settings of this repos anticipate UI5 releases 1.86+. Use below table to understand potential feature scope for older releases.

| Feature | SAPUI5 release | Usage | | ----------- | ----------- | ----------- | | AppLifeCycle | 1.38+ | Use SAP's public API to handle app loaded events | | Interaction | 1.76+ | Use SAP public tracing APIs for analysis, matching SAP backend trace measurments | | User Info | 1.86+ | Use SAP's public Fiori user API to correlate user info | | Passport | n.a. | Use SAP's internal API to enrich requests with RootId and TransactionId for deep linking from Azure into SAP backend transactions |

If none are applicable revert to tracking Fiori hash changes only:

//uncomment in init function
$(window).hashchange(function () {
window.appInsights.trackPageView();
}

Another alternative poses the App Insights configuration enableAutoRouteTracking. However, launchpad navigation durations are not reflected, because it gets treated as a large single-page-application (SPA).

Local build instructions (SAP Business Application Studio)

git clone https://github.com/MartinPankraz/az-monitor-sap-fiori-plugin.git

This app has been generated using the SAP Fiori tools - App Generator in SAP Business Application Studio, as part of the SAP Fiori tools suite. In order to launch the generated app, simply run the following commands from the generated app root folder:

npm install

Maintain your Azure Application Insights Connection String and AICloudRole attributes on the Component.js.

npm run build

npm start

Deploying the plugin

There are multiple ways to deploy the plugin to AS ABAP. Learn more [here](documentation/DEPLOYMENT.md)

> [!Note] > The provided guidance focuses on AS ABAP but the plugin also applies to the SAP Build Workzone, standard edition (formerly SAP Launchpad service)....