Service Discovery

Steeltoe provides a set of generalized interfaces for interacting with multiple service discovery back ends. This section will cover the general components first. If you are looking for something specific to the registry server you are using, feel free to skip ahead to the section for Netflix Eureka or HashiCorp Consul.

In order to use any Steeltoe Discovery client, you need to do the following:

• Add appropriate NuGet package reference to your project.
• Configure the settings the Discovery client will use to register services in the service registry.
• Configure the settings the Discovery client will use to discover services in the service registry.
• Add and Use the Discovery client service in the application.
• Use an injected IDiscoveryClient to lookup services.

NOTE: The Steeltoe Discovery implementation (for example: the decision between Eureka and Consul) is automatically setup within the application based on the application configuration provided.

Add NuGet References

The simplest way to get started with Steeltoe Discovery is to add a reference to a package built for either Microsoft's dependency injection or Autofac. Either package will also include all relevant dependencies. If you are using another DI tool, please file an issue to let us know, and in the mean time use the relevant base package:

App Type	Package	Description
ASP.NET Core	Steeltoe.Discovery.ClientCore	Includes base. Adds ASP.NET Core dependency injection.
ASP.NET 4.x with Autofac	Steeltoe.Discovery.ClientAutofac	Includes base. Adds Autofac dependency injection.
Console/ASP.NET 4.x	Steeltoe.Discovery.EurekaBase	Base Eureka functionality. No dependency injection.
Console/ASP.NET 4.x	Steeltoe.Discovery.ConsulBase	Base Consul functionality. No dependency injection.

To add this type of NuGet to your project, add an element resembling the following PackageReference:

<ItemGroup>
...
    <PackageReference Include="Steeltoe.Discovery.ClientCore" Version="2.5.2" />
...
</ItemGroup>

Enable Debug Logging

Sometimes, it is desirable to turn on debug logging in the Discovery client. To do so, you can modify the appsettings.json file and turn on Debug level logging for the Steeltoe components, as shown in the following example:

Here is an example appsettings.json file:

{
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Warning",
      "Steeltoe": "Debug"
    }
  },
  ...
}