@microsoft/1ds-core-js

---

ArtifactType: npm package, javascript from CDN. Documentation: https://1dsdocs.azurewebsites.net/getting-started/javascript-getting_started.html Language: typescript Platform: various Stackoverflow: N/A Tags: 1DSJSSDK ms.reviewedAt: 02/21/2019 ms.reviewedBy: ramthi

Microsoft 1DS Web SDK Core

Description

1DS Web SDK Core is the telemetry orchestrator, responsible for initializing all attached plugins and calling process() on each of them.

npm

Package available here.

Basic Usage

Setup

import { AppInsightsCore, IExtendedConfiguration } from '@microsoft/1ds-core-js';

var appInsightsCore: AppInsightsCore = new AppInsightsCore();
var coreConfig: IExtendedConfiguration = {
      instrumentationKey: "YOUR_TENANT_KEY"
};
//Initialize SDK
appInsightsCore.initialize(coreConfig, []);

Configuration

IExtendedConfiguration

| Config | Description | Type |----------------|----------------------------------------|----|----------------------------------------------------------| | instrumentationKey |Instrumentation key of resource.|string | diagnosticLogInterval |Polling interval (in ms) for internal logging queue.|number | maxMessageLimit |Maximum number of iKey transmitted logging telemetry per page view.|number | loggingLevelConsole |Console logging level. All logs with a severity level higher than the configured level will be printed to console. Otherwise they are suppressed. |number | loggingLevelTelemetry |Telemtry logging level to instrumentation key. All logs with a severity level higher than the configured level will sent as telemetry data to the configured instrumentation key.|number | enableDebugExceptions |If enabled, uncaught exceptions will be thrown to help with debugging.|boolean | endpointUrl |Endpoint where telemetry data is sent.|string | extensionConfig |Extension configs loaded in SDK.|[key: string]: any; | extensions |Additional plugins that should be loaded by core at runtime.| Array< ITelemetryPlugin> | channels |Channel queues that is setup by caller in desired order.|Array< IChannelControls[]> | propertyStorageOverride |The property storage override that should be used to store internal SDK properties, otherwise stored as cookies. It is needed where cookies are not available.|IPropertyStorageOverride | disableCookiesUsage |A boolean that indicated whether to disable the use of cookies by the Aria SDK. The cookies added by the SDK are MicrosoftApplicationsTelemetryDeviceId.|boolean | anonCookieName |Name of the Anon cookie. The value will be set in the qsp header to collector requests. Collector will use this value to look for specific cookie to use for anid property.|string | enablePerfMgr | [Optional] When enabled (true) this will create local perfEvents for code that has been instrumented to emit perfEvents (via the doPerf() helper). This can be used to identify performance issues within the SDK based on your usage or optionally within your own instrumented code. More details are available by the basic documentation. Since v2.4.0| boolean
Defaults to false | perfEvtsSendAll | [Optional] When enablePerfMgr is enabled and the IPerfManager fires a INotificationManager.perfEvent() this flag determines whether an event is fired (and sent to all listeners) for all events (true) or only for 'parent' events (false <default>).
A parent IPerfEvent is an event where no other IPerfEvent is still running at the point of this event being created and it's parent property is not null or undefined. Since v2.4.0 | boolean
Defaults to false | idLength | 22 | [Optional] Identifies the default length used to generate new random session and user id's. Defaults to 22, previous default value was 5 (v2.4.2 or less), if you need to keep the previous maximum length you should set this value to 5.

IPropertyStorageOverride

| Config | Description | Type |----------------|----------------------------------------|----|----------------------------------------------------------| | setProperty |A function for passing key value pairs to be stored.| function | getProperty | A function that gets a value for a given key.| function

API documentation

https://1dsdocs.azurewebsites.net/api/webSDK/utl/core/3.0/f/index.html

Sample App

React sample App.

React Native sample App.

Learn More

You can learn more in 1DS First party getting started.

Data Collection

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.

To turn off sending telemetry to Microsoft, ensure that the POST channel is not configured in the extensions. See below configuration for example:

var coreConfig: IExtendedConfiguration = {
      instrumentationKey: "YOUR_TENANT_KEY",
      extensions: [
        postChannel  // << REMOVE THIS EXTENSION TO STOP SENDING TELEMETRY TO MICROSOFT
      ],
      extensionConfig: []
};

License

MIT