Skip to content

Commit f6ba092

Browse files
authored
added docs for transaction_ignore_urls (#1086)
1 parent eab84c0 commit f6ba092

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

docs/configuration.asciidoc

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,20 @@ A list of exception types to be filtered.
419419
Exceptions of these types will not be sent to the APM Server.
420420

421421

422+
[float]
423+
[[config-transaction-ignore-urls]]
424+
==== `transaction_ignore_urls`
425+
[options="header"]
426+
|============
427+
| Environment | Django/Flask | Default | Example
428+
| `ELASTIC_APM_TRANSACTION_IGNORE_URLS` | `TRANSACTION_IGNORE_URLS` | `[]` | `['/api/ping', '/static/*']`
429+
| multiple values separated by commas, without spaces |||
430+
|============
431+
432+
A list of URLs for which the agent should not capture any transaction data.
433+
434+
Optionally, `*` can be used to match multiple URLs at once.
435+
422436
[float]
423437
[[config-transactions-ignore-patterns]]
424438
==== `transactions_ignore_patterns`
@@ -430,8 +444,11 @@ Exceptions of these types will not be sent to the APM Server.
430444
|============
431445

432446
A list of regular expressions.
433-
Transactions that match any of the of the configured patterns will be ignored and not sent to the APM Server.
447+
Transactions with a name that matches any of the configured patterns will be ignored and not sent to the APM Server.
434448

449+
NOTE: as the the name of the transaction can only be determined at the end of the transaction,
450+
the agent might still cause overhead for transactions ignored through this setting.
451+
If agent overhead is a concern, we recommend <<config-transaction-ignore-urls,`transaction_ignore_urls`>> instead.
435452

436453
[float]
437454
[[config-server-timeout]]

0 commit comments

Comments
 (0)