https://github.com/aerth/diamond

Runlevel 1, you stay unix socket. Runlevel 3, you listen tcp! Kicks old process on boot. Shuts down when kicked by new process. Could contribute to less downtime between app restarts and upgrades.
https://github.com/aerth/diamond

administrator kick listeners runlevel runlevels server unix-socket web-application

Last synced: about 2 months ago
JSON representation

Runlevel 1, you stay unix socket. Runlevel 3, you listen tcp! Kicks old process on boot. Shuts down when kicked by new process. Could contribute to less downtime between app restarts and upgrades.

• Host: GitHub
• URL: https://github.com/aerth/diamond
• Owner: aerth
• License: mit
• Created: 2016-10-22T02:26:34.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-02-05T10:37:47.000Z (over 3 years ago)
• Last Synced: 2024-06-29T03:34:09.453Z (3 months ago)
• Topics: administrator, kick, listeners, runlevel, runlevels, server, unix-socket, web-application
• Language: Go
• Homepage: https://aerth.github.io/diamond/
• Size: 5.61 MB
• Stars: 23
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# DIAMOND ⋄

### Runlevels for your web application

Diamond provides a UNIX socket for administrators to gracefully shutdown an application, such as a web server.

Apart from only shutting down, the admin can change gears, triggering functions and killing/starting listeners.

The "KICK" feature allows upgrading a program with minimal downtime, kicking the old running process gracefully.

If diamond-admin doesn't run on your platform (bsd?) you can still use the client library!

:zap: ```telinit 3```

[![GoDoc](https://godoc.org/github.com/aerth/diamond/lib?status.svg)](https://godoc.org/github.com/aerth/diamond/lib)

[![Build Status](https://travis-ci.org/aerth/diamond.svg?branch=master)](https://travis-ci.org/aerth/diamond)

![Screenshot diamond-admin CUI](https://github.com/aerth/diamond/blob/master/docs/diamond-screenshot.png?raw=true)

# Using diamond-admin

You can open admin interface by using no arguments:

```

diamond-admin -s diamond.sock

```

### Start all listeners and http servers

```

diamond-admin -s diamond.sock RUNLEVEL 3

```

### Stop all listeners, cut http connections

```

diamond-admin -s diamond.sock RUNLEVEL 1

```

## Using the library

Diamond requires a recent version of Go

```

// New creates a new admin socket and starts listening for commands

s, err := diamond.New("/tmp/diamond.socket")

if err != nil {

    log.Fatalln(err)

}

// Add variety of http handlers and their addr to listen on

// They won't start listening right away, so they could be

// occupied by other servers

s.AddHTTPHandler(":8080", http.HandlerFunc(myHandler))

s.AddHTTPHandler(":8081", http.HandlerFunc(handler2))

s.AddHTTPHandler(":8082", handler3)

// start in multiuser mode, serving http

// without calling Runlevel(3) you must

// connect via socket and issue the RUNLEVEL 3 command

s.Runlevel(3) 

// serve forever

log.Fatalln(s.Wait())

```

See the [examples](example)

Read more:

[aerth.github.io/diamond](https://aerth.github.io/diamond/)

[github.com/aerth/diamond](https://github.com/aerth/diamond/)

#### CAUTION

API may change without notice! (it already has two times!)

#### Contributing

Submit new issue or pull request

### Old version

```

import "gopkg.in/aerth/diamond.v1"

```