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

perf: improve performance of update metrics #1329

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
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
23 changes: 12 additions & 11 deletions native/core/src/execution/jni_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,6 @@ struct ExecutionContext {
pub debug_native: bool,
/// Whether to write native plans with metrics to stdout
pub explain_native: bool,
/// Map of metrics name -> jstring object to cache jni_NewStringUTF calls.
pub metrics_jstrings: HashMap<String, Arc<GlobalRef>>,
/// Memory pool config
pub memory_pool_config: MemoryPoolConfig,
}
Expand Down Expand Up @@ -237,7 +235,6 @@ pub unsafe extern "system" fn Java_org_apache_comet_Native_createPlan(
session_ctx: Arc::new(session),
debug_native: debug_native == 1,
explain_native: explain_native == 1,
metrics_jstrings: HashMap::new(),
memory_pool_config,
});

Expand Down Expand Up @@ -508,9 +505,6 @@ pub unsafe extern "system" fn Java_org_apache_comet_Native_executePlan(
let next_item = exec_context.stream.as_mut().unwrap().next();
let poll_output = exec_context.runtime.block_on(async { poll!(next_item) });

// Update metrics
update_metrics(&mut env, exec_context)?;
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if we should add a config so that we can choose between frequent metrics updates vs just updating once the query completes. It can sometimes be helpful to see live metrics.

Copy link
Contributor

Choose a reason for hiding this comment

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

Per-batch is probably always overkill. For long-running jobs is there a period that makes sense? It looks like Spark History defaults to 10s.

Copy link
Member

Choose a reason for hiding this comment

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

I do like the idea of updating metrics every N seconds

Copy link
Contributor

Choose a reason for hiding this comment

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

I think checking a coarse-grained clock (i.e., CLOCK_MONOTONIC_COARSE) to see if N seconds has elapsed to produce updated metrics would be a reasonable compromise on performance impact vs. fresh metrics.


match poll_output {
Poll::Ready(Some(output)) => {
// prepare output for FFI transfer
Expand Down Expand Up @@ -561,8 +555,12 @@ pub extern "system" fn Java_org_apache_comet_Native_releasePlan(
_class: JClass,
exec_context: jlong,
) {
try_unwrap_or_throw(&e, |_| unsafe {
try_unwrap_or_throw(&e, |mut env| unsafe {
let execution_context = get_execution_context(exec_context);

// Update metrics
update_metrics(&mut env, execution_context)?;

if execution_context.memory_pool_config.pool_type == MemoryPoolType::FairSpillTaskShared
|| execution_context.memory_pool_config.pool_type == MemoryPoolType::GreedyTaskShared
{
Expand All @@ -586,10 +584,13 @@ pub extern "system" fn Java_org_apache_comet_Native_releasePlan(

/// Updates the metrics of the query plan.
fn update_metrics(env: &mut JNIEnv, exec_context: &mut ExecutionContext) -> CometResult<()> {
let native_query = exec_context.root_op.as_ref().unwrap();
let metrics = exec_context.metrics.as_obj();
let metrics_jstrings = &mut exec_context.metrics_jstrings;
update_comet_metric(env, metrics, native_query, metrics_jstrings)
if exec_context.root_op.is_some() {
let native_query = exec_context.root_op.as_ref().unwrap();
let metrics = exec_context.metrics.as_obj();
update_comet_metric(env, metrics, native_query)
} else {
Ok(())
}
}

fn convert_datatype_arrays(
Expand Down
96 changes: 33 additions & 63 deletions native/core/src/execution/metrics/utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,11 @@
// under the License.

use crate::execution::spark_plan::SparkPlan;
use crate::jvm_bridge::jni_new_global_ref;
use crate::{
errors::CometError,
jvm_bridge::{jni_call, jni_new_string},
};
use crate::{errors::CometError, jvm_bridge::jni_call};
use datafusion::physical_plan::metrics::MetricValue;
use jni::objects::{GlobalRef, JString};
use datafusion_comet_proto::spark_metric::NativeMetricNode;
use jni::{objects::JObject, JNIEnv};
use prost::Message;
use std::collections::HashMap;
use std::sync::Arc;

Expand All @@ -34,10 +31,22 @@ pub fn update_comet_metric(
env: &mut JNIEnv,
metric_node: &JObject,
spark_plan: &Arc<SparkPlan>,
metrics_jstrings: &mut HashMap<String, Arc<GlobalRef>>,
) -> Result<(), CometError> {
// combine all metrics from all native plans for this SparkPlan
let metrics = if spark_plan.additional_native_plans.is_empty() {
unsafe {
let native_metric = to_native_metric_node(spark_plan);
let jbytes = env.byte_array_from_slice(&native_metric?.encode_to_vec())?;
jni_call!(env, comet_metric_node(metric_node).set_all_from_bytes(&jbytes) -> ())?;
}
Ok(())
}

pub fn to_native_metric_node(spark_plan: &Arc<SparkPlan>) -> Result<NativeMetricNode, CometError> {
let mut native_metric_node = NativeMetricNode {
metrics: HashMap::new(),
children: Vec::new(),
};

let node_metrics = if spark_plan.additional_native_plans.is_empty() {
spark_plan.native_plan.metrics()
} else {
let mut metrics = spark_plan.native_plan.metrics().unwrap_or_default();
Expand All @@ -55,60 +64,21 @@ pub fn update_comet_metric(
Some(metrics.aggregate_by_name())
};

update_metrics(
env,
metric_node,
&metrics
.unwrap_or_default()
.iter()
.map(|m| m.value())
.map(|m| (m.name(), m.as_usize() as i64))
.collect::<Vec<_>>(),
metrics_jstrings,
)?;
// add metrics
node_metrics
.unwrap_or_default()
.iter()
.map(|m| m.value())
.map(|m| (m.name(), m.as_usize() as i64))
.for_each(|(name, value)| {
native_metric_node.metrics.insert(name.to_string(), value);
});

unsafe {
for (i, child_plan) in spark_plan.children().iter().enumerate() {
let child_metric_node: JObject = jni_call!(env,
comet_metric_node(metric_node).get_child_node(i as i32) -> JObject
)?;
if child_metric_node.is_null() {
continue;
}
update_comet_metric(env, &child_metric_node, child_plan, metrics_jstrings)?;
}
}
Ok(())
}
// add children
spark_plan.children().iter().for_each(|child_plan| {
let child_node = to_native_metric_node(child_plan).unwrap();
Copy link
Member

Choose a reason for hiding this comment

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

Can we avoid the unwrap here?

Suggested change
let child_node = to_native_metric_node(child_plan).unwrap();
let child_node = to_native_metric_node(child_plan)?;

native_metric_node.children.push(child_node);
});

#[inline]
fn update_metrics(
env: &mut JNIEnv,
metric_node: &JObject,
metric_values: &[(&str, i64)],
metrics_jstrings: &mut HashMap<String, Arc<GlobalRef>>,
) -> Result<(), CometError> {
unsafe {
for &(name, value) in metric_values {
// Perform a lookup in the jstrings cache.
if let Some(map_global_ref) = metrics_jstrings.get(name) {
// Cache hit. Extract the jstring from the global ref.
let jobject = map_global_ref.as_obj();
let jstring = JString::from_raw(**jobject);
// Update the metrics using the jstring as a key.
jni_call!(env, comet_metric_node(metric_node).set(&jstring, value) -> ())?;
} else {
// Cache miss. Allocate a new string, promote to global ref, and insert into cache.
let local_jstring = jni_new_string!(env, &name)?;
let global_ref = jni_new_global_ref!(env, local_jstring)?;
let arc_global_ref = Arc::new(global_ref);
metrics_jstrings.insert(name.to_string(), Arc::clone(&arc_global_ref));
let jobject = arc_global_ref.as_obj();
let jstring = JString::from_raw(**jobject);
// Update the metrics using the jstring as a key.
jni_call!(env, comet_metric_node(metric_node).set(&jstring, value) -> ())?;
}
}
}
Ok(())
Ok(native_metric_node)
}
8 changes: 8 additions & 0 deletions native/core/src/jvm_bridge/comet_metric_node.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ pub struct CometMetricNode<'a> {
pub method_get_child_node_ret: ReturnType,
pub method_set: JMethodID,
pub method_set_ret: ReturnType,
pub method_set_all_from_bytes: JMethodID,
pub method_set_all_from_bytes_ret: ReturnType,
}

impl<'a> CometMetricNode<'a> {
Expand All @@ -47,6 +49,12 @@ impl<'a> CometMetricNode<'a> {
method_get_child_node_ret: ReturnType::Object,
method_set: env.get_method_id(Self::JVM_CLASS, "set", "(Ljava/lang/String;J)V")?,
method_set_ret: ReturnType::Primitive(Primitive::Void),
method_set_all_from_bytes: env.get_method_id(
Self::JVM_CLASS,
"set_all_from_bytes",
"([B)V",
)?,
method_set_all_from_bytes_ret: ReturnType::Primitive(Primitive::Void),
class,
})
}
Expand Down
8 changes: 0 additions & 8 deletions native/core/src/jvm_bridge/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,6 @@ macro_rules! jvalues {
}}
}

/// Macro for create a new JNI string.
macro_rules! jni_new_string {
($env:expr, $value:expr) => {{
$crate::jvm_bridge::jni_map_error!($env, $env.new_string($value))
}};
}

/// Macro for calling a JNI method.
/// The syntax is:
/// jni_call!(env, comet_metric_node(metric_node).add(jname, value) -> ())?;
Expand Down Expand Up @@ -173,7 +166,6 @@ macro_rules! jni_new_global_ref {
pub(crate) use jni_call;
pub(crate) use jni_map_error;
pub(crate) use jni_new_global_ref;
pub(crate) use jni_new_string;
pub(crate) use jni_static_call;
pub(crate) use jvalues;

Expand Down
1 change: 1 addition & 0 deletions native/proto/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ fn main() -> Result<()> {
prost_build::Config::new().out_dir(out_dir).compile_protos(
&[
"src/proto/expr.proto",
"src/proto/metric.proto",
"src/proto/partitioning.proto",
"src/proto/operator.proto",
],
Expand Down
6 changes: 6 additions & 0 deletions native/proto/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,9 @@ pub mod spark_partitioning {
pub mod spark_operator {
include!(concat!("generated", "/spark.spark_operator.rs"));
}

// Include generated modules from .proto files.
#[allow(missing_docs)]
pub mod spark_metric {
include!(concat!("generated", "/spark.spark_metric.rs"));
}
29 changes: 29 additions & 0 deletions native/proto/src/proto/metric.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF 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.



syntax = "proto3";

package spark.spark_metric;

option java_package = "org.apache.comet.serde";

message NativeMetricNode {
map<string, int64> metrics = 1;
repeated NativeMetricNode children = 2;
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,15 @@

package org.apache.spark.sql.comet

import scala.collection.JavaConverters._

import org.apache.spark.SparkContext
import org.apache.spark.internal.Logging
import org.apache.spark.sql.execution.SparkPlan
import org.apache.spark.sql.execution.metric.{SQLMetric, SQLMetrics}

import org.apache.comet.serde.Metric

/**
* A node carrying SQL metrics from SparkPlan, and metrics of its children. Native code will call
* [[getChildNode]] and [[set]] to update the metrics.
Expand Down Expand Up @@ -65,6 +69,20 @@ case class CometMetricNode(metrics: Map[String, SQLMetric], children: Seq[CometM
logDebug(s"Non-existing metric: $metricName. Ignored")
}
}

private def set_all(metricNode: Metric.NativeMetricNode): Unit = {
metricNode.getMetricsMap.forEach((name, value) => {
set(name, value)
})
metricNode.getChildrenList.asScala.zip(children).foreach { case (child, childNode) =>
childNode.set_all(child)
}
}

def set_all_from_bytes(bytes: Array[Byte]): Unit = {
val metricNode = Metric.NativeMetricNode.parseFrom(bytes)
set_all(metricNode)
}
}

object CometMetricNode {
Expand Down
Loading