Microsoft.ServiceFabricApps.FabricObserver.Extensibility 3.2.0

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

Requires NuGet 3.3.0 or higher.

dotnet add package Microsoft.ServiceFabricApps.FabricObserver.Extensibility --version 3.2.0

NuGet\Install-Package Microsoft.ServiceFabricApps.FabricObserver.Extensibility -Version 3.2.0

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.2.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Microsoft.ServiceFabricApps.FabricObserver.Extensibility --version 3.2.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Microsoft.ServiceFabricApps.FabricObserver.Extensibility, 3.2.0"

#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 Microsoft.ServiceFabricApps.FabricObserver.Extensibility as a Cake Addin
#addin nuget:?package=Microsoft.ServiceFabricApps.FabricObserver.Extensibility&version=3.2.0

// Install Microsoft.ServiceFabricApps.FabricObserver.Extensibility as a Cake Tool
#tool nuget:?package=Microsoft.ServiceFabricApps.FabricObserver.Extensibility&version=3.2.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

FabricObserver Extensibility Library 3.2.0

This .NET Standard 2.0 library is for building FabricObserver plugins, which are custom observers that extend FabricObserver's capabilities to match your needs. Each plugin is managed like a first class observer.

How to implement an observer plugin using FO's extensibility model

Create a new .NET Standard (2.0) library project.
Install the latest Microsoft.ServiceFabricApps.FabricObserver.Extensibility nupkg from https://www.nuget.org/profiles/ServiceFabricApps into your plugin project.
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	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. 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.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- Microsoft.ApplicationInsights (>= 2.20.0)
- Microsoft.ApplicationInsights.DependencyCollector (>= 2.20.0)
- Microsoft.ApplicationInsights.NLogTarget (>= 2.20.0)
- Microsoft.ApplicationInsights.PerfCounterCollector (>= 2.20.0)
- Microsoft.ApplicationInsights.WindowsServer (>= 2.20.0)
- Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel (>= 2.20.0)
- Microsoft.AspNet.WebApi.Client (>= 5.2.9)
- Microsoft.Extensions.DependencyInjection (>= 5.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 5.0.0)
- Microsoft.ServiceFabric.Services (>= 5.0.516)
- Microsoft.Win32.Registry (>= 5.0.0)
- NLog (>= 5.0.0)

NuGet packages (4)

Showing the top 4 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.	19.0K
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.	18.9K
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.	14.1K
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.	13.8K

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Microsoft.ServiceFabricApps.FabricObserver.Extensibility:

Repository	Stars
microsoft/service-fabric-observer Highly configurable, extensible and performant Service Fabric watchdog service that, out of the box, monitors a broad range of physical machine resources that tend to be very important to Service Fabric services and maps these metrics to SF entities. It targets both Windows and Linux SF clusters.	102