Skip to content

Commit 0182689

Browse files
authored
docs: add dynamic badge to config reference (#794)
1 parent e131fc0 commit 0182689

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

docs/configuration.asciidoc

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,24 @@ ELASTIC_APM = {
2828

2929
The precedence is as follows:
3030

31-
* <<config-central_config, central configuration>>
31+
* <<config-central_config,Central configuration>>
32+
(supported options are marked with <<dynamic-configuration, image:./images/dynamic-config.svg[] >>)
3233
* environment variables
3334
* inline configuration
3435
* framework specific configuration
3536
* default value
3637

38+
[float]
39+
[[dynamic-configuration]]
40+
=== Dynamic configuration
41+
42+
Configuration options marked with the image:./images/dynamic-config.svg[] badge can be changed at runtime
43+
when set from a supported source.
44+
45+
The Python Agent supports {apm-app-ref}/agent-configuration.html[Central configuration],
46+
which allows you to fine-tune certain configurations from in the APM app.
47+
This feature is enabled in the Agent by default, with <<config-central_config>>.
48+
3749
[float]
3850
[[django-configuration]]
3951
=== Django
@@ -387,6 +399,8 @@ WARNING: Especially for spans, collecting source code can have a large impact on
387399
[[config-capture-body]]
388400
==== `capture_body`
389401

402+
<<dynamic-configuration, image:./images/dynamic-config.svg[] >>
403+
390404
|============
391405
| Environment | Django/Flask | Default
392406
| `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
410424
[[config-capture-headers]]
411425
==== `capture_headers`
412426

427+
<<dynamic-configuration, image:./images/dynamic-config.svg[] >>
428+
413429
|============
414430
| Environment | Django/Flask | Default
415431
| `ELASTIC_APM_CAPTURE_HEADERS` | `CAPTURE_HEADERS` | `true`
@@ -428,6 +444,8 @@ filter such data.
428444
[[config-transaction-max-spans]]
429445
==== `transaction_max_spans`
430446

447+
<<dynamic-configuration, image:./images/dynamic-config.svg[] >>
448+
431449
|============
432450
| Environment | Django/Flask | Default
433451
| `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`.
457475
[[config-span-frames-min-duration]]
458476
==== `span_frames_min_duration`
459477

478+
<<dynamic-configuration, image:./images/dynamic-config.svg[] >>
479+
460480
|============
461481
| Environment | Django/Flask | Default
462482
| `ELASTIC_APM_SPAN_FRAMES_MIN_DURATION` | `SPAN_FRAMES_MIN_DURATION` | `"5ms"`
@@ -479,6 +499,8 @@ this setting has to be provided in *<<config-format-duration, duration format>>*
479499
[[config-api-request-size]]
480500
==== `api_request_size`
481501

502+
<<dynamic-configuration, image:./images/dynamic-config.svg[] >>
503+
482504
|============
483505
| Environment | Django/Flask | Default
484506
| `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.
499521
[[config-api-request-time]]
500522
==== `api_request_time`
501523

524+
<<dynamic-configuration, image:./images/dynamic-config.svg[] >>
525+
502526
|============
503527
| Environment | Django/Flask | Default
504528
| `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
539563
[[config-transaction-sample-rate]]
540564
==== `transaction_sample_rate`
541565

566+
<<dynamic-configuration, image:./images/dynamic-config.svg[] >>
567+
542568
|============
543569
| Environment | Django/Flask | Default
544570
| `ELASTIC_APM_TRANSACTION_SAMPLE_RATE` | `TRANSACTION_SAMPLE_RATE` | `1.0`
@@ -706,7 +732,7 @@ NOTE: This feature requires APM Server and Kibana >= 7.3.
706732

707733
When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration.
708734

709-
See {apm-app-ref}/agent-configuration.html#agent-configuration[APM Agent Configuration] for more documentation on central agent configuration.
735+
See <<dynamic-configuration>> for more information.
710736

711737
NOTE: This feature requires APM Server and Kibana >= 7.3.
712738

docs/images/dynamic-config.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)