/*
 * Copyright 2020 LinkedIn Corp.
 *
 * Licensed 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 azkaban.webapp.metrics;

import azkaban.metrics.AzkabanAPIMetrics;
import azkaban.utils.Props;

/**
 * Defines all the metrics the Web server can emit.
 */
public interface WebMetrics {

  void setUp(final DataProvider dataProvider);

  void startReporting(final Props props);

  AzkabanAPIMetrics setUpAzkabanAPIMetrics(final String endpointUri);

  void markWebGetCall();

  void markWebPostCall();


  /**
   * DropWizard Gauges are instantaneous measurement of a value.
   * This interface defines the methods {@link WebMetrics} implementations will call to obtain
   * said measurements.
   */
  interface DataProvider {

    int getNumberOfIdleServerThreads();

    int getNumberOfServerThreads();

    int getServerJobsQueueSize();

    long getNumberOfQueuedFlows();

    int getNumberOfRunningFlows();

    long getNumberOfCurrentSessions();

    long getNumberOfAgedQueuedFlows();
  }
}
