-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ML] Parse and report memory usage for DF Analytics (#52778)
Adds reporting of memory usage for data frame analytics jobs. This commit introduces a new index pattern `.ml-stats-*` whose first concrete index will be `.ml-stats-000001`. This index serves to store instrumentation information for those jobs.
- Loading branch information
1 parent
a095115
commit dd33193
Showing
29 changed files
with
921 additions
and
218 deletions.
There are no files selected for viewing
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
88 changes: 88 additions & 0 deletions
88
client/rest-high-level/src/main/java/org/elasticsearch/client/ml/dataframe/MemoryUsage.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.elasticsearch.client.ml.dataframe; | ||
|
|
||
| import org.elasticsearch.client.common.TimeUtil; | ||
| import org.elasticsearch.common.ParseField; | ||
| import org.elasticsearch.common.inject.internal.ToStringBuilder; | ||
| import org.elasticsearch.common.xcontent.ConstructingObjectParser; | ||
| import org.elasticsearch.common.xcontent.ObjectParser; | ||
| import org.elasticsearch.common.xcontent.ToXContentObject; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
|
|
||
| import java.io.IOException; | ||
| import java.time.Instant; | ||
| import java.util.Objects; | ||
|
|
||
| public class MemoryUsage implements ToXContentObject { | ||
|
|
||
| static final ParseField TIMESTAMP = new ParseField("timestamp"); | ||
| static final ParseField PEAK_USAGE_BYTES = new ParseField("peak_usage_bytes"); | ||
|
|
||
| public static final ConstructingObjectParser<MemoryUsage, Void> PARSER = new ConstructingObjectParser<>("analytics_memory_usage", | ||
| true, a -> new MemoryUsage((Instant) a[0], (long) a[1])); | ||
|
|
||
| static { | ||
| PARSER.declareField(ConstructingObjectParser.constructorArg(), | ||
| p -> TimeUtil.parseTimeFieldToInstant(p, TIMESTAMP.getPreferredName()), | ||
| TIMESTAMP, | ||
| ObjectParser.ValueType.VALUE); | ||
| PARSER.declareLong(ConstructingObjectParser.constructorArg(), PEAK_USAGE_BYTES); | ||
| } | ||
|
|
||
| private final Instant timestamp; | ||
| private final long peakUsageBytes; | ||
|
|
||
| public MemoryUsage(Instant timestamp, long peakUsageBytes) { | ||
| this.timestamp = Instant.ofEpochMilli(Objects.requireNonNull(timestamp).toEpochMilli()); | ||
| this.peakUsageBytes = peakUsageBytes; | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(); | ||
| builder.timeField(TIMESTAMP.getPreferredName(), TIMESTAMP.getPreferredName() + "_string", timestamp.toEpochMilli()); | ||
| builder.field(PEAK_USAGE_BYTES.getPreferredName(), peakUsageBytes); | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (o == this) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
|
|
||
| MemoryUsage other = (MemoryUsage) o; | ||
| return Objects.equals(timestamp, other.timestamp) | ||
| && peakUsageBytes == other.peakUsageBytes; | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(timestamp, peakUsageBytes); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return new ToStringBuilder(getClass()) | ||
| .add(TIMESTAMP.getPreferredName(), timestamp.getEpochSecond()) | ||
| .add(PEAK_USAGE_BYTES.getPreferredName(), peakUsageBytes) | ||
| .toString(); | ||
| } | ||
| } |
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
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
47 changes: 47 additions & 0 deletions
47
...rest-high-level/src/test/java/org/elasticsearch/client/ml/dataframe/MemoryUsageTests.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.elasticsearch.client.ml.dataframe; | ||
|
|
||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.test.AbstractXContentTestCase; | ||
|
|
||
| import java.io.IOException; | ||
| import java.time.Instant; | ||
|
|
||
| public class MemoryUsageTests extends AbstractXContentTestCase<MemoryUsage> { | ||
|
|
||
| @Override | ||
| protected MemoryUsage createTestInstance() { | ||
| return createRandom(); | ||
| } | ||
|
|
||
| public static MemoryUsage createRandom() { | ||
| return new MemoryUsage(Instant.now(), randomNonNegativeLong()); | ||
| } | ||
|
|
||
| @Override | ||
| protected MemoryUsage doParseInstance(XContentParser parser) throws IOException { | ||
| return MemoryUsage.PARSER.apply(parser, null); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean supportsUnknownFields() { | ||
| return true; | ||
| } | ||
| } |
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
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
50 changes: 50 additions & 0 deletions
50
x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ml/MlStatsIndex.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
| package org.elasticsearch.xpack.core.ml; | ||
|
|
||
| import org.elasticsearch.Version; | ||
| import org.elasticsearch.action.ActionListener; | ||
| import org.elasticsearch.client.Client; | ||
| import org.elasticsearch.cluster.ClusterState; | ||
| import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver; | ||
| import org.elasticsearch.xpack.core.ml.utils.MlIndexAndAlias; | ||
| import org.elasticsearch.xpack.core.template.TemplateUtils; | ||
|
|
||
| /** | ||
| * Describes the indices where ML is storing various stats about the users jobs. | ||
| */ | ||
| public class MlStatsIndex { | ||
|
|
||
| public static final String TEMPLATE_NAME = ".ml-stats"; | ||
|
|
||
| private static final String MAPPINGS_VERSION_VARIABLE = "xpack.ml.version"; | ||
|
|
||
| private MlStatsIndex() {} | ||
|
|
||
| public static String mapping() { | ||
| return TemplateUtils.loadTemplate("/org/elasticsearch/xpack/core/ml/stats_index_mappings.json", | ||
| Version.CURRENT.toString(), MAPPINGS_VERSION_VARIABLE); | ||
| } | ||
|
|
||
| public static String indexPattern() { | ||
| return TEMPLATE_NAME + "-*"; | ||
| } | ||
|
|
||
| public static String writeAlias() { | ||
| return ".ml-stats-write"; | ||
| } | ||
|
|
||
| /** | ||
| * Creates the first concrete .ml-stats-000001 index (if necessary) | ||
| * Creates the .ml-stats-write alias for that index. | ||
| * The listener will be notified with a boolean to indicate if the index was created because of this call, | ||
| * but unless there is a failure after this method returns the index and alias should be present. | ||
| */ | ||
| public static void createStatsIndexAndAliasIfNecessary(Client client, ClusterState state, IndexNameExpressionResolver resolver, | ||
| ActionListener<Boolean> listener) { | ||
| MlIndexAndAlias.createIndexAndAliasIfNecessary(client, state, resolver, TEMPLATE_NAME, writeAlias(), listener); | ||
| } | ||
| } |
Oops, something went wrong.