blob: f03695bb5e019acc69b05bb4dfd1b3583ca87b48 [file] [log] [blame]
Jian Lib97f6fb2016-03-21 11:33:28 -07001/*
Brian O'Connora09fe5b2017-08-03 21:12:30 -07002 * Copyright 2016-present Open Networking Foundation
Jian Lib97f6fb2016-03-21 11:33:28 -07003 *
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 */
16package org.onosproject.influxdbmetrics;
17
Jian Li55cbd5c2016-04-06 09:50:20 -070018import org.onlab.metrics.MetricsReporter;
19
Jian Lib97f6fb2016-03-21 11:33:28 -070020/**
Jian Lie1d97c92016-03-22 10:21:44 -070021 * A Metric reporter interface for reporting all metrics to influxDB server.
Jian Lib97f6fb2016-03-21 11:33:28 -070022 */
Jian Li55cbd5c2016-04-06 09:50:20 -070023public interface InfluxDbMetricsReporter extends MetricsReporter {
Jian Lib97f6fb2016-03-21 11:33:28 -070024
25 /**
Jian Lie1d97c92016-03-22 10:21:44 -070026 * Configures default parameters for influx database metrics reporter.
Jian Lib97f6fb2016-03-21 11:33:28 -070027 *
Jian Lie1d97c92016-03-22 10:21:44 -070028 * @param address IP address of influxDB server
29 * @param port Port number of influxDB server
30 * @param database Database name of influxDB server
31 * @param username Username of influxDB server
32 * @param password Password of influxDB server
Jian Lib97f6fb2016-03-21 11:33:28 -070033 */
Jian Lie1d97c92016-03-22 10:21:44 -070034 void config(String address, int port, String database, String username, String password);
Jian Lib97f6fb2016-03-21 11:33:28 -070035}