Add azure_storage_queue input plugin (#5323)

plugins/inputs/all/all.go

@@ -7,6 +7,7 @@ import (
 	_ "github.com/influxdata/telegraf/plugins/inputs/apache"
 	_ "github.com/influxdata/telegraf/plugins/inputs/apcupsd"
 	_ "github.com/influxdata/telegraf/plugins/inputs/aurora"
+	_ "github.com/influxdata/telegraf/plugins/inputs/azure_storage_queue"
 	_ "github.com/influxdata/telegraf/plugins/inputs/bcache"
 	_ "github.com/influxdata/telegraf/plugins/inputs/beanstalkd"
 	_ "github.com/influxdata/telegraf/plugins/inputs/bind"

plugins/inputs/azure_storage_queue/README.md

@@ -0,0 +1,35 @@
+# Telegraf Input Plugin: Azure Storage Queue
+
+This plugin gathers sizes of Azure Storage Queues.
+
+### Configuration:
+
+```toml
+# Description
+[[inputs.azure_storage_queue]]
+  ## Required Azure Storage Account name
+  account_name = "mystorageaccount"
+
+  ## Required Azure Storage Account access key
+  account_key = "storageaccountaccesskey"
+  
+  ## Set to false to disable peeking age of oldest message (executes faster)
+  # peek_oldest_message_age = true
+```
+
+### Metrics
+- azure_storage_queues
+  - tags:
+    - queue
+    - account
+  - fields:
+    - size (integer, count)
+    - oldest_message_age_ns (integer, nanoseconds) Age of message at the head of the queue.
+      Requires `peek_oldest_message_age` to be configured to `true`.
+      
+### Example Output
+
+```
+azure_storage_queues,queue=myqueue,account=mystorageaccount oldest_message_age=799714900i,size=7i 1565970503000000000
+azure_storage_queues,queue=myemptyqueue,account=mystorageaccount size=0i 1565970502000000000
+```

plugins/inputs/azure_storage_queue/azure_storage_queue.go

@@ -0,0 +1,134 @@
+package activemq
+
+import (
+	"context"
+	"errors"
+	"log"
+	"net/url"
+	"strings"
+	"time"
+
+	"github.com/Azure/azure-storage-queue-go/azqueue"
+	"github.com/influxdata/telegraf"
+	"github.com/influxdata/telegraf/plugins/inputs"
+)
+
+type AzureStorageQueue struct {
+	StorageAccountName   string `toml:"account_name"`
+	StorageAccountKey    string `toml:"account_key"`
+	PeekOldestMessageAge bool   `toml:"peek_oldest_message_age"`
+
+	serviceURL *azqueue.ServiceURL
+}
+
+var sampleConfig = `
+  ## Required Azure Storage Account name
+  account_name = "mystorageaccount"
+
+  ## Required Azure Storage Account access key
+  account_key = "storageaccountaccesskey"
+
+  ## Set to false to disable peeking age of oldest message (executes faster)
+  # peek_oldest_message_age = true
+  `
+
+func (a *AzureStorageQueue) Description() string {
+	return "Gather Azure Storage Queue metrics"
+}
+
+func (a *AzureStorageQueue) SampleConfig() string {
+	return sampleConfig
+}
+
+func (a *AzureStorageQueue) Init() error {
+	if a.StorageAccountName == "" {
+		return errors.New("account_name must be configured")
+	}
+
+	if a.StorageAccountKey == "" {
+		return errors.New("account_key must be configured")
+	}
+	return nil
+}
+
+func (a *AzureStorageQueue) GetServiceURL() (azqueue.ServiceURL, error) {
+	if a.serviceURL == nil {
+		_url, err := url.Parse("https://" + a.StorageAccountName + ".queue.core.windows.net")
+		if err != nil {
+			return azqueue.ServiceURL{}, err
+		}
+
+		credential, err := azqueue.NewSharedKeyCredential(a.StorageAccountName, a.StorageAccountKey)
+		if err != nil {
+			return azqueue.ServiceURL{}, err
+		}
+
+		pipeline := azqueue.NewPipeline(credential, azqueue.PipelineOptions{})
+
+		serviceURL := azqueue.NewServiceURL(*_url, pipeline)
+		a.serviceURL = &serviceURL
+	}
+	return *a.serviceURL, nil
+}
+
+func (a *AzureStorageQueue) GatherQueueMetrics(acc telegraf.Accumulator, queueItem azqueue.QueueItem, properties *azqueue.QueueGetPropertiesResponse, peekedMessage *azqueue.PeekedMessage) {
+	fields := make(map[string]interface{})
+	tags := make(map[string]string)
+	tags["queue"] = strings.TrimSpace(queueItem.Name)
+	tags["account"] = a.StorageAccountName
+	fields["size"] = properties.ApproximateMessagesCount()
+	if peekedMessage != nil {
+		fields["oldest_message_age_ns"] = time.Now().UnixNano() - peekedMessage.InsertionTime.UnixNano()
+	}
+	acc.AddFields("azure_storage_queues", fields, tags)
+}
+
+func (a *AzureStorageQueue) Gather(acc telegraf.Accumulator) error {
+	serviceURL, err := a.GetServiceURL()
+	if err != nil {
+		return err
+	}
+
+	ctx := context.TODO()
+
+	for marker := (azqueue.Marker{}); marker.NotDone(); {
+		log.Printf("D! [inputs.azure_storage_queue] Listing queues of storage account '%s'", a.StorageAccountName)
+		queuesSegment, err := serviceURL.ListQueuesSegment(ctx, marker,
+			azqueue.ListQueuesSegmentOptions{
+				Detail: azqueue.ListQueuesSegmentDetails{Metadata: false},
+			})
+		if err != nil {
+			return err
+		}
+		marker = queuesSegment.NextMarker
+
+		for _, queueItem := range queuesSegment.QueueItems {
+			log.Printf("D! [inputs.azure_storage_queue] Processing queue '%s' of storage account '%s'", queueItem.Name, a.StorageAccountName)
+			queueURL := serviceURL.NewQueueURL(queueItem.Name)
+			properties, err := queueURL.GetProperties(ctx)
+			if err != nil {
+				log.Printf("E! [inputs.azure_storage_queue] Error getting properties for queue %s: %s", queueItem.Name, err.Error())
+				continue
+			}
+			var peekedMessage *azqueue.PeekedMessage
+			if a.PeekOldestMessageAge {
+				messagesURL := queueURL.NewMessagesURL()
+				messagesResponse, err := messagesURL.Peek(ctx, 1)
+				if err != nil {
+					log.Printf("E! [inputs.azure_storage_queue] Error peeking queue %s: %s", queueItem.Name, err.Error())
+				} else if messagesResponse.NumMessages() > 0 {
+					peekedMessage = messagesResponse.Message(0)
+				}
+			}
+
+			a.GatherQueueMetrics(acc, queueItem, properties, peekedMessage)
+		}
+	}
+	return nil
+}
+
+func init() {
+	inputs.Add("azure_storage_queue", func() telegraf.Input {
+		return &AzureStorageQueue{PeekOldestMessageAge: true}
+	})
+}