Circonus integration for telemetry metrics

command/agent/command.go

@@ -16,6 +16,7 @@ import (
 	"time"
 
 	"github.com/armon/go-metrics"
+	"github.com/armon/go-metrics/circonus"
 	"github.com/hashicorp/consul/lib"
 	"github.com/hashicorp/go-checkpoint"
 	"github.com/hashicorp/go-syslog"
@@ -585,6 +586,43 @@ func (c *Command) setupTelementry(config *Config) error {
 		fanout = append(fanout, sink)
 	}
 
+	// Configure the Circonus sink
+	if telConfig.CirconusAPIToken != "" || telConfig.CirconusCheckSubmissionURL != "" {
+		cfg := &circonus.Config{}
+		cfg.Interval = telConfig.CirconusSubmissionInterval
+		cfg.CheckManager.API.TokenKey = telConfig.CirconusAPIToken
+		cfg.CheckManager.API.TokenApp = telConfig.CirconusAPIApp
+		cfg.CheckManager.API.URL = telConfig.CirconusAPIURL
+		cfg.CheckManager.Check.SubmissionURL = telConfig.CirconusCheckSubmissionURL
+		cfg.CheckManager.Check.ID = telConfig.CirconusCheckID
+		cfg.CheckManager.Check.ForceMetricActivation = telConfig.CirconusCheckForceMetricActivation
+		cfg.CheckManager.Check.InstanceID = telConfig.CirconusCheckInstanceID
+		cfg.CheckManager.Check.SearchTag = telConfig.CirconusCheckSearchTag
+		cfg.CheckManager.Broker.ID = telConfig.CirconusBrokerID
+		cfg.CheckManager.Broker.SelectTag = telConfig.CirconusBrokerSelectTag
+
+		if cfg.CheckManager.API.TokenApp == "" {
+			cfg.CheckManager.API.TokenApp = "nomad"
+		}
+
+		if cfg.CheckManager.Check.InstanceID == "" {
+			if config.NodeName != "" && config.Datacenter != "" {
+				cfg.CheckManager.Check.InstanceID = fmt.Sprintf("%s:%s", config.NodeName, config.Datacenter)
+			}
+		}
+
+		if cfg.CheckManager.Check.SearchTag == "" {
+			cfg.CheckManager.Check.SearchTag = "service:nomad"
+		}
+
+		sink, err := circonus.NewCirconusSink(cfg)
+		if err != nil {
+			return err
+		}
+		sink.Start()
+		fanout = append(fanout, sink)
+	}
+
 	// Initialize the global sink
 	if len(fanout) > 0 {
 		fanout = append(fanout, inm)

command/agent/config.go

@@ -245,6 +245,70 @@ type Telemetry struct {
 	DisableHostname    bool          `mapstructure:"disable_hostname"`
 	CollectionInterval string        `mapstructure:"collection_interval"`
 	collectionInterval time.Duration `mapstructure:"-"`
+
+	// Circonus: see https://github.com/circonus-labs/circonus-gometrics
+	// for more details on the various configuration options.
+	// Valid configuration combinations:
+	//    - CirconusAPIToken
+	//      metric management enabled (search for existing check or create a new one)
+	//    - CirconusSubmissionUrl
+	//      metric management disabled (use check with specified submission_url,
+	//      broker must be using a public SSL certificate)
+	//    - CirconusAPIToken + CirconusCheckSubmissionURL
+	//      metric management enabled (use check with specified submission_url)
+	//    - CirconusAPIToken + CirconusCheckID
+	//      metric management enabled (use check with specified id)
+
+	// CirconusAPIToken is a valid API Token used to create/manage check. If provided,
+	// metric management is enabled.
+	// Default: none
+	CirconusAPIToken string `mapstructure:"circonus_api_token"`
+	// CirconusAPIApp is an app name associated with API token.
+	// Default: "consul"
+	CirconusAPIApp string `mapstructure:"circonus_api_app"`
+	// CirconusAPIURL is the base URL to use for contacting the Circonus API.
+	// Default: "https://api.circonus.com/v2"
+	CirconusAPIURL string `mapstructure:"circonus_api_url"`
+	// CirconusSubmissionInterval is the interval at which metrics are submitted to Circonus.
+	// Default: 10s
+	CirconusSubmissionInterval string `mapstructure:"circonus_submission_interval"`
+	// CirconusCheckSubmissionURL is the check.config.submission_url field from a
+	// previously created HTTPTRAP check.
+	// Default: none
+	CirconusCheckSubmissionURL string `mapstructure:"circonus_submission_url"`
+	// CirconusCheckID is the check id (not check bundle id) from a previously created
+	// HTTPTRAP check. The numeric portion of the check._cid field.
+	// Default: none
+	CirconusCheckID string `mapstructure:"circonus_check_id"`
+	// CirconusCheckForceMetricActivation will force enabling metrics, as they are encountered,
+	// if the metric already exists and is NOT active. If check management is enabled, the default
+	// behavior is to add new metrics as they are encoutered. If the metric already exists in the
+	// check, it will *NOT* be activated. This setting overrides that behavior.
+	// Default: "false"
+	CirconusCheckForceMetricActivation string `mapstructure:"circonus_check_force_metric_activation"`
+	// CirconusCheckInstanceID serves to uniquely identify the metrics comming from this "instance".
+	// It can be used to maintain metric continuity with transient or ephemeral instances as
+	// they move around within an infrastructure.
+	// Default: hostname:app
+	CirconusCheckInstanceID string `mapstructure:"circonus_check_instance_id"`
+	// CirconusCheckSearchTag is a special tag which, when coupled with the instance id, helps to
+	// narrow down the search results when neither a Submission URL or Check ID is provided.
+	// Default: service:app (e.g. service:consul)
+	CirconusCheckSearchTag string `mapstructure:"circonus_check_search_tag"`
+	// CirconusBrokerID is an explicit broker to use when creating a new check. The numeric portion
+	// of broker._cid. If metric management is enabled and neither a Submission URL nor Check ID
+	// is provided, an attempt will be made to search for an existing check using Instance ID and
+	// Search Tag. If one is not found, a new HTTPTRAP check will be created.
+	// Default: use Select Tag if provided, otherwise, a random Enterprise Broker associated
+	// with the specified API token or the default Circonus Broker.
+	// Default: none
+	CirconusBrokerID string `mapstructure:"circonus_broker_id"`
+	// CirconusBrokerSelectTag is a special tag which will be used to select a broker when
+	// a Broker ID is not provided. The best use of this is to as a hint for which broker
+	// should be used based on *where* this particular instance is running.
+	// (e.g. a specific geo location or datacenter, dc:sfo)
+	// Default: none
+	CirconusBrokerSelectTag string `mapstructure:"circonus_broker_select_tag"`
 }
 
 // Ports is used to encapsulate the various ports we bind to for network
@@ -676,6 +740,39 @@ func (a *Telemetry) Merge(b *Telemetry) *Telemetry {
 	if b.collectionInterval != 0 {
 		result.collectionInterval = b.collectionInterval
 	}
+	if b.CirconusAPIToken != "" {
+		result.CirconusAPIToken = b.CirconusAPIToken
+	}
+	if b.CirconusAPIApp != "" {
+		result.CirconusAPIApp = b.CirconusAPIApp
+	}
+	if b.CirconusAPIURL != "" {
+		result.CirconusAPIURL = b.CirconusAPIURL
+	}
+	if b.CirconusCheckSubmissionURL != "" {
+		result.CirconusCheckSubmissionURL = b.CirconusCheckSubmissionURL
+	}
+	if b.CirconusSubmissionInterval != "" {
+		result.CirconusSubmissionInterval = b.CirconusSubmissionInterval
+	}
+	if b.CirconusCheckID != "" {
+		result.CirconusCheckID = b.CirconusCheckID
+	}
+	if b.CirconusCheckForceMetricActivation != "" {
+		result.CirconusCheckForceMetricActivation = b.CirconusCheckForceMetricActivation
+	}
+	if b.CirconusCheckInstanceID != "" {
+		result.CirconusCheckInstanceID = b.CirconusCheckInstanceID
+	}
+	if b.CirconusCheckSearchTag != "" {
+		result.CirconusCheckSearchTag = b.CirconusCheckSearchTag
+	}
+	if b.CirconusBrokerID != "" {
+		result.CirconusBrokerID = b.CirconusBrokerID
+	}
+	if b.CirconusBrokerSelectTag != "" {
+		result.CirconusBrokerSelectTag = b.CirconusBrokerSelectTag
+	}
 	return &result
 }
 

command/agent/config_parse.go

@@ -493,6 +493,17 @@ func parseTelemetry(result **Telemetry, list *ast.ObjectList) error {
 		"statsd_address",
 		"disable_hostname",
 		"collection_interval",
+		"circonus_api_token",
+		"circonus_api_app",
+		"circonus_api_url",
+		"circonus_submission_interval",
+		"circonus_submission_url",
+		"circonus_check_id",
+		"circonus_check_force_metric_activation",
+		"circonus_check_instance_id",
+		"circonus_check_search_tag",
+		"circonus_broker_id",
+		"circonus_broker_select_tag",
 	}
 	if err := checkHCLKeys(listVal, valid); err != nil {
 		return err

command/agent/config_test.go

@@ -27,9 +27,20 @@ func TestConfig_Merge(t *testing.T) {
 		DisableAnonymousSignature: false,
 		BindAddr:                  "127.0.0.1",
 		Telemetry: &Telemetry{
-			StatsiteAddr:    "127.0.0.1:8125",
-			StatsdAddr:      "127.0.0.1:8125",
-			DisableHostname: false,
+			StatsiteAddr:                       "127.0.0.1:8125",
+			StatsdAddr:                         "127.0.0.1:8125",
+			DisableHostname:                    false,
+			CirconusAPIToken:                   "0",
+			CirconusAPIApp:                     "nomadic",
+			CirconusAPIURL:                     "http://api.circonus.com/v2",
+			CirconusSubmissionInterval:         "60s",
+			CirconusCheckSubmissionURL:         "https://someplace.com/metrics",
+			CirconusCheckID:                    "0",
+			CirconusCheckForceMetricActivation: "true",
+			CirconusCheckInstanceID:            "node1:nomadic",
+			CirconusCheckSearchTag:             "service:nomadic",
+			CirconusBrokerID:                   "0",
+			CirconusBrokerSelectTag:            "dc:dc1",
 		},
 		Client: &ClientConfig{
 			Enabled:   false,
@@ -100,9 +111,20 @@ func TestConfig_Merge(t *testing.T) {
 		DisableAnonymousSignature: true,
 		BindAddr:                  "127.0.0.2",
 		Telemetry: &Telemetry{
-			StatsiteAddr:    "127.0.0.2:8125",
-			StatsdAddr:      "127.0.0.2:8125",
-			DisableHostname: true,
+			StatsiteAddr:                       "127.0.0.2:8125",
+			StatsdAddr:                         "127.0.0.2:8125",
+			DisableHostname:                    true,
+			CirconusAPIToken:                   "1",
+			CirconusAPIApp:                     "nomad",
+			CirconusAPIURL:                     "https://api.circonus.com/v2",
+			CirconusSubmissionInterval:         "10s",
+			CirconusCheckSubmissionURL:         "https://example.com/metrics",
+			CirconusCheckID:                    "1",
+			CirconusCheckForceMetricActivation: "false",
+			CirconusCheckInstanceID:            "node2:nomad",
+			CirconusCheckSearchTag:             "service:nomad",
+			CirconusBrokerID:                   "1",
+			CirconusBrokerSelectTag:            "dc:dc2",
 		},
 		Client: &ClientConfig{
 			Enabled:   true,