Jian Li | 7261c7b | 2016-03-05 00:04:55 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Jian Li | 7261c7b | 2016-03-05 00:04:55 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Jian Li | 55cbd5c | 2016-04-06 09:50:20 -0700 | [diff] [blame] | 16 | package org.onlab.metrics; |
Jian Li | 7261c7b | 2016-03-05 00:04:55 -0800 | [diff] [blame] | 17 | |
| 18 | /** |
Jian Li | 55cbd5c | 2016-04-06 09:50:20 -0700 | [diff] [blame] | 19 | * Interface of reporter that reports all metrics value to third party monitor. |
Jian Li | 7261c7b | 2016-03-05 00:04:55 -0800 | [diff] [blame] | 20 | */ |
| 21 | public interface MetricsReporter { |
| 22 | |
| 23 | /** |
| 24 | * Starts to report a set of metrics to the monitoring server. |
| 25 | */ |
| 26 | void startReport(); |
| 27 | |
| 28 | /** |
| 29 | * Stops reporting metrics. |
| 30 | */ |
| 31 | void stopReport(); |
Jian Li | 55cbd5c | 2016-04-06 09:50:20 -0700 | [diff] [blame] | 32 | |
| 33 | /** |
| 34 | * Restarts metrics reporter. |
| 35 | */ |
| 36 | void restartReport(); |
| 37 | |
| 38 | /** |
| 39 | * Notifies the changes on metric registry. |
| 40 | */ |
| 41 | void notifyMetricsChange(); |
Jian Li | 7261c7b | 2016-03-05 00:04:55 -0800 | [diff] [blame] | 42 | } |