Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [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 | b97f6fb | 2016-03-21 11:33:28 -0700 | [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 | */ |
| 16 | package org.onosproject.influxdbmetrics; |
| 17 | |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 18 | /** |
Jian Li | e1d97c9 | 2016-03-22 10:21:44 -0700 | [diff] [blame] | 19 | * A Metric reporter interface for reporting all metrics to influxDB server. |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 20 | */ |
Jian Li | e1d97c9 | 2016-03-22 10:21:44 -0700 | [diff] [blame] | 21 | public interface InfluxDbMetricsReporter { |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 22 | |
| 23 | /** |
Jian Li | e1d97c9 | 2016-03-22 10:21:44 -0700 | [diff] [blame] | 24 | * Starts to report metrics to InfluxDB server. |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 25 | */ |
Jian Li | e1d97c9 | 2016-03-22 10:21:44 -0700 | [diff] [blame] | 26 | void startReport(); |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 27 | |
| 28 | /** |
Jian Li | e1d97c9 | 2016-03-22 10:21:44 -0700 | [diff] [blame] | 29 | * Stops reporting metrics. |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 30 | */ |
Jian Li | e1d97c9 | 2016-03-22 10:21:44 -0700 | [diff] [blame] | 31 | void stopReport(); |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 32 | |
| 33 | /** |
Jian Li | e1d97c9 | 2016-03-22 10:21:44 -0700 | [diff] [blame] | 34 | * Restarts metrics reporter. |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 35 | */ |
Jian Li | e1d97c9 | 2016-03-22 10:21:44 -0700 | [diff] [blame] | 36 | void restartReport(); |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 37 | |
| 38 | /** |
Jian Li | e1d97c9 | 2016-03-22 10:21:44 -0700 | [diff] [blame] | 39 | * Configures default parameters for influx database metrics reporter. |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 40 | * |
Jian Li | e1d97c9 | 2016-03-22 10:21:44 -0700 | [diff] [blame] | 41 | * @param address IP address of influxDB server |
| 42 | * @param port Port number of influxDB server |
| 43 | * @param database Database name of influxDB server |
| 44 | * @param username Username of influxDB server |
| 45 | * @param password Password of influxDB server |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 46 | */ |
Jian Li | e1d97c9 | 2016-03-22 10:21:44 -0700 | [diff] [blame] | 47 | void config(String address, int port, String database, String username, String password); |
Jian Li | b97f6fb | 2016-03-21 11:33:28 -0700 | [diff] [blame] | 48 | } |