/*
 * MIT License
 *
 * Copyright (c) 2020-present Cloudogu GmbH and Contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package sonia.scm.metrics;

import io.micrometer.core.instrument.MeterRegistry;
import sonia.scm.plugin.ExtensionPoint;

import java.util.Optional;

/**
 * Extension point to pass SCM-Manager metrics to a monitoring system.
 *
 * @since 2.15.0
 */
@ExtensionPoint
public interface MonitoringSystem {

  /**
   * Returns name of monitoring system.
   *
   * @return name of monitoring system
   */
  String getName();

  /**
   * Returns registry of metrics provider.
   *
   * @return metrics registry
   */
  MeterRegistry getRegistry();

  /**
   * Returns an optional scrape target.
   * A scrape target is only needed if the monitoring system pulls the metrics over http.
   * If the monitoring system uses a push based model, this method returns an empty optional.
   *
   * @return optional scrape target
   */
  default Optional<ScrapeTarget> getScrapeTarget() {
    return Optional.empty();
  }
}
