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

Change deprecation logs data stream name #68737

Merged
merged 6 commits into from
Apr 13, 2021
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
3 changes: 2 additions & 1 deletion distribution/src/config/log4j2.properties
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ appender.deprecation_rolling.type = RollingFile
appender.deprecation_rolling.name = deprecation_rolling
appender.deprecation_rolling.fileName = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_deprecation.json
appender.deprecation_rolling.layout.type = ECSJsonLayout
appender.deprecation_rolling.layout.dataset = elasticsearch.deprecation
# Intentionally follows a different pattern to above
appender.deprecation_rolling.layout.dataset = deprecation.elasticsearch
appender.deprecation_rolling.filter.rate_limit.type = RateLimitingFilter

appender.deprecation_rolling.filePattern = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_deprecation-%i.json.gz
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ public void testTemplateExists() throws IOException {
request.setOptions(expectWarnings(
"legacy template [template] has index patterns [*] matching patterns from existing composable templates " +
"[.deprecation-indexing-template,.slm-history,.watch-history-14,ilm-history,logs," +
"metrics,synthetics] with patterns (.deprecation-indexing-template => [.logs-deprecation-elasticsearch]," +
"metrics,synthetics] with patterns (.deprecation-indexing-template => [.logs-deprecation.elasticsearch-default]," +
".slm-history => [.slm-history-5*]," +
".watch-history-14 => [.watcher-history-14*],ilm-history => [ilm-history-5*]," +
"logs => [logs-*-*],metrics => [metrics-*-*],synthetics => [synthetics-*-*]" +
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,14 +92,15 @@ public void testDeprecatedMessageWithoutXOpaqueId() throws IOException {

assertThat(jsonLogs, contains(
allOf(
hasEntry("event.dataset", "elasticsearch.deprecation"),
hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "DEPRECATION"),
hasEntry("log.logger", "org.elasticsearch.deprecation.test"),
hasEntry("elasticsearch.cluster.name", "elasticsearch"),
hasEntry("elasticsearch.node.name", "sample-name"),
hasEntry("message", "deprecated message1"),
hasEntry("data_stream.type", "logs"),
hasEntry("data_stream.dataset", "elasticsearch.deprecation"),
hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION),
hasEntry(DeprecatedMessage.KEY_FIELD_NAME, "a key"),
not(hasKey(DeprecatedMessage.X_OPAQUE_ID_FIELD_NAME)),
Expand Down Expand Up @@ -131,8 +132,9 @@ public void testCompatibleLog() throws Exception {
contains(
allOf(
hasEntry("log.level", "DEPRECATION"),
hasEntry("event.dataset", "elasticsearch.deprecation"),
hasEntry("data_stream.dataset", "elasticsearch.deprecation"),
hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"),
hasEntry("log.logger", "org.elasticsearch.deprecation.test"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION),
Expand All @@ -146,8 +148,9 @@ public void testCompatibleLog() throws Exception {
allOf(
hasEntry("log.level", "DEPRECATION"),
// event.dataset and data_stream.dataset have to be the same across the data stream
hasEntry("event.dataset", "elasticsearch.deprecation"),
hasEntry("data_stream.dataset", "elasticsearch.deprecation"),
hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"),
hasEntry("log.logger", "org.elasticsearch.deprecation.test"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION),
Expand All @@ -165,6 +168,7 @@ public void testCompatibleLog() throws Exception {
assertWarnings("deprecated message1", "compatible API message");
});
}

public void testParseFieldEmittingDeprecatedLogs() throws Exception {
withThreadContext(threadContext -> {
threadContext.putHeader(Task.X_OPAQUE_ID, "someId");
Expand Down Expand Up @@ -193,8 +197,9 @@ public void testParseFieldEmittingDeprecatedLogs() throws Exception {
// deprecation log for field deprecated_name
allOf(
hasEntry("log.level", "DEPRECATION"),
hasEntry("event.dataset", "elasticsearch.deprecation"),
hasEntry("data_stream.dataset", "elasticsearch.deprecation"),
hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"),
hasEntry("log.logger", "org.elasticsearch.deprecation.common.ParseField"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION),
Expand All @@ -208,8 +213,9 @@ public void testParseFieldEmittingDeprecatedLogs() throws Exception {
// deprecation log for field deprecated_name2 (note it is not being throttled)
allOf(
hasEntry("log.level", "DEPRECATION"),
hasEntry("event.dataset", "elasticsearch.deprecation"),
hasEntry("data_stream.dataset", "elasticsearch.deprecation"),
hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"),
hasEntry("log.logger", "org.elasticsearch.deprecation.common.ParseField"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION),
Expand All @@ -220,11 +226,12 @@ public void testParseFieldEmittingDeprecatedLogs() throws Exception {
hasEntry(DeprecatedMessage.X_OPAQUE_ID_FIELD_NAME, "someId"),
hasEntry("elasticsearch.event.category", "api")
),
//compatible log line
// compatible log line
allOf(
hasEntry("log.level", "DEPRECATION"),
hasEntry("event.dataset", "elasticsearch.deprecation"),
hasEntry("data_stream.dataset", "elasticsearch.deprecation"),
hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"),
hasEntry("log.logger", "org.elasticsearch.deprecation.common.ParseField"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION),
Expand Down Expand Up @@ -263,14 +270,15 @@ public void testDeprecatedMessage() throws Exception {
jsonLogs,
contains(
allOf(
hasEntry("event.dataset", "elasticsearch.deprecation"),
hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "DEPRECATION"),
hasEntry("log.logger", "org.elasticsearch.deprecation.test"),
hasEntry("elasticsearch.cluster.name", "elasticsearch"),
hasEntry("elasticsearch.node.name", "sample-name"),
hasEntry("message", "deprecated message1"),
hasEntry("data_stream.type", "logs"),
hasEntry("data_stream.dataset", "elasticsearch.deprecation"),
hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION),
hasEntry(DeprecatedMessage.KEY_FIELD_NAME, "someKey"),
hasEntry(DeprecatedMessage.X_OPAQUE_ID_FIELD_NAME, "someId"),
Expand Down Expand Up @@ -422,7 +430,6 @@ public void testStacktrace() throws IOException {
}
}


public void testJsonInStacktraceMessageIsNotSplitted() throws IOException {
final Logger testLogger = LogManager.getLogger("test");

Expand Down Expand Up @@ -454,7 +461,6 @@ public void testJsonInStacktraceMessageIsNotSplitted() throws IOException {
}
}


public void testDuplicateLogMessages() throws Exception {
final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger("org.elasticsearch.test");

Expand All @@ -473,7 +479,7 @@ public void testDuplicateLogMessages() throws Exception {

assertThat(jsonLogs, contains(
allOf(
hasEntry("event.dataset", "elasticsearch.deprecation"),
hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "DEPRECATION"),
hasEntry("log.logger", "org.elasticsearch.deprecation.test"),
hasEntry("elasticsearch.cluster.name", "elasticsearch"),
Expand Down Expand Up @@ -505,7 +511,7 @@ public void testDuplicateLogMessages() throws Exception {
jsonLogs,
contains(
allOf(
hasEntry("event.dataset", "elasticsearch.deprecation"),
hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "DEPRECATION"),
hasEntry("log.logger", "org.elasticsearch.deprecation.test"),
hasEntry("elasticsearch.cluster.name", "elasticsearch"),
Expand All @@ -515,7 +521,7 @@ public void testDuplicateLogMessages() throws Exception {
hasEntry("elasticsearch.event.category", "other")
),
allOf(
hasEntry("event.dataset", "elasticsearch.deprecation"),
hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "DEPRECATION"),
hasEntry("log.logger", "org.elasticsearch.deprecation.test"),
hasEntry("elasticsearch.cluster.name", "elasticsearch"),
Expand Down Expand Up @@ -555,7 +561,6 @@ private void setupLogging(final String config, final Settings settings) throws I
LogConfigurator.configure(environment);
}


private Matcher<JsonLogLine> logLine(String type, Level level, String nodeName, String component, String message) {
return logLine(mapOfParamsToCheck(type, level, nodeName, component, message));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@ appender.file.layout.dataset = elasticsearch.file
appender.deprecated.type = File
appender.deprecated.name = deprecated
appender.deprecated.fileName = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_deprecated.json
# Intentionally follows a different pattern to above
appender.deprecated.layout.type = ECSJsonLayout
appender.deprecated.layout.dataset = elasticsearch.deprecation
appender.deprecated.layout.dataset = deprecation.elasticsearch
appender.deprecated.filter.rate_limit.type = RateLimitingFilter

appender.deprecatedconsole.type = Console
appender.deprecatedconsole.name = deprecatedconsole
appender.deprecatedconsole.layout.type = ECSJsonLayout
appender.deprecatedconsole.layout.dataset = elasticsearch.deprecation
# Intentionally follows a different pattern to above
appender.deprecatedconsole.layout.dataset = deprecation.elasticsearch
appender.deprecatedconsole.filter.rate_limit.type = RateLimitingFilter


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ private static ESLogMessage getEsLogMessage(
String messagePattern,
Object[] args) {
ESLogMessage esLogMessage = new ESLogMessage(messagePattern, args)
.field("data_stream.dataset", "elasticsearch.deprecation")
.field("data_stream.dataset", "deprecation.elasticsearch")
.field("data_stream.type", "logs")
.field("data_stream.namespace", "default")
.field("ecs.version", ECS_VERSION)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"hot": {
"actions": {
"rollover": {
"max_primary_shard_size": "50gb",
"max_age": "30d"
"max_primary_shard_size": "10gb",
"max_age": "14d"
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
}
},
"_meta": {
"description": "default mappings for ES deprecation logs index template installed by x-pack",
"description": "default mappings for Stack deprecation logs index template installed by x-pack",
"managed": true
},
"version": ${xpack.deprecation.indexing.template.version}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
}
},
"_meta": {
"description": "default settings for ES deprecation logs index template installed by x-pack",
"description": "default settings for Stack deprecation logs index template installed by x-pack",
"managed": true
},
"version": ${xpack.deprecation.indexing.template.version}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"index_patterns": [".logs-deprecation-elasticsearch"],
"index_patterns": [".logs-deprecation.*"],
"priority": 1000,
"data_stream": {
"hidden": true
Expand All @@ -10,7 +10,7 @@
],
"allow_auto_create": true,
"_meta": {
"description": "default template for ES deprecation logs index template installed by x-pack",
"description": "default template for Stack deprecation logs index template installed by x-pack",
"managed": true
},
"version": ${xpack.deprecation.indexing.template.version}
Expand Down
Loading