ServiceSpy 1.0.1

.NET 6.0
NuGet\Install-Package ServiceSpy -Version 1.0.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.
dotnet add package ServiceSpy --version 1.0.1
<PackageReference Include="ServiceSpy" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ServiceSpy --version 1.0.1
#r "nuget: ServiceSpy, 1.0.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ServiceSpy as a Cake Addin
#addin nuget:?package=ServiceSpy&version=1.0.1

// Install ServiceSpy as a Cake Tool
#tool nuget:?package=ServiceSpy&version=1.0.1

Service Spy - Simple Decentralized and Distributed Service Discovery

Github Sponsorship

Service spy aims to be a decentralized (not blockchain) service discovery framework. Each service acts as a node and repository for service metadata, mirrored to each service.

If you want a centralized service discovery framework, you can use ZooKeeper, Consul, Eureka or the like.

By default, UDP is used and each service that registers will broadcast service metadata to the local network on a timer.

Metadata store

Service spy stores service metadata in memory on each service.

Service metadata is defined in appsettings.json as follows:

"ServiceSpy":
{
    "Services":
    {
        "Storage": "InMemory", // only InMemory supported for now
        "Items":
        [
            {
                "Id": "459F9F45-B520-42F9-C5BD-373667624231", // unique id for service
                "Name": "ServiceSpyTest", // service name
                // "Version" auto populated from entry assembly
                "Group": "USEastAZ1", // can be a region, zone, etc.
                "IPAddressString": "*", // * will pick any ip
                "Port": 7172, // port
                "Host": "127.0.0.1", // http host
                "Path": "/", // http root path
                "HealthCheckPath": "/health-check" // http health check path
            }
        ]
    }
}

Typically only one service would be hosted per process, but you could define multiple services in Items if desired. These services will be broadcast on a regular interval.

Metadata health check store

Health check status is also stored in memory on each service. Any service performing health checks will broadcast health check results regularly.

Health checks can be setup to be performed from each service to every other service, or from dedicated health check services.

Health checks are defined in appsettings.json as follows:

"ServiceSpy":
{
    "HealthChecks":
    {
        "HealthCheckInterval": 0, // interval in seconds to perform health checks or 0 to not perform health checks (ignored if PerformHealthChecks is false)
        "HealthyCacheTime": 5, // cache healthy results for 5 seconds
        "CleanupInterval": 5, // interval in seconds to check for expired health check metadata
        "ExpireTime": 300, // interval in seconds to purge expired metadata that has not had a health check result, these metadata will not be considered for future service calls
        "Storage": "InMemory" // only InMemory supported for now
    }
}

If HealthCheckInterval is greater than 0, health checks will be performed for every distinct service metadata received that has a health check path.

Send/receive service metadata and health checks

Service metadata and health check results are broadcast on regular intervals.

Each service configures these notifications in appsettings.json:

"ServiceSpy":
{
    "Notifications":
    {
        "BroadcastInterval": 5, // send service metadata notifications every 5 seconds
        "Connection":
        {
            "IPAddress": "127.0.0.1", // * to auto-select
            "Port": 7777,
            "Protocol": "Udp" // Only udp is supported currently
        }
    }
}

To create a health check only service, set the BroadcastInterval to 0 and ensure HealthCheckInterval is set greater than 0 in the HealthChecks section.

Api calls

You can grab healthy service metadata by injecting IMetadataStore and calling GetHealthyMetadatasAsync. You will receive back 0 or more healthy metadatas and can loop over them until a successful call is made.

Example projects

Please reference ServiceSpy.Example.ApiService.csproj and ServiceSpy.Example.HealthChecks.csproj for example code and configuration.

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.

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
1.0.1 89 7/3/2022
1.0.0 94 2/19/2022

Generate documentation file