CompositeMetricReader.cs

// <copyright file="CompositeMetricReader.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// 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.
// </copyright>

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.Metrics;
using System.Threading;
using OpenTelemetry.Internal;

namespace OpenTelemetry.Metrics
{
    internal sealed class CompositeMetricReader : MetricReader
    {
        private readonly DoublyLinkedListNode head;
        private DoublyLinkedListNode tail;
        private bool disposed;
        private int count;

        public CompositeMetricReader(IEnumerable<MetricReader> readers)
        {
            Guard.Null(readers, nameof(readers));

            using var iter = readers.GetEnumerator();
            if (!iter.MoveNext())
            {
                throw new ArgumentException($"'{iter}' is null or empty", nameof(iter));
            }

            this.head = new DoublyLinkedListNode(iter.Current);
            this.tail = this.head;
            this.count++;

            while (iter.MoveNext())
            {
                this.AddReader(iter.Current);
            }
        }

        public CompositeMetricReader AddReader(MetricReader reader)
        {
            Guard.Null(reader, nameof(reader));

            var node = new DoublyLinkedListNode(reader)
            {
                Previous = this.tail,
            };
            this.tail.Next = node;
            this.tail = node;
            this.count++;

            return this;
        }

        public Enumerator GetEnumerator() => new Enumerator(this.head);

        internal List<Metric> AddMetricsWithNoViews(Instrument instrument)
        {
            var metrics = new List<Metric>();
            for (var cur = this.head; cur != null; cur = cur.Next)
            {
                var metric = cur.Value.AddMetricWithNoViews(instrument);
                metrics.Add(metric);
            }

            return metrics;
        }

        internal void RecordSingleStreamLongMeasurements(List<Metric> metrics, long value, ReadOnlySpan<KeyValuePair<string, object>> tags)
        {
            Debug.Assert(metrics.Count == this.count, "The count of metrics to be updated for a CompositeReader must match the number of individual readers.");

            int index = 0;
            for (var cur = this.head; cur != null; cur = cur.Next)
            {
                if (metrics[index] != null)
                {
                    cur.Value.RecordSingleStreamLongMeasurement(metrics[index], value, tags);
                }

                index++;
            }
        }

        internal void RecordSingleStreamDoubleMeasurements(List<Metric> metrics, double value, ReadOnlySpan<KeyValuePair<string, object>> tags)
        {
            Debug.Assert(metrics.Count == this.count, "The count of metrics to be updated for a CompositeReader must match the number of individual readers.");

            int index = 0;
            for (var cur = this.head; cur != null; cur = cur.Next)
            {
                if (metrics[index] != null)
                {
                    cur.Value.RecordSingleStreamDoubleMeasurement(metrics[index], value, tags);
                }

                index++;
            }
        }

        internal List<List<Metric>> AddMetricsSuperListWithViews(Instrument instrument, List<MetricStreamConfiguration> metricStreamConfigs)
        {
            var metricsSuperList = new List<List<Metric>>();
            for (var cur = this.head; cur != null; cur = cur.Next)
            {
                var metrics = cur.Value.AddMetricsListWithViews(instrument, metricStreamConfigs);
                metricsSuperList.Add(metrics);
            }

            return metricsSuperList;
        }

        internal void RecordLongMeasurements(List<List<Metric>> metricsSuperList, long value, ReadOnlySpan<KeyValuePair<string, object>> tags)
        {
            Debug.Assert(metricsSuperList.Count == this.count, "The count of metrics to be updated for a CompositeReader must match the number of individual readers.");

            int index = 0;
            for (var cur = this.head; cur != null; cur = cur.Next)
            {
                if (metricsSuperList[index].Count > 0)
                {
                    cur.Value.RecordLongMeasurement(metricsSuperList[index], value, tags);
                }

                index++;
            }
        }

        internal void RecordDoubleMeasurements(List<List<Metric>> metricsSuperList, double value, ReadOnlySpan<KeyValuePair<string, object>> tags)
        {
            Debug.Assert(metricsSuperList.Count == this.count, "The count of metrics to be updated for a CompositeReader must match the number of individual readers.");

            int index = 0;
            for (var cur = this.head; cur != null; cur = cur.Next)
            {
                if (metricsSuperList[index].Count > 0)
                {
                    cur.Value.RecordDoubleMeasurement(metricsSuperList[index], value, tags);
                }

                index++;
            }
        }

        internal void CompleteSingleStreamMeasurements(List<Metric> metrics)
        {
            Debug.Assert(metrics.Count == this.count, "The count of metrics to be updated for a CompositeReader must match the number of individual readers.");

            int index = 0;
            for (var cur = this.head; cur != null; cur = cur.Next)
            {
                if (metrics[index] != null)
                {
                    cur.Value.CompleteSingleStreamMeasurement(metrics[index]);
                }

                index++;
            }
        }

        /// <inheritdoc/>
        protected override bool ProcessMetrics(in Batch<Metric> metrics, int timeoutMilliseconds)
        {
            // CompositeMetricReader delegates the work to its underlying readers,
            // so CompositeMetricReader.ProcessMetrics should never be called.
            throw new NotSupportedException();
        }

        /// <inheritdoc/>
        protected override bool OnCollect(int timeoutMilliseconds = Timeout.Infinite)
        {
            var result = true;
            var sw = Stopwatch.StartNew();

            for (var cur = this.head; cur != null; cur = cur.Next)
            {
                if (timeoutMilliseconds == Timeout.Infinite)
                {
                    result = cur.Value.Collect(Timeout.Infinite) && result;
                }
                else
                {
                    var timeout = timeoutMilliseconds - sw.ElapsedMilliseconds;

                    // notify all the readers, even if we run overtime
                    result = cur.Value.Collect((int)Math.Max(timeout, 0)) && result;
                }
            }

            return result;
        }

        /// <inheritdoc/>
        protected override bool OnShutdown(int timeoutMilliseconds)
        {
            var result = true;
            var sw = Stopwatch.StartNew();

            for (var cur = this.head; cur != null; cur = cur.Next)
            {
                if (timeoutMilliseconds == Timeout.Infinite)
                {
                    result = cur.Value.Shutdown(Timeout.Infinite) && result;
                }
                else
                {
                    var timeout = timeoutMilliseconds - sw.ElapsedMilliseconds;

                    // notify all the readers, even if we run overtime
                    result = cur.Value.Shutdown((int)Math.Max(timeout, 0)) && result;
                }
            }

            return result;
        }

        protected override void Dispose(bool disposing)
        {
            if (!this.disposed)
            {
                if (disposing)
                {
                    for (var cur = this.head; cur != null; cur = cur.Next)
                    {
                        try
                        {
                            cur.Value?.Dispose();
                        }
                        catch (Exception)
                        {
                            // TODO: which event source do we use?
                            // OpenTelemetrySdkEventSource.Log.SpanProcessorException(nameof(this.Dispose), ex);
                        }
                    }
                }

                this.disposed = true;
            }

            base.Dispose(disposing);
        }

        public struct Enumerator
        {
            private DoublyLinkedListNode node;

            internal Enumerator(DoublyLinkedListNode node)
            {
                this.node = node;
                this.Current = null;
            }

            public MetricReader Current { get; private set; }

            public bool MoveNext()
            {
                if (this.node != null)
                {
                    this.Current = this.node.Value;
                    this.node = this.node.Next;
                    return true;
                }

                return false;
            }
        }

        internal class DoublyLinkedListNode
        {
            public readonly MetricReader Value;

            public DoublyLinkedListNode(MetricReader value)
            {
                this.Value = value;
            }

            public DoublyLinkedListNode Previous { get; set; }

            public DoublyLinkedListNode Next { get; set; }
        }
    }
}