Ticket #14 : Configure function in order to return "/metrics"

habarthierry-hue · habarthierry-hue · commit 01f224de5672 · 2021-10-08T16:30:51.000+02:00
diff --git a/GatewayDockerfile b/GatewayDockerfile
@@ -2,6 +2,7 @@ FROM mcr.microsoft.com/dotnet/aspnet:5.0
 
 COPY build/results/services/Gateway/ App/
 ENV ASPNETCORE_URLS=http://*:8080
+ENV ASPNETCORE_ENVIRONMENT=Docker
 
 EXPOSE 8080
 
diff --git a/conf/docker/prometheus/prometheus.yml b/conf/docker/prometheus/prometheus.yml
@@ -23,4 +23,4 @@ scrape_configs:
   - job_name: "prometheus"
     file_sd_configs:
     - files:
-      - 'targets.json'
+      - '/shared/targets.json'
diff --git a/default.ps1 b/default.ps1
@@ -90,6 +90,8 @@ task initLocalKubernetes {
     exec { kubectl apply -f ./kubernetes/run-mssql.yml --namespace=faas }
     exec { kubectl apply -f ./kubernetes/mssql-external-svc.yml --namespace=faas }
     exec { kubectl apply -f ./kubernetes/mssql-internal-svc.yml --namespace=faas }
+    exec { kubectl apply -f ./kubernetes/prometheus-persistent-volume.yml --namespace=faas }
+    exec { kubectl apply -f ./kubernetes/prometheus-persistent-volume-claim.yml --namespace=faas }
 	exec { kubectl apply -f ./kubernetes/run-faas-kubernetes.yml --namespace=faas }
 	exec { kubectl apply -f ./kubernetes/faas-kubernetes-svc.yml --namespace=faas }
 	exec { kubectl apply -f ./kubernetes/run-faas-gateway.yml --namespace=faas }
diff --git a/kubernetes/prometheus-persistent-volume-claim.yml b/kubernetes/prometheus-persistent-volume-claim.yml
@@ -0,0 +1,11 @@
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: prometheus-pv-claim
+spec:
+  storageClassName: manual
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 3Gi
diff --git a/kubernetes/prometheus-persistent-volume.yml b/kubernetes/prometheus-persistent-volume.yml
@@ -0,0 +1,14 @@
+apiVersion: v1
+kind: PersistentVolume
+metadata:
+  name: prometheus-pv-volume
+  labels:
+    type: local
+spec:
+  storageClassName: manual
+  capacity:
+    storage: 10Gi
+  accessModes:
+    - ReadWriteOnce
+  hostPath:
+    path: "/conf"
diff --git a/kubernetes/run-faas-gateway.yml b/kubernetes/run-faas-gateway.yml
@@ -12,8 +12,15 @@ spec:
       labels:
         run: faas-gateway
     spec:
+      volumes:
+      - name: prometheus-pv-storage
+        persistentVolumeClaim:
+          claimName: prometheus-pv-claim
       containers:
       - name: faas-gateway
         image: localhost:5000/faasgateway
         ports:
         - containerPort: 8080
+        volumeMounts:
+        - mountPath: "/shared"
+          name: prometheus-pv-storage
diff --git a/kubernetes/run-prometheus.yml b/kubernetes/run-prometheus.yml
@@ -12,8 +12,15 @@ spec:
       labels:
         run: faas-prometheus
     spec:
+      volumes:
+      - name: prometheus-pv-storage
+        persistentVolumeClaim:
+          claimName: prometheus-pv-claim
       containers:
       - name: faas-website
         image: localhost:5000/faasprometheus
         ports:
         - containerPort: 9090
+        volumeMounts:
+        - mountPath: "/shared"
+          name: prometheus-pv-storage
diff --git a/src/FaasNet.Gateway.Core/Functions/Commands/Handlers/PublishFunctionCommandHandler.cs b/src/FaasNet.Gateway.Core/Functions/Commands/Handlers/PublishFunctionCommandHandler.cs
@@ -1,6 +1,7 @@
 ﻿using FaasNet.Gateway.Core.Domains;
 using FaasNet.Gateway.Core.Exceptions;
 using FaasNet.Gateway.Core.Factories;
+using FaasNet.Gateway.Core.Helpers;
 using FaasNet.Gateway.Core.Repositories;
 using FaasNet.Gateway.Core.Resources;
 using MediatR;
@@ -18,15 +19,18 @@ public class PublishFunctionCommandHandler : IRequestHandler<PublishFunctionComm
     {
         private readonly IHttpClientFactory _httpClientFactory;
         private readonly IFunctionCommandRepository _functionRepository;
+        private readonly IPrometheusHelper _prometheusHelper;
         private readonly GatewayConfiguration _configuration;
 
         public PublishFunctionCommandHandler(
             IHttpClientFactory httpClientFactory,
             IFunctionCommandRepository functionRepository,
+            IPrometheusHelper prometheusHelper,
             IOptions<GatewayConfiguration> configuration)
         {
             _httpClientFactory = httpClientFactory;
             _functionRepository = functionRepository;
+            _prometheusHelper = prometheusHelper;
             _configuration = configuration.Value;
         }
 
@@ -51,6 +55,7 @@ public async Task<bool> Handle(PublishFunctionCommand command, CancellationToken
                 function = FunctionAggregate.Create(command.Name, command.Image);
                 await _functionRepository.Add(function, cancellationToken);
                 await _functionRepository.SaveChanges(cancellationToken);
+                _prometheusHelper.Add(command.Name);
                 return true;
             }
         }
diff --git a/src/FaasNet.Gateway.Core/Functions/Commands/Handlers/UnpublishFunctionCommandHandler.cs b/src/FaasNet.Gateway.Core/Functions/Commands/Handlers/UnpublishFunctionCommandHandler.cs
@@ -1,5 +1,6 @@
 ﻿using FaasNet.Gateway.Core.Exceptions;
 using FaasNet.Gateway.Core.Factories;
+using FaasNet.Gateway.Core.Helpers;
 using FaasNet.Gateway.Core.Repositories;
 using FaasNet.Gateway.Core.Resources;
 using MediatR;
@@ -15,15 +16,18 @@ public class UnpublishFunctionCommandHandler : IRequestHandler<UnpublishFunction
     {
         private readonly IHttpClientFactory _httpClientFactory;
         private readonly IFunctionCommandRepository _functionRepository;
+        private readonly IPrometheusHelper _prometheusHelper;
         private readonly GatewayConfiguration _configuration;
 
         public UnpublishFunctionCommandHandler(
             IHttpClientFactory httpClientFactory,
             IFunctionCommandRepository functionRepository,
+            IPrometheusHelper prometheusHelper,
             IOptions<GatewayConfiguration> configuration)
         {
             _httpClientFactory = httpClientFactory;
             _functionRepository = functionRepository;
+            _prometheusHelper = prometheusHelper;
             _configuration = configuration.Value;
         }
 
@@ -46,6 +50,7 @@ public async Task<bool> Handle(UnpublishFunctionCommand command, CancellationTok
                 httpResult.EnsureSuccessStatusCode();
                 await _functionRepository.Delete(function, cancellationToken);
                 await _functionRepository.SaveChanges(cancellationToken);
+                _prometheusHelper.Remove(command.Name);
                 return true;
             }
         }
diff --git a/src/FaasNet.Gateway.Core/GatewayConfiguration.cs b/src/FaasNet.Gateway.Core/GatewayConfiguration.cs
@@ -8,5 +8,6 @@ public GatewayConfiguration()
         }
 
         public string FunctionApi { get; set; }
+        public string PrometheusFilePath { get; set; }
     }
 }
diff --git a/src/FaasNet.Gateway.Core/Helpers/IPrometheusHelper.cs b/src/FaasNet.Gateway.Core/Helpers/IPrometheusHelper.cs
@@ -0,0 +1,8 @@
+﻿namespace FaasNet.Gateway.Core.Helpers
+{
+    public interface IPrometheusHelper
+    {
+        void Add(string name);
+        void Remove(string name);
+    }
+}
diff --git a/src/FaasNet.Gateway.Core/Helpers/PrometheusHelper.cs b/src/FaasNet.Gateway.Core/Helpers/PrometheusHelper.cs
@@ -0,0 +1,53 @@
+﻿using Microsoft.Extensions.Options;
+using Newtonsoft.Json;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+
+namespace FaasNet.Gateway.Core.Helpers
+{
+    public class PrometheusHelper : IPrometheusHelper
+    {
+        private readonly GatewayConfiguration _configuration;
+
+        public PrometheusHelper(IOptions<GatewayConfiguration> configuration)
+        {
+            _configuration = configuration.Value;
+        }
+
+        public void Add(string name)
+        {
+            var targets = GetTargets();
+            targets.Add(new PrometheusTarget
+            {
+                Labels = new PrometheusLabel
+                {
+                    Job = name
+                },
+                Targets = new List<string>
+                {
+                    $"{name}-entry.{name}.svc.cluster.local"
+                }
+            });
+            Update(targets);
+        }
+
+        public void Remove(string name)
+        {
+            var targets = GetTargets();
+            var filteredTargets = targets.Where(t => !(t.Labels.Job == name)).ToList();
+            Update(filteredTargets);
+        }
+
+        private ICollection<PrometheusTarget> GetTargets()
+        {
+            var content = File.ReadAllText(_configuration.PrometheusFilePath);
+            return JsonConvert.DeserializeObject<List<PrometheusTarget>>(content);
+        }
+
+        private void Update(ICollection<PrometheusTarget> targets)
+        {
+            File.WriteAllText(_configuration.PrometheusFilePath, JsonConvert.SerializeObject(targets));
+        }
+    }
+}
diff --git a/src/FaasNet.Gateway.Core/Helpers/PrometheusLabel.cs b/src/FaasNet.Gateway.Core/Helpers/PrometheusLabel.cs
@@ -0,0 +1,10 @@
+﻿using Newtonsoft.Json;
+
+namespace FaasNet.Gateway.Core.Helpers
+{
+    public class PrometheusLabel
+    {
+        [JsonProperty(PropertyName = "job")]
+        public string Job { get; set; }
+    }
+}
diff --git a/src/FaasNet.Gateway.Core/Helpers/PrometheusTarget.cs b/src/FaasNet.Gateway.Core/Helpers/PrometheusTarget.cs
@@ -0,0 +1,18 @@
+﻿using Newtonsoft.Json;
+using System.Collections.Generic;
+
+namespace FaasNet.Gateway.Core.Helpers
+{
+    public class PrometheusTarget
+    {
+        public PrometheusTarget()
+        {
+            Targets = new List<string>();
+        }
+        
+        [JsonProperty(PropertyName = "labels")]
+        public PrometheusLabel Labels { get; set; }
+        [JsonProperty(PropertyName = "targets")]
+        public List<string> Targets { get; set; }
+    }
+}
diff --git a/src/FaasNet.Gateway.Core/ServiceCollectionExtensions.cs b/src/FaasNet.Gateway.Core/ServiceCollectionExtensions.cs
@@ -3,6 +3,7 @@
 using FaasNet.Gateway.Core.Domains;
 using FaasNet.Gateway.Core.Factories;
 using FaasNet.Gateway.Core.Functions;
+using FaasNet.Gateway.Core.Helpers;
 using FaasNet.Gateway.Core.Repositories;
 using FaasNet.Gateway.Core.Repositories.InMemory;
 using MediatR;
@@ -36,6 +37,7 @@ private static IServiceCollection AddApi(this IServiceCollection services)
             services.AddMediatR(typeof(ServerBuilder));
             services.AddTransient<IApiDefinitionService, ApiDefinitionService>();
             services.AddTransient<IFunctionService, FunctionService>();
+            services.AddTransient<IPrometheusHelper, PrometheusHelper>();
             return services;
         }
 
diff --git a/src/FaasNet.Gateway.Startup/Startup.cs b/src/FaasNet.Gateway.Startup/Startup.cs
@@ -3,31 +3,46 @@
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using System.IO;
 
 namespace FaasNet.Gateway.Startup
 {
     public class Startup
     {
-        public Startup(IConfiguration configuration)
+        public Startup(IConfiguration configuration, IWebHostEnvironment webHostEnvironment)
         {
             Configuration = configuration;
+            WebHostEnvironment = webHostEnvironment;
         }
 
+        public IWebHostEnvironment WebHostEnvironment { get; }
         public IConfiguration Configuration { get; }
 
         public void ConfigureServices(IServiceCollection services)
         {
+            var prometheusFilePath = Configuration.GetValue<string>("prometheusFilePath");
             services.AddCors(options => options.AddPolicy("AllowAll", p => p.AllowAnyOrigin()
                 .AllowAnyMethod()
                 .AllowAnyHeader()));
-            services.AddGateway()
+            services.AddGateway(opt => opt.PrometheusFilePath = prometheusFilePath)
                 .AddApiDefs(DefaultConfiguration.ApiDefinitions);
             services.AddSwaggerGen();
             services.AddControllers().AddNewtonsoftJson();
         }
 
         public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
         {
+            if (env.IsEnvironment("Docker"))
+            {
+                var prometheusFilePath = Configuration.GetValue<string>("prometheusFilePath");
+                if (!string.IsNullOrWhiteSpace(prometheusFilePath) && !File.Exists(prometheusFilePath))
+                {
+                    var sourceFileName = Path.Combine(WebHostEnvironment.ContentRootPath, "targets.json");
+                    File.Copy(sourceFileName, prometheusFilePath);
+                }
+            }
+
             app.UseCors("AllowAll");
             app.UseSwagger();
             app.UseSwaggerUI(c =>
diff --git a/src/FaasNet.Gateway.Startup/appsettings.Docker.json b/src/FaasNet.Gateway.Startup/appsettings.Docker.json
@@ -0,0 +1,11 @@
+{
+  "DetailedErrors": true,
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft": "Warning",
+      "Microsoft.Hosting.Lifetime": "Information"
+    }
+  },
+  "prometheusFilePath": "/shared/targets.json"
+}
diff --git a/src/FaasNet.Gateway.Startup/appsettings.json b/src/FaasNet.Gateway.Startup/appsettings.json
@@ -6,5 +6,6 @@
       "Microsoft.Hosting.Lifetime": "Information"
     }
   },
-  "AllowedHosts": "*"
+  "AllowedHosts": "*",
+  "prometheusFilePath": ""
 }
diff --git a/src/FaasNet.Gateway.Startup/targets.json b/src/FaasNet.Gateway.Startup/targets.json
@@ -0,0 +1,2 @@
+[
+]

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@ public GatewayConfiguration()`
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`public string FunctionApi { get; set; }`
	`11`	`+ public string PrometheusFilePath { get; set; }`
`11`	`12`	`}`
`12`	`13`	`}`