Configure Envoy Tracing in Consul Connect Jobs

Introduction

This is to provide a Nomad job example where Consul Connect has been configured with Envoy tracing.

Procedure

Turning on Envoy tracing is possible from within a Consul Connect job by adding a config block to the sidecar_service Stanza. Below example facilitates testing to the point where the tracing driver is loaded:

job "countdash" {
  datacenters = ["dc1"]

  group "api" {
    network {
      mode = "bridge"
    }

    service {
      name = "count-api"
      port = "9001"
      tags = ["test1","test2"]
      connect {
        sidecar_service {
            tags = ["test3","test4"]
        }
      }
    }

    task "web" {
      driver = "docker"

      config {
        image = "hashicorpnomad/counter-api:v1"
      }
    }
  }

  group "dashboard" {
    network {
      mode = "bridge"

      port "http" {
        static = 9002
        to     = 9002
      }
    }

    service {
      name = "count-dashboard"
      port = "9002"

      connect {
        sidecar_service {
          proxy {
            upstreams {
              destination_name = "count-api"
              local_bind_port  = 8080
            }
          config {
            envoy_tracing_json = <<EOF
              {
                 "http": {
                  "name": "envoy.zipkin",
                    "config": {
                    "collector_cluster": "zipkin",
                    "collector_endpoint": "/api/v1/spans",
                    "shared_span_context": false
             }
       }
     }
  EOF
  }
          }
        }
      }
    }

    task "dashboard" {
      driver = "docker"

      env {
        COUNTING_SERVICE_URL = "http://${NOMAD_UPSTREAM_ADDR_count_api}"
      }

      config {
        image = "hashicorpnomad/counter-dashboard:v1"
      }
    }
  }
}

Additional Information

Proxy configuration is opaque to Nomad and passed directly to Consul.