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

[WIP] Metrics framework integration with ml-commons #3661

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[WIP] Metrics framework integration with ml-commons #3661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9054f6c
feat(telemetry aware plugin): adding counters and implementing teleme…
pyek-bot Mar 12, 2025
26a2ea9
feature: job extension and static job
pyek-bot Mar 14, 2025
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: 3 additions & 0 deletions common/src/main/java/org/opensearch/ml/common/CommonValue.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,10 @@ public class CommonValue {
public static final String ML_MEMORY_META_INDEX = ".plugins-ml-memory-meta";
public static final String ML_MEMORY_MESSAGE_INDEX = ".plugins-ml-memory-message";
public static final String ML_STOP_WORDS_INDEX = ".plugins-ml-stop-words";
// index used in 2.19 to track MlTaskBatchUpdate task
public static final String TASK_POLLING_JOB_INDEX = ".ml_commons_task_polling_job";
// index created in 3.0 to track all ml jobs created via job scheduler
public static final String ML_JOBS_INDEX = ".plugins-ml-jobs";
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already have multiple system index. To avoid adding too many system index, can we reuse .plugins-ml-task index ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the job scheduler monitors a particular index for its documents. If a new document is added, it starts a new job using certain parameters in document defined in MLJobParameter. If the index has different documents with different format, I'm not sure how this will react. At the same time, how will the existing tasks work if job scheduler documents are present in it? I can test this out and get back to you

public static final Set<String> stopWordsIndices = ImmutableSet.of(".plugins-ml-stop-words");
public static final String TOOL_PARAMETERS_PREFIX = "tools.parameters.";

Expand Down
12 changes: 12 additions & 0 deletions common/src/main/java/org/opensearch/ml/common/MLModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
import org.opensearch.ml.common.model.MetricsCorrelationModelConfig;
import org.opensearch.ml.common.model.QuestionAnsweringModelConfig;
import org.opensearch.ml.common.model.TextEmbeddingModelConfig;
import org.opensearch.telemetry.metrics.tags.Tags;

import lombok.Builder;
import lombok.Getter;
Expand Down Expand Up @@ -745,4 +746,15 @@ public static MLModel fromStream(StreamInput in) throws IOException {
return new MLModel(in);
}

public Tags getModelTags() {
return Tags
.create()
.addTag("type", algorithm == FunctionName.REMOTE ? "remote" : "local")
.addTag("provider", algorithm == FunctionName.REMOTE ? getRemoteModelType() : algorithm.name());
}

private String getRemoteModelType() {
return "remote_sub_tye";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo - "tye -> type"

}

}
44 changes: 44 additions & 0 deletions plugin/src/main/java/org/opensearch/ml/cluster/MLCommonsClusterManagerEventListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,27 @@
import static org.opensearch.ml.plugin.MachineLearningPlugin.GENERAL_THREAD_POOL;
import static org.opensearch.ml.settings.MLCommonsSettings.ML_COMMONS_SYNC_UP_JOB_INTERVAL_IN_SECONDS;

import java.io.IOException;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.List;

import org.opensearch.action.index.IndexRequest;
import org.opensearch.action.support.WriteRequest;
import org.opensearch.cluster.LocalNodeClusterManagerListener;
import org.opensearch.cluster.service.ClusterService;
import org.opensearch.common.lifecycle.LifecycleListener;
import org.opensearch.common.settings.Settings;
import org.opensearch.common.unit.TimeValue;
import org.opensearch.common.xcontent.json.JsonXContent;
import org.opensearch.core.action.ActionListener;
import org.opensearch.jobscheduler.spi.schedule.IntervalSchedule;
import org.opensearch.ml.autoredeploy.MLModelAutoReDeployer;
import org.opensearch.ml.common.CommonValue;
import org.opensearch.ml.engine.encryptor.Encryptor;
import org.opensearch.ml.engine.indices.MLIndicesHandler;
import org.opensearch.ml.jobs.MLJobParameter;
import org.opensearch.ml.jobs.MLJobType;
import org.opensearch.ml.settings.MLFeatureEnabledSetting;
import org.opensearch.remote.metadata.client.SdkClient;
import org.opensearch.threadpool.Scheduler;
Expand Down Expand Up @@ -95,6 +105,40 @@ public void onClusterManager() {
TimeValue.timeValueSeconds(jobInterval),
GENERAL_THREAD_POOL
);
// startStatsCollectorJob();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it commented intentionally ?

Copy link
Contributor Author

@pyek-bot pyek-bot Mar 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a draft PR, it is not complete, still in development - raised a PR just to show the structure of adding metrics to ml-commons

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh ok

}

public void startStatsCollectorJob() {
try {
int intervalInMinutes = 5;
Long lockDurationSeconds = 20L;

MLJobParameter jobParameter = new MLJobParameter(
MLJobType.STATS_COLLECTOR.name(),
new IntervalSchedule(Instant.now(), intervalInMinutes, ChronoUnit.MINUTES),
lockDurationSeconds,
null,
MLJobType.STATS_COLLECTOR
);

IndexRequest indexRequest = new IndexRequest()
.index(CommonValue.ML_JOBS_INDEX)
.id(MLJobType.STATS_COLLECTOR.name())
.source(jobParameter.toXContent(JsonXContent.contentBuilder(), null))
.setRefreshPolicy(WriteRequest.RefreshPolicy.IMMEDIATE);

client
.index(
indexRequest,
ActionListener
.wrap(
r -> log.info("Indexed ml stats collection job successfully"),
e -> log.error("Failed to index stats collection job", e)
)
);
} catch (IOException e) {
log.error("Failed to index stats collection job", e);
}
}

private void startSyncModelRoutingCron() {
Expand Down
88 changes: 0 additions & 88 deletions plugin/src/main/java/org/opensearch/ml/jobs/MLBatchTaskUpdateExtension.java
View file
Open in desktop

This file was deleted.

168 changes: 0 additions & 168 deletions plugin/src/main/java/org/opensearch/ml/jobs/MLBatchTaskUpdateJobRunner.java
View file
Open in desktop

This file was deleted.

Loading
Loading