From eaa142bbd397c474a93a84e9875d9061476b8d18 Mon Sep 17 00:00:00 2001 From: Jackson Weber Date: Tue, 10 Nov 2026 22:39:46 -0800 Subject: [PATCH] Fix broken 1DS package documentation links Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- channels/1ds-post-js/README.md | 5 +++-- shared/1ds-core-js/README.md | 8 ++++---- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/channels/1ds-post-js/README.md b/channels/1ds-post-js/README.md index 171710295..29ca3fa98 100644 --- a/channels/1ds-post-js/README.md +++ b/channels/1ds-post-js/README.md @@ -66,7 +66,8 @@ appInsightsCore.initialize(coreConfig, []); | [maxEventRetryAttempts](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-post-js/interfaces/IChannelConfiguration.html#maxEventRetryAttempts)
(Since 3.1.11+) | [Optional] Identifies the number of times any single event will be retried if it receives a failed (retirable) response, this causes the event to be internally "requeued" and resent in the next batch. As each normal batched send request is retried at least once before starting to increase the internal backoff send interval, normally batched events will generally be attempted the next nearest even number of times. This means that the total number of actual send attempts will almost always be even (setting to 5 will cause 6 requests), unless using manual synchronous flushing (calling flush(false)) which is not subject to request level retry attempts. | number
Default: 6 | [maxUnloadEventRetryAttempts](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-post-js/interfaces/IChannelConfiguration.html#maxUnloadEventRetryAttempts)
(Since 3.1.11+) | [Optional] Identifies the number of times any single event will be retried if it receives a failed (retriable) response as part of processing / flushing events once a page unload state has been detected, this causes the event to be internally "requeued" and resent in the next batch, which during page unload. Unlike the normal batching process, send requests are never retried, so the value listed here is always the maximum number of attempts for any single event.
Notes: The SDK by default will use the sendBeacon() API if it exists which is treated as a fire and forget successful response, so for environments that support or supply this API the events won't be retried (because they will be deeded to be successfully sent). When an environment (IE) doesn't support sendBeacon(), this will cause multiple synchronous (by default) XMLHttpRequests to be sent, which will block the UI until a response is received. You can disable ALL synchronous XHR requests by setting the 'disableXhrSync' configuration setting and/or changing this value to 0 or 1. | number
Default: 2 | [addNoResponse](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-post-js/interfaces/IChannelConfiguration.html#addNoResponse)
(Since 3.2.8+) | [Optional] flag to indicate whether the sendBeacon and fetch (with keep-alive flag) should add the "NoResponseBody" query string value to indicate that the server should return a 204 for successful requests. | boolean
Default: true -| [disableZip](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-post-js/interfaces/IChannelConfiguration.html#disableZip)
(Since 4.3.7+) | [Optional] flag to use CompressionStream API to compress the payload. Compression will only occur if the event is asynchronous. For events like unloads, compression will not be applied. * Note: if user set payloadPreprocessor, this zip compression will not be applied. | boolean
Default: true + +To enable payload compression, configure [the `zipPayload` feature flag](https://github.com/microsoft/ApplicationInsights-JS#feature) on the core configuration. Compression applies only to asynchronous events when the CompressionStream API is available and no `payloadPreprocessor` is configured. ### [IXHROverride](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-post-js/interfaces/IXHROverride.html) @@ -259,7 +260,7 @@ The currently configured set of fields include ### Excluded Part A fields -- All direct top-level fields of the envelope, this includes "ver"; "name"; "time" and "iKey". see [Common Schema 4.0 - Part A](https://aka.ms/CommonSchema/PartA) for all defined fields. Note: This exclusion does does not match sub-keys (objects) like "ext", "data" and "properties". +- All direct top-level fields of the envelope, this includes "ver"; "name"; "time" and "iKey". see [Common Schema 4.0 - Part A](https://msazure.visualstudio.com/One/_git/CommonSchema?path=%2Fv4.0%2FPartA%2FREADME.md&_a=preview) for all defined fields. Note: This exclusion does does not match sub-keys (objects) like "ext", "data" and "properties". - All fields of the web extension, this includes all fields and sub keys of "ext.web" (example fields include "ext.web.browser"; "ext.web.domain"; "ext.web.consentDetails"). see [Common Schema 4.0 - Part A Extension - web](https://aka.ms/CommonSchema/PartA/Web) for the complete set of defined fields. - All fields and paths of the metadata extension, this includes all fields and sub keys of "ext.metadata". see [Common Schema 4.0 - Part A Extension - metadata](https://aka.ms/CommonSchema/PartA/MetaData) for the complete set of defined fields. diff --git a/shared/1ds-core-js/README.md b/shared/1ds-core-js/README.md index 3b1abcf94..b0fa71ac7 100644 --- a/shared/1ds-core-js/README.md +++ b/shared/1ds-core-js/README.md @@ -92,16 +92,16 @@ appInsightsCore.initialize(coreConfig, []); | [maxMessageLimit](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#maxMessageLimit) |Maximum number of iKey transmitted logging telemetry per page view.|number | [loggingLevelConsole](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#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](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#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](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#enableDebugExceptions) |If enabled, uncaught exceptions will be thrown to help with debugging.|boolean +| [enableDebug](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#enableDebug) |If enabled, uncaught exceptions will be thrown to help with debugging.|boolean | [endpointUrl](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#endpointUrl) |Endpoint where telemetry data is sent.|string | [extensionConfig](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#extensionConfig) |Extension configs loaded in SDK.|[key: string]: any; | [extensions](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#extensions) |Additional plugins that should be loaded by core at runtime.| Array< ITelemetryPlugin> | [channels](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#channels) |Channel queues that is setup by caller in desired order.|Array< IChannelControls[]> | [propertyStorageOverride](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#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 -| [cookieCfg](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#cookieCfg) | Defaults to cookie usage enabled see [ICookieCfgConfig](#ICookieMgrConfig) settings for full defaults. | [ICookieCfgConfig](#ICookieMgrConfig)
[Optional]
(Since 3.1.0) +| [cookieCfg](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#cookieCfg) | Defaults to cookie usage enabled see [ICookieMgrConfig](#icookiemgrconfig) settings for full defaults. | [ICookieMgrConfig](#icookiemgrconfig)
[Optional]
(Since 3.1.0) | [disableCookiesUsage](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#disableCookiesUsage) |A boolean that indicated whether to disable the use of cookies by the Aria SDK. The cookies added by the SDK are MicrosoftApplicationsTelemetryDeviceId and MicrosoftApplicationsTelemetryFirstLaunchTime. If cookies are disabled, then session events are not sent unless propertyStorageOverride is provided to store the values elsewhere.|boolean -| [cookieDomain](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#cookieDomain) | Custom cookie domain. This is helpful if you want to share Application Insights cookies across subdomains.
(Since v3.1.0) If `cookieCfg.domain` is defined it will take precedence over this value. | alias for [`cookieCfg.domain`](#ICookieMgrConfig)
[Optional]
(Since 3.1.0) -| [cookiePath](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#cookiePath) | Custom cookie path. This is helpful if you want to share Application Insights cookies behind an application gateway.
If `cookieCfg.path` is defined it will take precedence over this value. | alias for [`cookieCfg.path`](#ICookieMgrConfig)
[Optional]
(Since 3.1.0) | +| [cookieDomain](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#cookieDomain) | Custom cookie domain. This is helpful if you want to share Application Insights cookies across subdomains.
(Since v3.1.0) If `cookieCfg.domain` is defined it will take precedence over this value. | alias for [`cookieCfg.domain`](#icookiemgrconfig)
[Optional]
(Since 3.1.0) +| [cookiePath](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#cookiePath) | Custom cookie path. This is helpful if you want to share Application Insights cookies behind an application gateway.
If `cookieCfg.path` is defined it will take precedence over this value. | alias for [`cookieCfg.path`](#icookiemgrconfig)
[Optional]
(Since 3.1.0) | | [anonCookieName](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#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](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#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](https://github.com/microsoft/ApplicationInsights-JS/blob/main/docs/PerformanceMonitoring.md). Since v2.4.0| boolean
Defaults to false | [perfEvtsSendAll](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html#perfEvtsSendAll) | [Optional] When _enablePerfMgr_ is enabled and the [IPerfManager](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/IPerfManager.html) fires a [INotificationManager](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/INotificationManager.html).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](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/IPerfEvent.html) 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