| // Licensed to the Apache Software Foundation (ASF) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The ASF licenses this file |
| // to you 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. |
| |
| using System.Collections.Generic; |
| using Org.Apache.REEF.Tang.Annotations; |
| |
| namespace Org.Apache.REEF.Common.Telemetry |
| { |
| /// <summary> |
| /// Interface for a collection of metrics. |
| /// </summary> |
| [DefaultImplementation(typeof(MetricsData))] |
| public interface IMetricSet |
| { |
| /// <summary> |
| /// Add a metric object to this collection. |
| /// </summary> |
| /// <param name="metric">The metric object to add.</param> |
| void RegisterMetric(IMetric metric); |
| |
| /// <summary> |
| /// Get metric value given the metric name. |
| /// </summary> |
| /// <param name="name">Name of the metric</param> |
| /// <param name="metric">The metric object returned</param> |
| /// <returns>Returns a boolean to indicate if the value is found.</returns> |
| bool TryGetMetric<T>(string name, out T metric) |
| where T : IMetric; |
| |
| /// <summary> |
| /// Returns all the metric trackers. |
| /// </summary> |
| /// <returns></returns> |
| IEnumerable<MetricTracker> GetMetricTrackers(); |
| |
| /// <summary> |
| /// Empties the cached records for each metric. |
| /// </summary> |
| /// <returns>Key Value pair of metric name and record.</returns> |
| IEnumerable<KeyValuePair<string, MetricTracker.MetricRecord>> FlushMetricRecords(); |
| |
| /// <summary> |
| /// Serializes the metrics data. |
| /// </summary> |
| /// <returns>Serialized string.</returns> |
| string Serialize(); |
| } |
| } |