Merge pull request #24 from prom-client-net/response-encoding

Response encoding

Author: phnx47

.github/workflows/branch.yml

@@ -2,15 +2,11 @@ name: 💿 CI Branch
 
 on:
   push:
-    branches:
-      - '*'
-      - '!master'
-    tags:
-      - '!refs/tags/*'
+    branches-ignore:
+      - "master"
   pull_request:
     branches:
-      - master
-
+      - "master"
 jobs:
   build-branch:
     name: 🏭 Build Branch

.github/workflows/master.yml

@@ -3,9 +3,7 @@ name: 💿 CI Master
 on:
   push:
     branches:
-      - 'master'
-    tags:
-      - '!refs/tags/*'
+      - "master"
 
 jobs:
   build-dev:

.github/workflows/production.yml

@@ -3,7 +3,7 @@ name: 💿 CI Prod
 on:
   push:
     tags:
-      - 'v*'
+      - "v*"
 
 jobs:
   build-prod:

README.md

@@ -6,8 +6,7 @@
 
 [![NuGet](https://img.shields.io/nuget/v/Prometheus.Client.MetricServer.svg)](https://www.nuget.org/packages/Prometheus.Client.MetricServer)
 [![NuGet](https://img.shields.io/nuget/dt/Prometheus.Client.MetricServer.svg)](https://www.nuget.org/packages/Prometheus.Client.MetricServer)
-[![CI](https://github.com/PrometheusClientNet/Prometheus.Client.MetricServer/workflows/CI/badge.svg)](https://github.com/PrometheusClientNet/Prometheus.Client.MetricServer/actions?query=workflow%3ACI)
-[![Gitter](https://img.shields.io/gitter/room/PrometheusClientNet/community.svg)](https://gitter.im/PrometheusClientNet/community)
+[![CI](https://img.shields.io/github/workflow/status/prom-client-net/prom-client-metricserver/%F0%9F%92%BF%20CI%20Master?label=CI&logo=github)](https://github.com/prom-client-net/prom-client-metricserver/actions/workflows/master.yml)
 [![License MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
 
 Extension for [Prometheus. Client](https://github.com/PrometheusClientNet/Prometheus.Client)

src/Prometheus.Client.MetricServer/MetricServer.cs

@@ -87,7 +87,7 @@ public void Start()
                         options.Listen(IPAddress.Any, _options.Port, listenOptions => { listenOptions.UseHttps(_options.Certificate); });
                 })
                 .UseUrls($"http{(_options.Certificate != null ? "s" : "")}://{_options.Host}:{_options.Port}")
-                .ConfigureServices(services => { services.AddSingleton<IStartup>(new Startup(_options.CollectorRegistryInstance, _options.MapPath)); })
+                .ConfigureServices(services => { services.AddSingleton<IStartup>(new Startup(_options)); })
                 .UseSetting(WebHostDefaults.ApplicationKey, typeof(Startup).GetTypeInfo().Assembly.FullName)
                 .Build();
 
@@ -106,15 +106,11 @@ public void Stop()
 
         internal class Startup : IStartup
         {
-            private const string _contentType = "text/plain; version=0.0.4";
-            private readonly string _mapPath;
+            private readonly MetricServerOptions _options;
 
-            private readonly ICollectorRegistry _registry;
-
-            public Startup(ICollectorRegistry registry, string mapPath)
+            public Startup(MetricServerOptions options)
             {
-                _registry = registry;
-                _mapPath = mapPath;
+                _options = options;
 
                 var builder = new ConfigurationBuilder();
                 Configuration = builder.Build();
@@ -129,15 +125,20 @@ public IServiceProvider ConfigureServices(IServiceCollection services)
 
             public void Configure(IApplicationBuilder app)
             {
-                app.Map(_mapPath, coreapp =>
+                var contentType = "text/plain; version=0.0.4";
+
+                if (_options.ResponseEncoding != null)
+                    contentType += $"; charset={_options.ResponseEncoding.BodyName}";
+
+                app.Map(_options.MapPath, coreapp =>
                 {
                     coreapp.Run(async context =>
                     {
                         var response = context.Response;
-                        response.ContentType = _contentType;
+                        response.ContentType = contentType;
 
                         using var outputStream = response.Body;
-                        await ScrapeHandler.ProcessAsync(_registry, outputStream);
+                        await ScrapeHandler.ProcessAsync(_options.CollectorRegistryInstance, outputStream);
                     });
                 });
             }

src/Prometheus.Client.MetricServer/MetricServerOptions.cs

@@ -1,4 +1,5 @@
 using System.Security.Cryptography.X509Certificates;
+using System.Text;
 using Prometheus.Client.Collectors;
 
 namespace Prometheus.Client.MetricServer
@@ -37,5 +38,10 @@ public class MetricServerOptions
         ///     Use default collectors(dotnet and process stats)
         /// </summary>
         public bool UseDefaultCollectors { get; set; } = false;
+
+        /// <summary>
+        ///     Charset of text response.
+        /// </summary>
+        public Encoding ResponseEncoding { get; set; }
     }
 }

src/Prometheus.Client.MetricServer/Prometheus.Client.MetricServer.csproj

@@ -1,20 +1,15 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <Description>Standalone Kestrel server for the Prometheus.Client</Description>
-    <Copyright>2020 © Serge K, Oleksandr Poliakov</Copyright>
-    <AssemblyTitle>Prometheus.Client.MetricServer</AssemblyTitle>
-    <VersionPrefix>4.2.0</VersionPrefix>
-    <Authors>Serge K, Oleksandr Poliakov</Authors>
+    <VersionPrefix>4.3.0</VersionPrefix>
     <TargetFrameworks>netstandard2.0;netstandard2.1;netcoreapp3.1;net5.0</TargetFrameworks>
-    <LangVersion>latest</LangVersion>
     <AssemblyName>Prometheus.Client.MetricServer</AssemblyName>
     <PackageId>Prometheus.Client.MetricServer</PackageId>
     <PackageTags>prometheus;metrics</PackageTags>
     <PackageIcon>icon.png</PackageIcon>
-    <PackageProjectUrl>https://github.com/prom-client-net/Prometheus.Client.MetricServer</PackageProjectUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <RepositoryType>git</RepositoryType>
-    <RepositoryUrl>https://github.com/prom-client-net/Prometheus.Client.MetricServer</RepositoryUrl>
+    <RepositoryUrl>https://github.com/prom-client-net/prom-client-metricserver</RepositoryUrl>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <SignAssembly>true</SignAssembly>

tests/Prometheus.Client.MetricServer.Tests/MetricServerTests.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Net;
 using System.Net.Http;
+using System.Text;
 using System.Threading.Tasks;
 using Prometheus.Client.Collectors;
 using Xunit;
@@ -125,7 +126,7 @@ public async Task Find_Metric()
         {
             var registry = new CollectorRegistry();
             var factory = new MetricFactory(registry);
-            var metricServer = new MetricServer(new MetricServerOptions { Port = _port, CollectorRegistryInstance = registry});
+            var metricServer = new MetricServer(new MetricServerOptions { Port = _port, CollectorRegistryInstance = registry });
 
             try
             {
@@ -179,12 +180,7 @@ public async Task Url_NotFound()
         public async Task Find_Default_Metric()
         {
             var registry = new CollectorRegistry();
-            var metricServer = new MetricServer(new MetricServerOptions
-            {
-                Port = _port,
-                CollectorRegistryInstance = registry,
-                UseDefaultCollectors = true
-            });
+            var metricServer = new MetricServer(new MetricServerOptions { Port = _port, CollectorRegistryInstance = registry, UseDefaultCollectors = true });
 
             try
             {
@@ -205,5 +201,33 @@ public async Task Find_Default_Metric()
                 metricServer.Stop();
             }
         }
+
+        [Fact]
+        public async Task Add_Encoding()
+        {
+            var metricServer = new MetricServer(new MetricServerOptions { Port = _port, ResponseEncoding = Encoding.UTF8 });
+
+            try
+            {
+                metricServer.Start();
+
+                const string help = "русский хелп";
+                var counter = Metrics.DefaultFactory.CreateCounter("test_counter_rus", help);
+                counter.Inc();
+
+                using var httpClient = new HttpClient();
+                string response = await httpClient.GetStringAsync($"http://localhost:{_port}/metrics");
+                Assert.Contains(help, response);
+            }
+            catch (Exception ex)
+            {
+                _testOutputHelper.WriteLine(ex.ToString());
+                throw;
+            }
+            finally
+            {
+                metricServer.Stop();
+            }
+        }
     }
 }