PrometheusExporterEndpointRouteBuilderExtensions.cs

// <copyright file="PrometheusExporterEndpointRouteBuilderExtensions.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 Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using OpenTelemetry.Exporter;
using OpenTelemetry.Internal;
using OpenTelemetry.Metrics;

namespace Microsoft.AspNetCore.Builder
{
    /// <summary>
    /// Provides extension methods for <see cref="IEndpointRouteBuilder"/> to add
    /// Prometheus scraping endpoint.
    /// </summary>
    public static class PrometheusExporterEndpointRouteBuilderExtensions
    {
        /// <summary>
        /// Adds OpenTelemetry Prometheus scraping endpoint middleware to an
        /// <see cref="IEndpointRouteBuilder"/> instance.
        /// </summary>
        /// <remarks>Note: A branched pipeline is created for the route
        /// specified by <see
        /// cref="PrometheusAspNetCoreOptions.ScrapeEndpointPath"/>.</remarks>
        /// <param name="endpoints">The <see cref="IEndpointRouteBuilder"/> to add
        /// middleware to.</param>
        /// <returns>A convention routes for the Prometheus scraping endpoint.</returns>
        public static IEndpointConventionBuilder MapPrometheusScrapingEndpoint(this IEndpointRouteBuilder endpoints)
            => MapPrometheusScrapingEndpoint(endpoints, path: null, meterProvider: null, configureBranchedPipeline: null);

        /// <summary>
        /// Adds OpenTelemetry Prometheus scraping endpoint middleware to an
        /// <see cref="IEndpointRouteBuilder"/> instance.
        /// </summary>
        /// <param name="endpoints">The <see cref="IEndpointRouteBuilder"/> to add
        /// middleware to.</param>
        /// <param name="path">The path to use for the branched pipeline.</param>
        /// <returns>A convention routes for the Prometheus scraping endpoint.</returns>
        public static IEndpointConventionBuilder MapPrometheusScrapingEndpoint(this IEndpointRouteBuilder endpoints, string path)
        {
            Guard.ThrowIfNull(path);
            return MapPrometheusScrapingEndpoint(endpoints, path, meterProvider: null, configureBranchedPipeline: null);
        }

        /// <summary>
        /// Adds OpenTelemetry Prometheus scraping endpoint middleware to an
        /// <see cref="IEndpointRouteBuilder"/> instance.
        /// </summary>
        /// <param name="endpoints">The <see cref="IEndpointRouteBuilder"/> to add
        /// middleware to.</param>
        /// <param name="path">Optional path to use for the branched pipeline.
        /// If not provided then <see cref="PrometheusAspNetCoreOptions.ScrapeEndpointPath"/>
        /// is used.</param>
        /// <param name="meterProvider">Optional <see cref="MeterProvider"/>
        /// containing a Prometheus exporter otherwise the primary SDK provider
        /// will be resolved using application services.</param>
        /// <param name="configureBranchedPipeline">Optional callback to
        /// configure the branched pipeline. Called before registration of the
        /// Prometheus middleware.</param>
        /// <returns>A convention routes for the Prometheus scraping endpoint.</returns>
        public static IEndpointConventionBuilder MapPrometheusScrapingEndpoint(
            this IEndpointRouteBuilder endpoints,
            string path = null,
            MeterProvider meterProvider = null,
            Action<IApplicationBuilder> configureBranchedPipeline = null)
        {
            var builder = endpoints.CreateApplicationBuilder();

            // Note: Order is important here. MeterProvider is accessed before
            // GetOptions<PrometheusAspNetCoreOptions> so that any changes made to
            // PrometheusAspNetCoreOptions in deferred AddPrometheusExporter
            // configure actions are reflected.
            meterProvider ??= endpoints.ServiceProvider.GetRequiredService<MeterProvider>();

            if (path == null)
            {
                var options = endpoints.ServiceProvider.GetRequiredService<IOptions<PrometheusAspNetCoreOptions>>().Value;

                path = options.ScrapeEndpointPath ?? PrometheusAspNetCoreOptions.DefaultScrapeEndpointPath;
            }

            if (!path.StartsWith("/"))
            {
                path = $"/{path}";
            }

            configureBranchedPipeline?.Invoke(builder);

            builder.UseMiddleware<PrometheusExporterMiddleware>(meterProvider);

            return endpoints.Map(new PathString(path), builder.Build());
        }
    }
}