Log deprecations originating from Kibana on debug level #123660
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rudolf
added
v7.17.0
bug
rudolf
commented
Jan 24, 2022
| loggers: [ | ||
| { | ||
| name: 'root', | ||
| level: 'error', |
There was a problem hiding this comment.
before jest integration tests wouldn't log anything to the console, but having at least error logs is useful for failing/flaky tests
rudolf
force-pushed
the
debug-deprecation-logs
branch
from
c2a4f99 to
462e093
Compare
|
Pinging @elastic/kibana-core (Team:Core) |
pgayvallet
approved these changes
Jan 24, 2022
Comment on lines
143
to
147
| if (requestOrigin === 'kibana') { | ||
| deprecationLogger.info(deprecationMsg); | ||
| deprecationLogger.debug(deprecationMsg); | ||
| } else { | ||
| deprecationLogger.debug(deprecationMsg); | ||
| } |
There was a problem hiding this comment.
NIT: given that's now the same level, should we just remove this if/else block?
Comment on lines
+125
to
+126
| deprecation: { type: 'console', layout: { type: 'json' } }, | ||
| console: { type: 'console', layout: { type: 'pattern' } }, |
There was a problem hiding this comment.
Isn't it going to be an issue to have both json and pattern messages output on stdout?
pgayvallet
added
the
release_note:skip
rudolf
added
the
auto-backport
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: |
💔 All backports failed
How to fixRe-run the backport manually: Questions ?Please refer to the Backport tool documentation |
rudolf
added a commit
that referenced
this pull request
Jan 25, 2022
* Log deprecations originating from Kibana on debug level * Surface debug level deprecation logs on CI * Review feedback (cherry picked from commit c64c766)
rudolf
added a commit
that referenced
this pull request
Jan 25, 2022
rudolf
added a commit
to rudolf/kibana
that referenced
this pull request
Jan 26, 2022
* Log deprecations originating from Kibana on debug level * Surface debug level deprecation logs on CI * Review feedback (cherry picked from commit c64c766)
rudolf
added a commit
that referenced
this pull request
Jan 26, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
In #120044 Kibana started logging when Elasticsearch requests returned the deprecation header. For requests with the
x-elastic-product-origin: kibanaheader we logged on the info level. Since our thinking was to remove all usages of deprecated API's this wouldn't produce a lot of log volume.However, most teams didn't remove usage of deprecated API's and some deprecation logs cannot be avoided such as elastic/elasticsearch#81589 elastic/elasticsearch#81480 elastic/elasticsearch#81345
So to avoid confusion and a lot of log noise for our users it's better to log these messages on the debug level.
Risks
The only change to non-test code is a single line to change the log level 98c7892 so the risk of this affecting users is very small.
We could however risk that deprecations are no longer correctly showing up in CI runs. To mitigate this I'll verify the amount of surfaced deprecation logs with this PR against previous 7.17 builds.
For maintainers