Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
 

C# - .NET Core Console로 리눅스 daemon 프로그램 만드는 방법

검색해 보면 ASP.NET Core Generic Host를 기반으로 데몬 프로세스 만드는 방법이 공개되어 있습니다.

Creating a Daemon with .NET Core (Part 1)
; https://www.wintellect.com/creating-a-daemon-with-net-core-part-1/

Creating a Daemon with .NET Core (Part 2) 
; https://www.wintellect.com/creating-a-daemon-with-net-core-part-2/

물론 저렇게 만들어도 되지만, 간단한 데몬을 만드는 경우라면 가능한 별다른 모듈에 대한 의존성 없이 단일 dll로 만드는 방법도 고려해 볼 수 있습니다. 시작은, 프로그램이 종료하지 못하도록 막고 있기만 하면 됩니다.

static void Main(string[] args)
{
    EventWaitHandle ewh = new EventWaitHandle(false, EventResetMode.ManualReset);

    ewh.WaitOne();
}

이렇게 만든 프로그램을 "/etc/systemd/system"에 등록하면,

라즈베리 파이 - (윈도우의 NT 서비스처럼) 부팅 시 시작하는 프로그램 설정
; https://www.sysnet.pe.kr/2/0/11374

// $ ls -l /usr/lib/systemd/system
// $ ls -l /etc/systemd/system
// $ systemctl list-unit-files

$ cat /etc/systemd/system/dotnet-testd.service 

[Unit]
Description=testd.dll running on Unix 3.10.0.957

[Service]
WorkingDirectory=/home/tusr/testd/bin
ExecStart=/usr/share/dotnet/dotnet /home/tusr/testd/bin/testd.dll
KillSignal=SIGINT
SyslogIdentifier=dotnet-testd

[Install]
WantedBy=multi-user.target

이후부터 systemctl 명령을 이용해 NT 서비스처럼 daemon으로 실행시킬 수 있습니다.

[컴퓨터 시작 시 서비스가 로드하도록 등록]
$ sudo systemctl enable dotnet-testd

[서비스 지금 시작]
$ sudo systemctl start dotnet-testd

그런데 종료가 문제입니다. 우선 systemctl의 종료 명령에는 2가지가 있습니다.

[service 파일에 등록한 KillSignal로 종료, 이번 예제에서는 SIGINT 발생]
sudo systemctl stop dotnet-testd

[프로세스 종료]
sudo systemctl kill dotnet-testd

이 중에서 "kill" 명령어의 대응은 AppDomain.CurrentDomain.ProcessExit로 처리할 수 있습니다.

AppDomain.CurrentDomain.ProcessExit += (s, e) =>
{
    CleanupResources();
    WriteLog("Exited gracefully!");
};

그런데, 이것만 하게 되면 systemctl stop 명령어에 대해서는 반응하지 않고 그냥 종료해 버립니다.

sudo systemctl stop dotnet-testd
    (ProcessExit 없이 종료)

sudo systemctl kill dotnet-testd
    ProcessExit 이벤트 발생

따라서 systemctl stop에 대한 처리를 위해 Console.CancelKeyPress를 다음과 같이 추가할 수 있습니다.

// SIGINT에 반응
Console.CancelKeyPress += (s, e) =>
{
    WriteLog("stopped");
};

// 프로세스 종료에 반응
AppDomain.CurrentDomain.ProcessExit += (s, e) =>
{
    CleanupResources();
    WriteLog("Exited gracefully!");
};

위와 같이 각각 이벤트를 등록한 경우 systemctl 명령에 대해 다음과 같은 식의 로그를 확인할 수 있습니다.

sudo systemctl stop dotnet-testd
    Jun 24 21:38:33 centos7 dotnet-testd: stopped

sudo systemctl kill dotnet-testd
    Jun 24 21:48:49 centos7 dotnet-testd: Exited gracefully!

2가지 모두 반응했지만 재미있는 것은 SIGINT의 경우 ProcessExit 이벤트가 발생하지 않는다는 특이점이 있습니다. 만약 CancelKeyPress에서 ProcessExit로 흐르게 하고 싶다면 Cancel 속성을 true로 설정한 다음, EventWaitHandle을 시그널시켜서 프로세스를 종료하게 해 자연스럽게 ProcessExit가 발생하도록 만들 수 있습니다.

Console.CancelKeyPress += (s, e) =>
{
    WriteLog("stopped");
    e.Cancel = true;
    ewh.Set();
};

AppDomain.CurrentDomain.ProcessExit += (s, e) =>
{
    CleanupResources();
    WriteLog("Exited gracefully!");
};

따라서 각각의 종료에 대해 로그는 다음과 같이 바뀝니다.

sudo systemctl stop dotnet-testd
    Jun 24 21:41:57 centos7 dotnet-testd: stopped
    Jun 24 21:41:57 centos7 dotnet-testd: Exited gracefully!

sudo systemctl kill dotnet-testd
    Jun 24 21:41:08 centos7 dotnet-testd: Exited gracefully!




부가적으로, 서비스 스스로 install/uninstall을 하도록 다음과 같은 식의 처리도 추가해 주면 좋을 것입니다.

static void Main(string[] args)
{
    EventWaitHandle ewh = new EventWaitHandle(false, EventResetMode.ManualReset);

    if (args.Length >= 1)
    {
        string netDllPath = typeof(Program).Assembly.Location;
        if (args[0] == "--install" || args[0] == "-i")
        {
            InstallService(netDllPath, true);
        }
        else if (args[0] == "--uninstall" || args[0] == "-u")
        {
            InstallService(netDllPath, false);
        }
        return;
    }

    // ...[생략]...

    ewh.WaitOne();
}

static int InstallService(string netDllPath, bool doInstall)
{
    // 업데이트 2021-04-22
    // KillSignal=SIGINT 제거
    // KillMode=mixed 추가
    string serviceFile = @"
[Unit]
Description={0} running on {1}

[Service]
WorkingDirectory={2}
ExecStart={3} {4}
SyslogIdentifier={5}
KillMode=mixed

[Install]
WantedBy=multi-user.target
";

    string dllFileName = Path.GetFileName(netDllPath);
    string osName = Environment.OSVersion.ToString();

    FileInfo fi = null;

    try
    {
        fi = new FileInfo(netDllPath);
    }
    catch { }

    if (doInstall == true && fi != null && fi.Exists == false)
    {
        WriteLog("NOT FOUND: " + fi.FullName);
        return 1;
    }

    string serviceName = "dotnet-" + Path.GetFileNameWithoutExtension(dllFileName).ToLower();

    string exeName = Process.GetCurrentProcess().MainModule.FileName;

    string workingDir = Path.GetDirectoryName(fi.FullName);
    string fullText = string.Format(serviceFile, dllFileName, osName, workingDir,
            exeName, fi.FullName, serviceName);

    string serviceFilePath = $"/etc/systemd/system/{serviceName}.service";

    if (doInstall == true)
    {
        File.WriteAllText(serviceFilePath, fullText);
        WriteLog(serviceFilePath + " Created");
        ControlService(serviceName, "enable");
        ControlService(serviceName, "start");
    }
    else
    {
        if (File.Exists(serviceFilePath) == true)
        {
            ControlService(serviceName, "stop");
            File.Delete(serviceFilePath);
            WriteLog(serviceFilePath + " Deleted");
        }
    }

    return 0;
}

이 정도면 거의 틀을 갖췄군요. ^^ 이제 빌드하고 testd.dll과 testd.runtimeconfig.json 파일만 리눅스 시스템에 복사하면 서비스로써 완벽하게 동작할 수 있습니다.

[서비스 등록 및 시작]
$ sudo dotnet ./test.dll --install

[서비스 해제]
$ sudo dotnet ./test.dll --uninstall

[서비스 시작]
$ sudo systemctl start dotnet-testd

[서비스 중지-1]
$ sudo systemctl stop dotnet-testd

[서비스 중지-2]
$ sudo systemctl kill dotnet-testd

이 상태에서 여러분들의 업무 코드만 추가하면 됩니다. ^^ (그나저나 제가 리눅스에 잘 모르는 상태에서 만든 것이므로, 혹시 더 좋은 예제 코드가 있다면 덧글 부탁드립니다. ^^)

(이 글의 예제 프로젝트 코드는 github에 올려두었습니다.)





[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]


donaricano-btn



[최초 등록일: ]
[최종 수정일: 7/7/2021

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 쓴 사람
 



2019-09-06 09시01분
정성태
2021-02-26 05시41분
정성태
2021-04-21 05시53분
[행인1] netcore3.1에서 systemctl stop 으로 실행하면 SIGINT 발생해서 cancelkey 이벤트가 들어왔는데,
net5로 프로젝트 업그레이드 이후엔 cancelkey 이벤트가 들어오지 않는데 원인을 아실까요ㅠ?
[손님]
2021-04-21 10시12분
.NET 5에서 SIGINT가 CancelKeyPress로 안 되는 것을 확인했습니다. 그런데, ^^; 답이 안 나오는군요. 아무래도 github의 dotnet repo에 직접 이슈를 제기하는 것이 좋을 듯합니다.
정성태
2021-04-22 05시26분
아래의 내용에 덧글을 달아주신 분이 해결 방법을 제시했습니다.

C# - Generic Host를 이용해 .NET 5로 리눅스 daemon 프로그램 만드는 방법
; https://www.sysnet.pe.kr/2/0/12608#14927

따라서, 현재 만들어 두신 소스 코드에서 다음의 serviceFile 문자열만,

https://github.com/stjeong/DotNetSamples/blob/master/NetCore/testd/Program.cs#L84

바꿔서 설정하시면 됩니다. (물론, 기존 등록된 service 파일의 경우 KillSignal=SIGINT 값을 삭제하고, KillMode=mixed 설정을 추가해도 됩니다.)

바뀐 소스 코드의 경우, systemctl stop/kill 모두 AppDomain.CurrentDomain.ProcessExit 이벤트 핸들러가 실행이 되는 것을 확인했습니다.
정성태

[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
12839정성태9/15/2021218.NET Framework: 1118. C# 10 - (17) 제네릭 타입의 특성 적용파일 다운로드1
12838정성태9/13/2021215.NET Framework: 1117. C# - Task에 전달한 Action, Func 유형에 따라 달라지는 async/await 비동기 처리 [2]파일 다운로드1
12837정성태9/11/2021118VC++: 151. Golang - fmt.Errorf, errors.Is, errors.As 설명
12836정성태9/10/202183Linux: 45. 리눅스 - 실행 중인 다른 프로그램의 출력을 확인하는 방법
12835정성태9/7/2021158.NET Framework: 1116. C# 10 - (16) CallerArgumentExpression 특성 추가파일 다운로드1
12834정성태9/7/202176오류 유형: 762. Visual Studio 2019 Build Tools - 'C:\Program' is not recognized as an internal or external command, operable program or batch file.
12833정성태9/6/2021126VC++: 150. Golang - TCP client/server echo 예제 코드파일 다운로드1
12832정성태9/6/202180VC++: 149. Golang - 인터페이스 포인터가 의미 있을까요?
12831정성태9/6/2021111VC++: 148. Golang - 채널에 따른 다중 작업 처리파일 다운로드1
12830정성태9/6/202171오류 유형: 761. Internet Explorer에서 파일 다운로드 시 "Your current security settings do not allow this file to be downloaded." 오류
12829정성태9/5/2021202.NET Framework: 1115. C# 10 - (15) 구조체 타입에 기본 생성자 정의 가능파일 다운로드1
12828정성태9/4/2021192.NET Framework: 1114. C# 10 - (14) 단일 파일 내에 적용되는 namespace 선언파일 다운로드1
12827정성태9/4/2021112스크립트: 27. 파이썬 - 웹 페이지 데이터 수집을 위한 scrapy Crawler 사용법 요약
12826정성태9/3/2021168.NET Framework: 1113. C# 10 - (13) 문자열 보간 성능 개선파일 다운로드1
12825정성태9/3/202169개발 환경 구성: 603. GoLand - WSL 환경과 연동
12824정성태9/2/2021142오류 유형: 760. 파이썬 tensorflow - Dst tensor is not initialized. 오류 메시지
12823정성태9/2/2021164스크립트: 26. 파이썬 - PyCharm을 이용한 fork 디버그 방법
12822정성태9/1/202197오류 유형: 759. 파이썬 tensorflow - ValueError: Shapes (...) and (...) are incompatible
12821정성태9/1/2021150.NET Framework: 1112. C# - .NET 6부터 공개된 ISpanFormattable 사용법
12820정성태9/1/202187VC++: 147. Golang - try/catch에 대응하는 panic/recover파일 다운로드1
12819정성태8/31/2021182.NET Framework: 1111. C# - FormattableString 타입
12818정성태8/31/2021118Windows: 198. 윈도우 - 작업 관리자에서 (tensorflow 등으로 인한) GPU 연산 부하 보는 방법
12817정성태8/31/202176스크립트: 25. 파이썬 - 윈도우 환경에서 directml을 이용한 tensorflow의 AMD GPU 사용 방법
12816정성태8/30/2021320스크립트: 24. 파이썬 - tensorflow 2.6 NVidia GPU 사용 방법 [2]
12815정성태8/30/2021199개발 환경 구성: 602. WSL 2 - docker-desktop-data, docker-desktop (%LOCALAPPDATA%\Docker\wsl\data\ext4.vhdx) 파일을 다른 디렉터리로 옮기는 방법
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...