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.

Sign up for GitHub

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

Jump to bottom

Configuration option to not redact usernames for APM #174743

Closed
rudolf opened this issue Jan 12, 2024 · 2 comments · Fixed by #176566
Closed

Configuration option to not redact usernames for APM #174743

rudolf opened this issue Jan 12, 2024 · 2 comments · Fixed by #176566
Assignees
@pgayvallet
Labels
Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@rudolf
Copy link
Contributor

rudolf commented Jan 12, 2024 •
edited
Loading

When instrumenting APM Kibana redacts all usernames from the APM data:

https://github.com/elastic/kibana/blob/main/packages/kbn-apm-config-loader/src/init_apm.ts#L25

However, some users would like to instrument Kibana with APM and preserve the usernames for further analysis. To enable this use case for these users we should introduce a config option like redactUsernames: schema.maybe(schema.boolean({ defaultValue: true })) so that users can disable the redaction.
@rudolf rudolf added the Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc label Jan 12, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@pgayvallet
Copy link
Contributor

we should introduce a config option like redactUsernames

Under the elastic.apm config prefix I assume? (Otherwise it may be slightly harder to have it available in the @kbn/apm-config-loader package)

Then the only thing we need to be careful about is to make sure this "custom" apm configuration property is not propagated down to apm

kibana/packages/kbn-apm-config-loader/src/init_apm.ts

Line 18 in 40674b5

const apmConfig = apmConfigLoader.getConfig(serviceName);

kibana/packages/kbn-apm-config-loader/src/init_apm.ts

Line 38 in 40674b5

apm.start(apmConfig);

@pgayvallet pgayvallet mentioned this issue Feb 9, 2024
Merged
pgayvallet added a commit that referenced this issue Feb 18, 2024
@pgayvallet @kibanamachine
Add an option to disable APM user redaction (#176566)
d65460c 
## Summary

Fix #174743

Add an `elastic.apm.redactUsers` configuration option that defaults to
`true` (preserving current behavior)

---------

Co-authored-by: Kibana Machine <[email protected]>
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Feb 18, 2024
@pgayvallet
Add an option to disable APM user redaction (elastic#176566)
655011e 
## Summary

Fix elastic#174743

Add an `elastic.apm.redactUsers` configuration option that defaults to
`true` (preserving current behavior)

---------

Co-authored-by: Kibana Machine <[email protected]>
(cherry picked from commit d65460c)
kibanamachine referenced this issue Feb 18, 2024
@kibanamachine @pgayvallet
[8.13] Add an option to disable APM user redaction (#176566) (#177140)
6389daf 
# Backport

This will backport the following commits from `main` to `8.13`:
- [Add an option to disable APM user redaction
(#176566)](#176566)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Pierre
Gayvallet","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-02-18T15:30:01Z","message":"Add
an option to disable APM user redaction (#176566)\n\n##
Summary\r\n\r\nFix
https://github.com/elastic/kibana/issues/174743\r\n\r\nAdd an
`elastic.apm.redactUsers` configuration option that defaults
to\r\n`true` (preserving current
behavior)\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<[email protected]>","sha":"d65460cb3973826f680b0934815b9de7a0682905","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:enhancement","Team:Core","v8.13.0","v8.14.0"],"title":"Add
an option to disable APM user
redaction","number":176566,"url":"https://github.com/elastic/kibana/pull/176566","mergeCommit":{"message":"Add
an option to disable APM user redaction (#176566)\n\n##
Summary\r\n\r\nFix
https://github.com/elastic/kibana/issues/174743\r\n\r\nAdd an
`elastic.apm.redactUsers` configuration option that defaults
to\r\n`true` (preserving current
behavior)\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<[email protected]>","sha":"d65460cb3973826f680b0934815b9de7a0682905"}},"sourceBranch":"main","suggestedTargetBranches":["8.13"],"targetPullRequestStates":[{"branch":"8.13","label":"v8.13.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/176566","number":176566,"mergeCommit":{"message":"Add
an option to disable APM user redaction (#176566)\n\n##
Summary\r\n\r\nFix
https://github.com/elastic/kibana/issues/174743\r\n\r\nAdd an
`elastic.apm.redactUsers` configuration option that defaults
to\r\n`true` (preserving current
behavior)\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<[email protected]>","sha":"d65460cb3973826f680b0934815b9de7a0682905"}}]}]
BACKPORT-->

Co-authored-by: Pierre Gayvallet <[email protected]>
fkanout pushed a commit to fkanout/kibana that referenced this issue Mar 4, 2024
@pgayvallet @kibanamachine @fkanout
Add an option to disable APM user redaction (elastic#176566)
4fe6924 
## Summary

Fix elastic#174743

Add an `elastic.apm.redactUsers` configuration option that defaults to
`true` (preserving current behavior)

---------

Co-authored-by: Kibana Machine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pgayvallet pgayvallet

Labels
Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add an option to disable APM user redaction pgayvallet/kibana
3 participants
@rudolf @pgayvallet @elasticmachine