CodeNote.net

Initial setup for running Beego apps on Heroku

Tadashi Shigeoka ·  Tue, June 4, 2019

I’ll introduce the initial setup for running Beego apps on Heroku.

Beego

Prerequisites

  • go v1.12.5
  • beego v1.11.1

The beego app is just in the state after bee new.

The source code is published on GitHub, and it should work if you checkout the commit codenote-net/beego-sandbox@9d2a0ea and push to heroku.

Heroku Support for beego Apps

Heroku $PORT

Since Heroku has an undefined PORT, you need to use the environment variable $PORT when starting the process.

You can refer to your app's config vars, most usefully $PORT, in the commands you specify.

The web process type - The Procfile | Heroku Dev Center

Web process failed to bind to $PORT Error

If you don’t support $PORT for Heroku, the following error will occur:

Error R10 (Boot timeout) -> Web process failed to bind to $PORT within 60 seconds of launch

2019-06-04T13:43:30.805065+00:00 heroku[web.1]: State changed from starting to crashed
2019-06-04T13:43:30.821498+00:00 heroku[web.1]: State changed from crashed to starting
2019-06-04T13:43:30.645826+00:00 heroku[web.1]: Error R10 (Boot timeout) -> Web process failed to bind to $PORT within 60 seconds of launch
2019-06-04T13:43:30.645922+00:00 heroku[web.1]: Stopping process with SIGKILL
2019-06-04T13:43:30.775058+00:00 heroku[web.1]: Process exited with status 137
2019-06-04T13:43:31.427835+00:00 heroku[web.1]: Starting process with command `bin/beego-sandbox`
2019-06-04T13:43:33.934977+00:00 app[web.1]: 2019/06/04 13:43:33.934 [I] [asm_amd64.s:1337]  http server Running on http://:8080

2019-06-04T13:44:20.065228+00:00 heroku[router]: at=error code=H20 desc="App boot timeout" method=GET path="/" host=beego-sandbox.herokuapp.com request_id=38df9122-9d28-46c8-a9f4-22cc76f815b7 fwd="125.197.212.146" dyno= connect= service= status=503 bytes= protocol=https

Setting HTTPPort and HTTPSPort in beego

According to the official beego documentation, Port settings can be configured using beego.BConfig.Listen.HTTPPort and beego.BConfig.Listen.HTTPSPort respectively.

HTTPPort

Set the port the app listens on. By default this is 8080

beego.BConfig.Listen.HTTPPort = 8080

HTTPSPort

Set the port the app listens on. By default this is 10443

beego.BConfig.Listen.HTTPSPort = 10443

Configuration - beego: simple & powerful Go app framework

Therefore, to run beego apps on Heroku, you need to modify the code to get the PORT from environment variables using os.Getenv(“PORT”) and set it to beego.BConfig.Listen.HTTPPort and beego.BConfig.Listen.HTTPSPort respectively.

(Sample Code) beego for Heroku

package main

import (
  "log"
  "os"
  "strconv"

  "github.com/astaxie/beego"
  _ "github.com/codenote-net/beego-sandbox/routers"
)

func main() {
  log.Println("Env $PORT :", os.Getenv("PORT"))
  if os.Getenv("PORT") != "" {
    port, err := strconv.Atoi(os.Getenv("PORT"))
    if err != nil {
      log.Fatal(err)
      log.Fatal("$PORT must be set")
    }
    log.Println("port : ", port)
    beego.BConfig.Listen.HTTPPort = port
    beego.BConfig.Listen.HTTPSPort = port
  }

  beego.Run()
}

That’s all from the Gemba, where we want to run beego apps on Heroku.

Reference Information