You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sometimes it is necessary to sanitize, i.e., remove, sensitive data sent to Elastic APM.
452
-
This config accepts a list of wildcard patterns of field names which should be sanitized.
453
-
These apply to HTTP headers and `application/x-www-form-urlencoded` data.
451
+
Sometimes, sanitizing, i.e., redacting sensitive data sent to Elastic APM, is necessary.
452
+
This configuration accepts a comma-separated list of wildcard patterns of field names that should be sanitized.
453
+
These apply to HTTP headers for requests and responses, cookies and `application/x-www-form-urlencoded` data.
454
454
455
-
IMPORTANT: This setting only applies to values that are captured automatically by the agent. If you capture the request body manually with the public API, this configuration doesn't apply, and the agent won't sanitize the body.
455
+
IMPORTANT: This setting only applies to values captured automatically by the agent. If you capture the request
456
+
body manually with the public API, this configuration doesn't apply, and the agent won't sanitize the body.
456
457
457
458
The wildcard, `*`, matches zero or more characters, and matching is case insensitive by default.
458
459
Prepending an element with `(?-i)` makes the matching case sensitive.
459
460
Examples: `/foo/*/bar/*/baz*`, `*foo*`.
460
461
461
-
Please be sure to review the data captured by Elastic APM carefully to make sure it does not contain sensitive information.
462
-
If you do find sensitive data in your {es} index, add an additional entry to this list.
463
-
Setting a value here will overwrite the defaults, so be sure to include the default entries as well.
462
+
Please review the data captured by Elastic APM carefully to ensure it does not contain sensitive information.
463
+
If you find sensitive data in your {es} index, add an additional entry to this list.
464
+
Setting a value here will *overwrite* the defaults, so be sure to include the default entries as well.
464
465
465
466
NOTE: Sensitive information should not be sent in the query string. Data in the query string is considered non-sensitive.
466
467
See https://www.owasp.org/index.php/Information_exposure_through_query_strings_in_url[owasp.org] for more information.
467
468
469
+
*`Cookie` header sanitization:*
470
+
471
+
The `Cookie` header is automatically redacted for incoming HTTP request transactions. Each name-value pair from the
472
+
Cookie header is parsed by the agent and sent to the APM Server. Before the name-value pairs are recorded, they are
473
+
sanitized based on the `SanitizeFieldNames` configuration. Cookies with sensitive data in
474
+
their value can be redacted by adding the cookie's name to the comma-separated list.
Copy file name to clipboardExpand all lines: docs/troubleshooting.asciidoc
+19-1Lines changed: 19 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -244,4 +244,22 @@ The most expensive operation in the agent is typically stack trace capturing. Th
244
244
If this is too much in your environment, consider disabling stack trace capturing either partially or entirely:
245
245
246
246
- To disable stack trace capturing for spans, but continue to capture stack traces for errors, set the <<config-span-stack-trace-min-duration>> to `-1` and leave the <<config-stack-trace-limit>> on its default.
247
-
- To disable stack trace capturing entirely –which in most applications reduces the agent overhead dramatically– set <<config-stack-trace-limit>> to `0`.
247
+
- To disable stack trace capturing entirely –which in most applications reduces the agent overhead dramatically– set <<config-stack-trace-limit>> to `0`.
248
+
249
+
[float]
250
+
[[iisexpress-classic-pipeline]]
251
+
=== The ElasticApmModule does not load or capture transactions and there are no agent logs generated on IISExpress
252
+
253
+
When debugging applications using Visual Studio and IISExpress, the same requirement to use the `Integrated` managed
254
+
pipeline mode exists. Select your web application project in the solution explorer and press F4 to load the properties
255
+
window. If the managed pipeline mode is set to classic, the ElasticApmModule will not load.
256
+
257
+
For example:
258
+
259
+
image::./images/classic-pipeline.png[Classic Managed Pipeline Mode in Properties]
260
+
261
+
Should be changed to:
262
+
263
+
image::./images/integrated-pipeline.png[Integrated Managed Pipeline Mode in Properties]
264
+
265
+
You may need to restart Visual Studio for these changes to fully apply.
0 commit comments