diff --git a/docs/configuration.asciidoc b/docs/configuration.asciidoc index 2e15f6f06..09d866ae1 100644 --- a/docs/configuration.asciidoc +++ b/docs/configuration.asciidoc @@ -28,12 +28,24 @@ ELASTIC_APM = { The precedence is as follows: - * <> + * <> +(supported options are marked with <>) * environment variables * inline configuration * framework specific configuration * default value +[float] +[[dynamic-configuration]] +=== Dynamic configuration + +Configuration options marked with the image:./images/dynamic-config.svg[] badge can be changed at runtime +when set from a supported source. + +The Python Agent supports {apm-app-ref}/agent-configuration.html[Central configuration], +which allows you to fine-tune certain configurations from in the APM app. +This feature is enabled in the Agent by default, with <>. + [float] [[django-configuration]] === Django @@ -387,6 +399,8 @@ WARNING: Especially for spans, collecting source code can have a large impact on [[config-capture-body]] ==== `capture_body` +<> + |============ | Environment | Django/Flask | Default | `ELASTIC_APM_CAPTURE_BODY` | `CAPTURE_BODY` | `off` @@ -410,6 +424,8 @@ If your service handles data like this, we advise to only enable this feature wi [[config-capture-headers]] ==== `capture_headers` +<> + |============ | Environment | Django/Flask | Default | `ELASTIC_APM_CAPTURE_HEADERS` | `CAPTURE_HEADERS` | `true` @@ -428,6 +444,8 @@ filter such data. [[config-transaction-max-spans]] ==== `transaction_max_spans` +<> + |============ | Environment | Django/Flask | Default | `ELASTIC_APM_TRANSACTION_MAX_SPANS` | `TRANSACTION_MAX_SPANS` | `500` @@ -457,6 +475,8 @@ To disable the limit and always capture all frames, set the value to `-1`. [[config-span-frames-min-duration]] ==== `span_frames_min_duration` +<> + |============ | Environment | Django/Flask | Default | `ELASTIC_APM_SPAN_FRAMES_MIN_DURATION` | `SPAN_FRAMES_MIN_DURATION` | `"5ms"` @@ -479,6 +499,8 @@ this setting has to be provided in *<>* [[config-api-request-size]] ==== `api_request_size` +<> + |============ | Environment | Django/Flask | Default | `ELASTIC_APM_API_REQUEST_SIZE` | `API_REQUEST_SIZE` | `"768kb"` @@ -499,6 +521,8 @@ By default, the APM Server limits request payload size to 1 MByte. [[config-api-request-time]] ==== `api_request_time` +<> + |============ | Environment | Django/Flask | Default | `ELASTIC_APM_API_REQUEST_TIME` | `API_REQUEST_TIME` | `"10s"` @@ -539,6 +563,8 @@ WARNING: We recommend to always include the default set of validators if you cus [[config-transaction-sample-rate]] ==== `transaction_sample_rate` +<> + |============ | Environment | Django/Flask | Default | `ELASTIC_APM_TRANSACTION_SAMPLE_RATE` | `TRANSACTION_SAMPLE_RATE` | `1.0` @@ -706,7 +732,7 @@ NOTE: This feature requires APM Server and Kibana >= 7.3. When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration. -See {apm-app-ref}/agent-configuration.html#agent-configuration[APM Agent Configuration] for more documentation on central agent configuration. +See <> for more information. NOTE: This feature requires APM Server and Kibana >= 7.3. diff --git a/docs/images/dynamic-config.svg b/docs/images/dynamic-config.svg new file mode 100644 index 000000000..df62a3c84 --- /dev/null +++ b/docs/images/dynamic-config.svg @@ -0,0 +1 @@ + DynamicDynamic \ No newline at end of file