From 161e54274942feafb2c70238502b34e5f143f059 Mon Sep 17 00:00:00 2001 From: adityahiran Date: Sat, 4 Jul 2020 00:04:55 -0400 Subject: [PATCH] docs: add version in which the configurations were added #1134 --- docs/configuration.asciidoc | 98 +++++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) diff --git a/docs/configuration.asciidoc b/docs/configuration.asciidoc index 587eac58968..04b5b4074de 100644 --- a/docs/configuration.asciidoc +++ b/docs/configuration.asciidoc @@ -19,6 +19,8 @@ the agent will use the `name` from `package.json` by default if available. [[service-name]] ==== `serviceName` +[small]#Added in: v1.0.0# + * *Type:* String * *Default:* `name` field of `package.json` * *Env:* `ELASTIC_APM_SERVICE_NAME` @@ -31,6 +33,8 @@ Allowed characters: `a-z`, `A-Z`, `0-9`, `-`, `_`, and space. [[service-node-name]] ==== `serviceNodeName` +[small]#Added in: v3.2.0# + * *Type:* String * *Env:* `ELASTIC_APM_SERVICE_NODE_NAME` @@ -44,6 +48,8 @@ This option allows you to set the node name manually to ensure uniqueness and me [[secret-token]] ==== `secretToken` +[small]#Added in: v0.1.0# + * *Type:* String * *Env:* `ELASTIC_APM_SECRET_TOKEN` @@ -52,6 +58,8 @@ The secret token optionally expected by the APM Server. [[server-url]] ==== `serverUrl` +[small]#Added in: v0.1.0# + * *Type:* String * *Default:* `http://localhost:8200` * *Env:* `ELASTIC_APM_SERVER_URL` @@ -61,6 +69,8 @@ The URL to where the APM Server is deployed. [[validate-server-cert]] ==== `verifyServerCert` +[small]#Added in: v0.3.0# + * *Type:* Boolean * *Default:* `true` * *Env:* `ELASTIC_APM_VERIFY_SERVER_CERT` @@ -71,6 +81,8 @@ You can switch this behavior off by setting this option to `false`. [[server-ca-cert-file]] ==== `serverCaCertFile` +[small]#Added in: v3.3.0# + * *Type:* String * *Env:* `ELASTIC_APM_SERVER_CA_CERT_FILE` @@ -86,6 +98,8 @@ certificate validation is disabled. [[service-version]] ==== `serviceVersion` +[small]#Added in: v1.0.0# + * *Type:* String * *Default:* `version` field of `package.json` * *Env:* `ELASTIC_APM_SERVICE_VERSION` @@ -98,6 +112,8 @@ or any other string that might help you pinpoint a specific version or deploymen [[active]] ==== `active` +[small]#Added in: v0.1.0# + * *Type:* Boolean * *Default:* `true` * *Env:* `ELASTIC_APM_ACTIVE` @@ -119,6 +135,8 @@ var options = { [[environment]] ===== `environment` +[small]#Added in: v2.12.0# + * *Type:* String * *Default:* `process.env.NODE_ENV || 'development'` * *Env:* `ELASTIC_APM_ENVIRONMENT` @@ -137,6 +155,8 @@ You must use the query bar to filter for a specific environment in versions prio [[instrument]] ==== `instrument` +[small]#Added in: v0.1.0# + * *Type:* Boolean * *Default:* `true` * *Env:* `ELASTIC_APM_INSTRUMENT` @@ -148,6 +168,8 @@ Note that both `active` and `instrument` needs to be `true` for instrumentation [[instrument-incoming-http-requests]] ==== `instrumentIncomingHTTPRequests?:` +[small]#Added in: v3.0.0# + * *Type:* Boolean * *Default:* `true` * *Env:* `ELASTIC_APM_INSTRUMENT_INCOMING_HTTP_REQUESTS` @@ -160,6 +182,8 @@ see <>. [[central-config]] ==== `centralConfig` +[small]#Added in: v2.13.0# + * *Type:* Boolean * *Default:* `true` * *Env:* `ELASTIC_APM_CENTRAL_CONFIG` @@ -173,6 +197,8 @@ More information is available in {kibana-ref}/agent-configuration.html[APM Agent [[async-hooks]] ==== `asyncHooks` +[small]#Added in: v0.10.0# + * *Type:* Boolean * *Default:* `true` * *Env:* `ELASTIC_APM_ASYNC_HOOKS` @@ -250,6 +276,8 @@ require('elastic-apm-node').start({ <> +[small]#Added in: v1.0.0# + * *Type:* String * *Default:* `off` * *Env:* `ELASTIC_APM_CAPTURE_BODY` @@ -273,6 +301,8 @@ The agent will look for the body on the following properties: [[capture-headers]] ==== `captureHeaders` +[small]#Added in: v2.3.0# + * *Type:* Boolean * *Default:* true * *Env:* `ELASTIC_APM_CAPTURE_HEADERS` @@ -285,6 +315,8 @@ This can be disabled by setting this option to `false`. [[error-on-aborted-requests]] ==== `errorOnAbortedRequests` +[small]#Added in: v0.4.0# + * *Type:* Boolean * *Default:* `false` * *Env:* `ELASTIC_APM_ERROR_ON_ABORTED_REQUESTS` @@ -295,6 +327,8 @@ An error will be generated and sent to the APM Server if this happens. [[aborted-error-threshold]] ==== `abortedErrorThreshold` +[small]#Added in: v0.4.0# + * *Type:* Number * *Default:* `25s` * *Env:* `ELASTIC_APM_ABORTED_ERROR_THRESHOLD` @@ -310,6 +344,8 @@ If the `errorOnAbortedRequests` property is `false`, this property is ignored. <> +[small]#Added in: v1.0.0# + * *Type:* Number * *Default:* `1.0` * *Env:* `ELASTIC_APM_TRANSACTION_SAMPLE_RATE` @@ -321,6 +357,8 @@ The value should between `0.0` and `1.0` where `1.0` is 100% of all requests. [[hostname]] ==== `hostname` +[small]#Added in: v0.1.0# + * *Type:* String * *Default:* OS hostname * *Env:* `ELASTIC_APM_HOSTNAME` @@ -332,6 +370,8 @@ use this option. [[framework-name]] ==== `frameworkName` +[small]#Added in: v1.0.0# + * *Type:* String * *Env:* `ELASTIC_APM_FRAMEWORK_NAME` @@ -345,6 +385,8 @@ the agent will set the value of this config option if the framework can be detec [[framework-version]] ==== `frameworkVersion` +[small]#Added in: v1.0.0# + * *Type:* String * *Env:* `ELASTIC_APM_FRAMEWORK_VERSION` @@ -371,6 +413,8 @@ require('elastic-apm-node').start({ [[log-level]] ==== `logLevel` +[small]#Added in: v0.1.0# + * *Type:* String * *Default:* `'info'` * *Env:* `ELASTIC_APM_LOG_LEVEL` @@ -406,6 +450,8 @@ Note that if a custom logger is provided, the `logLevel` option will be ignored. [[capture-exceptions]] ==== `captureExceptions` +[small]#Added in: v0.1.0# + * *Type:* Boolean * *Default:* `true` * *Env:* `ELASTIC_APM_CAPTURE_EXCEPTIONS` @@ -415,6 +461,8 @@ Whether or not the agent should monitor for uncaught exceptions and send them to [[log-uncaught-exceptions]] ==== `logUncaughtExceptions` +[small]#Added in: v3.1.0# + * *Type:* Boolean * *Default:* `false` * *Env:* `ELASTIC_APM_LOG_UNCAUGHT_EXCEPTIONS` @@ -425,6 +473,8 @@ Set this config option to `true` to have the agent write stack traces of uncaugh [[capture-error-log-stack-traces]] ==== `captureErrorLogStackTraces` +[small]#Added in: v1.0.0# + * *Type:* String * *Default:* `messages` * *Env:* `ELASTIC_APM_CAPTURE_ERROR_LOG_STACK_TRACES` @@ -458,6 +508,8 @@ A capture location stack trace is never generated for uncaught exceptions. [[capture-span-stack-traces]] ==== `captureSpanStackTraces` +[small]#Added in: v1.0.0# + * *Type:* Boolean * *Default:* `true` * *Env:* `ELASTIC_APM_CAPTURE_SPAN_STACK_TRACES` @@ -467,6 +519,8 @@ Set this option to `false` to disable capture of stack traces for measured spans [[use-path-as-transaction-name]] ==== `usePathAsTransactionName` +[small]#Added in: v2.8.0# + * *Type:* Boolean * *Default:* `false` * *Env:* `ELASTIC_APM_USE_PATH_AS_TRANSACTION_NAME` @@ -491,6 +545,8 @@ Use the following two config options to change how many lines of source code to [[source-context-error-app-frames]] *`sourceLinesErrorAppFrames`* +[small]#Added in: v0.12.0# + * *Type:* Number * *Default:* `5` * *Env:* `ELASTIC_APM_SOURCE_LINES_ERROR_APP_FRAMES` @@ -503,6 +559,8 @@ Setting this config option to `0` means that no source code will be collected fo [[source-context-error-library-frames]] *`sourceLinesErrorLibraryFrames`* +[small]#Added in: v0.12.0# + * *Type:* Number * *Default:* `5` * *Env:* `ELASTIC_APM_SOURCE_LINES_ERROR_LIBRARY_FRAMES` @@ -532,6 +590,8 @@ Use the following two config options to change how many lines of source code to [[source-context-span-app-frames]] *`sourceLinesSpanAppFrames`* +[small]#Added in: v1.0.0# + * *Type:* Number * *Default:* `0` * *Env:* `ELASTIC_APM_SOURCE_LINES_SPAN_APP_FRAMES` @@ -541,6 +601,8 @@ The default value `0` means that no source code will be collected for in-app spa [[source-context-span-library-frames]] *`sourceLinesSpanLibraryFrames`* +[small]#Added in: v1.0.0# + * *Type:* Number * *Default:* `0` * *Env:* `ELASTIC_APM_SOURCE_LINES_SPAN_LIBRARY_FRAMES` @@ -550,6 +612,8 @@ The default value `0` means that no source code will be collected for span libra [[error-message-max-length]] ==== `errorMessageMaxLength` +[small]#Added in: v1.8.0# + * *Type:* String * *Default:* `2kb` * *Env:* `ELASTIC_APM_ERROR_MESSAGE_MAX_LENGTH` @@ -572,6 +636,8 @@ This applies to the following properties: [[stack-trace-limit]] ==== `stackTraceLimit` +[small]#Added in: v0.1.0# + * *Type:* Number * *Default:* `50` * *Env:* `ELASTIC_APM_STACK_TRACE_LIMIT` @@ -585,6 +651,8 @@ Setting it to `Infinity` means that all frames will be collected. <> +[small]#Added in: v1.0.0# + * *Type:* Number * *Default:* `500` * *Env:* `ELASTIC_APM_TRANSACTION_MAX_SPANS` @@ -596,6 +664,8 @@ Setting to `-1` means that spans will never be dropped. [[api-request-time]] ==== `apiRequestTime` +[small]#Added in: v2.0.0# + * *Type:* String * *Default:* `10s` * *Env:* `ELASTIC_APM_API_REQUEST_TIME` @@ -618,6 +688,8 @@ Use the <> config option to control the byte [[api-request-size]] ==== `apiRequestSize` +[small]#Added in: v2.0.0# + * *Type:* String * *Default:* `768kb` * *Env:* `ELASTIC_APM_API_REQUEST_SIZE` @@ -644,6 +716,8 @@ The HTTP request is otherwise ended at regular intervals controlled by the <> functions. [[disable-instrumentations]] ==== `disableInstrumentations` +[small]#Added in: v1.7.0# + * *Type:* Array of strings * *Env:* `ELASTIC_APM_DISABLE_INSTRUMENTATIONS` @@ -717,6 +795,8 @@ see <>. [[container-id]] ==== `containerId` +[small]#Added in: v2.3.0# + * *Type:* String * *Env:* `ELASTIC_APM_CONTAINER_ID` @@ -727,6 +807,8 @@ it will be parsed out of the `/proc/self/cgroup` file. [[kubernetes-node-name]] ==== `kubernetesNodeName` +[small]#Added in: v2.11.0# + * *Type:* String * *Env:* `KUBERNETES_NODE_NAME` @@ -735,6 +817,8 @@ Specify the kubernetes node name to associate with all reported events. [[kubernetes-namespace]] ==== `kubernetesNamespace` +[small]#Added in: v2.11.0# + * *Type:* String * *Env:* `KUBERNETES_NAMESPACE` @@ -743,6 +827,8 @@ Specify the kubernetes namespace to associate with all reported events. [[kubernetes-pod-name]] ==== `kubernetesPodName` +[small]#Added in: v2.11.0# + * *Type:* String * *Env:* `KUBERNETES_POD_NAME` @@ -754,6 +840,8 @@ this will default to the local hostname. [[kubernetes-pod-uid]] ==== `kubernetesPodUID` +[small]#Added in: v2.11.0# + * *Type:* String * *Env:* `KUBERNETES_POD_UID` @@ -764,6 +852,8 @@ it will be parsed out of the `/proc/self/cgroup` file. [[metrics-interval]] ==== `metricsInterval` +[small]#Added in: v2.5.0# + * *Type:* String * *Default:* `30s` * *Env:* `ELASTIC_APM_METRICS_INTERVAL` @@ -778,6 +868,8 @@ set the interval to `0`. [[metrics-limit]] ==== `metricsLimit` +[small]#Added in: v2.15.0# + * *Type:* Number * *Default:* `1000` * *Env:* `ELASTIC_APM_METRICS_LIMIT` @@ -789,6 +881,8 @@ the oldest metric will be dropped to give it space. [[global-labels]] ==== `globalLabels` +[small]#Added in: v2.11.0# + * *Type:* Object * *Env:* `ELASTIC_APM_GLOBAL_LABELS` @@ -803,6 +897,8 @@ ELASTIC_APM_GLOBAL_LABELS="subspace=sap-hana,rack=number6" [[config-file]] ==== `configFile` +[small]#Added in: v0.3.0# + * *Type:* String * *Default:* `elastic-apm-node.js` * *Env:* `ELASTIC_APM_CONFIG_FILE` @@ -841,6 +937,8 @@ module.exports = { [[breakdown-metrics]] ==== `breakdownMetrics` +[small]#Added in: v2.13.0# + * *Type:* Boolean * *Default:* `true` * *Env:* `ELASTIC_APM_BREAKDOWN_METRICS`