[#319] Add custom error status code configuration support

Author: feelform

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 All notable changes to Pinpoint Node.js agent will be documented in this file.
 
+## [1.0.1] - 2025-05-23
+### Added
+- [[#319](https://github.com/pinpoint-apm/pinpoint-node-agent/issues/319)] Add support for custom error status code configuration
+
+### ⚠️ Breaking Changes
+In unsupported web frameworks such as Next.js App Router, HTTP responses with status code 500 may not appear in scatter charts. You can customizing HTTP error status code.
+
 ## [1.0.0] - 2025-05-22
 ### Added
 - [[#214](https://github.com/pinpoint-apm/pinpoint-node-agent/issues/214)] Support Active Request

README.md

@@ -112,6 +112,7 @@ PINPOINT_TRACE_EXCLUSION_URL_PATTERN |  | comma-separated string. ex) `/health_c
 PINPOINT_TRACE_EXCLUSION_URL_CACHE_SIZE | | If the app is designed so that the pathname of the URL is fixed, if the cache size is set, the pathname of the frequently used URL does not match with patterns. In case of using query for pathname like `/user/1000`, cache is unnecessarily. [Unit tests](https://github.com/pinpoint-apm/pinpoint-node-agent/blob/01fcbdefe5a0ffba9c957bee0da3fb7397638182/test/utils/ant-path-matcher.test.js#L447)
 PINPOINT_PROFILER_SQL_STAT | false | SQL uid
 PINPOINT_TRACE_LOCATION_AND_FILENAME_OF_CALL_SITE | false | CallSite line number and filename
+PINPOINT_HTTP_STATUS_CODE_ERRORS | 5xx,401,403 | Comma-separated list of HTTP status codes that should be treated as errors. When a response matches one of these codes, the agent will record the request as an error in Pinpoint. You can customize this list to include any status codes relevant to your application's error.
 
 ### Agent ID
 The agent ID is used as the identifier per the server or node. You need to set the hostname or node identifier(The maximum length is 24) on the server.

demo/express/package-lock.json

@@ -18,6 +18,6 @@
     "morgan": "~1.9.1",
     "mysql": "^2.18.1",
     "mysql2": "^3.9.1",
-    "pinpoint-node-agent": "^0.9.0"
+    "pinpoint-node-agent": "^1.0.0"
   }
 }

demo/express/package.json

@@ -62,6 +62,7 @@ const ENV_MAP = {
   traceLocationAndFileNameOfCallSite: valueOfBoolean('PINPOINT_TRACE_LOCATION_AND_FILENAME_OF_CALL_SITE'),
   profilerSqlStat: valueOfBoolean('PINPOINT_PROFILER_SQL_STAT'),
   logError: valueOfBoolean('PINPOINT_LOG_ERROR'),
+  httpStatusCodeErrors: valueOfString('PINPOINT_HTTP_STATUS_CODE_ERRORS'),
 }
 
 const CONFIG_FILE_MAP = {
@@ -75,7 +76,7 @@ const CONFIG_FILE_MAP = {
   collectorSpanPort: 'collector.span-port',
   sampling: 'sampling.enable',
   sampleRate: 'sampling.rate',
-  httpStatusCodeErrors: 'http-status-code-errors',
+  httpStatusCodeErrors: 'http-status-code.errors',
   logLevel: 'log-level',
   enabledDataSending: 'enabled-data-sending',
   enabledStatsMonitor: 'enabled-stats-monitor-sending',
@@ -261,6 +262,13 @@ const getConfig = (initOptions) => {
 const initializeConfig = (initOptions) => {
   clear()
   init(initOptions)
+  loadedConfigCallbacks.forEach(callback => {
+    try {
+      callback.callback(agentConfig[callback.propertyName])
+    } catch (e) {
+      log.error('Error in loadedConfig callback', e)
+    }
+  })
 }
 
 const clear = () => agentConfig && (agentConfig = null)
@@ -289,6 +297,15 @@ function hasDockerCGroup() {
 
 let agentConfig = readConfigJson(defaultConfig)
 
+const loadedConfigCallbacks = []
+function registerLoadedConfig(propertyName, callback) {
+  if (typeof propertyName !== 'string' || typeof callback !== 'function') {
+    return
+  }
+
+  loadedConfigCallbacks.push({ propertyName, callback })
+}
+
 module.exports = {
   getConfig,
   clear,
@@ -297,4 +314,5 @@ module.exports = {
   getMainModulePath,
   isContainerEnvironment,
   initializeConfig,
+  registerLoadedConfig,
 }

lib/config.js

@@ -14,7 +14,7 @@ const TraceSampler = require('./trace/trace-sampler')
 const SpanBuilder = require('./span-builder')
 const SpanChunkBuilder = require('./span-chunk-builder')
 const SpanRepository = require('./trace/span-repository')
-const Trace2 = require('./trace/trace2')
+const Trace = require('./trace/trace')
 const AsyncSpanChunkBuilder = require('./trace/async-span-chunk-builder')
 const ChildTraceBuilder = require('./trace/child-trace-builder')
 const DisableChildTrace = require('./trace/disable-child-trace')
@@ -82,7 +82,7 @@ class TraceContext {
     const spanChunkBuilder = new SpanChunkBuilder(traceRoot)
     const repository = new SpanRepository(spanChunkBuilder, this.dataSender, this.agentInfo)
     activeRequestRepository.register(traceRoot)
-    return new Trace2(spanBuilder, repository)
+    return new Trace(spanBuilder, repository)
   }
 
   // DefaultAsyncContext.java: newAsyncContextTrace