applicationinsights

/// <reference types="node" /> import http = require("http"); import https = require("https"); import * as azureCoreAuth from "@azure/core-auth"; import { DistributedTracingModes } from "../applicationinsights"; import { IDisabledExtendedMetrics } from "../AutoCollection/NativePerformance"; export interface IBaseConfig { /** Application Insights resource instrumentation key */ instrumentationKey: string; /** The ingestion endpoint to send telemetry payloads to */ endpointUrl: string; /** The maximum number of telemetry items to include in a payload to the ingestion endpoint (Default 250) */ maxBatchSize: number; /** The maximum amount of time to wait for a payload to reach maxBatchSize (Default 15000) */ maxBatchIntervalMs: number; /** A flag indicating if telemetry transmission is disabled (Default false) */ disableAppInsights: boolean; /** The percentage of telemetry items tracked that should be transmitted (Default 100) */ samplingPercentage: number; /** The time to wait before retrying to retrieve the id for cross-component correlation (Default 30000) */ correlationIdRetryIntervalMs: number; /** A list of domains to exclude from cross-component header injection */ correlationHeaderExcludedDomains: string[]; /** A proxy server for SDK HTTP traffic (Optional, Default pulled from `http_proxy` environment variable) */ proxyHttpUrl: string; /** A proxy server for SDK HTTPS traffic (Optional, Default pulled from `https_proxy` environment variable) */ proxyHttpsUrl: string; /** Disable including legacy headers in outgoing requests, x-ms-request-id */ ignoreLegacyHeaders: boolean; /** * Sets the distributed tracing modes. If W3C mode is enabled, W3C trace context * headers (traceparent/tracestate) will be parsed in all incoming requests, and included in outgoing * requests. In W3C mode, existing back-compatibility AI headers will also be parsed and included. * Enabling W3C mode will not break existing correlation with other Application Insights instrumented * services. Default=AI */ distributedTracingMode: DistributedTracingModes; /** * Sets the state of console * if true logger activity will be sent to Application Insights */ enableAutoCollectExternalLoggers: boolean; /** * Sets the state of logger tracking (enabled by default for third-party loggers only) * if true, logger autocollection will include console.log calls (default false) */ enableAutoCollectConsole: boolean; /** * Sets tracking error logs from loggers (console, bunyan, winston) as traces. If true errors will be returned as traces */ enableLoggerErrorToTrace: boolean; /** * Sets the state of exception tracking (enabled by default) * if true uncaught exceptions will be sent to Application Insights */ enableAutoCollectExceptions: boolean; /** * Sets the state of performance tracking (enabled by default) * if true performance counters will be collected every second and sent to Application Insights */ enableAutoCollectPerformance: boolean; /** * Sets the state of performance tracking (enabled by default) * if true, extended metrics counters will be collected every minute and sent to Application Insights */ enableAutoCollectExtendedMetrics: boolean | IDisabledExtendedMetrics; /** * Sets the state of pre aggregated metrics tracking (enabled by default) * if true pre aggregated metrics will be collected every minute and sent to Application Insights */ enableAutoCollectPreAggregatedMetrics: boolean; /** * Sets the state of request tracking (enabled by default) * if true HeartBeat metric data will be collected every 15 minutes and sent to Application Insights */ enableAutoCollectHeartbeat: boolean; /** * Sets the state of request tracking (enabled by default) * if true requests will be sent to Application Insights */ enableAutoCollectRequests: boolean; /** * Sets the state of dependency tracking (enabled by default) * if true dependencies will be sent to Application Insights */ enableAutoCollectDependencies: boolean; /** * Sets the state of automatic dependency correlation (enabled by default) * if true dependencies will be correlated with requests */ enableAutoDependencyCorrelation: boolean; /** * Sets the state of automatic dependency correlation (enabled by default) * if true, forces use of experimental async_hooks module to provide correlation. If false, instead uses only patching-based techniques. If left blank, the best option is chosen for you based on your version of Node.js. */ enableUseAsyncHooks: boolean; /** * Enable or disable disk-backed retry caching to cache events when client is offline (enabled by default) * Note that this method only applies to the default client. Disk-backed retry caching is disabled by default for additional clients. * For enable for additional clients, use client.channel.setUseDiskRetryCaching(true). * These cached events are stored in your system or user's temporary directory and access restricted to your user when possible. * enableUseDiskRetryCaching if true events that occured while client is offline will be cached on disk * enableResendInterval The wait interval for resending cached events. * enableMaxBytesOnDisk The maximum size (in bytes) that the created temporary directory for cache events can grow to, before caching is disabled. */ enableUseDiskRetryCaching: boolean; enableResendInterval: number; enableMaxBytesOnDisk: number; /** * Enables debug and warning logging for AppInsights itself. * if true, enables debug logging */ enableInternalDebugLogging: boolean; /** * Enables debug and warning logging for AppInsights itself. * if true, enables warning logging */ enableInternalWarningLogging: boolean; /** * Enables communication with Application Insights Live Metrics. * if true, enables communication with the live metrics service */ enableSendLiveMetrics: boolean; /** * Disable all environment variables set */ disableAllExtendedMetrics: boolean; /** * Disable individual environment variables set. eg. "extendedMetricDisablers": "..." */ extendedMetricDisablers: string; /** * Disable Statsbeat */ disableStatsbeat: boolean; /** * Live Metrics custom host */ quickPulseHost: string; /** * @deprecated, please use enableWebInstrumentation instead * Enable web snippet auto html injection, default to false, this config is NOT exposed in documentation after version 2.3.5 */ enableAutoWebSnippetInjection?: boolean; /** * @deprecated, Please use webInstrumentationConnectionString instead * Application Insights resource connection string for web snippet, this config is NOT exposed in documentation after version 2.3.5 * Note: if no valid connection string is provided here, web snippet will use the connection string during initializing Nodejs SDK */ webSnippetConnectionString?: string; /** * Enable web instrumentation and automatic monitoring, default to false */ enableWebInstrumentation: boolean; /** * Enable automatic incoming request tracking when running in Azure Functions */ enableAutoCollectIncomingRequestAzureFunctions: boolean; /** * Application Insights resource connection string for web instrumentation and automatic monitoring * Note: if no VALID connection string is provided here, web instrumentation will use the connection string during initializing Nodejs SDK */ webInstrumentationConnectionString?: string; /** * Application Insights web Instrumentation config * NOTE: if no config is provided here, web instrumentation will use default values * IMPORTANT NOTE: please convert any functions and objects to double-quoted strings, otherwise they will be skipped. * For example: if you want to pass in a function: function() { return 'hi'; }, * you SHOULD wrap it in double-quoted string: "function () {\n return \"hi\";\n}" * see more Application Insights web Instrumentation config details at: https://github.com/microsoft/ApplicationInsights-JS#configuration */ webInstrumentationConfig?: IWebInstrumentationConfig[]; /** * Application Insights web Instrumentation CDN url * NOTE: this config can be changed from env variable: APPLICATIONINSIGHTS_WEB_INSTRUMENTATION_SOURCE or Json Config: webInstrumentationSrc * If no resouce is provided here, default CDN endpoint: https://js.monitor.azure.com/scripts/b/ai will be used * see more details at: https://github.com/microsoft/ApplicationInsights-JS */ webInstrumentationSrc?: string; } export interface IWebInstrumentationConfig { /** * Name of Application Insights web Instrumentation config to be changed * see more Application Insights web Instrumentation config details at: https://github.com/microsoft/ApplicationInsights-JS#configuration */ name: string; /** * value provided to replace the default config value above */ value: string | boolean | number; } export interface IEnvironmentConfig { /** Connection String used to send telemetry payloads to */ connectionString: string; /** * In order to track context across asynchronous calls, * some changes are required in third party libraries such as mongodb and redis. * By default ApplicationInsights will use diagnostic-channel-publishers to monkey-patch some of these libraries. * This property is to disable the feature. * Note that by setting this flag, events may no longer be correctly associated with the right operation. */ noDiagnosticChannel: boolean; /** * Disable individual monkey-patches. * Set `noPatchModules` to a comma separated list of packages to disable. * e.g. `"noPatchModules": "console,redis"` to avoid patching the console and redis packages. * The following modules are available: `azuresdk, bunyan, console, mongodb, mongodb-core, mysql, redis, winston, pg`, and `pg-pool`. */ noPatchModules: string; /** * HTTPS without a passed in agent */ noHttpAgentKeepAlive: boolean; } export interface IJsonConfig extends IBaseConfig, IEnvironmentConfig { } export interface IConfig extends IBaseConfig { /** An http.Agent to use for SDK HTTP traffic (Optional, Default undefined) */ httpAgent: http.Agent; /** An https.Agent to use for SDK HTTPS traffic (Optional, Default undefined) */ httpsAgent: https.Agent; /** AAD TokenCredential to use to authenticate the app */ aadTokenCredential?: azureCoreAuth.TokenCredential; }