Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bring docs folder up to date manually #2297

Merged
merged 1 commit into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions docs/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -448,23 +448,31 @@ the latest {apm-app-ref}/agent-configuration.html[APM Agent configuration].

<<dynamic-configuration, image:./images/dynamic-config.svg[] >>

Sometimes it is necessary to sanitize, i.e., remove, sensitive data sent to Elastic APM.
This config accepts a list of wildcard patterns of field names which should be sanitized.
These apply to HTTP headers and `application/x-www-form-urlencoded` data.
Sometimes, sanitizing, i.e., redacting sensitive data sent to Elastic APM, is necessary.
This configuration accepts a comma-separated list of wildcard patterns of field names that should be sanitized.
These apply to HTTP headers for requests and responses, cookies and `application/x-www-form-urlencoded` data.

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.
IMPORTANT: This setting only applies to values 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.

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

Please be sure to review the data captured by Elastic APM carefully to make sure it does not contain sensitive information.
If you do find sensitive data in your {es} index, add an additional entry to this list.
Setting a value here will overwrite the defaults, so be sure to include the default entries as well.
Please review the data captured by Elastic APM carefully to ensure it does not contain sensitive information.
If you find sensitive data in your {es} index, add an additional entry to this list.
Setting a value here will *overwrite* the defaults, so be sure to include the default entries as well.

NOTE: Sensitive information should not be sent in the query string. Data in the query string is considered non-sensitive.
See https://www.owasp.org/index.php/Information_exposure_through_query_strings_in_url[owasp.org] for more information.

*`Cookie` header sanitization:*

The `Cookie` header is automatically redacted for incoming HTTP request transactions. Each name-value pair from the
Cookie header is parsed by the agent and sent to the APM Server. Before the name-value pairs are recorded, they are
sanitized based on the `SanitizeFieldNames` configuration. Cookies with sensitive data in
their value can be redacted by adding the cookie's name to the comma-separated list.

[options="header"]
|============
| Environment variable name | IConfiguration key
Expand Down
Binary file added docs/images/classic-pipeline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/integrated-pipeline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/supported-technologies.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Automatic instrumentation is supported for the following data access technologie
|<<setup-auto-instrumentation, Profiler auto instrumentation>>

|MongoDB added[1.9]
|MongoDB.Driver 2.4.4+
|MongoDB.Driver 2.19.0+
|<<setup-mongo-db, NuGet package>>

|Oracle added[1.12]
Expand Down
20 changes: 19 additions & 1 deletion docs/troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -244,4 +244,22 @@ The most expensive operation in the agent is typically stack trace capturing. Th
If this is too much in your environment, consider disabling stack trace capturing either partially or entirely:

- 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.
- To disable stack trace capturing entirely –which in most applications reduces the agent overhead dramatically– set <<config-stack-trace-limit>> to `0`.
- To disable stack trace capturing entirely –which in most applications reduces the agent overhead dramatically– set <<config-stack-trace-limit>> to `0`.

[float]
[[iisexpress-classic-pipeline]]
=== The ElasticApmModule does not load or capture transactions and there are no agent logs generated on IISExpress

When debugging applications using Visual Studio and IISExpress, the same requirement to use the `Integrated` managed
pipeline mode exists. Select your web application project in the solution explorer and press F4 to load the properties
window. If the managed pipeline mode is set to classic, the ElasticApmModule will not load.

For example:

image::./images/classic-pipeline.png[Classic Managed Pipeline Mode in Properties]

Should be changed to:

image::./images/integrated-pipeline.png[Integrated Managed Pipeline Mode in Properties]

You may need to restart Visual Studio for these changes to fully apply.
Loading