Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stevejgordon committed Apr 12, 2024
1 parent 79b2631 commit 83fcb3e
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions docs/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1074,6 +1074,30 @@ NOTE: All errors that are captured during a request to an ignored URL are still

NOTE: Changing this configuration will overwrite the default value.

[float]
[[config-transaction-name-groups]]
==== `TransactionNameGroups` (added[1.27.0])

With this option, you can group transaction names that contain dynamic parts with a wildcard expression. For example, the pattern GET /user/*/cart would consolidate transactions, such as GET /users/42/cart and GET /users/73/cart into a single transaction name GET /users/*/cart, hence reducing the transaction name cardinality.

This option supports the wildcard *, which matches zero or more characters. Examples: /foo/*/bar/*/baz*, *foo*. Matching is case insensitive by default. Prepending an element with (?-i) makes the matching case sensitive.

This property should be set to a comma separated string containing one or more paths.

For example, in order to define multiple groups handling urls, such as `foo/1` and `bar/10`, set the configuration value to `"foo/*,bar/*"`.

[options="header"]
|============
| Environment variable name | IConfiguration or Web.config key
| `ELASTIC_APM_TRANSACTION_NAME_GROUPS` | `ElasticApm:TransactionNameGroups`
|============

[options="header"]
|============
| Default | Type
| `<none>` | String
|============

[float]
[[config-use-elastic-apm-traceparent-header]]
==== `UseElasticTraceparentHeader` (added[1.3.0])
Expand All @@ -1094,6 +1118,30 @@ When this setting is `true`, the agent also adds the header `elasticapm-tracepar
| `true` | Boolean
|============

[float]
[[config-use-path-as-transaction-name]]
==== `UsePathAsTransactionName` (added[1.27.0])

If set to `true`,
transaction names of unsupported or partially-supported frameworks will be in the form of `$method $path` instead of just `$method unknown route`.

WARNING: If your URLs contain path parameters like `/user/$userId`,
you should be very careful when enabling this flag,
as it can lead to an explosion of transaction groups.
Take a look at the <<config-transaction-name-groups,`TransactionNameGroups`>> option on how to mitigate this problem by grouping URLs together.

[options="header"]
|============
| Environment variable name | IConfiguration or Web.config key
| `ELASTIC_APM_USE_PATH_AS_TRANSACTION_NAME` | `ElasticApm:UsePathAsTransactionName`
|============

[options="header"]
|============
| Default | Type
| `true` | Boolean
|============

[float]
[[config-use-windows-credentials]]
==== `UseWindowsCredentials`
Expand Down Expand Up @@ -1368,10 +1416,12 @@ you must instead set the `LogLevel` for the internal APM logger under the `Loggi
| <<config-stack-trace-limit,`StackTraceLimit`>> | Yes | Stacktrace, Performance
| <<config-trace-context-ignore-sampled-false,`TraceContextIgnoreSampledFalse`>> | No | Core
| <<config-transaction-ignore-urls,`TransactionIgnoreUrls`>> | Yes | HTTP, Performance
| <<config-transaction-name-groups,`TransactionNameGroups`>> | No | HTTP
| <<config-transaction-max-spans,`TransactionMaxSpans`>> | Yes | Core, Performance
| <<config-transaction-sample-rate,`TransactionSampleRate`>> | Yes | Core, Performance
| <<config-trace-continuation-strategy,`TraceContinuationStrategy`>> | Yes | HTTP, Performance
| <<config-use-elastic-apm-traceparent-header,`UseElasticTraceparentHeader`>> | No | HTTP
| <<config-use-path-as-transaction-name,`UsePathAsTransactionName`>> | No | HTTP
| <<config-use-windows-credentials,`UseWindowsCredentials`>> | No | Reporter
| <<config-verify-server-cert,`VerifyServerCert`>> | No | Reporter

Expand Down

0 comments on commit 83fcb3e

Please sign in to comment.