api.go 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208
  1. package guerrilla
  2. import (
  3. "encoding/json"
  4. "errors"
  5. "fmt"
  6. "github.com/flashmob/go-guerrilla/backends"
  7. "github.com/flashmob/go-guerrilla/log"
  8. "io/ioutil"
  9. "time"
  10. )
  11. type Daemon struct {
  12. Config *AppConfig
  13. Logger log.Logger
  14. Backend backends.Backend
  15. g Guerrilla
  16. configLoadTime time.Time
  17. }
  18. const defaultInterface = "127.0.0.1:2525"
  19. // AddProcessor adds a processor constructor to the backend.
  20. // name is the identifier to be used in the config. See backends docs for more info.
  21. func (d *Daemon) AddProcessor(name string, pc backends.ProcessorConstructor) {
  22. backends.Svc.AddProcessor(name, pc)
  23. }
  24. // Starts the daemon, initializing d.Config, d.Logger and d.Backend with defaults
  25. // can only be called once through the lifetime of the program
  26. func (d *Daemon) Start() (err error) {
  27. if d.g == nil {
  28. if d.Config == nil {
  29. d.Config = &AppConfig{}
  30. }
  31. if err = d.configureDefaults(); err != nil {
  32. return err
  33. }
  34. if d.Logger == nil {
  35. d.Logger, err = log.GetLogger(d.Config.LogFile)
  36. if err != nil {
  37. return err
  38. }
  39. d.Logger.SetLevel(d.Config.LogLevel)
  40. }
  41. if d.Backend == nil {
  42. d.Backend, err = backends.New(d.Config.BackendConfig, d.Logger)
  43. if err != nil {
  44. return err
  45. }
  46. }
  47. d.g, err = New(d.Config, d.Backend, d.Logger)
  48. if err != nil {
  49. return err
  50. }
  51. }
  52. err = d.g.Start()
  53. if err == nil {
  54. if err := d.resetLogger(); err == nil {
  55. d.log().Infof("main log configured to %s", d.Config.LogFile)
  56. }
  57. }
  58. return err
  59. }
  60. // Shuts down the daemon, including servers and backend.
  61. // Do not call Start on it again, use a new server.
  62. func (d *Daemon) Shutdown() {
  63. if d.g != nil {
  64. d.g.Shutdown()
  65. }
  66. }
  67. // ReadConfig reads in the config from a JSON file.
  68. func (d *Daemon) ReadConfig(path string) error {
  69. data, err := ioutil.ReadFile(path)
  70. if err != nil {
  71. return fmt.Errorf("Could not read config file: %s", err.Error())
  72. }
  73. d.Config = &AppConfig{}
  74. if err := d.Config.Load(data); err != nil {
  75. return err
  76. }
  77. d.configLoadTime = time.Now()
  78. return nil
  79. }
  80. // SetConfig is same as ReadConfig, except you can pass AppConfig directly
  81. func (d *Daemon) SetConfig(c AppConfig) error {
  82. // Config.Load takes []byte so we need to serialize
  83. data, err := json.Marshal(c)
  84. if err != nil {
  85. return err
  86. }
  87. // put the data into a fresh d.Config
  88. d.Config = &AppConfig{}
  89. if err := d.Config.Load(data); err != nil {
  90. return err
  91. }
  92. d.configLoadTime = time.Now()
  93. return nil
  94. }
  95. // Reload a config using the passed in AppConfig and emit config change events
  96. func (d *Daemon) ReloadConfig(c AppConfig) error {
  97. if d.Config == nil {
  98. return errors.New("d.Config nil")
  99. }
  100. oldConfig := *d.Config
  101. err := d.SetConfig(c)
  102. if err != nil {
  103. d.log().WithError(err).Error("Error while reloading config")
  104. return err
  105. } else {
  106. d.log().Infof("Configuration was reloaded at %s", d.configLoadTime)
  107. d.Config.EmitChangeEvents(&oldConfig, d.g)
  108. }
  109. return nil
  110. }
  111. // Reload a config from a file and emit config change events
  112. func (d *Daemon) ReloadConfigFile(path string) error {
  113. if d.Config == nil {
  114. return errors.New("d.Config nil")
  115. }
  116. var oldConfig AppConfig
  117. oldConfig = *d.Config
  118. err := d.ReadConfig(path)
  119. if err != nil {
  120. d.log().WithError(err).Error("Error while reloading config from file")
  121. return err
  122. } else {
  123. d.log().Infof("Configuration was reloaded at %s", d.configLoadTime)
  124. d.Config.EmitChangeEvents(&oldConfig, d.g)
  125. }
  126. return nil
  127. }
  128. // ReopenLogs re-opens all log files. Typically, one would call this after rotating logs
  129. func (d *Daemon) ReopenLogs() {
  130. d.Config.EmitLogReopenEvents(d.g)
  131. }
  132. // Subscribe for subscribing to config change events
  133. func (d *Daemon) Subscribe(topic Event, fn interface{}) error {
  134. return d.g.Subscribe(topic, fn)
  135. }
  136. // for publishing config change events
  137. func (d *Daemon) Publish(topic Event, args ...interface{}) {
  138. d.g.Publish(topic, args...)
  139. }
  140. // for unsubscribing from config change events
  141. func (d *Daemon) Unsubscribe(topic Event, handler interface{}) error {
  142. return d.g.Unsubscribe(topic, handler)
  143. }
  144. // log returns a logger that implements our log.Logger interface.
  145. // level is set to "info" by default
  146. func (d *Daemon) log() log.Logger {
  147. if d.Logger != nil {
  148. return d.Logger
  149. }
  150. out := log.OutputStderr.String()
  151. if d.Config != nil && len(d.Config.LogFile) > 0 {
  152. out = d.Config.LogFile
  153. }
  154. l, err := log.GetLogger(out)
  155. if err == nil {
  156. l.SetLevel("info")
  157. }
  158. return l
  159. }
  160. // set the default values for the servers and backend config options
  161. func (d *Daemon) configureDefaults() error {
  162. err := d.Config.setDefaults()
  163. if err != nil {
  164. return err
  165. }
  166. if d.Backend == nil {
  167. err = d.Config.setBackendDefaults()
  168. if err != nil {
  169. return err
  170. }
  171. }
  172. return err
  173. }
  174. // resetLogger sets the logger to the one specified in the config.
  175. // This is because at the start, the daemon may be logging to stderr,
  176. // then attaches to the logs once the config is loaded.
  177. // This will propagate down to the servers / backend too.
  178. func (d *Daemon) resetLogger() error {
  179. l, err := log.GetLogger(d.Config.LogFile)
  180. if err != nil {
  181. return err
  182. }
  183. d.Logger = l
  184. d.g.SetLogger(d.Logger)
  185. return nil
  186. }