Setting to disable x-opaque-id in logs throttling #78911

pgomulka · 2021-10-11T10:46:30Z

Introduces a setting cluster.deprecation_indexing.x_opaque_id_used.enabled to disable use of
x-opaque-id in RateLimitingFilter. This will be used for deprecation
logs indexing and will not affect logging to files (it uses different
instance of RateLimitingFilter with this flag enabled by default)

Changes the indices backing a deprecation log data stream to be hidden.

Refactors DeprecationHttpIT to be more reliable

relates #76292
closes #77936

Have you signed the contributor license agreement?
Have you followed the contributor guidelines?
If submitting code, have you built your formula locally prior to submission with gradle check?
If submitting code, is your pull request against master? Unless there is a good reason otherwise, we prefer pull requests against master and will backport as needed.
If submitting code, have you checked that your submission is for an OS and architecture that we support?
If you are submitting this code for a class then read our policy for that.

Introduces a setting cluster.deprecation_indexing.x_opaque_id_used.enabled to disable use of x-opaque-id in RateLimitingFilter. This will be used for deprecation logs indexing and will not affect logging to files (it uses different instance of RateLimitingFilter with this flag enabled by default) Changes the indices backing a deprecation log data stream to be hidden. Refactors DeprecationHttpIT to be more reliable relates elastic#76292 closes elastic#77936

elasticmachine · 2021-10-11T10:46:33Z

Pinging @elastic/es-core-infra (Team:Core/Infra)

pgomulka · 2021-10-11T10:47:34Z

I split this PR from the main PR that was meant to enable deprecation logs indexing by default.
This will help to make the PR more cohesive and easier to review. Also easier to identify the what is causing tests to fail.
#78319

...ion/qa/rest/src/javaRestTest/java/org/elasticsearch/xpack/deprecation/DeprecationHttpIT.java

pugnascotia · 2021-10-11T11:58:02Z

docs/reference/setup/logging-config.asciidoc

+This applies to both indexed deprecation logs and logs emitted to log files.
+You can disable the use of `x-opaque-id` in throttling by changing
+`cluster.deprecation_indexing.x_opaque_id_used.enabled` to false
+See link:./server/src/main/java/org/elasticsearch/common/logging/RateLimitingFilter.java[RateLimitingFilter]


I'm not sure we should be linked to the source code. It implies we can't or don't want to explain what's going on. cc @jrodewig for his input.

Also, can we link x-opaque-id to something descriptive?

I thought I will link to a javadoc for more low level internals documentation.

pugnascotia · 2021-10-11T12:00:11Z

server/src/main/java/org/elasticsearch/common/logging/RateLimitingFilter.java

@@ -28,9 +28,20 @@
 import static org.elasticsearch.common.logging.DeprecatedMessage.KEY_FIELD_NAME;
 import static org.elasticsearch.common.logging.DeprecatedMessage.X_OPAQUE_ID_FIELD_NAME;

+/**
+ * A log4j filter used for throttling deprecation logs. Should be used in pair with a log4j2 appender.


I don't think we need to explain log4j here. You could link to https://logging.apache.org/log4j/2.x/manual/filters.html if you want to provide a reference.

will do. I thought to comment about log4j so that someone won't bother trying to reuse this in some other context

server/src/main/java/org/elasticsearch/common/logging/RateLimitingFilter.java

pugnascotia · 2021-10-11T12:03:59Z

...re/src/main/resources/org/elasticsearch/xpack/deprecation/deprecation-indexing-settings.json

@@ -2,6 +2,7 @@
  "template": {
    "settings": {
      "index": {
+        "hidden" : true,


I don't think this change is related?

not necessarily related, not even covered in testing here (index backing data stream is implementation detail)
do you recon we should do this in a separate PR?

I don't suppose it matters either way, we can leave this in.

pugnascotia · 2021-10-11T12:04:42Z

x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/Deprecation.java

+        final DeprecationIndexingComponent component = new DeprecationIndexingComponent(client,
+            environment.settings(),
+            rateLimitingFilterForIndexing,
+            WRITE_DEPRECATION_LOGS_TO_INDEX.getDefault(environment.settings())// default is true, enable on start.


Comment is wrong.

true, will fix. I will leave the code for passing of the default value though.
I want to have the PR that will switch the default to true as small as possible. (previous problems with tests failing due this value being enabled on startup in CI)

...ion/qa/rest/src/javaRestTest/java/org/elasticsearch/xpack/deprecation/DeprecationHttpIT.java

…asticsearch/xpack/deprecation/DeprecationHttpIT.java Co-authored-by: Rory Hunter <[email protected]>

pgomulka · 2021-10-11T14:32:21Z

@elasticmachine update branch

pgomulka · 2021-10-11T15:17:36Z

@elasticmachine run elasticsearch-ci/part-2

) Introduces a setting cluster.deprecation_indexing.x_opaque_id_used.enabled to disable use of x-opaque-id in RateLimitingFilter. This will be used for deprecation logs indexing and will not affect logging to files (it uses different instance of RateLimitingFilter with this flag enabled by default) Changes the indices backing a deprecation log data stream to be hidden. Refactors DeprecationHttpIT to be more reliable relates elastic#76292 closes elastic#77936

…78982) Introduces a setting cluster.deprecation_indexing.x_opaque_id_used.enabled to disable use of x-opaque-id in RateLimitingFilter. This will be used for deprecation logs indexing and will not affect logging to files (it uses different instance of RateLimitingFilter with this flag enabled by default) Changes the indices backing a deprecation log data stream to be hidden. Refactors DeprecationHttpIT to be more reliable relates #76292 closes #77936 backport #78911

pgomulka added :Core/Infra/Logging Log management and logging utilities v8.0.0 v7.16.0 labels Oct 11, 2021

pgomulka self-assigned this Oct 11, 2021

elasticmachine added the Team:Core/Infra Meta label for core/infra team label Oct 11, 2021

pgomulka commented Oct 11, 2021

View reviewed changes

...ion/qa/rest/src/javaRestTest/java/org/elasticsearch/xpack/deprecation/DeprecationHttpIT.java Show resolved Hide resolved

switch default to false

e1f0d80

pugnascotia reviewed Oct 11, 2021

View reviewed changes

server/src/main/java/org/elasticsearch/common/logging/RateLimitingFilter.java Show resolved Hide resolved

pugnascotia reviewed Oct 11, 2021

View reviewed changes

...ion/qa/rest/src/javaRestTest/java/org/elasticsearch/xpack/deprecation/DeprecationHttpIT.java Outdated Show resolved Hide resolved

pugnascotia reviewed Oct 11, 2021

View reviewed changes

...ion/qa/rest/src/javaRestTest/java/org/elasticsearch/xpack/deprecation/DeprecationHttpIT.java Show resolved Hide resolved

pgomulka and others added 2 commits October 11, 2021 15:19

code review follow up

8eadcd5

Update x-pack/plugin/deprecation/qa/rest/src/javaRestTest/java/org/el…

4690804

…asticsearch/xpack/deprecation/DeprecationHttpIT.java Co-authored-by: Rory Hunter <[email protected]>

Merge branch 'master' into upstream/rate_limiting_xopaque_setting

1471660

pgomulka requested a review from pugnascotia October 12, 2021 09:11

pugnascotia approved these changes Oct 12, 2021

View reviewed changes

pgomulka merged commit f5e4228 into elastic:master Oct 12, 2021

pgomulka mentioned this pull request Oct 12, 2021

Setting to disable x-opaque-id in logs throttling backport(#78911) #78982

Merged

jakelandis added v8.0.0-beta1 and removed v8.0.0 labels Oct 27, 2021

danhermann added >deprecation >non-issue and removed >deprecation labels Dec 3, 2021

ChrisHegarty unassigned pgomulka Oct 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Setting to disable x-opaque-id in logs throttling #78911

Setting to disable x-opaque-id in logs throttling #78911

pgomulka commented Oct 11, 2021 •

edited

Loading

elasticmachine commented Oct 11, 2021

pgomulka commented Oct 11, 2021

pugnascotia Oct 11, 2021

pgomulka Oct 11, 2021 •

edited

Loading

pugnascotia Oct 11, 2021

pgomulka Oct 11, 2021

pugnascotia Oct 11, 2021

pgomulka Oct 11, 2021

pugnascotia Oct 11, 2021

pugnascotia Oct 11, 2021

pgomulka Oct 11, 2021

pgomulka commented Oct 11, 2021

pgomulka commented Oct 11, 2021

Setting to disable x-opaque-id in logs throttling #78911

Setting to disable x-opaque-id in logs throttling #78911

Conversation

pgomulka commented Oct 11, 2021 • edited Loading

elasticmachine commented Oct 11, 2021

pgomulka commented Oct 11, 2021

Choose a reason for hiding this comment

pgomulka Oct 11, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pgomulka commented Oct 11, 2021

pgomulka commented Oct 11, 2021

pgomulka commented Oct 11, 2021 •

edited

Loading

pgomulka Oct 11, 2021 •

edited

Loading