配置Node.js应用Azure AppInsights后NodeClient属性为undefined的问题排查

问题描述 #

已为Node.js应用配置Azure AppInsights，但发现NodeClient的enableAutoCollectConsole、enableAutoDependencyCorrelation等配置属性均显示为undefined，需排查原因。

日志信息 #

appInsights.defaultClient NodeClient {
  _telemetryProcessors: [],
  config: Config {
    _endpointBase: 'https://dc.services.visualstudio.com',
    _connectionString: undefined,
    _instrumentationKey: '3e9532',
    correlationHeaderExcludedDomains: [
      '*.core.windows.net',
      '*.core.chinacloudapi.cn',
      '*.core.cloudapi.de',
      '*.core.usgovcloudapi.net',
      '*.core.microsoft.scloud',
      '*.core.eaglex.ic.gov'
    ],
    correlationIdRetryIntervalMs: 30000,
    disableAllExtendedMetrics: false,
    disableAppInsights: false,
    disableStatsbeat: false,
    distributedTracingMode: undefined,
    enableAutoCollectConsole: undefined,
    enableLoggerErrorToTrace: undefined,
    enableAutoCollectDependencies: undefined,
    enableAutoCollectIncomingRequestAzureFunctions: undefined,
    enableAutoCollectExceptions: undefined,
    enableAutoCollectExtendedMetrics: undefined,
    enableAutoCollectExternalLoggers: undefined,
    enableAutoCollectHeartbeat: undefined,
    enableAutoCollectPerformance: undefined,
    enableAutoCollectPreAggregatedMetrics: undefined,
    enableAutoCollectRequests: undefined,
    enableAutoDependencyCorrelation: undefined,
    enableInternalDebugLogging: undefined,
    enableInternalWarningLogging: undefined,
    enableResendInterval: undefined,
    enableMaxBytesOnDisk: undefined,
    enableSendLiveMetrics: undefined,
    enableUseAsyncHooks: undefined,
    enableUseDiskRetryCaching: undefined,
    endpointUrl: 'https://centralindia-0.in.applicationinsights.azure.com/v2.1/track',
    extendedMetricDisablers: undefined,
    ignoreLegacyHeaders: false,
    maxBatchIntervalMs: 15000,
    maxBatchSize: 250,
    proxyHttpUrl: undefined,
    proxyHttpsUrl: undefined,
    quickPulseHost: 'centralindia.livediagnostics.monitor.azure.com',
    samplingPercentage: 100,
    enableWebInstrumentation: false,
    _webInstrumentationConnectionString: '',
    webInstrumentationConfig: null,
    webInstrumentationSrc: '',
    enableAutoWebSnippetInjection: false,
    _profileQueryEndpoint: 'https://centralindia-0.in.applicationinsights.azure.com/',
    correlationId: 'cid-v1:'
  },

代码示例 #

index.js #

const express = require('express');
const querystring = require('querystring');
const url = require('url');
const appInsights = require('./appInsightsSetup'); // Import the appInsights setup from the separate file

const app = express();
const port = 3000;

app.get('/', (req, res) => {
    console.log("appInsights.defaultClient", appInsights.defaultClient)
    // Track the incoming request
    appInsights.defaultClient.trackRequest({
        name: req.path,
        url: req.url,
        duration: Date.now() - req.startTime,
        resultCode: res.statusCode,
        success: true
    });

    res.send('Hello World!');
});

app.get('/stdout', (req, res) => {
    let logStr = querystring.parse(url.parse(req.url).query).log;
    // logStr = "logging stdout"
    process.stdout.write(logStr + '\n');
    console.log('console: ' + logStr + '\n');

    // Track the custom event
    appInsights.defaultClient.trackEvent({ name: 'stdout', properties: { log: logStr } });

    res.send('Received\n');
});

app.get('/stderr', (req, res) => {
    let errStr = querystring.parse(url.parse(req.url).query).log;
    process.stderr.write(errStr + '\n');
    console.log('console: ' + errStr + '\n');

    // Track the custom event
    appInsights.defaultClient.trackEvent({ name: 'stderr', properties: { log: errStr } });

    res.send('Received\n');
});

// Middleware to record request start time
app.use((req, res, next) => {
    req.startTime = Date.now();
    next();
});

app.listen(port, () => console.log(`Example app listening on port ${port}!`));

appInsightsSetup.js #

const appInsights = require('applicationinsights');

appInsights.setup("InstrumentationKey=;IngestionEndpoint=")
    .setAutoDependencyCorrelation(false)
    .setAutoCollectRequests(true)
    .setAutoCollectPerformance(false)
    .setAutoCollectExceptions(false)
    .setAutoCollectDependencies(false)
    .setAutoCollectConsole(true, true)
    .setUseDiskRetryCaching(true)
    .setSendLiveMetrics(false)
    .setInternalLogging(true)
    .start();

module.exports = appInsights;

排查原因分析 #

1. SDK版本差异：不同版本的Application Insights Node.js SDK对配置属性的存储方式不同。较新版本中，这些自动收集类的配置不再直接暴露在config对象顶层，而是通过内部逻辑管理，仅在初始化时通过链式方法设置，不会在config中直接显示。可以通过npm list applicationinsights查看当前版本，对比官方文档确认API变化。
2. 配置初始化异常：appInsights.setup传入的连接字符串缺少有效的InstrumentationKey值（当前为InstrumentationKey=;IngestionEndpoint=），这会导致SDK初始化不完整，进而影响配置属性的正常赋值。需补充正确的InstrumentationKey。
3. 属性显示与实际生效分离：即使config中显示属性为undefined，也不代表配置未生效。可以通过实际行为验证：比如触发console.log后查看AppInsights门户是否有对应的日志，或检查请求的依赖关联是否正常工作，以此确认配置是否真正生效。
4. 配置方法调用顺序：虽然当前代码中setup链式调用在start()之前，但需确保没有在start()之后再修改配置，否则不会生效。

内容的提问来源于stack exchange，提问作者krishna kurtakoti