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에 올려두었습니다.)





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

[연관 글]






[최초 등록일: ]
[최종 수정일: 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)
13069정성태5/26/202276.NET Framework: 2019. C# - .NET에서 제공하는 3가지 Timer 비교
13068정성태5/24/2022117.NET Framework: 2018. C# - 일정 크기를 할당하는 동안 GC를 (가능한) 멈추는 방법파일 다운로드1
13067정성태5/23/202232Windows: 206. Outlook - 1년 이상 지난 메일이 기본적으로 안 보이는 문제
13066정성태5/23/202229Windows: 205. Windows 11 - Windows + S(또는 Q)로 뜨는 작업 표시줄의 검색 바가 동작하지 않는 경우
13065정성태5/20/2022246.NET Framework: 2017. C# - Windows I/O Ring 소개파일 다운로드1
13064정성태5/18/2022117.NET Framework: 2016. C# - JIT 컴파일러의 인라인 메서드 처리 유무
13063정성태5/18/2022143.NET Framework: 2015. C# - 인라인 메서드(inline methods)
13062정성태5/17/2022287.NET Framework: 2014. C# - async/await 그리고 스레드 (4) 비동기 I/O 재현파일 다운로드1
13061정성태5/16/2022107.NET Framework: 2013. C# - FILE_FLAG_OVERLAPPED가 적용된 파일의 읽기/쓰기 시 Position 관리파일 다운로드1
13060정성태5/15/2022187.NET Framework: 2012. C# - async/await 그리고 스레드 (3) Task.Delay 재현파일 다운로드1
13059정성태5/14/2022191.NET Framework: 2011. C# - CLR ThreadPool의 I/O 스레드에 작업을 맡기는 방법파일 다운로드1
13058정성태5/13/2022126.NET Framework: 2010. C# - ThreadPool.SetMaxThreads 사용법
13057정성태5/12/202282오류 유형: 812. 파이썬 - ImportError: cannot import name ...
13056정성태5/12/2022327.NET Framework: 2009. C# - async/await 그리고 스레드 (2) MyTask의 호출 흐름 [2]파일 다운로드1
13055정성태5/11/2022456.NET Framework: 2008. C# - async/await 그리고 스레드 (1) MyTask로 재현 [4]파일 다운로드1
13054정성태5/11/2022272.NET Framework: 2007. C# - 10진수 숫자를 담은 문자열을 숫자로 변환하는 방법 [9]파일 다운로드1
13053정성태5/10/2022138.NET Framework: 2006. C# - GC.KeepAlive 메서드의 역할
13052정성태5/9/2022207.NET Framework: 2005. C# - 생성한 참조 개체가 언제 GC의 정리 대상이 될까요?
13051정성태5/8/2022111.NET Framework: 2004. C# XingAPI - ACF 검색 결과로 구한 CSV 파일을 통해 퀀트 종목 찾기파일 다운로드1
13050정성태5/6/2022135.NET Framework: 2003. C# - COM 개체의 이벤트 핸들러에서 발생하는 예외에 대한 CLR의 특별 대우파일 다운로드1
13049정성태5/6/202269오류 유형: 811. GoLand - Error: Cannot find package
13048정성태5/6/202291오류 유형: 810. "ASUS TUF GAMING B550M-PLUS (WI-FI)" 모델에서 블루투스 장치가 인식이 안 되는 문제
13047정성태5/6/202264오류 유형: 809. Speech Recognition could not start
13046정성태5/5/2022133.NET Framework: 2002. C# XingAPI - ACF 파일을 이용한 퀀트 종목 찾기(t1857)
13045정성태5/5/2022121.NET Framework: 2001. C# XingAPI - 주식 종목에 따른 PBR, PER, ROE 구하는 방법(t3341 예제)
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...