NewLife.Extensions.Hosting.AgentService

NewLife.Agent - Cross-Platform Service Daemon & Ops Framework

🌐 简体中文 | 繁體中文 | Español | Deutsch | 日本語 | Français | Português | Русский | 한국어 | العربية

Tutorial: https://newlifex.com/core/agent

Overview

NewLife.Agent is a service-oriented framework for long-running applications. It enables console/Web/Worker programs to be quickly hosted as operating system services, and provides unified install, start/stop, monitoring, restart, and troubleshooting capabilities.

Supported platforms:

• Windows (Service / startup at login)
• Linux (Systemd / Procd / RcInit, etc.)
• macOS (LaunchAgent)

Supported frameworks:

• NewLife.Agent: net40;net45;net461;netstandard2.0;netstandard2.1;net6.0;net7.0;net8.0;net9.0;net10.0
• NewLife.Extensions.Hosting.AgentService: netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0;net10.0

Highlights

• Integrated Development and Operations: Inherit ServiceBase to gain full service governance capabilities.
• Built-in Web Dashboard: A lightweight management panel for viewing status and performing operations in a browser, with extension panels and theme switching, built-in token authentication and brute-force protection; it listens on localhost by default (WebBind can expose it to the LAN).
• Cross-Platform Auto-Adaptation: Automatically selects the most suitable host implementation per operating system.
• NativeAOT Native Publishing Support: Built-in commands and the Web dashboard are fully adapted for trimming/AOT; net8.0+ builds produce zero IsAotCompatible warnings, and CI covers 12 RIDs: 9 targets run real smoke tests (8 native targets + linux-loongarch64 under QEMU user-mode emulation), while cross targets (linux-arm/linux-musl-arm/linux-musl-arm64) get publish verification.
• Multi-Architecture Unit Tests: win-x64 / linux-x64 / linux-arm64 run natively, and linux-loongarch64 (Loongson) runs the full test suite under QEMU user-mode emulation; triggered by push/PR and supports manual runs.
• Built-in Command System: Supports -install/-start/-stop/-restart/-status/-run.
• Health Monitoring & Self-Healing: The HealthMonitor component provides memory/thread/handle thresholds, scheduled restarts, and WatchDog health checks.
• Multi-Instance Friendly: Configure different ServiceName values to deploy multiple instances of one program.
• Host Integration Extension Package: Bring ASP.NET Core/Worker applications under unified service lifecycle management.

Getting Started

1) Minimal Service

Inherit ServiceBase and call Main(args) at the entry point:

• Override StartWork(String reason) to start your business logic
• Override StopWork(String reason) to stop and clean up resources

2) Command-Line Operations

Common commands:

• -i: Install the service
• -install: Install and start the service
• -start: Start the service
• -stop: Stop the service
• -restart: Restart the service
• -status: View service status
• -u: Uninstall the service
• -uninstall: Stop and uninstall the service
• -run: Run in console mode (for debugging)

Install/uninstall/start/stop typically require Administrator (Windows) or root (Linux) privileges.

3) ASP.NET Core / Worker Integration

Reference NewLife.Extensions.Hosting.AgentService and call UseAgentService() on your HostBuilder to bridge the generic host lifecycle with Agent service governance.

Documentation

• NewLife.Agent User & Ops Manual (Chinese)
• Requirements Document (Chinese)
• Feature List (Chinese)
• Architecture Design (Chinese)
• Competitive Analysis (Chinese)
• Changelog (Chinese)
• Changelog (English)

Quick Install

dotnet new install NewLife.Templates
dotnet new service --name agent
cd agent
dotnet run

NewLife Project Matrix

All projects target net9.0/netstandard2.1/netstandard2.0/net4.62/net4.5 by default; the legacy version (2024.0801) supports net4.0/net2.0.

NewLife Team

The NewLife team, founded in 2002, is a new-era IoT industry solution provider dedicated to software/hardware application consulting, system architecture planning, and development services. The team's 80+ open-source projects have been widely used across industries, with cumulative NuGet downloads exceeding 4 million. Flagship products developed by the team — NewLife.XCode big data middleware, AntJob distributed computing platform, Stardust distributed platform, NewLife.Redis cache queue component, and the FIoT IoT platform — have been successfully deployed in power, education, internet, telecommunications, transportation, logistics, industrial control, healthcare, and cultural heritage sectors, delivering a large number of advanced, reliable, secure, high-quality, and easily extensible products and system integration services to customers.

We will continuously improve our services to become a long-term trusted partner of our customers, and through continuous innovation and development, become an excellent domestic IoT service provider.

The NewLife team started in 2002; some open-source projects have a history of more than 20 years, and the source repository retains all modification records since 2010. Website: https://newlifex.com GitHub: https://github.com/newlifex QQ Group: 1600800/1600838 WeChat Official Account: