dimas-b commented on code in PR #3468: URL: https://github.com/apache/polaris/pull/3468#discussion_r2705818892
########## runtime/service/src/main/java/org/apache/polaris/service/reporting/MetricsProcessingContext.java: ########## @@ -0,0 +1,66 @@ +/* + * 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. + */ +package org.apache.polaris.service.reporting; + +import java.util.Optional; +import org.apache.iceberg.catalog.TableIdentifier; +import org.apache.iceberg.metrics.MetricsReport; +import org.immutables.value.Value; + +/** + * Context information for metrics processing, providing access to request metadata, security + * context, and tracing information. + * + * <p>This immutable context object contains all the information needed to process and persist + * Iceberg metrics reports, including catalog and table identifiers, the metrics report itself, and + * associated metadata like principal name, request ID, and OpenTelemetry trace context. + */ [email protected] +public interface MetricsProcessingContext { + + /** The catalog name where the metrics originated */ + String catalogName(); + + /** The table identifier */ + TableIdentifier tableIdentifier(); + + /** The Iceberg metrics report (ScanReport or CommitReport) */ + MetricsReport metricsReport(); + + /** The realm ID */ + String realmId(); Review Comment: We already have `RealmContext` as a request-scoped CDI bean for conveying realm information. I'd prefer to avoid parallel contexts for the same data. ########## runtime/service/src/main/java/org/apache/polaris/service/reporting/MetricsProcessingContext.java: ########## @@ -0,0 +1,66 @@ +/* + * 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. + */ +package org.apache.polaris.service.reporting; + +import java.util.Optional; +import org.apache.iceberg.catalog.TableIdentifier; +import org.apache.iceberg.metrics.MetricsReport; +import org.immutables.value.Value; + +/** + * Context information for metrics processing, providing access to request metadata, security + * context, and tracing information. + * + * <p>This immutable context object contains all the information needed to process and persist + * Iceberg metrics reports, including catalog and table identifiers, the metrics report itself, and + * associated metadata like principal name, request ID, and OpenTelemetry trace context. + */ [email protected] +public interface MetricsProcessingContext { + + /** The catalog name where the metrics originated */ + String catalogName(); + + /** The table identifier */ + TableIdentifier tableIdentifier(); + + /** The Iceberg metrics report (ScanReport or CommitReport) */ + MetricsReport metricsReport(); + + /** The realm ID */ + String realmId(); + + /** The catalog ID (internal entity ID) */ + Optional<Long> catalogId(); + + /** The principal name who submitted the metrics */ + Optional<String> principalName(); Review Comment: If processors require the proncipal, why would they not receive it via CDI? Cf. https://github.com/apache/polaris/blob/27ae684304c6c62e5ee516404eee1419bc5d67f8/runtime/service/src/main/java/org/apache/polaris/service/context/catalog/PolarisPrincipalHolder.java#L39 ########## runtime/service/src/main/java/org/apache/polaris/service/reporting/MetricsProcessingContext.java: ########## @@ -0,0 +1,66 @@ +/* + * 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. + */ +package org.apache.polaris.service.reporting; + +import java.util.Optional; +import org.apache.iceberg.catalog.TableIdentifier; +import org.apache.iceberg.metrics.MetricsReport; +import org.immutables.value.Value; + +/** + * Context information for metrics processing, providing access to request metadata, security + * context, and tracing information. + * + * <p>This immutable context object contains all the information needed to process and persist + * Iceberg metrics reports, including catalog and table identifiers, the metrics report itself, and + * associated metadata like principal name, request ID, and OpenTelemetry trace context. + */ [email protected] +public interface MetricsProcessingContext { + + /** The catalog name where the metrics originated */ + String catalogName(); + + /** The table identifier */ + TableIdentifier tableIdentifier(); + + /** The Iceberg metrics report (ScanReport or CommitReport) */ + MetricsReport metricsReport(); + + /** The realm ID */ + String realmId(); + + /** The catalog ID (internal entity ID) */ + Optional<Long> catalogId(); + + /** The principal name who submitted the metrics */ + Optional<String> principalName(); + + /** The request ID for correlation */ + Optional<String> requestId(); + + /** OpenTelemetry trace ID */ + Optional<String> otelTraceId(); + + /** OpenTelemetry span ID */ + Optional<String> otelSpanId(); Review Comment: I'd prefer to handle OTel via its natural context objects. ########## runtime/service/src/main/java/org/apache/polaris/service/reporting/MetricsProcessor.java: ########## @@ -0,0 +1,77 @@ +/* + * 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. + */ +package org.apache.polaris.service.reporting; + +/** + * Interface for processing Iceberg metrics reports in Polaris. + * + * <p>This interface provides a pluggable mechanism for handling metrics reports from Iceberg table + * operations. Implementations can persist metrics to various backends, forward them to external + * systems, or perform custom processing. + * + * <p>Processors are discovered via CDI using the {@link io.smallrye.common.annotation.Identifier} + * annotation. Custom processors can be implemented and registered by annotating them with + * {@code @ApplicationScoped} and {@code @Identifier("custom-name")}. + * + * <p>Available built-in processors: + * + * <ul> + * <li>{@code noop} - Discards all metrics (default) + * <li>{@code logging} - Logs metrics to console for debugging + * <li>{@code persistence} - Persists to dedicated metrics tables + * </ul> + * + * <p>Example configuration: + * + * <pre> + * polaris: + * metrics: + * processor: + * type: persistence + * </pre> + * + * <p>Custom implementations should be annotated with: + * + * <pre> + * {@literal @}ApplicationScoped + * {@literal @}Identifier("custom-processor") + * public class CustomMetricsProcessor implements MetricsProcessor { + * {@literal @}Override + * public void process(MetricsProcessingContext context) { + * // implementation + * } + * } + * </pre> + * + * @see MetricsProcessingContext + * @see MetricsProcessorConfiguration + */ +public interface MetricsProcessor { + + /** + * Process a metrics report with full context information. + * + * <p>Implementations should handle exceptions gracefully and not throw exceptions that would + * disrupt the metrics reporting flow. Errors should be logged and metrics about processing + * failures should be emitted. + * + * @param context the complete context for metrics processing + */ + void process(MetricsProcessingContext context); Review Comment: Why not evolve `PolarisMetricsReporter`? If we introduce a new SPI, we'll break existing use cases anyway. Changing the old SPI at least allows downstream builds to detect the breakage at compile time 🤔 @cccs-cat001 : WDYT? ########## runtime/service/src/main/java/org/apache/polaris/service/reporting/MetricsProcessingContext.java: ########## @@ -0,0 +1,66 @@ +/* + * 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. + */ +package org.apache.polaris.service.reporting; + +import java.util.Optional; +import org.apache.iceberg.catalog.TableIdentifier; +import org.apache.iceberg.metrics.MetricsReport; +import org.immutables.value.Value; + +/** + * Context information for metrics processing, providing access to request metadata, security + * context, and tracing information. + * + * <p>This immutable context object contains all the information needed to process and persist + * Iceberg metrics reports, including catalog and table identifiers, the metrics report itself, and + * associated metadata like principal name, request ID, and OpenTelemetry trace context. + */ [email protected] +public interface MetricsProcessingContext { + + /** The catalog name where the metrics originated */ + String catalogName(); + + /** The table identifier */ + TableIdentifier tableIdentifier(); + + /** The Iceberg metrics report (ScanReport or CommitReport) */ + MetricsReport metricsReport(); + + /** The realm ID */ + String realmId(); + + /** The catalog ID (internal entity ID) */ + Optional<Long> catalogId(); + + /** The principal name who submitted the metrics */ + Optional<String> principalName(); + + /** The request ID for correlation */ + Optional<String> requestId(); Review Comment: Requests IDs in Polaris are a bit special. I'm not sure a mainstream use case exists for them. In any case, I believe they should be handled via dedicated context objects similar to `PolarisPrincipalHolder`. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
