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

Add sanitize_field_names spec #334

Merged
merged 1 commit into from
Sep 15, 2020
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
1 change: 1 addition & 0 deletions specs/agents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ You can find details about each of these in the [APM Data Model](https://www.ela
- [Metrics](metrics.md)
- [Logging Correlation](log-correlation.md)
- [Agent Configuration](configuration.md)
- [Data sanitization](sanitization.md)

# Processes

Expand Down
16 changes: 16 additions & 0 deletions specs/agents/sanitization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Data sanitization

### `sanitize_field_names` configuration

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 (including cookies) and `application/x-www-form-urlencoded` data (POST form fields).
The query string and the captured request body (such as `application/json` data) will not get sanitized.

| | |
|----------------|---|
| Type | `List<`[`WildcardMatcher`](../../tests/agents/json-specs/wildcard_matcher_tests.json)`>` |
| Default | `password, passwd, pwd, secret, *key, *token*, *session*, *credit*, *card*, authorization, set-cookie` |
| Dynamic | `true` |
| Central config | `true` |