| /* |
| * 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.samza.metrics; |
| |
| import org.apache.samza.config.Config; |
| |
| |
| /** |
| * A MetricsValidator reads the job's metrics values by using the {@link org.apache.samza.metrics.MetricsAccessor}, |
| * and validate them. |
| */ |
| public interface MetricsValidator { |
| /** |
| * Initialize with config. |
| * @param config Job config |
| */ |
| void init(Config config); |
| |
| /** |
| * Validate the metrics values of a job |
| * @param accessor Accessor to get the metrics values through specific metrics system, e.g. JMX. |
| * @throws MetricsValidationFailureException Exception when the validation fails. |
| */ |
| void validate(MetricsAccessor accessor) throws MetricsValidationFailureException; |
| |
| /** |
| * Complete validation. Final checks can be performed here. |
| * @throws MetricsValidationFailureException Exception when the validation fails. |
| */ |
| void complete() throws MetricsValidationFailureException; |
| } |