FCMicroservices 0.3.1

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package FCMicroservices --version 0.3.1                

                    
                

            
NuGet\Install-Package FCMicroservices -Version 0.3.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="FCMicroservices" Version="0.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add FCMicroservices --version 0.3.1                

                    
                

            
#r "nuget: FCMicroservices, 0.3.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install FCMicroservices as a Cake Addin
#addin nuget:?package=FCMicroservices&version=0.3.1

// Install FCMicroservices as a Cake Tool
#tool nuget:?package=FCMicroservices&version=0.3.1

Creating New Microservice

The following service package should be connected to a newly created service. First create a brand new web-api application in your ide. Then install this nuget.

nuget install fc.micro.services

Program.cs

A minimum start can be made to the Program.cs file as follows. The dbcontext needed by the microservice is given and it is run with Run() method. By default, the connection string is tried to be retrieved by searching for a key called "DB".

Microservice
    .Create(args)
    .UseDbContext<HelloWorldDbContext>()
    .Run();

Events / Subcriptions

If we want the service to listen to an event, a code like the one below will suffice. It listens for the CalculationFinished event and executes CalculationFinishedSubscription when it receives the message.

Microservice
    .Create(args)
    .WithSubscription<CalculationFinished>()
    .Run();

Sample Event:

using fc.micro.services.Core.Microservice.Components.BUS.Events;

namespace fc.micro.services.Hello.Microservice.Messages.Events
{
    [Event]
    public class CalculationFinished
    {
        public int Result { get; set; }
    }
}

Sample Event Subscription:

using fc.micro.services.Core.Microservice.Components.BUS.Events;
using fc.micro.services.Core.Microservice.Extensions;

namespace fc.micro.services.Hello.Microservice.Messages.Events
{
    public class CalculationFinishedSubscription : EventSubscription<CalculationFinished>
    {
        public override void OnEvent(CalculationFinished input)
        {
            Console.WriteLine("Message received!" + input.ToJson(true));
        }
    }
}

Probe'lar

We understand the status of a service with probes. The following are the default values. Here is an example of the code that says I am healthy in any case. Probes are used during virtualization. Configure Liveness, Readiness and Startup Probes | Kubernetes

  • Liveness http://localhost:5000/liveness

    • There may be cases where a pod opens very slowly. Killing with Liveness is prevented. If Liveness is false, it will be deleted and restarted.

  • Readiness http://localhost:5000/readiness

    • This service allows you to decide whether to receive a request or not. It cannot be done. Shall I provide request traffic to the pod? says kubernetes

  • Startup http://localhost:5000/startup

    • It allows to query whether the application is ready or not. Liveness and readiness are treated as false in the startup = false case. If everything is ok, Kubernetes deploys the pod to the network.
Microservice
    .Create(args)
    .WithProbes(x => x
        .SetLiveness<DefaultLivenessHealthCheck>()
        .SetReadiness<DefaultReadinessHealthCheck>()
        .SetStartup<DefaultStartupHealthCheck>()
    )
    .Run();

IConfigLoader

With ConfigLoader, it is provided to get settings first from environment and then from appsettings.

var a = IConfigloader.Load ("a", "1");

In the above case, if the a variable is passed in appsettings, it takes the value there. It is useful for us when debugging while working in local.

{
    "a" : 200
}

The variable a is overwritten to 200. If it is not in appsettings, it may come from environment. This happens mostly with docker run.

docker run microservice -e a 100

The variable a will be crushed to 100 in the environment it is running.

The default value of 1 is the value to be assigned if nothing is found. It is optional, if it is not given, it means no default value. And we force it to be in env and appsettings.

Settings for api

  • use_pubsub : "yes" / "no"

  • use_tracer : "yes" / "no"

Components to be used in appsettings.json can be determined. If Event/Subscription is to be used, use_pubsub must be marked yes. If trace is to be done, use_tracer must be yes in the same way.


    "use_pubsub": "yes",
    "use_tracer": "yes"

Kestrel Endpoints

To change the endpoints, the Kestrel part in appsettings.json can be given as follows. Which ports are required for GRPC and HTTP.

 "Kestrel": {
        "Endpoints": {
            "http": {
                "Url": "http://0.0.0.0:5000",
                "Protocols": "Http1"
            },
            "grpc": {
                "Url": "http://0.0.0.0:5001",
                "Protocols": "Http2"
            }
        }
    },

When the Console application runs, it will give an output like the one below.

PROBES
=========================
{
  "liveness": null,
  "readiness": null,
  "startup": null
}
subscribing... HesaplamaBitti

SUBSCRIPTIONS
=========================
[
  "HesaplamaBitti"
]

ConfigLoader
=========================
{
  "DB": "Host=localhost;Database=hello-microservice;Port=5432;Username=postgres;Password=1234",
  "use_pubsub": "yes",
  "use_tracer": "yes",
  "PUBSUB_URL": "http://localhost:4222",
  "LOG_COLLECTOR": "http://localhost:14268",
  "LOG_AGENT": "localhost",
  "LOG_AGENT_PORT": "6831"
}
warn: Microsoft.AspNetCore.Server.Kestrel[0]
      Overriding address(es) 'http://localhost:5000'. Binding to endpoints defined via IConfiguration and/or UseKestrel() instead.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: http://0.0.0.0:5001
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: http://0.0.0.0:5000
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: C:\repos\microservice\hello.microservice\

Enterprise Service BUS

We run commands and queries with the bus. When we need to throw an event, we can broadcast or look at the result of another service with BUSClient.

Command:

Query:

Event:

Dependency injection in Handlers

service inspection with api/info

BUS usage

Publisher usage on BUS

Connecting other micro-services to the microservice

In order to include and call messages from other microservices in the project, the following package must be installed.

nuget install [TODO:MicroMessages]

BUS and BUSClient example

Docker microservice and send to harbor

Using one (more than one) dockerized service on the same machine

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.4.0.12 1,602 7/11/2024
0.4.0.11 3,338 4/26/2024
0.4.0.10 59 4/26/2024
0.4.0.9 67 4/26/2024
0.4.0.8 153 4/25/2024
0.4.0.7 66 4/25/2024
0.4.0.6 404 4/4/2024
0.4.0.5 1,464 3/4/2024
0.4.0.4 76 3/4/2024
0.4.0.3 561 2/16/2024
0.4.0.2 76 2/16/2024
0.4.0.1 71 2/15/2024
0.4.0 103 2/10/2024
0.3.20.9 329 1/29/2024
0.3.20.8 69 1/29/2024
0.3.20.7 1,033 1/16/2024
0.3.20.6 270 1/9/2024
0.3.20.5 90 1/8/2024
0.3.20.4 126 1/8/2024
0.3.20.3 110 1/6/2024
0.3.20.2 104 1/2/2024
0.3.20.1 93 1/2/2024
0.3.10.100 774 12/8/2023
0.3.10.10 100 11/26/2023
0.3.10.9 78 11/26/2023
0.3.10.8 879 11/13/2023
0.3.10.7 79 11/10/2023
0.3.10.5 81 11/10/2023
0.3.10.4 321 11/7/2023
0.3.10.3 382 11/4/2023
0.3.10.2 90 11/4/2023
0.3.10.1 100 11/1/2023
0.3.10 91 10/31/2023
0.3.9.20 624 10/25/2023
0.3.9.19 111 10/24/2023
0.3.9.18 418 10/14/2023
0.3.9.17 367 10/8/2023
0.3.9.16 108 10/8/2023
0.3.9.15 887 8/27/2023
0.3.9.14 1,530 7/4/2023
0.3.9.13 111 7/4/2023
0.3.9.12 130 5/1/2023
0.3.9.11 817 4/8/2023
0.3.9.10 189 4/2/2023
0.3.9.9 200 3/31/2023
0.3.9.8 171 3/27/2023
0.3.9.7 417 3/25/2023
0.3.9.6 162 3/25/2023
0.3.9.5 144 3/24/2023
0.3.9.4 141 3/24/2023
0.3.9.3 185 3/23/2023
0.3.9.2 129 3/23/2023
0.3.9.1 132 3/23/2023
0.3.9 154 3/22/2023
0.3.8 141 3/22/2023
0.3.7 326 2/27/2023
0.3.6 656 2/15/2023
0.3.5 141 2/15/2023
0.3.3 310 1/30/2023
0.3.2.1 73 1/2/2024
0.3.2 176 1/29/2023
0.3.1 150 1/29/2023
0.0.3 152 1/28/2023
0.0.2.1 153 1/29/2023
0.0.2 300 1/23/2023