@microsoft/applicationinsights-cfgsync-js

Microsoft Application Insights JavaScript SDK - CfgSync Plugin

Application Insights CfgSync Plugin enables configuration change communication among multiple instances. Refer to our GitHub page for more details on getting started.

Getting Started

Installation

Install both the base Application Insights Web SDK and the CfgSync plugin used in the examples below:

npm install @microsoft/applicationinsights-web @microsoft/applicationinsights-cfgsync-js

Basic Usage

The CfgSync Plugin supports three synchronization modes:

• Broadcast (default): The instance broadcasts its configuration changes to other instances.
• Receive: The instance only receives configuration changes from broadcasting instances.
• None: The instance neither broadcasts nor receives configuration changes.

Broadcasting Instance

The main (broadcaster) instance sends configuration updates to all listener instances:

import { ApplicationInsights } from "@microsoft/applicationinsights-web";
import { CfgSyncPlugin, ICfgSyncConfig, ICfgSyncMode } from "@microsoft/applicationinsights-cfgsync-js";

const cfgSyncPlugin = new CfgSyncPlugin();

const appInsights = new ApplicationInsights({
    config: {
        connectionString: "YOUR_CONNECTION_STRING",
        extensions: [cfgSyncPlugin],
        extensionConfig: {
            [cfgSyncPlugin.identifier]: {
                syncMode: ICfgSyncMode.Broadcast
            } as ICfgSyncConfig
        }
    }
});
appInsights.loadAppInsights();

Receiving Instance

Listener instances receive and apply configuration updates from broadcasting instances. Use nonOverrideConfigs to protect specific fields from being overwritten:

import { ApplicationInsights } from "@microsoft/applicationinsights-web";
import { CfgSyncPlugin, ICfgSyncConfig, ICfgSyncMode } from "@microsoft/applicationinsights-cfgsync-js";

const cfgSyncPlugin = new CfgSyncPlugin();

const listenerAppInsights = new ApplicationInsights({
    config: {
        connectionString: "InstrumentationKey=LISTENER_KEY",
        extensions: [cfgSyncPlugin],
        extensionConfig: {
            [cfgSyncPlugin.identifier]: {
                syncMode: ICfgSyncMode.Receive,
                nonOverrideConfigs: {
                    connectionString: true,
                    instrumentationKey: true,
                    endpointUrl: true
                }
            } as ICfgSyncConfig
        }
    }
});
listenerAppInsights.loadAppInsights();

Disabling Sync (None Mode)

Use ICfgSyncMode.None when you want to include the plugin in a page but opt out of both broadcasting and receiving configuration changes:

import { ApplicationInsights } from "@microsoft/applicationinsights-web";
import { CfgSyncPlugin, ICfgSyncConfig, ICfgSyncMode } from "@microsoft/applicationinsights-cfgsync-js";

const cfgSyncPlugin = new CfgSyncPlugin();

const appInsights = new ApplicationInsights({
    config: {
        connectionString: "InstrumentationKey=YOUR_KEY",
        extensions: [cfgSyncPlugin],
        extensionConfig: {
            [cfgSyncPlugin.identifier]: {
                syncMode: ICfgSyncMode.None
            } as ICfgSyncConfig
        }
    }
});
appInsights.loadAppInsights();

Fetching Configuration from a CDN Endpoint

You can configure an instance to fetch its configuration from a remote URL:

import { ApplicationInsights } from "@microsoft/applicationinsights-web";
import { CfgSyncPlugin, ICfgSyncConfig } from "@microsoft/applicationinsights-cfgsync-js";

const cfgSyncPlugin = new CfgSyncPlugin();

const appInsights = new ApplicationInsights({
    config: {
        connectionString: "InstrumentationKey=YOUR_KEY",
        extensions: [cfgSyncPlugin],
        extensionConfig: {
            [cfgSyncPlugin.identifier]: {
                cfgUrl: "https://your-cdn-endpoint/config.json",
                scheduleFetchTimeout: 1800000  // re-fetch every 30 minutes
            } as ICfgSyncConfig
        }
    }
});
appInsights.loadAppInsights();

The CDN endpoint should return a JSON object following the ICfgSyncCdnConfig interface.

Plugin API

Method	Description
getCfg()	Returns the current configuration of this instance.
setCfg(config)	Manually sets the configuration of this instance. Returns true on success.
sync(customDetails?)	Manually broadcasts the current configuration to all listener instances. Returns true on success.
pause()	Pauses the scheduled CDN fetch timer.
resume()	Resumes the scheduled CDN fetch timer.
updateEventListenerName(eventName?)	Updates the custom event name used to broadcast/receive configuration changes.

Configuration

Name	Type	Default	Description
syncMode	ICfgSyncMode [Optional]	Broadcast	Sync mode of current instance. If set to None, current instance will NOT receive or broadcast config changes. If set to Broadcast, current instance will ONLY broadcast changes. If set to Receive, instance will ONLY receive config changes but NOT broadcast config changes.
customEvtName	string [Optional]	ai_cfgsync	Event name for sending or listening to configuration change details.
cfgUrl	string [Optional]	null	CDN endpoint for fetching configuration. If cfgUrl is defined, instance will NOT listen to core configuration changes. Details defined in the CDN endpoint should follow ICfgSyncCdnConfig interface.
blkCdnCfg	boolean [Optional]	false	Determines if fetching the CDN endpoint should be blocked or not.
onCfgChangeReceive	function [Optional]	null	Overrides callback function to handle event details when changes are received via event listener.
overrideSyncFn	function [Optional]	null	Overrides sync() function to broadcast changes.
overrideFetchFn	function [Optional]	null	Overrides fetch function to get config from cfgUrl when cfgUrl is defined.
nonOverrideConfigs	NonOverrideCfg [Optional]	{instrumentationKey: true, connectionString: true, endpointUrl: true }	When current instance is set with syncMode: Receive, config fields under nonOverrideConfigs will NOT be changed by any config details sent out from other instances. NOTE: this config will be ONLY applied during initialization, so it won't be changed dynamically.
scheduleFetchTimeout	number [Optional]	30 mins	Identifies the time interval (in milliseconds) for fetching config details from cfgUrl when cfgUrl is defined. If set to 0, the fetch operation will only be called once during initialization.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Data Collection

As this SDK is designed to enable applications to perform data collection which is sent to the Microsoft collection endpoints the following is required to identify our privacy statement.

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

License

MIT