azure_storage_queue

README

Azure Storage Queue Input Plugin

This plugin gathers sizes of Azure Storage Queues.

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Gather Azure Storage Queue metrics
[[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

Documentation

Index

• type AzureStorageQueue
  • func (a *AzureStorageQueue) Gather(acc telegraf.Accumulator) error
  • func (a *AzureStorageQueue) GatherQueueMetrics(acc telegraf.Accumulator, queueItem azqueue.QueueItem, ...)
  • func (a *AzureStorageQueue) GetServiceURL() (azqueue.ServiceURL, error)
  • func (a *AzureStorageQueue) Init() error
  • func (*AzureStorageQueue) SampleConfig() string

Types

type AzureStorageQueue

type AzureStorageQueue struct {
	StorageAccountName   string `toml:"account_name"`
	StorageAccountKey    string `toml:"account_key"`
	PeekOldestMessageAge bool   `toml:"peek_oldest_message_age"`
	Log                  telegraf.Logger
	// contains filtered or unexported fields
}

func (*AzureStorageQueue) Gather

func (a *AzureStorageQueue) Gather(acc telegraf.Accumulator) error

func (*AzureStorageQueue) GatherQueueMetrics

func (a *AzureStorageQueue) GatherQueueMetrics(
	acc telegraf.Accumulator,
	queueItem azqueue.QueueItem,
	properties *azqueue.QueueGetPropertiesResponse,
	peekedMessage *azqueue.PeekedMessage,
)

func (*AzureStorageQueue) GetServiceURL

func (a *AzureStorageQueue) GetServiceURL() (azqueue.ServiceURL, error)

func (*AzureStorageQueue) Init

func (a *AzureStorageQueue) Init() error

func (*AzureStorageQueue) SampleConfig

func (*AzureStorageQueue) SampleConfig() string