Microsoft.ServiceFabricApps.FabricObserver.Extensibility 3.3.3

Prefix Reserved

Requires NuGet 3.3.3 or higher.

dotnet add package Microsoft.ServiceFabricApps.FabricObserver.Extensibility --version 3.3.3
                    
NuGet\Install-Package Microsoft.ServiceFabricApps.FabricObserver.Extensibility -Version 3.3.3
                    
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="Microsoft.ServiceFabricApps.FabricObserver.Extensibility" Version="3.3.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Microsoft.ServiceFabricApps.FabricObserver.Extensibility" Version="3.3.3" />
                    
Directory.Packages.props
<PackageReference Include="Microsoft.ServiceFabricApps.FabricObserver.Extensibility" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Microsoft.ServiceFabricApps.FabricObserver.Extensibility --version 3.3.3
                    
#r "nuget: Microsoft.ServiceFabricApps.FabricObserver.Extensibility, 3.3.3"
                    
#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.
#:package Microsoft.ServiceFabricApps.FabricObserver.Extensibility@3.3.3
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Microsoft.ServiceFabricApps.FabricObserver.Extensibility&version=3.3.3
                    
Install as a Cake Addin
#tool nuget:?package=Microsoft.ServiceFabricApps.FabricObserver.Extensibility&version=3.3.3
                    
Install as a Cake Tool

FabricObserver Extensibility Library 3.3.3 (NET 8, SF Runtime version 10.0 and higher)

FabricObserver.Extensibility is a .NET 8 library for building custom observers that extend FabricObserver's and ClusterObserver's capabilities to match your needs. A custom observer is managed just like a built-in observer.

Note: Version 3.3.3 supports SF Runtime versions 10.0 and higher. It can not be used for lesser versions.

How to implement an observer using FO's extensibility model

  1. Create a new .NET core library project. You should target net8.0 in your csproj because that is the target net SDK version that FabricObserver 3.3.3 is built for.

  2. Install the latest Microsoft.ServiceFabricApps.FabricObserver.Extensibility nupkg from https://www.nuget.org/profiles/ServiceFabricApps into your plugin project.

  3. Write an observer plugin!

Steps

  • Create a new class file, MyObserver.cs.

    This is the required signature for your plugin's constructor:

    // FO will provide (and manage) both the FabricClient instance and StatelessServiceContext instance during startup.
    public MyObserver(FabricClient fabricClient, StatelessServiceContext context) : base(fabricClient, context)
    {
    }
  • Implement ObserverBase's two abstract functions:
    public override Task ObserveAsync()
    {
    }

    public override Task ReportAsync()
    {
    }
  • Create a [PluginTypeName]Startup.cs file
    using System.Fabric;
    using FabricObserver;
    using FabricObserver.Observers;
    using Microsoft.Extensions.DependencyInjection;

    [assembly: FabricObserverStartup(typeof(MyObserverStartup))]
    namespace FabricObserver.Observers
    {
        public class MyObserverStartup : IFabricObserverStartup
        {
            public void ConfigureServices(IServiceCollection services, FabricClient fabricClient, StatelessServiceContext context)
            {
                services.AddScoped(typeof(ObserverBase), s => new MyObserver(fabricClient, context));
            }
        }
    }
  • Build, put the output dll and ALL of its dependencies, both managed and native (this is very important), into the Config/Data/Plugins folder in FabricObserver/PackageRoot. You can place your plugin dll and all of its dependencies in its own folder under the Plugins directory (useful if you have multiple plugins). Again, ALL plugin dll dependencies (and their dependencies, if any) need to live in the same folder as the plugin dll. Note that if FabricObserver already employs the same version of dependency dll, then you can omit adding the dependency manually.

  • Add a new config section for your observer in FabricObserver/PackageRoot/Config/Settings.xml (see example at bottom of that file) Update ApplicationManifest.xml with Parameters if you want to support Versionless Application Parameter-only Upgrades for your plugin.

  • Ship it! (Well, test it first =)

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on Microsoft.ServiceFabricApps.FabricObserver.Extensibility:

Package Downloads
Microsoft.ServiceFabricApps.ClusterObserver.Linux.SelfContained

This package contains the Service Fabric ClusterObserver(CO) Application - built for .NET 8.0 and SF Runtime 10.1.x. CO is a highly configurable and extensible Service Fabric stateless service that monitors aggregated cluster health and emits SF entity-specific telemetry. It is designed to be run in Service Fabric Windows and Linux clusters. This package contains the entire application and can be used to build .NET Standard 2.0/.NET6 observer plugins. NOTE: If you want to target .NET 6 for your plugins, then you must use Microsoft.ServiceFabricApps.FabricObserver.Extensibility.3.2.9 or higher nuget package to build them.

Microsoft.ServiceFabricApps.ClusterObserver.Windows.SelfContained

This package contains the Service Fabric ClusterObserver(CO) Application - built for .NET 8.0 and SF Runtime 10.1.x. CO is a highly configurable and extensible Service Fabric stateless service that monitors aggregated cluster health and emits SF entity-specific telemetry. It is designed to be run in Service Fabric Windows and Linux clusters. This package contains the entire application and can be used to build .NET Standard 2.0/.NET6 observer plugins. NOTE: If you want to target .NET 6 for your plugins, then you must use Microsoft.ServiceFabricApps.FabricObserver.Extensibility.3.2.9 or higher nuget package to build them.

Microsoft.ServiceFabricApps.ClusterObserver.Linux.FrameworkDependent

This package contains the Service Fabric ClusterObserver(CO) Application - built for .NET 8.0 and SF Runtime 10.1.x. CO is a highly configurable and extensible Service Fabric stateless service that monitors aggregated cluster health and emits SF entity-specific telemetry. It is designed to be run in Service Fabric Windows and Linux clusters. This package contains the entire application and can be used to build .NET Standard 2.0/.NET6 observer plugins. NOTE: If you want to target .NET 6 for your plugins, then you must use Microsoft.ServiceFabricApps.FabricObserver.Extensibility.3.2.9 or higher nuget package to build them.

Microsoft.ServiceFabricApps.ClusterObserver.Windows.FrameworkDependent

This package contains the Service Fabric ClusterObserver(CO) Application - built for .NET 8.0 and SF Runtime 10.1.x. CO is a highly configurable and extensible Service Fabric stateless service that monitors aggregated cluster health and emits SF entity-specific telemetry. It is designed to be run in Service Fabric Windows and Linux clusters. This package contains the entire application and can be used to build .NET Standard 2.0/.NET6 observer plugins. NOTE: If you want to target .NET 6 for your plugins, then you must use Microsoft.ServiceFabricApps.FabricObserver.Extensibility.3.2.9 or higher nuget package to build them.

Microsoft.ServiceFabricApps.ClusterObserver.WindowsArm64.SelfContained

This package contains the Service Fabric ClusterObserver(CO) Application - built for .NET 8.0 and SF Runtime 10.1.x. CO is a highly configurable and extensible Service Fabric stateless service that monitors aggregated cluster health and emits SF entity-specific telemetry. It is designed to be run in Service Fabric Windows and Linux clusters. This package contains the entire application and can be used to build .NET Standard 2.0/.NET6 observer plugins. NOTE: If you want to target .NET 6 for your plugins, then you must use Microsoft.ServiceFabricApps.FabricObserver.Extensibility.3.2.9 or higher nuget package to build them.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.3.3 92 9/5/2025
3.3.2 216 7/7/2025
3.3.1 254 3/12/2025
3.3.0 247 8/7/2024
3.2.15 346 3/20/2024
3.2.14 265 1/31/2024
3.2.13 173 1/19/2024
3.2.12 209 12/21/2023
3.2.11 280 10/12/2023
3.2.10 303 9/7/2023
3.2.9 454 8/14/2023
3.2.8 300 5/15/2023
3.2.7 441 4/27/2023
3.2.6 610 3/17/2023
3.2.5 587 3/7/2023
3.2.4 457 12/8/2022
3.2.3 590 10/19/2022
3.2.2 612 9/27/2022
3.2.1 627 8/22/2022
3.2.0 672 7/12/2022

- This is the .NET 8 implementation of FabricObserver's Extensibility library. Use this library to build .NET 8 FabricObserver and ClusterObserver plugins.
- Updated dependencies. For NLog, this required code changes in Logger.cs and DataLogger.cs to accommodate breaking changes in NLog 6.0.3 (obsolete properties of FileTarget).