newrelic 9.5.0 → 9.6.0

package/lib/config/default.js

@@ -5,57 +5,73 @@
 
 'use strict'
 
+const defaultConfig = module.exports
+const { array, int, float, boolean, object, objectList, allowList } = require('./formatters')
+
 /**
+ * A function that returns the definition of the agent configuration
  * This file includes all of the configuration variables used by the Node.js
  * module. If there's a configurable element of the module and it's not
  * described in here, there's been a terrible mistake.
+ *
+ * This is used to set a default value, a formatter to run when assigning the value, and
+ * an override if the env var does not follow our standard convention.  We should not have
+ * to add any more overrides as all new configuration values should follow the convention of
+ * `NEW_RELIC_PATH_TO_CONFIG_KEY`
  */
+defaultConfig.definition = () => ({
+  newrelic_home: {
+    env: 'NEW_RELIC_HOME',
+    default: null
+  },
 
-exports.config = () => ({
   /**
    * Array of application names.
-   *
-   * @env NEW_RELIC_APP_NAME
    */
-  app_name: [],
+  app_name: {
+    formatter(val) {
+      return val.split(/;|,/).map((k) => k.trim())
+    },
+    default: []
+  },
   /**
    * The user's license key. Must be set by per-app configuration file.
-   *
-   * @env NEW_RELIC_LICENSE_KEY
    */
   license_key: '',
   /**
    *
    * Enables/Disables security policies.  Paste your security policies
    * token from the New Relic Admin below.
-   *
-   * @env NEW_RELIC_SECURITY_POLICIES_TOKEN
    */
   security_policies_token: '',
   /**
    * Hostname for the New Relic collector proxy.
    *
    * You shouldn't need to change this.
-   *
-   * @env NEW_RELIC_HOST
    */
   host: '',
   /**
    * The port on which the collector proxy will be listening.
    *
    * You shouldn't need to change this.
-   *
-   * @env NEW_RELIC_PORT
    */
-  port: 443,
+  port: {
+    formatter: int,
+    default: 443
+  },
   /**
    * Whether or not to use SSL to connect to New Relic's servers.
    *
    * NOTE: This option can no longer be disabled.
-   *
-   * @env NEW_RELIC_USE_SSL
    */
-  ssl: true,
+  ssl: {
+    env: 'NEW_RELIC_USE_SSL',
+    formatter(_, logger) {
+      logger.warn('SSL config key can no longer be disabled, not updating.')
+      return true
+    },
+    default: true
+  },
   /**
    * Proxy url
    *
@@ -65,38 +81,37 @@ exports.config = () => ({
    * e.g. http://user:pass@host:port/
    *
    * Setting proxy will override other proxy settings.
-   *
-   * @env NEW_RELIC_PROXY_URL
    */
-  proxy: '',
+  proxy: {
+    env: 'NEW_RELIC_PROXY_URL',
+    default: ''
+  },
   /**
    * Proxy host to use to connect to the internet.
-   *
-   * @env NEW_RELIC_PROXY_HOST
    */
   proxy_host: '',
   /**
    * Proxy port to use to connect to the internet.
-   *
-   * @env NEW_RELIC_PROXY_PORT
    */
   proxy_port: '',
   /**
    * Proxy user name when required.
-   *
-   * @env NEW_RELIC_PROXY_USER
    */
   proxy_user: '',
   /**
    * Proxy password when required.
-   *
-   * @env NEW_RELIC_PROXY_PASS
    */
   proxy_pass: '',
   // Serverless DT config defaults
-  trusted_account_key: null,
-  primary_application_id: null,
-  account_id: null,
+  trusted_account_key: {
+    default: null
+  },
+  primary_application_id: {
+    default: null
+  },
+  account_id: {
+    default: null
+  },
   /**
    * Custom SSL certificates
    *
@@ -110,13 +125,18 @@ exports.config = () => ({
    * ]
    *
    */
-  certificates: [],
+  certificates: {
+    formatter: array,
+    default: []
+  },
   /**
    * Whether the module is enabled.
-   *
-   * @env NEW_RELIC_ENABLED
    */
-  agent_enabled: true,
+  agent_enabled: {
+    env: 'NEW_RELIC_ENABLED',
+    formatter: boolean,
+    default: true
+  },
   /**
    * The default Apdex tolerating / threshold value for applications, in
    * seconds. The default for Node is apdexT to 100 milliseconds, which is
@@ -128,24 +148,25 @@ exports.config = () => ({
    *
    * @see https://docs.newrelic.com/docs/apm/new-relic-apm/apdex/changing-your-apdex-settings
    */
-  apdex_t: 0.1,
-
+  apdex_t: {
+    formatter: float,
+    default: 0.1
+  },
   /**
    * When true, all request headers except for those listed in attributes.exclude
    * will be captured for all traces, unless otherwise specified in a destination's
    * attributes include/exclude lists.
-   *
-   * @env NEW_RELIC_ALLOW_ALL_HEADERS
    */
-  allow_all_headers: false,
+  allow_all_headers: {
+    formatter: boolean,
+    default: false
+  },
 
   /**
    * If the data compression threshold is reached in the payload, the
    * agent compresses data, using gzip compression by default. The
    * config option `compressed_content_encoding` can be set to 'deflate'
    * to use deflate compression.
-   *
-   * @env NEW_RELIC_COMPRESSED_CONTENT_ENCODING
    */
   compressed_content_encoding: 'gzip',
 
@@ -157,45 +178,51 @@ exports.config = () => ({
     /**
      * If `true`, enables capture of attributes for all destinations.
      * If there are specific parameters you want ignored, use `attributes.exclude`.
-     *
-     * @env NEW_RELIC_ATTRIBUTES_ENABLED
      */
-    enabled: true,
+    enabled: {
+      formatter: boolean,
+      default: true
+    },
 
     /**
      * Prefix of attributes to exclude from all destinations. Allows * as wildcard at end.
      *
      * NOTE: If excluding headers, they must be in camelCase form to be filtered.
-     *
-     * @env NEW_RELIC_ATTRIBUTES_EXCLUDE
      */
-    exclude: [],
+    exclude: {
+      formatter: array,
+      default: []
+    },
 
     /**
      * Prefix of attributes to include in all destinations. Allows * as wildcard at end.
      *
      * NOTE: If including headers, they must be in camelCase form to be filtered.
-     *
-     * @env NEW_RELIC_ATTRIBUTES_INCLUDE
      */
-    include: [],
+    include: {
+      formatter: array,
+      default: []
+    },
 
     /**
      * If `true`, patterns may be added to the `attributes.include`
      * list.
-     *
-     * @env NEW_RELIC_ATTRIBUTES_INCLUDE_ENABLED
      */
-    include_enabled: true,
+    include_enabled: {
+      formatter: boolean,
+      default: true
+    },
 
     /**
      * Controls how many attribute include/exclude rule results are cached by
      * the filter. Increasing this limit will cause greater memory usage and is
      * only necessary if you have an extremely high variety of attributes.
      */
-    filter_cache_limit: 1000
+    filter_cache_limit: {
+      formatter: int,
+      default: 1000
+    }
   },
-
   logging: {
     /**
      * Verbosity of the module's logging. This module uses bunyan
@@ -204,42 +231,49 @@ exports.config = () => ({
      * 'trace'. Logging at levels 'info' and higher is very terse. For support
      * requests, attaching logs captured at 'trace' level are extremely helpful
      * in chasing down bugs.
-     *
-     * @env NEW_RELIC_LOG_LEVEL
      */
-    level: 'info',
+    level: {
+      default: 'info',
+      env: 'NEW_RELIC_LOG_LEVEL'
+    },
     /**
      * Where to put the log file -- by default just uses process.cwd +
      * 'newrelic_agent.log'. A special case is a filepath of 'stdout',
      * in which case all logging will go to stdout, or 'stderr', in which
      * case all logging will go to stderr.
-     *
-     * @env NEW_RELIC_LOG
      */
-    filepath: require('path').join(process.cwd(), 'newrelic_agent.log'),
+    filepath: {
+      default: require('path').join(process.cwd(), 'newrelic_agent.log'),
+      env: 'NEW_RELIC_LOG'
+    },
     /**
      * Whether to write to a log file at all
-     *
-     * @env NEW_RELIC_LOG_ENABLED
      */
-    enabled: true,
+    enabled: {
+      formatter: boolean,
+      default: true,
+      env: 'NEW_RELIC_LOG_ENABLED'
+    },
 
     /**
      * Enables extra debugging at `warn` level. No need to enable except under
      * specific debugging conditions.
      */
-    diagnostics: false
+    diagnostics: {
+      formatter: boolean,
+      deafult: false
+    }
   },
-
   audit_log: {
     /**
      * Enables logging of out bound traffic from the Agent to the Collector.
      * This field is ignored if trace level logging is enabled.
      * With trace logging, all traffic is logged.
-     *
-     * @env NEW_RELIC_AUDIT_LOG_ENABLED
      */
-    enabled: false,
+    enabled: {
+      formatter: boolean,
+      default: false
+    },
 
     /**
      * Specify which methods are logged. Used in conjunction with the audit_log flag
@@ -247,44 +281,49 @@ exports.config = () => ({
      * Otherwise, if the audit log is enabled, only the methods specified
      * in the filter will be logged
      * Methods include: error_data, metric_data, and analytic_event_data
-     *
-     * @env NEW_RELIC_AUDIT_LOG_ENDPOINTS
      */
-    endpoints: []
+    endpoints: {
+      formatter: array,
+      default: []
+    }
   },
   /**
    * Whether to collect & submit error traces to New Relic.
-   *
-   * @env NEW_RELIC_ERROR_COLLECTOR_ENABLED
    */
   error_collector: {
     attributes: {
       /**
        * If `true`, the agent captures attributes from error collection.
-       *
-       * @env NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_ENABLED
        */
-      enabled: true,
+      enabled: {
+        formatter: boolean,
+        default: true
+      },
       /**
        * Prefix of attributes to exclude from error collection.
        * Allows * as wildcard at end.
-       *
-       * @env NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_EXCLUDE
        */
-      exclude: [],
+      exclude: {
+        formatter: array,
+        default: []
+      },
       /**
        * Prefix of attributes to include in error collection.
        * Allows * as wildcard at end.
-       *
-       * @env NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_INCLUDE
        */
-      include: []
+      include: {
+        formatter: array,
+        default: []
+      }
     },
     /**
      * Disabling the error tracer just means that errors aren't collected
      * and sent to New Relic -- it DOES NOT remove any instrumentation.
      */
-    enabled: true,
+    enabled: {
+      formatter: boolean,
+      default: true
+    },
     /**
      * List of HTTP error status codes the error tracer should disregard.
      * Ignoring a status code means that the transaction is not renamed to
@@ -295,14 +334,19 @@ exports.config = () => ({
      * `noticeError()`.
      *
      * Defaults to 404 NOT FOUND.
-     *
-     * @env NEW_RELIC_ERROR_COLLECTOR_IGNORE_ERROR_CODES
      */
-    ignore_status_codes: [404],
+    ignore_status_codes: {
+      env: 'NEW_RELIC_ERROR_COLLECTOR_IGNORE_ERROR_CODES',
+      formatter: array,
+      default: [404]
+    },
     /**
      * Whether error events are collected.
      */
-    capture_events: true,
+    capture_events: {
+      formatter: boolean,
+      default: true
+    },
     /**
      * The agent will collect all error events up to this number per minute.
      * If there are more than that, a statistical sampling will be collected.
@@ -313,16 +357,35 @@ exports.config = () => ({
      * Relic servers. The memory concerns are something you should consider for
      * your own server's sake. The payload of events is compressed, but if it
      * grows too large the New Relic servers may reject it.
-     *
-     * @env NEW_RELIC_ERROR_COLLECTOR_MAX_EVENT_SAMPLES_STORED
      */
-    max_event_samples_stored: 100,
+    max_event_samples_stored: {
+      formatter: int,
+      default: 100
+    },
 
-    expected_classes: [],
-    expected_messages: {},
-    expected_status_codes: [],
-    ignore_classes: [],
-    ignore_messages: {}
+    expected_classes: {
+      formatter: array,
+      default: [],
+      env: 'NEW_RELIC_ERROR_COLLECTOR_EXPECTED_ERRORS'
+    },
+    expected_messages: {
+      formatter: object,
+      default: {}
+    },
+    expected_status_codes: {
+      formatter: array,
+      default: [],
+      env: 'NEW_RELIC_ERROR_COLLECTOR_EXPECTED_ERROR_CODES'
+    },
+    ignore_classes: {
+      formatter: array,
+      default: [],
+      env: 'NEW_RELIC_ERROR_COLLECTOR_IGNORE_ERRORS'
+    },
+    ignore_messages: {
+      formatter: object,
+      default: {}
+    }
   },
   /**
    * Error message redaction
@@ -334,10 +397,11 @@ exports.config = () => ({
     /**
      * When `true`, the agent will redact the messages of captured
      * errors.
-     *
-     *  @env NEW_RELIC_STRIP_EXCEPTION_MESSAGES_ENABLED
      */
-    enabled: false
+    enabled: {
+      formatter: boolean,
+      default: false
+    }
   },
   /**
    * Options regarding collecting system information. Used for system
@@ -347,80 +411,104 @@ exports.config = () => ({
     /**
      * This flag dictates whether the agent attempts to reach out to AWS
      * to get info about the vm the process is running on.
-     *
-     * @env NEW_RELIC_UTILIZATION_DETECT_AWS
      */
-    detect_aws: true,
+    detect_aws: {
+      formatter: boolean,
+      default: true
+    },
     /**
      * This flag dictates whether the agent attempts to detect if the
      * the process is running on Pivotal Cloud Foundry.
-     *
-     * @env NEW_RELIC_UTILIZATION_DETECT_PCF
      */
-    detect_pcf: true,
+    detect_pcf: {
+      formatter: boolean,
+      default: true
+    },
     /**
      * This flag dictates whether the agent attempts to reach out to Azure to
      * get info about the vm the process is running on.
-     *
-     * @env NEW_RELIC_UTILIZATION_DETECT_AZURE
      */
-    detect_azure: true,
+    detect_azure: {
+      formatter: boolean,
+      default: true
+    },
     /**
      * This flag dictates whether the agent attempts to read files
      * to get info about the container the process is running in.
      *
      * @env NEW_RELIC_UTILIZATION_DETECT_DOCKER
      */
-    detect_docker: true,
+    detect_docker: {
+      formatter: boolean,
+      default: true
+    },
 
     /**
      * This flag dictates whether the agent attempts to reach out to GCP
      * to get info about the vm the process is running on.
-     *
-     * @env NEW_RELIC_UTILIZATION_DETECT_GCP
      */
-    detect_gcp: true,
+    detect_gcp: {
+      formatter: boolean,
+      default: true
+    },
 
     /**
      * This flag dictates whether the agent attempts to reach out to
      * Kubernetes to get info about the container the process is running on.
-     *
-     * @env NEW_RELIC_UTILIZATION_DETECT_KUBERNETES
      */
-    detect_kubernetes: true
+    detect_kubernetes: {
+      formatter: boolean,
+      default: true
+    },
+    logical_processors: {
+      formatter: float,
+      default: null
+    },
+    billing_hostname: {
+      default: null
+    },
+    total_ram_mib: {
+      formatter: int,
+      default: null
+    }
   },
   transaction_tracer: {
     attributes: {
       /**
        * If `true`, the agent captures attributes from transaction traces.
-       *
-       * @env NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_ENABLED
        */
-      enabled: true,
+      enabled: {
+        formatter: boolean,
+        default: true
+      },
       /**
        * Prefix of attributes to exclude from transaction traces.
        * Allows * as wildcard at end.
-       *
-       * @env NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_EXCLUDE
        */
-      exclude: [],
+      exclude: {
+        formatter: array,
+        default: []
+      },
       /**
        * Prefix of attributes to include in transaction traces.
        * Allows * as wildcard at end.
-       *
-       * @env NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_INCLUDE
        */
-      include: []
+      include: {
+        formatter: array,
+        default: []
+      }
     },
     /**
      * Whether to collect & submit slow transaction traces to New Relic. The
      * instrumentation is loaded regardless of this setting, as it's necessary
      * to gather metrics. Disable the agent to prevent the instrumentation from
      * loading.
-     *
-     * @env NEW_RELIC_TRACER_ENABLED
      */
-    enabled: true,
+    enabled: {
+      formatter: boolean,
+      default: true,
+      env: 'NEW_RELIC_TRACER_ENABLED'
+    },
     /**
      * The duration at below which the slow transaction tracer should collect a
      * transaction trace. If set to 'apdex_f', the threshold will be set to
@@ -428,10 +516,12 @@ exports.config = () => ({
      * be 2 seconds.
      *
      * If a time is provided, it is set in seconds.
-     *
-     * @env NEW_RELIC_TRACER_THRESHOLD
      */
-    transaction_threshold: 'apdex_f',
+    transaction_threshold: {
+      formatter: float,
+      default: 'apdex_f',
+      env: 'NEW_RELIC_TRACER_THRESHOLD'
+    },
     /**
      * Increase this parameter to increase the diversity of the slow
      * transaction traces recorded by your application over time. Confused?
@@ -457,7 +547,11 @@ exports.config = () => ({
      *
      * @env NEW_RELIC_TRACER_TOP_N
      */
-    top_n: 20,
+    top_n: {
+      formatter: int,
+      default: 20,
+      env: 'NEW_RELIC_TRACER_TOP_N'
+    },
 
     /**
      * This option affects both slow-queries and record_sql for transaction
@@ -467,31 +561,23 @@ exports.config = () => ({
      * or 'obfuscated' and other criteria (slow_sql.enabled etc) are met
      * for a query. The raw or obfuscated sql will be included in the
      * transaction trace and a slow query sample will be collected.
-     *
-     * @env NEW_RELIC_RECORD_SQL
      */
-    record_sql: 'off',
+    record_sql: {
+      formatter: allowList.bind(null, ['off', 'obfuscated', 'raw']),
+      default: 'off',
+      env: 'NEW_RELIC_RECORD_SQL'
+    },
 
     /**
      * This option affects both slow-queries and record_sql for transaction
      * traces.  This is the minimum duration a query must take (in ms) for it
      * to be considered for for slow query and inclusion in transaction traces.
      */
-    explain_threshold: 500,
-
-    /**
-     * This option controls the enumerability of internal properties the agent
-     * puts on application objects such as requests and promises while tracing.
-     * When `true`, these properties will be configured with `enumerable: false`
-     * using `Object.defineProperty`.
-     *
-     * XXX: This can have a significant impact on application performance, so if
-     * this is not necessary for your application we recommend disabling the
-     * feature.
-     *
-     * @env NEW_RELIC_HIDE_INTERNALS
-     */
-    hide_internals: true
+    explain_threshold: {
+      formatter: int,
+      default: 500,
+      env: 'NEW_RELIC_EXPLAIN_THRESHOLD'
+    }
   },
   /**
    * Rules for naming or ignoring transactions.
@@ -504,10 +590,12 @@ exports.config = () => ({
      * are ignored. Patterns may have capture groups (following JavaScript
      * conventions), and names will use $1-style replacement strings. See
      * the documentation for addNamingRule for important caveats.
-     *
-     * @env NEW_RELIC_NAMING_RULES
      */
-    name: [],
+    name: {
+      formatter: objectList,
+      default: [],
+      env: 'NEW_RELIC_NAMING_RULES'
+    },
     /**
      * A list of patterns for matching incoming request URLs to be ignored by
      * the agent. Patterns may be strings or regular expressions.
@@ -516,7 +604,11 @@ exports.config = () => ({
      *
      * @env NEW_RELIC_IGNORING_RULES
      */
-    ignore: ['^/socket.io/.*/xhr-polling/']
+    ignore: {
+      formatter: array,
+      default: ['^/socket.io/.*/xhr-polling/'],
+      env: 'NEW_RELIC_IGNORING_RULES'
+    }
   },
   /**
    * By default, any transactions that are not affected by other bits of
@@ -527,10 +619,11 @@ exports.config = () => ({
    * metric grouping issues and are confident your application isn't going
    * to run afoul of them. Your application could end up getting blocked!
    * Nobody wants that.
-   *
-   * @env NEW_RELIC_ENFORCE_BACKSTOP
    */
-  enforce_backstop: true,
+  enforce_backstop: {
+    formatter: boolean,
+    default: true
+  },
   /**
    * Browser Monitoring
    *
@@ -542,24 +635,27 @@ exports.config = () => ({
     attributes: {
       /**
        * If `true`, the agent captures attributes from browser monitoring.
-       *
-       * @env NEW_RELIC_BROWSER_MONITOR_ATTRIBUTES
        */
-      enabled: false,
+      enabled: {
+        formatter: boolean,
+        default: false
+      },
       /**
        * Prefix of attributes to exclude from browser monitoring.
        * Allows * as wildcard at end.
-       *
-       * @env NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_EXCLUDE
        */
-      exclude: [],
+      exclude: {
+        formatter: array,
+        default: []
+      },
       /**
        * Prefix of attributes to include in browser monitoring.
        * Allows * as wildcard at end.
-       *
-       * @env NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_INCLUDE
        */
-      include: []
+      include: {
+        formatter: array,
+        default: []
+      }
     },
     /**
      * Enable browser monitoring header generation.
@@ -587,16 +683,20 @@ exports.config = () => ({
      * time you want to generate the headers.
      *
      * Do *not* reuse the headers between users, or even between requests.
-     *
-     * @env NEW_RELIC_BROWSER_MONITOR_ENABLE
      */
-    enable: true,
+    enable: {
+      formatter: boolean,
+      default: true,
+      env: 'NEW_RELIC_BROWSER_MONITOR_ENABLE'
+    },
     /**
      * Request un-minified sources from the server.
-     *
-     * @env NEW_RELIC_BROWSER_MONITOR_DEBUG
      */
-    debug: false
+    debug: {
+      formatter: boolean,
+      default: false,
+      env: 'NEW_RELIC_BROWSER_MONITOR_DEBUG'
+    }
   },
   /**
    * API Configuration
@@ -608,29 +708,35 @@ exports.config = () => ({
   api: {
     /**
      * Controls for the `API.addCustomAttribute` method.
-     *
-     * @env NEW_RELIC_API_CUSTOM_ATTRIBUTES
      */
-    custom_attributes_enabled: true,
+    custom_attributes_enabled: {
+      formatter: boolean,
+      default: true,
+      env: 'NEW_RELIC_API_CUSTOM_ATTRIBUTES'
+    },
     /**
      * Controls for the `API.recordCustomEvent` method.
-     *
-     * @env NEW_RELIC_API_CUSTOM_EVENTS
      */
-    custom_events_enabled: true,
+    custom_events_enabled: {
+      formatter: boolean,
+      default: true,
+      env: 'NEW_RELIC_API_CUSTOM_EVENTS'
+    },
     /**
      * Controls for the `API.noticeError` method.
-     *
-     * @env NEW_RELIC_API_NOTICE_ERROR
      */
-    notice_error_enabled: true,
+    notice_error_enabled: {
+      formatter: boolean,
+      default: true,
+      env: 'NEW_RELIC_API_NOTICE_ERROR'
+    },
     /**
      * Sets the path to custom ESM instrumentation
-     *
-     * @env NEW_RELIC_API_ESM_CUSTOM_INSTRUMENTATION_ENTRYPOINT
      */
     esm: {
-      custom_instrumentation_entrypoint: null
+      custom_instrumentation_entrypoint: {
+        default: null
+      }
     }
   },
   /**
@@ -645,39 +751,49 @@ exports.config = () => ({
     attributes: {
       /**
        * If `true`, the agent captures attributes from transaction events.
-       *
-       * @env NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_ENABLED
        */
-      enabled: true,
+      enabled: {
+        formatter: boolean,
+        default: true
+      },
       /**
        * Prefix of attributes to exclude in transaction events.
        * Allows * as wildcard at end.
        *
        * @env NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_EXCLUDE
        */
-      exclude: [],
+      exclude: {
+        formatter: array,
+        default: []
+      },
       /**
        * Prefix of attributes to include in transaction events.
        * Allows * as wildcard at end.
        *
        * @env NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_INCLUDE
        */
-      include: []
+      include: {
+        formatter: array,
+        default: []
+      }
     },
     /**
      * If this is disabled, the agent does not collect, nor try to send,
      * analytic data.
      */
-    enabled: true,
+    enabled: {
+      formatter: boolean,
+      default: true
+    },
     /**
      * The agent will collect all events up to this number per minute. If
      * there are more than that, a statistical sampling will be collected.
-     *
-     * @env NEW_RELIC_TRANSACTION_EVENTS_MAX_SAMPLES_STORED
      */
-    max_samples_stored: 10000
+    max_samples_stored: {
+      formatter: int,
+      default: 10000
+    }
   },
-
   /**
    * Custom Insights Events
    *
@@ -693,7 +809,10 @@ exports.config = () => ({
      * If this is disabled, the agent does not collect, nor try to send, custom
      * event data.
      */
-    enabled: true,
+    enabled: {
+      formatter: boolean,
+      default: true
+    },
     /**
      * The agent will collect all events up to this number per minute. If there
      * are more than that, a statistical sampling will be collected. Currently
@@ -704,10 +823,11 @@ exports.config = () => ({
      * Relic servers. The memory concerns are something you should consider for
      * your own server's sake. The payload of events is compressed, but if it
      * grows too large the New Relic servers may reject it.
-     *
-     * @env NEW_RELIC_CUSTOM_INSIGHTS_EVENTS_MAX_SAMPLES_STORED
      */
-    max_samples_stored: 3000
+    max_samples_stored: {
+      formatter: int,
+      default: 3000
+    }
   },
   /**
    * This is used to configure properties about the user's host name.
@@ -715,18 +835,17 @@ exports.config = () => ({
   process_host: {
     /**
      * Configurable display name for hosts
-     *
-     * @env NEW_RELIC_PROCESS_HOST_DISPLAY_NAME
      */
     display_name: '',
     /**
      * ip address preference when creating hostnames
-     *
-     * @env NEW_RELIC_IPV_PREFERENCE
      */
-    ipv_preference: '4'
+    ipv_preference: {
+      formatter: allowList.bind(null, ['4', '6']),
+      default: '4',
+      env: 'NEW_RELIC_IPV_PREFERENCE'
+    }
   },
-
   /**
    * High Security
    *
@@ -742,7 +861,10 @@ exports.config = () => ({
    *
    * To read more see: https://docs.newrelic.com/docs/subscriptions/high-security
    */
-  high_security: false,
+  high_security: {
+    formatter: boolean,
+    default: false
+  },
 
   /**
    * Labels
@@ -751,8 +873,9 @@ exports.config = () => ({
    * from this agent. Both label names and label values have a maximum length of
    * 255 characters. This object should contain at most 64 labels.
    */
-  labels: {},
-
+  labels: {
+    default: {}
+  },
   /**
    * These options control behavior for slow queries, but do not affect sql
    * nodes in transaction traces.
@@ -760,10 +883,11 @@ exports.config = () => ({
   slow_sql: {
     /**
      * Enables and disables `slow_sql` recording.
-     *
-     * @env NEW_RELIC_SLOW_SQL_ENABLED
      */
-    enabled: false,
+    enabled: {
+      formatter: boolean,
+      default: false
+    },
 
     /**
      * Sets the maximum number of slow query samples that will be collected in a
@@ -771,9 +895,12 @@ exports.config = () => ({
      *
      * @env NEW_RELIC_MAX_SQL_SAMPLES
      */
-    max_samples: 10
+    max_samples: {
+      formatter: int,
+      default: 10,
+      env: 'NEW_RELIC_MAX_SQL_SAMPLES'
+    }
   },
-
   /**
    * Controls behavior of datastore instance metrics.
    *
@@ -784,64 +911,79 @@ exports.config = () => ({
    *  Enables reporting of database/schema names. Default is `true`.
    */
   datastore_tracer: {
-    instance_reporting: { enabled: true },
-    database_name_reporting: { enabled: true }
+    instance_reporting: {
+      enabled: {
+        formatter: boolean,
+        default: true,
+        env: 'NEW_RELIC_DATASTORE_INSTANCE_REPORTING_ENABLED'
+      }
+    },
+    database_name_reporting: {
+      enabled: {
+        formatter: boolean,
+        default: true,
+        env: 'NEW_RELIC_DATASTORE_DATABASE_NAME_REPORTING_ENABLED'
+      }
+    }
   },
-
   /**
    * Controls behavior of gRPC server instrumentation.
    */
   grpc: {
     /**
      * Enables recording of non-zero gRPC status codes. Default is `true`.
-     *
-     * @env NEW_RELIC_GRPC_RECORD_ERRORS
      */
-    record_errors: true
+    record_errors: {
+      formatter: boolean,
+      default: true
+    }
   },
-
   /**
    * Controls the behavior of span events produced by the agent.
    */
   span_events: {
     /**
      * Enables/disables span event generation
-     *
-     * @env NEW_RELIC_SPAN_EVENTS_ENABLED
      */
-    enabled: true,
+    enabled: {
+      formatter: boolean,
+      default: true
+    },
 
     attributes: {
       /**
        * If `true`, the agent captures attributes from span events.
-       *
-       * @env NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_ENABLED
        */
-      enabled: true,
+      enabled: {
+        formatter: boolean,
+        default: true
+      },
       /**
        * Prefix of attributes to exclude in span events.
        * Allows * as wildcard at end.
-       *
-       * @env NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_EXCLUDE
        */
-      exclude: [],
+      exclude: {
+        formatter: array,
+        default: []
+      },
       /**
        * Prefix of attributes to include in span events.
        * Allows * as wildcard at end.
-       *
-       * @env NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_INCLUDE
        */
-      include: []
+      include: {
+        formatter: array,
+        default: []
+      }
     },
     /**
      * The agent will collect all events up to this number per minute. If
      * there are more than that, a statistical sampling will be collected.
-     *
-     * @env NEW_RELIC_SPAN_EVENTS_MAX_SAMPLES_STORED
      */
-    max_samples_stored: 2000
+    max_samples_stored: {
+      formatter: int,
+      default: 2000
+    }
   },
-
   /**
    * Controls the behavior of transaction segments produced by the agent.
    */
@@ -849,27 +991,29 @@ exports.config = () => ({
     attributes: {
       /**
        * If `true`, the agent captures attributes from transaction segments.
-       *
-       * @env NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_ENABLED
        */
-      enabled: true,
+      enabled: {
+        formatter: boolean,
+        default: true
+      },
       /**
        * Prefix of attributes to exclude in transaction segments.
        * Allows * as wildcard at end.
-       *
-       * @env NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_EXCLUDE
        */
-      exclude: [],
+      exclude: {
+        formatter: array,
+        default: []
+      },
       /**
        * Prefix of attributes to include in transaction segments.
        * Allows * as wildcard at end.
-       *
-       * @env NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_INCLUDE
        */
-      include: []
+      include: {
+        formatter: array,
+        default: []
+      }
     }
   },
-
   /**
    * Controls the method of cross agent tracing in the agent.
    * Distributed tracing lets you see the path that a request takes through your
@@ -881,22 +1025,23 @@ exports.config = () => ({
   distributed_tracing: {
     /**
      * Enables/disables distributed tracing.
-     *
-     * @env NEW_RELIC_DISTRIBUTED_TRACING_ENABLED
      */
-    enabled: true,
+    enabled: {
+      formatter: boolean,
+      default: true
+    },
 
     /**
      * Excludes New Relic format distributed tracing header (`newrelic`) on
      * outbound requests when set to `true`. By default (when false)
      * both W3C TraceContext (`traceparent`, `tracecontext`) and
      * New Relic formats will be sent.
-     *
-     * @env NEW_RELIC_DISTRIBUTED_TRACING_EXCLUDE_NEWRELIC_HEADER
      */
-    exclude_newrelic_header: false
+    exclude_newrelic_header: {
+      formatter: boolean,
+      default: false
+    }
   },
-
   /**
    * Controls the use of cross-application tracing.
    *
@@ -905,8 +1050,12 @@ exports.config = () => ({
    * This feature has been deprecated in favor of Distributed Tracing (DT).
    * To fully enable this feature, you must also disable DT in your configuration.
    */
-  cross_application_tracer: { enabled: false },
-
+  cross_application_tracer: {
+    enabled: {
+      formatter: boolean,
+      default: false
+    }
+  },
   /**
    * Controls behavior of message broker tracing.
    *
@@ -914,9 +1063,13 @@ exports.config = () => ({
    *  Enables reporting parameters on message broker segments.
    */
   message_tracer: {
-    segment_parameters: { enabled: true }
+    segment_parameters: {
+      enabled: {
+        formatter: boolean,
+        default: true
+      }
+    }
   },
-
   /**
    * Controls the use of infinite tracing.
    */
@@ -924,45 +1077,49 @@ exports.config = () => ({
     trace_observer: {
       /**
        * The URI HOST of the observer.  Setting this enables infinite tracing.
-       *
-       * @env NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_HOST
        */
       host: '',
       /**
        * The URI PORT of the observer.
-       *
-       * @env NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_PORT
        */
-      port: '443'
+      port: {
+        formatter: int,
+        default: 443
+      }
     },
     span_events: {
       /**
        * The amount of spans to hold onto before dropping them
-       *
-       * @env NEW_RELIC_INFINITE_TRACING_SPAN_EVENTS_QUEUE_SIZE
        */
-      queue_size: 10000
+      queue_size: {
+        formatter: int,
+        default: 10000
+      }
     }
   },
-
   /**
    * Specifies whether the agent will be used to monitor serverless functions.
    * For example: AWS Lambda
-   *
-   * @env NEW_RELIC_SERVERLESS_MODE_ENABLED
    */
   serverless_mode: {
-    enabled: process.env.AWS_LAMBDA_FUNCTION_NAME != null
+    enabled: {
+      formatter: boolean,
+      default: process.env.AWS_LAMBDA_FUNCTION_NAME != null
+    }
   },
-
   plugins: {
     /**
      * Controls usage of the native metrics module which samples VM and event
      * loop data.
      */
-    native_metrics: { enabled: true }
+    native_metrics: {
+      enabled: {
+        formatter: boolean,
+        default: true,
+        env: 'NEW_RELIC_NATIVE_METRICS_ENABLED'
+      }
+    }
   },
-
   /**
    *
    * Controls the behavior of Logs in Context within agent
@@ -970,42 +1127,46 @@ exports.config = () => ({
   application_logging: {
     /**
      * Toggles the ability for all application logging features to be enabled.
-     *
-     * @env NEW_RELIC_APPLICATION_LOGGING_ENABLED
      */
-    enabled: true,
+    enabled: {
+      formatter: boolean,
+      default: true
+    },
     forwarding: {
       /**
        * Toggles whether the agent gathers log records for sending to New Relic.
-       *
-       * @env NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED
        */
-      enabled: true,
+      enabled: {
+        formatter: boolean,
+        default: true
+      },
       /**
        * Number of log records to send per minute to New Relic.
-       *
-       * @env NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED
        */
-      max_samples_stored: 10000
+      max_samples_stored: {
+        formatter: int,
+        default: 10000
+      }
     },
     metrics: {
       /**
        * Toggles whether the agent gathers logging metrics.
-       *
-       * @env NEW_RELIC_APPLICATION_LOGGING_METRICS_ENABLED
        */
-      enabled: true
+      enabled: {
+        formatter: boolean,
+        default: true
+      }
     },
     local_decorating: {
       /**
        * Toggles whether the agent performs log decoration on standard log output.
-       *
-       * @env NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED
        */
-      enabled: false
+      enabled: {
+        formatter: boolean,
+        default: false
+      }
     }
   },
-
   /**
    * You may want more control over how your agent is configured and want to
    * disallow the use of New Relic's server-side configuration for agents.
@@ -1013,5 +1174,85 @@ exports.config = () => ({
    *
    * @env NEW_RELIC_IGNORE_SERVER_SIDE_CONFIG
    */
-  ignore_server_configuration: false
+  ignore_server_configuration: {
+    formatter: boolean,
+    default: false,
+    env: 'NEW_RELIC_IGNORE_SERVER_SIDE_CONFIG'
+  }
 })
+
+/**
+ * Creates a new default config
+ */
+defaultConfig.config = () => {
+  const config = Object.create(null)
+  const definition = defaultConfig.definition()
+  buildConfig(definition, config)
+  return config
+}
+
+/**
+ * Iterates over the configuration definition and sets all default
+ * values.
+ *
+ * @param {object} definition configuration definition for a given leaf node
+ * @param {object} config object that is used to construct the agent config
+ * @param {Array} [paths=[]] an array to capture the leaf node keys to properly assign defaults for nested objects
+ * @param {int} [objectKeys=1] amount of keys in a given leaf node
+ */
+function buildConfig(definition, config, paths = [], objectKeys = 1) {
+  let keysSeen = 0
+  Object.entries(definition).reduce((conf, [key, value]) => {
+    const type = typeof value
+    keysSeen++
+    if (type === 'string') {
+      if (paths.length) {
+        setNestedKey(conf, [...paths, key], value)
+      } else {
+        conf[key] = value
+      }
+    } else if (type === 'object') {
+      if (value.hasOwnProperty('default')) {
+        if (paths.length) {
+          setNestedKey(conf, [...paths, key], value.default)
+        } else {
+          conf[key] = value.default
+        }
+      } else {
+        const { length } = Object.keys(value)
+        paths.push(key)
+        buildConfig(definition[key], conf, paths, length)
+      }
+    }
+
+    return conf
+  }, config)
+
+  // we have traversed every key in current object leaf node, remove wrapping key
+  // to properly derive env vars of future leaf nodes
+  if (keysSeen === objectKeys) {
+    paths.pop()
+  }
+}
+
+/**
+ * Properly sets the value of a nested key by creating the shells of empty parents
+ *
+ * @param {object} obj object to assign value to
+ * @param {Array} keys list of parent keys
+ * @param {value} value to assign the nested key
+ */
+function setNestedKey(obj, keys, value) {
+  const len = keys.length
+  for (let i = 0; i < len - 1; i++) {
+    const elem = keys[i]
+    if (!obj[elem]) {
+      obj[elem] = {}
+    }
+
+    obj = obj[elem]
+  }
+
+  obj[keys[len - 1]] = value
+}
+defaultConfig.setNestedKey = setNestedKey