Release 2021.5.0

to help understand why the ingress rule logged is being selected.

in addition, combine "Request Headers..." and "Serving with ingress..." logs
into this updated log.

Co-authored-by: Silver <sssilver@users.noreply.github.com>

.github/workflows/check.yaml

@@ -1,20 +0,0 @@
-on: [push, pull_request]
-name: Check
-jobs:
-  check:
-    strategy:
-      matrix:
-        go-version: [1.15.x]
-        os: [ubuntu-latest, macos-latest, windows-latest]
-    runs-on: ${{ matrix.os }}
-    steps:
-    - name: Install Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: ${{ matrix.go-version }}
-    - name: Install go-sumtype
-      run: go get github.com/BurntSushi/go-sumtype
-    - name: Checkout code
-      uses: actions/checkout@v2
-    - name: Test
-      run: make test

CHANGES.md

@@ -1,17 +1,6 @@
 **Experimental**: This is a new format for release notes. The format and availability is subject to change.
 
-## 2021.5.8
-### New Features
-- When creating a DNS record to point a hostname at a tunnel, you can now use --overwrite-dns to overwrite any existing
-  DNS records with that hostname. This works when using the CLI to provision DNS, and when starting an adhoc tunnel, e.g.
-  - `cloudflared route --overwrite-dns dns foo foo.example.com`
-  - `cloudflared tunnel --overwrite-dns --name foo --hostname foo.example.com`
-
-## 2021.5.7
-### New Features
-- Named Tunnels will automatically select the protocol to connect to Cloudflare's edge network.
-
-## 2021.5.0
+## 2020.5.0
 
 ### New Features
 - It is now possible to run the same tunnel using more than one `cloudflared` instance. This is a server-side change and

RELEASE_NOTES

@@ -1,24 +1,3 @@
-2021.5.8
-- 2021-05-14 TUN-4419: Improve error message when cloudflared cannot reach origin
-- 2021-05-19 TUN-4425: --overwrite-dns flag for in adhoc and route dns cmds
-
-2021.5.7
-- 2021-05-17 Fix typo in Changes.md
-- 2021-05-17 TUN-4421: Named Tunnels will automatically select the protocol to connect to Cloudflare's edge network
-
-2021.5.6
-- 2021-05-14 TUN-4418: Downgrade to Go 1.16.3
-
-2021.5.5
-
-
-2021.5.4
-- Fix release pipeline
-
-2021.5.1
-- 2021-05-10 TUN-4342: Fix false positive warning about unused hostname property
-- 2021-05-10 Release 2021.5.0
-
 2021.5.0
 - 2021-05-10 TUN-4384: Silence log from automaxprocs
 - 2021-05-10 AUTH-3537: AUDs in JWTs are now always arrays

cfsetup.yaml

@@ -1,4 +1,4 @@
-pinned_go: &pinned_go go=1.16.3-1
+pinned_go: &pinned_go go=1.16.4-3
 pinned_go_fips: &pinned_go_fips go-fips=1.15.5-3
 
 build_dir: &build_dir /cfsetup_build
@@ -279,8 +279,8 @@ centos-7:
       - https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
     pre-cache:
       - yum install -y fakeroot
-      - wget https://golang.org/dl/go1.16.3.linux-amd64.tar.gz -P /tmp/
-      - tar -C /usr/local -xzf /tmp/go1.16.3.linux-amd64.tar.gz
+      - wget https://golang.org/dl/go1.16.4.linux-amd64.tar.gz -P /tmp/
+      - tar -C /usr/local -xzf /tmp/go1.16.4.linux-amd64.tar.gz
     post-cache:
       - export PATH=$PATH:/usr/local/go/bin
       - export GOOS=linux
@@ -291,8 +291,8 @@ centos-7:
     builddeps: *el7_builddeps
     pre-cache:
       - yum install -y fakeroot
-      - wget https://golang.org/dl/go1.16.3.linux-amd64.tar.gz -P /tmp/
-      - tar -C /usr/local -xzf /tmp/go1.16.3.linux-amd64.tar.gz
+      - wget https://golang.org/dl/go1.16.4.linux-amd64.tar.gz -P /tmp/
+      - tar -C /usr/local -xzf /tmp/go1.16.4.linux-amd64.tar.gz
     post-cache:
       - export PATH=$PATH:/usr/local/go/bin
       - export GOOS=linux

cmd/cloudflared/tunnel/cmd.go

@@ -87,10 +87,6 @@ const (
 var (
 	graceShutdownC chan struct{}
 	version        string
-
-	routeFailMsg = fmt.Sprintf("failed to provision routing, please create it manually via Cloudflare dashboard or UI; "+
-		"most likely you already have a conflicting record there. You can also rerun this command with --%s to overwrite "+
-		"any existing DNS records for this hostname.", overwriteDNSFlag)
 )
 
 func Flags() []cli.Flag {
@@ -185,7 +181,7 @@ func runAdhocNamedTunnel(sc *subcommandContext, name, credentialsOutputPath stri
 
 	if r, ok := routeFromFlag(sc.c); ok {
 		if res, err := sc.route(tunnel.ID, r); err != nil {
-			sc.log.Err(err).Str("route", r.String()).Msg(routeFailMsg)
+			sc.log.Err(err).Msg("failed to create route, please create it manually")
 		} else {
 			sc.log.Info().Msg(res.SuccessSummary())
 		}
@@ -203,12 +199,12 @@ func runClassicTunnel(sc *subcommandContext) error {
 	return StartServer(sc.c, version, nil, sc.log, sc.isUIEnabled)
 }
 
-func routeFromFlag(c *cli.Context) (route tunnelstore.Route, ok bool) {
+func routeFromFlag(c *cli.Context) (tunnelstore.Route, bool) {
 	if hostname := c.String("hostname"); hostname != "" {
 		if lbPool := c.String("lb-pool"); lbPool != "" {
 			return tunnelstore.NewLBRoute(hostname, lbPool), true
 		}
-		return tunnelstore.NewDNSRoute(hostname, c.Bool(overwriteDNSFlagName)), true
+		return tunnelstore.NewDNSRoute(hostname), true
 	}
 	return nil, false
 }
@@ -617,7 +613,6 @@ func tunnelFlags(shouldHide bool) []cli.Flag {
 			Hidden: shouldHide,
 		}),
 		selectProtocolFlag,
-		overwriteDNSFlag,
 	}...)
 
 	return flags

cmd/cloudflared/tunnel/configuration.go

@@ -160,6 +160,10 @@ func prepareTunnelConfig(
 	if err != nil {
 		log.Err(err).Str(LogFieldHostname, configHostname).Msg("Invalid hostname")
 		return nil, ingress.Ingress{}, errors.Wrap(err, "Invalid hostname")
+	} else if hostname != "" && isNamedTunnel {
+		log.Warn().Msg("The property `hostname` in your configuration is ignored because you configured a Named Tunnel " +
+			"in the property `tunnel`. Make sure to provision the routing (e.g. via `cloudflared tunnel route`) or else " +
+			"your origin will not be reachable. You should remove the `hostname` property to avoid this warning.")
 	}
 	isFreeTunnel := hostname == ""
 	clientID := c.String("id")

cmd/cloudflared/tunnel/signal_test.go

@@ -1,5 +1,3 @@
-// +build !windows
-
 package tunnel
 
 import (

cmd/cloudflared/tunnel/subcommands.go

@@ -29,11 +29,10 @@ import (
 )
 
 const (
-	allSortByOptions     = "name, id, createdAt, deletedAt, numConnections"
-	connsSortByOptions   = "id, startedAt, numConnections, version"
-	CredFileFlagAlias    = "cred-file"
-	CredFileFlag         = "credentials-file"
-	overwriteDNSFlagName = "overwrite-dns"
+	allSortByOptions   = "name, id, createdAt, deletedAt, numConnections"
+	connsSortByOptions = "id, startedAt, numConnections, version"
+	CredFileFlagAlias  = "cred-file"
+	CredFileFlag       = "credentials-file"
 
 	LogFieldTunnelID = "tunnelID"
 )
@@ -111,7 +110,7 @@ var (
 	}
 	selectProtocolFlag = altsrc.NewStringFlag(&cli.StringFlag{
 		Name:    "protocol",
-		Value:   "auto",
+		Value:   "h2mux",
 		Aliases: []string{"p"},
 		Usage:   fmt.Sprintf("Protocol implementation to connect with Cloudflare's edge network. %s", connection.AvailableProtocolFlagMessage),
 		EnvVars: []string{"TUNNEL_TRANSPORT_PROTOCOL"},
@@ -134,12 +133,6 @@ var (
 		Usage:   `Constraints the cleanup to stop the connections of a single Connector (by its ID). You can find the various Connectors (and their IDs) currently connected to your tunnel via 'cloudflared tunnel info <name>'.`,
 		EnvVars: []string{"TUNNEL_CLEANUP_CONNECTOR"},
 	}
-	overwriteDNSFlag = &cli.BoolFlag{
-		Name:    overwriteDNSFlagName,
-		Aliases: []string{"f"},
-		Usage:   `Overwrites existing DNS records with this hostname`,
-		EnvVars: []string{"TUNNEL_FORCE_PROVISIONING_DNS"},
-	}
 )
 
 func buildCreateCommand() *cli.Command {
@@ -602,12 +595,6 @@ func runCommand(c *cli.Context) error {
 		}
 	}
 
-	if c.String("hostname") != "" {
-		sc.log.Warn().Msg("The property `hostname` in your configuration is ignored because you configured a Named Tunnel " +
-			"in the property `tunnel` to run. Make sure to provision the routing (e.g. via `cloudflared tunnel route dns/lb`) or else " +
-			"your origin will not be reachable. You should remove the `hostname` property to avoid this warning.")
-	}
-
 	return runNamedTunnel(sc, tunnelRef)
 }
 
@@ -677,11 +664,10 @@ Further information about managing Cloudflare WARP traffic to your tunnel is ava
 		Subcommands: []*cli.Command{
 			buildRouteIPSubcommand(),
 		},
-		Flags: []cli.Flag{overwriteDNSFlag},
 	}
 }
 
-func dnsRouteFromArg(c *cli.Context, overwriteExisting bool) (tunnelstore.Route, error) {
+func dnsRouteFromArg(c *cli.Context) (tunnelstore.Route, error) {
 	const (
 		userHostnameIndex = 2
 		expectedNArgs     = 3
@@ -695,7 +681,7 @@ func dnsRouteFromArg(c *cli.Context, overwriteExisting bool) (tunnelstore.Route,
 	} else if !validateHostname(userHostname, true) {
 		return nil, errors.Errorf("%s is not a valid hostname", userHostname)
 	}
-	return tunnelstore.NewDNSRoute(userHostname, overwriteExisting), nil
+	return tunnelstore.NewDNSRoute(userHostname), nil
 }
 
 func lbRouteFromArg(c *cli.Context) (tunnelstore.Route, error) {
@@ -764,7 +750,7 @@ func routeCommand(c *cli.Context) error {
 		if err != nil {
 			return err
 		}
-		route, err = dnsRouteFromArg(c, c.Bool(overwriteDNSFlagName))
+		route, err = dnsRouteFromArg(c)
 		if err != nil {
 			return err
 		}

cmd/cloudflared/tunnel/subcommands_test.go

@@ -1,6 +1,7 @@
 package tunnel
 
 import (
+	"fmt"
 	"path/filepath"
 	"testing"
 
@@ -94,7 +95,7 @@ func TestTunnelfilePath(t *testing.T) {
 	assert.NoError(t, err)
 	homeDir, err := homedir.Dir()
 	assert.NoError(t, err)
-	expected := filepath.Join(homeDir, ".cloudflared", tunnelID.String()+".json")
+	expected := fmt.Sprintf("%s/.cloudflared/%v.json", homeDir, tunnelID)
 	assert.Equal(t, expected, actual)
 }
 

cmd/cloudflared/updater/workers_service_test.go

@@ -1,5 +1,3 @@
-// +build !windows
-
 package updater
 
 import (
@@ -15,7 +13,6 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"os"
-	"path/filepath"
 	"runtime"
 	"strconv"
 	"strings"
@@ -24,8 +21,6 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-var testFilePath = filepath.Join(os.TempDir(), "test")
-
 func respondWithJSON(w http.ResponseWriter, v interface{}, status int) {
 	data, _ := json.Marshal(v)
 
@@ -213,6 +208,7 @@ func TestUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 	log.Println("server url: ", ts.URL)
@@ -233,6 +229,7 @@ func TestBetaUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 
@@ -252,6 +249,7 @@ func TestFailUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 
@@ -265,6 +263,7 @@ func TestNoUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 
@@ -279,6 +278,7 @@ func TestForcedUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 
@@ -298,6 +298,7 @@ func TestUpdateSpecificVersionService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 	reqVersion := "2020.9.1"
@@ -318,6 +319,7 @@ func TestCompressedUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 
@@ -337,6 +339,7 @@ func TestUpdateWhenRunningKnownBuggyVersion(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 

metrics/timer.go

@@ -0,0 +1,48 @@
+package metrics
+
+import (
+	"time"
+
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+// Timer assumes the metrics is partitioned by one label
+type Timer struct {
+	startTime   map[string]time.Time
+	metrics     *prometheus.HistogramVec
+	measureUnit time.Duration
+	labelKey    string
+}
+
+func NewTimer(metrics *prometheus.HistogramVec, unit time.Duration, labelKey string) *Timer {
+	return &Timer{
+		startTime:   make(map[string]time.Time),
+		measureUnit: unit,
+		metrics:     metrics,
+		labelKey:    labelKey,
+	}
+}
+
+func (i *Timer) Start(labelVal string) {
+	i.startTime[labelVal] = time.Now()
+}
+
+func (i *Timer) End(labelVal string) time.Duration {
+	if start, ok := i.startTime[labelVal]; ok {
+		return Latency(start, time.Now())
+	}
+	return 0
+}
+
+func (i *Timer) Observe(measurement time.Duration, labelVal string) {
+	metricsLabels := prometheus.Labels{i.labelKey: labelVal}
+	i.metrics.With(metricsLabels).Observe(float64(measurement / i.measureUnit))
+}
+
+func (i *Timer) EndAndObserve(labelVal string) {
+	i.Observe(i.End(labelVal), labelVal)
+}
+
+func Latency(startTime, endTime time.Time) time.Duration {
+	return endTime.Sub(startTime)
+}

metrics/timer_test.go

@@ -0,0 +1,24 @@
+package metrics
+
+import (
+	"testing"
+	"time"
+
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestEnd(t *testing.T) {
+	m := prometheus.NewHistogramVec(
+		prometheus.HistogramOpts{
+			Namespace: "TestCallLatencyWithoutMeasurement",
+			Name:      "Latency",
+			Buckets:   prometheus.LinearBuckets(0, 50, 100),
+		},
+		[]string{"key"},
+	)
+	timer := NewTimer(m, time.Millisecond, "key")
+	assert.Equal(t, time.Duration(0), timer.End("dne"))
+	timer.Start("test")
+	assert.NotEqual(t, time.Duration(0), timer.End("test"))
+}

origin/proxy.go

@@ -18,10 +18,9 @@ import (
 )
 
 const (
-	TagHeaderNamePrefix   = "Cf-Warp-Tag-"
-	LogFieldCFRay         = "cfRay"
-	LogFieldRule          = "ingressRule"
-	LogFieldOriginService = "originService"
+	TagHeaderNamePrefix = "Cf-Warp-Tag-"
+	LogFieldCFRay       = "cfRay"
+	LogFieldRule        = "ingressRule"
 )
 
 type proxy struct {
@@ -71,7 +70,7 @@ func (p *proxy) Proxy(w connection.ResponseWriter, req *http.Request, sourceConn
 			rule:    ingress.ServiceWarpRouting,
 		}
 		if err := p.proxyStreamRequest(serveCtx, w, req, p.warpRouting.Proxy, logFields); err != nil {
-			p.logRequestError(err, cfRay, "", ingress.ServiceWarpRouting)
+			p.logRequestError(err, cfRay, ingress.ServiceWarpRouting)
 			return err
 		}
 		return nil
@@ -87,8 +86,7 @@ func (p *proxy) Proxy(w connection.ResponseWriter, req *http.Request, sourceConn
 
 	if sourceConnectionType == connection.TypeHTTP {
 		if err := p.proxyHTTPRequest(w, req, rule, logFields); err != nil {
-			rule, srv := ruleField(p.ingressRules, ruleNum)
-			p.logRequestError(err, cfRay, rule, srv)
+			p.logRequestError(err, cfRay, ruleField(p.ingressRules, ruleNum))
 			return err
 		}
 		return nil
@@ -101,19 +99,17 @@ func (p *proxy) Proxy(w connection.ResponseWriter, req *http.Request, sourceConn
 	}
 
 	if err := p.proxyStreamRequest(serveCtx, w, req, connectionProxy, logFields); err != nil {
-		rule, srv := ruleField(p.ingressRules, ruleNum)
-		p.logRequestError(err, cfRay, rule, srv)
+		p.logRequestError(err, cfRay, ruleField(p.ingressRules, ruleNum))
 		return err
 	}
 	return nil
 }
 
-func ruleField(ing ingress.Ingress, ruleNum int) (ruleID string, srv string) {
-	srv = ing.Rules[ruleNum].Service.String()
+func ruleField(ing ingress.Ingress, ruleNum int) string {
 	if ing.IsSingleRule() {
-		return "", srv
+		return ""
 	}
-	return fmt.Sprintf("%d", ruleNum), srv
+	return fmt.Sprintf("%d", ruleNum)
 }
 
 func (p *proxy) proxyHTTPRequest(w connection.ResponseWriter, req *http.Request, rule *ingress.Rule, fields logFields) error {
@@ -137,7 +133,7 @@ func (p *proxy) proxyHTTPRequest(w connection.ResponseWriter, req *http.Request,
 
 	resp, err := httpService.RoundTrip(req)
 	if err != nil {
-		return errors.Wrap(err, "Unable to reach the origin service. The service may be down or it may not be responding to traffic from cloudflared")
+		return errors.Wrap(err, "Error proxying request to origin")
 	}
 	defer resp.Body.Close()
 
@@ -275,7 +271,7 @@ func (p *proxy) logOriginResponse(resp *http.Response, fields logFields) {
 	}
 }
 
-func (p *proxy) logRequestError(err error, cfRay string, rule, service string) {
+func (p *proxy) logRequestError(err error, cfRay string, rule string) {
 	requestErrors.Inc()
 	log := p.log.Error().Err(err)
 	if cfRay != "" {
@@ -284,9 +280,6 @@ func (p *proxy) logRequestError(err error, cfRay string, rule, service string) {
 	if rule != "" {
 		log = log.Str(LogFieldRule, rule)
 	}
-	if service != "" {
-		log = log.Str(LogFieldOriginService, service)
-	}
 	log.Msg("")
 }
 

sshgen/sshgen_test.go

@@ -1,5 +1,3 @@
-// +build !windows
-
 package sshgen
 
 import (

tunnelstore/client.go

@@ -72,7 +72,6 @@ type Route interface {
 	json.Marshaler
 	RecordType() string
 	UnmarshalResult(body io.Reader) (RouteResult, error)
-	String() string
 }
 
 type RouteResult interface {
@@ -81,8 +80,7 @@ type RouteResult interface {
 }
 
 type DNSRoute struct {
-	userHostname      string
-	overwriteExisting bool
+	userHostname string
 }
 
 type DNSRouteResult struct {
@@ -90,22 +88,19 @@ type DNSRouteResult struct {
 	CName Change `json:"cname"`
 }
 
-func NewDNSRoute(userHostname string, overwriteExisting bool) Route {
+func NewDNSRoute(userHostname string) Route {
 	return &DNSRoute{
-		userHostname:      userHostname,
-		overwriteExisting: overwriteExisting,
+		userHostname: userHostname,
 	}
 }
 
 func (dr *DNSRoute) MarshalJSON() ([]byte, error) {
 	s := struct {
-		Type              string `json:"type"`
-		UserHostname      string `json:"user_hostname"`
-		OverwriteExisting bool   `json:"overwrite_existing"`
+		Type         string `json:"type"`
+		UserHostname string `json:"user_hostname"`
 	}{
-		Type:              dr.RecordType(),
-		UserHostname:      dr.userHostname,
-		OverwriteExisting: dr.overwriteExisting,
+		Type:         dr.RecordType(),
+		UserHostname: dr.userHostname,
 	}
 	return json.Marshal(&s)
 }
@@ -121,10 +116,6 @@ func (dr *DNSRoute) RecordType() string {
 	return "dns"
 }
 
-func (dr *DNSRoute) String() string {
-	return fmt.Sprintf("%s %s", dr.RecordType(), dr.userHostname)
-}
-
 func (res *DNSRouteResult) SuccessSummary() string {
 	var msgFmt string
 	switch res.CName {
@@ -173,10 +164,6 @@ func (lr *LBRoute) RecordType() string {
 	return "lb"
 }
 
-func (lb *LBRoute) String() string {
-	return fmt.Sprintf("%s %s %s", lb.RecordType(), lb.lbName, lb.lbPool)
-}
-
 func (lr *LBRoute) UnmarshalResult(body io.Reader) (RouteResult, error) {
 	var result LBRouteResult
 	err := parseResponse(body, &result)

watcher/file_test.go

@@ -1,5 +1,3 @@
-// +build !windows
-
 package watcher
 
 import (