michaelenglert · adityajagtiani89 · Jul 4, 2018 · Jul 4, 2018 · Jul 4, 2018 · Jul 4, 2018
diff --git a/CHANGES.MD b/CHANGES.MD
@@ -1,3 +1,38 @@
+### Version 1.11.0.0 (Alpha)
+
+* Add managed service identity support
+* Add tests (mock both api and controller calls)
+* Bug fixes (memory leaks)
+
+### Version 1.10.0.0 (Alpha)
+
+* Add basic dimensions support
+* Add CLI support
+* Get multiple metrics with a simple API call
+
+### Version 1.9.9.0 (Alpha)
+
+* Changed to latest Extension Framework
+* Usage of Azure Java SDK Bindings
+* Change of Filter Strategy
+* Change of Config Structure
+
+### Version 1.2.3
+
+* Changed Exclude Filter Strategy
+
+### Version 1.2.2
+
+* Fixed config.yml change bug
+
+### Version 1.2.1
+
+* Error handling adjustments
+
+### Version 1.2
+
+* Released v1.2
+
 ### Version 1.1.9.3 (Beta)
 
 * Added Service Fabric Certificate Authentication

diff --git a/README.MD b/README.MD
@@ -12,25 +12,19 @@ Monitor Metrics provided by the Azure Monitor API and let them report into the A
 
 ## Installation
 
-Either [Download the Extension from the Github release](https://github.com/michaelenglert/azure-monitoring-extension/releases/tag/v1.1) or Build from Source.
+Either [Download the Extension from the Github release](https://github.com/michaelenglert/azure-monitoring-extension/releases) or Build from Source.
 
 1. Deploy the `AzureMonitor-<VERSION>.zip` file into the `<machine agent home>/monitors` directory.
 
   `> unzip AzureMonitor-<VERSION>.zip -d <machine agent home>/monitors/`
 
 2. Set up `config.yml`. At minimum this is:
   ```
-  # Client ID obtained from the Azure Portal
-  clientId: ""
-
-  # Client Key for the upper ID obtained from the Azure Portal
-  clientKey: ""
-
-  # Tenant ID obtained from the Azure Portal
-  tenantId: ""
-
-  # Subscription ID obtained from the Azure Portal
-  subscriptionId: ""
+subscriptions:
+  - subscriptionId: ""
+    tenantId: ""
+    clientId: ""
+    clientKey: ""
   ```
   Details for the Setup can be found in the [Azure - Resource Manager - Howto - Control Access - Create Service Principal - Azure Portal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal)
 
@@ -42,6 +36,14 @@ Either [Download the Extension from the Github release](https://github.com/micha
 2. Run `mvn -DskipTests clean install`
 3. The `AzureMonitor-<VERSION>.zip` file can be found in the `target` directory
 
+## CLI support
+
+It is possible to test the extension without the machine agent, and without sending real metrics to the controller by using the command line. Both the machine agent and the extension jar files must be present in the class path.
+
+Usage: `java -Dorg.slf4j.simpleLogger.defaultLogLevel=DEBUG -cp ./machine-agent-x.x.xx.jar:./target/azure-monitoring-extension.jar com.appdynamics.monitors.azure.AzureMonitor`
+
+NOTE: Depending on JRE version, you might need to add this parameter `--add-modules java.xml.bind`
+
 ## Directory Structure
 
 <table><tbody>
@@ -72,36 +74,91 @@ Either [Download the Extension from the Github release](https://github.com/micha
 </tbody>
 </table>
 
+## Authentication using MSI (Managed Service Identity)
+
+Managed Service Identity is a feature of Azure Active Directory that simplifies the way that credentials are handled. More info [here](https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview)
+
+To make use of this feature on a subscription, set the parameter useMSI to true in the config.yml file.
+  ```
+subscriptions:
+  - subscriptionId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+    useMSI: "true"
+  ```
+
+## Dimensions
+
+In case you need more granularity for the metrics, it is possible to define filters to use Azure dimensions. For more info, check [here](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-rest-api-walkthrough#retrieve-metric-definitions-multi-dimensional-api)
+
+  ```
+                metrics:
+                  - metric: "ThrottledRequests"
+                    filter: "EntityName eq 'myTopic'"
+                    alias: "Throttled Requests"
+                    subpath: "myTopic"
+  ```
+
+As a result, this would be the path of the metric that would be sent to the controller (note the use of the alias parameter to change the name of the metric in the path):
+
+`Custom Metrics|AzureMonitor|xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx|resourceGroup1|namespaces|TestEventHub1|myTopic|Throttled Requests`
+
 ## Metrics
 
 Metrics available for Azure are maintained within the [Azure Monitor Documentation - Reference - Metrics Supported](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-supported-metrics)
 
+## Metrics alias
+
+The same way as with dimensions, it is possible to use the alias parameter to change the name of any simple metric in the path.
+
+  ```
+                metrics:
+                  - metric: "ThrottledRequests"
+                    alias: "Throttled Requests"
+  ```
+And this would be the path of the metric sent to the controller:
+
+`Custom Metrics|AzureMonitor|xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx|resourceGroup1|namespaces|TestEventHub1|Throttled Requests`
+
+## Metric time-rollup
+
+The time-rollup qualifier specifies how the Controller rolls up the values when it converts from one-minute granularity tables to 10-minute granularity and 60-minute granularity tables over time. For more info, check [here](https://docs.appdynamics.com/display/PRO45/Build+a+Monitoring+Extension+Using+Java#BuildaMonitoringExtensionUsingJava-MetricProcessingQualifier)
+
+  ```
+                  - metric: "UnauthorizedRequests"
+                    timeRollUp: "METRIC_TIME_ROLLUP_TYPE_AVERAGE"
+  ```
+
 ## Excluding Metrics for Resources
 
-You can exlcude certain Metrics by adding an exclude within a filter Resource Element. To do this the following configuration in `config.yml` is required:
+You can exclude certain Metrics by adding an include within a filter Resource Element. To do this the following configuration in `config.yml` is required:
   ```
-    filter:
-      - resourceType: "Microsoft.Storage/storageAccounts"
-        exclude: ".*"
+  subscriptions:
+    - subscriptionId: ""
+      tenantId: ""
+      clientId: ""
+      clientKey: ""
+      resourceGroups:             # You can Filter with regex on any of these Types.
+        - resourceGroup: ".*"     # If you have multiple entries per Type be sure they do not overlap
+          resourceTypes:          # --> This will produce duplicate Metrics!!!!
+            - resourceType: ".*"
+              resources:
+                - resource: ".*"
+                  metrics:
+                  - metric: ".*"
   ```
-A regular expression is needed. Any match will be ignored for that specific resource.
+A regular expression is needed. Any match will be included for that specific type.
 
 ## Integration with Azure Key Vault
 
 If you do not want to store the Client Key from the Service Principal that is used to query Resources, Metric Definitions and Metrics you can obtain the Key from an Azure Key Vault Secret.
 To achieve this the following configuration in `config.yml` is required:
   ```
-    # Keyvault Client ID obtained from the Azure Portal
-    keyvaultClientId: ""
-
-    # Keyvault Key for the upper ID obtained from the Azure Portal
-    keyvaultClientKey: ""
-
-    # Keyvault Client Secret Url. From this URL the clientKey will be obtained
-    keyvaultClientSecretUrl: ""
-
-    # Client ID obtained from the Azure Portal
-    clientId: ""
+  subscriptions:
+    - subscriptionId: ""
+      tenantId: ""
+      clientId: ""
+      keyvaultClientId: ""
+      keyvaultClientKey: ""
+      keyvaultClientSecretUrl: ""
   ```
 The **Key Vault Client Key** can also be encrypted just as the normal **Client Key**.
 
@@ -110,8 +167,10 @@ The **Key Vault Client Key** can also be encrypted just as the normal **Client K
 Currently the Extension support Certificate based Authentication to gather the Health Status of your Service Fabric Clusters. To use this those properties in `config.yml` have to be used:
 
   ```
-    serviceFabricCert: 'monitors/AzureMonitor/your-cert.pfx'
-    serviceFabricPassphrase: ''
+  serviceFabrics:
+    - serviceFabric: "ServiceFabric"
+      serviceFabricCert: 'src/test/resources/cert/integration-test-sf.pfx'
+      serviceFabricPassphrase: ''
   ```
 
 ## Password Encryption Support