Release/list by tag (#53)

Co-Authored-By: vincentcreusotfx <34456730+vincentcreusotfx@users.noreply.github.com>

README.md

@@ -90,6 +90,12 @@ resource_groups:
     metrics:
     - name: "CPU Credits Consumed"
 
+resource_tags:
+  - resource_tag_name: "group"
+    resource_tag_value: "tomonitor"
+    metrics:
+    - name: "CPU Credits Consumed"
+
 ```
 
 By default, all aggregations are returned (`Total`, `Maximum`, `Average`, `Minimum`). It can be overridden per resource.
@@ -111,6 +117,16 @@ List of regexps that is matched against the resource name.
 Metrics of all matched resources are ignored (defaults to exclude none)
 Excludes take precedence over the include filter.
 
+### Resource tag filtering
+
+Resources having a specific tag name and tag value can be filtered:
+
+`resource_tag_name`:
+Name of the tag to be filtered against.
+
+`resource_tag_value`:
+Value of the tag to be filtered against.
+
 ## Prometheus configuration
 
 ### Example config
@@ -122,4 +138,4 @@ scrape_configs:
   - job_name: azure
     static_configs:
       - targets: ['localhost:9276']
-```
+```

azure.go

@@ -254,6 +254,15 @@ func (ac *AzureClient) filteredListFromResourceGroup(resourceGroup config.Resour
 	return filteredResources, nil
 }
 
+// Returns resource list filtered by tag name and tag value
+func (ac *AzureClient) filteredListByTag(resourceTag config.ResourceTag) ([]string, error) {
+	resources, err := ac.listByTag(resourceTag.ResourceTagName, resourceTag.ResourceTagValue)
+	if err != nil {
+		return nil, err
+	}
+	return resources, nil
+}
+
 // Returns all resources for given resource group and types
 func (ac *AzureClient) listFromResourceGroup(resourceGroup string, resourceTypes []string) ([]string, error) {
 	apiVersion := "2018-02-01"
@@ -266,9 +275,61 @@ func (ac *AzureClient) listFromResourceGroup(resourceGroup string, resourceTypes
 
 	subscription := fmt.Sprintf("subscriptions/%s", sc.C.Credentials.SubscriptionID)
 
-	metricValueEndpoint := fmt.Sprintf("%s/%s/resourceGroups/%s/resources?api-version=%s&$filter=%s", sc.C.ResourceManagerURL, subscription, resourceGroup, apiVersion, filterTypes)
+	resourcesEndpoint := fmt.Sprintf("%s/%s/resourceGroups/%s/resources?api-version=%s&$filter=%s", sc.C.ResourceManagerURL, subscription, resourceGroup, apiVersion, filterTypes)
 
-	req, err := http.NewRequest("GET", metricValueEndpoint, nil)
+	body, err := getAzureMonitorResponse(resourcesEndpoint)
+
+	if err != nil {
+		return nil, err
+	}
+
+	var data AzureResourceListResponse
+	err = json.Unmarshal(body, &data)
+	if err != nil {
+		return nil, fmt.Errorf("Error unmarshalling response body: %v", err)
+	}
+
+	resources := extractResourceNames(data, subscription)
+
+	return resources, nil
+}
+
+// Returns all resource with the given couple tagname, tagvalue
+func (ac *AzureClient) listByTag(tagName string, tagValue string) ([]string, error) {
+	apiVersion := "2018-05-01"
+	securedTagName := secureString(tagName)
+	securedTagValue := secureString(tagValue)
+	filterTypes := url.QueryEscape(fmt.Sprintf("tagName eq '%s' and tagValue eq '%s'", securedTagName, securedTagValue))
+
+	subscription := fmt.Sprintf("subscriptions/%s", sc.C.Credentials.SubscriptionID)
+
+	resourcesEndpoint := fmt.Sprintf("%s/%s/resources?api-version=%s&$filter=%s", sc.C.ResourceManagerURL,subscription, apiVersion, filterTypes)
+
+	body, err := getAzureMonitorResponse(resourcesEndpoint)
+
+	if err != nil {
+		return nil, err
+	}
+
+	var data AzureResourceListResponse
+	err = json.Unmarshal(body, &data)
+	if err != nil {
+		return nil, fmt.Errorf("Error unmarshalling response body: %v", err)
+	}
+
+	resources := extractResourceNames(data, subscription)
+
+	return resources, nil
+}
+
+func secureString(value string) string {
+	securedValue := strings.Replace(value, "'", "\\'", -1)
+	return securedValue
+}
+
+
+func getAzureMonitorResponse(azureManagementEndpoint string) ([]byte, error) {
+	req, err := http.NewRequest("GET", azureManagementEndpoint, nil)
 	if err != nil {
 		return nil, fmt.Errorf("Error creating HTTP request: %v", err)
 	}
@@ -279,32 +340,30 @@ func (ac *AzureClient) listFromResourceGroup(resourceGroup string, resourceTypes
 		return nil, fmt.Errorf("Error: %v", err)
 	}
 	defer resp.Body.Close()
+	body, err := ioutil.ReadAll(resp.Body)
+
 	if resp.StatusCode != 200 {
-		return nil, fmt.Errorf("Unable to query resource group API with status code: %d", resp.StatusCode)
+		return nil, fmt.Errorf("Unable to query API with status code: %d and with body: %s", resp.StatusCode, body)
 	}
 
-	body, err := ioutil.ReadAll(resp.Body)
 	if err != nil {
 		return nil, fmt.Errorf("Error reading body of response: %v", err)
 	}
+	return body, err
 
-	var data AzureResourceListResponse
-	err = json.Unmarshal(body, &data)
-	if err != nil {
-		return nil, fmt.Errorf("Error unmarshalling response body: %v", err)
-	}
+}
 
+// Extract resource names from the AzureResourceListResponse
+func extractResourceNames(data AzureResourceListResponse, subscription string) []string {
 	var resources []string
-
 	for _, result := range data.Value {
 		// subscription + leading '/'
 		subscriptionPrefixLen := len(subscription) + 1
 
 		// remove subscription from path to match manually specified ones
 		resources = append(resources, result.Id[subscriptionPrefixLen:])
 	}
-
-	return resources, nil
+	return resources
 }
 
 // Returns a filtered resource list based on a given resource list and regular expressions from the configuration

config/config.go

@@ -12,12 +12,12 @@ import (
 
 // Config - Azure exporter configuration
 type Config struct {
-// Config - Azure exporter configuration
 	ActiveDirectoryAuthorityURL      string          `yaml:"active_directory_authority_url"`
 	ResourceManagerURL               string          `yaml:"resource_manager_url"`
-	Credentials                      Credentials     `yaml:"credentials"`
-	Targets                          []Target        `yaml:"targets"`
-	ResourceGroups                   []ResourceGroup `yaml:"resource_groups"`
+	Credentials    Credentials     `yaml:"credentials"`
+	Targets        []Target        `yaml:"targets"`
+	ResourceGroups []ResourceGroup `yaml:"resource_groups"`
+	ResourceTags   []ResourceTag   `yaml:"resource_tags"`
 
 	// Catches all undefined fields and must be empty after parsing.
 	XXX map[string]interface{} `yaml:",inline"`
@@ -146,6 +146,16 @@ type ResourceGroup struct {
 	XXX map[string]interface{} `yaml:",inline"`
 }
 
+// ResourceTag selects resources with tag name and tag value
+type ResourceTag struct {
+	ResourceTagName  string   `yaml:"resource_tag_name"`
+	ResourceTagValue string   `yaml:"resource_tag_value"`
+	Metrics          []Metric `yaml:"metrics"`
+	Aggregations     []string `yaml:"aggregations"`
+
+	XXX map[string]interface{} `yaml:",inline"`
+}
+
 // Metric defines metric name
 type Metric struct {
 	Name string `yaml:"name"`

main.go

@@ -8,6 +8,7 @@ import (
 	"strings"
 
 	"github.com/RobustPerception/azure_metrics_exporter/config"
+
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"github.com/prometheus/common/version"
@@ -136,6 +137,26 @@ func (c *Collector) Collect(ch chan<- prometheus.Metric) {
 			c.collectResource(ch, resource, metricsStr, resourceGroup.Aggregations)
 		}
 	}
+
+	for _, resourceTag := range sc.C.ResourceTags {
+		metrics := []string{}
+		for _, metric := range resourceTag.Metrics {
+			metrics = append(metrics, metric.Name)
+		}
+		metricsStr := strings.Join(metrics, ",")
+
+		filteredResources, err := ac.filteredListByTag(resourceTag)
+		if err != nil {
+			log.Printf("Failed to get resources for tag name %s, tag value %s: %v",
+				resourceTag.ResourceTagName, resourceTag.ResourceTagValue, err)
+			ch <- prometheus.NewInvalidMetric(azureErrorDesc, err)
+			return
+		}
+
+		for _, resource := range filteredResources {
+			c.collectResource(ch, resource, metricsStr, resourceTag.Aggregations)
+		}
+	}
 }
 
 func handler(w http.ResponseWriter, r *http.Request) {