{"id":15318379,"url":"https://github.com/appleboy/graceful","last_synced_at":"2025-04-06T03:11:31.891Z","repository":{"id":40521701,"uuid":"443707613","full_name":"appleboy/graceful","owner":"appleboy","description":"graceful shutdown package when a service is turned off by software function","archived":false,"fork":false,"pushed_at":"2024-09-07T07:35:18.000Z","size":60,"stargazers_count":58,"open_issues_count":0,"forks_count":9,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-29T10:08:02.745Z","etag":null,"topics":["golang","golang-package","graceful","graceful-shutdown","graceful-stop"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appleboy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-02T07:30:04.000Z","updated_at":"2024-09-07T07:35:22.000Z","dependencies_parsed_at":"2024-01-12T04:54:51.187Z","dependency_job_id":"26f75901-a79f-4549-a59c-735524104d11","html_url":"https://github.com/appleboy/graceful","commit_stats":{"total_commits":71,"total_committers":3,"mean_commits":"23.666666666666668","dds":0.05633802816901412,"last_synced_commit":"48bd7bcfefdbe71f02f131aecda0f65647803b86"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fgraceful","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fgraceful/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fgraceful/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fgraceful/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appleboy","download_url":"https://codeload.github.com/appleboy/graceful/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246651564,"owners_count":20811994,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang","golang-package","graceful","graceful-shutdown","graceful-stop"],"created_at":"2024-10-01T08:59:52.876Z","updated_at":"2025-04-06T03:11:31.870Z","avatar_url":"https://github.com/appleboy.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# graceful\n\n[![Run Tests](https://github.com/appleboy/graceful/actions/workflows/go.yml/badge.svg)](https://github.com/appleboy/graceful/actions/workflows/go.yml)\n[![codecov](https://codecov.io/gh/appleboy/graceful/branch/master/graph/badge.svg?token=zPqtcz0Rum)](https://codecov.io/gh/appleboy/graceful)\n[![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/graceful)](https://goreportcard.com/report/github.com/appleboy/graceful)\n[![Go Reference](https://pkg.go.dev/badge/github.com/gin-contrib/graceful.svg)](https://pkg.go.dev/github.com/gin-contrib/graceful)\n\nGraceful shutdown package when a service is turned off by software function.\n\n## Example\n\nAdd running job\n\n```go\npackage main\n\nimport (\n  \"context\"\n  \"log\"\n  \"time\"\n\n  \"github.com/appleboy/graceful\"\n)\n\nfunc main() {\n  m := graceful.NewManager()\n\n  // Add job 01\n  m.AddRunningJob(func(ctx context.Context) error {\n    for {\n      select {\n      case \u003c-ctx.Done():\n        return nil\n      default:\n        log.Println(\"working job 01\")\n        time.Sleep(1 * time.Second)\n      }\n    }\n  })\n\n  // Add job 02\n  m.AddRunningJob(func(ctx context.Context) error {\n    for {\n      select {\n      case \u003c-ctx.Done():\n        return nil\n      default:\n        log.Println(\"working job 02\")\n        time.Sleep(500 * time.Millisecond)\n      }\n    }\n  })\n\n  \u003c-m.Done()\n}\n```\n\nYou can also add shutdown jobs.\n\n```go\npackage main\n\nimport (\n  \"context\"\n  \"log\"\n  \"time\"\n\n  \"github.com/appleboy/graceful\"\n)\n\nfunc main() {\n  m := graceful.NewManager()\n\n  // Add job 01\n  m.AddRunningJob(func(ctx context.Context) error {\n    for {\n      select {\n      case \u003c-ctx.Done():\n        return nil\n      default:\n        log.Println(\"working job 01\")\n        time.Sleep(1 * time.Second)\n      }\n    }\n  })\n\n  // Add job 02\n  m.AddRunningJob(func(ctx context.Context) error {\n    for {\n      select {\n      case \u003c-ctx.Done():\n        return nil\n      default:\n        log.Println(\"working job 02\")\n        time.Sleep(500 * time.Millisecond)\n      }\n    }\n  })\n\n  // Add shutdown 01\n  m.AddShutdownJob(func() error {\n    log.Println(\"shutdown job 01 and wait 1 second\")\n    time.Sleep(1 * time.Second)\n    return nil\n  })\n\n  // Add shutdown 02\n  m.AddShutdownJob(func() error {\n    log.Println(\"shutdown job 02 and wait 2 second\")\n    time.Sleep(2 * time.Second)\n    return nil\n  })\n\n  \u003c-m.Done()\n}\n```\n\nUsing custom logger, see the [zerolog example](./_example/example03/logger.go)\n\n```go\nm := graceful.NewManager(\n  graceful.WithLogger(logger{}),\n)\n```\n\nget [more information](./_example/example03/main.go)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappleboy%2Fgraceful","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappleboy%2Fgraceful","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappleboy%2Fgraceful/lists"}